diff --git a/src/fft-api/index.ts b/src/fft-api/index.ts index 6348c46..0dc631d 100644 --- a/src/fft-api/index.ts +++ b/src/fft-api/index.ts @@ -2,16 +2,17 @@ export * from './auth'; export * from './common'; export * from './facility'; export * from './handover'; +export * from './listing'; export * from './loadunit'; export * from './order'; +export * from './packjob'; export * from './parcel'; export * from './pickjob'; -export * from './packjob'; export * from './process'; export * from './routing-plan'; export * from './shipment'; +export * from './stock'; export * from './subscription'; export * from './tag'; export * from './types'; -export * from './stock'; export * from './zone'; diff --git a/src/fft-api/listing/fftListingService.ts b/src/fft-api/listing/fftListingService.ts new file mode 100644 index 0000000..cf7daef --- /dev/null +++ b/src/fft-api/listing/fftListingService.ts @@ -0,0 +1,118 @@ +import { Logger } from 'tslog'; +import { ResponseError } from 'superagent'; + +import { FftApiClient } from '../common'; +import { CustomLogger } from '../../common'; +import { Listing, ListingForReplacement, ModifyListingAction, StrippedListings } from '../types'; + +export class FftListingService { + private readonly path = 'listings'; + private readonly logger: Logger = new CustomLogger(); + + constructor(private readonly apiClient: FftApiClient) {} + + public async create(facilityId: string, listing: ListingForReplacement): Promise { + try { + const listingsForReplacement = { listings: [listing] }; + return await this.apiClient.put(`facilities/${facilityId}/${this.path}`, { + ...listingsForReplacement, + }); + } catch (err) { + const httpError = err as ResponseError; + this.logger.error( + `Could not create listing ${listing.tenantArticleId} for facility ${facilityId}. Failed with status ${ + httpError.status + }, error: ${httpError.response ? JSON.stringify(httpError.response.body) : ''}` + ); + + throw err; + } + } + + public async get(facilityId: string, tenantArticleId: string, relaxed = false): Promise { + try { + return await this.apiClient.get(`facilities/${facilityId}/${this.path}/${tenantArticleId}`); + } catch (err) { + const httpError = err as ResponseError; + if (httpError.status === 404 && relaxed) { + return undefined; + } + this.logger.error( + `Could not fetch listing ${tenantArticleId} for facility ${facilityId}. Failed with status ${ + httpError.status + }, error: ${httpError.response ? JSON.stringify(httpError.response.body) : ''}` + ); + + throw err; + } + } + + public async getAll(facilityId: string, size = 25): Promise { + try { + return await this.apiClient.get(`facilities/${facilityId}/${this.path}`, { + ...(size && { size: size.toString() }), + }); + } catch (error) { + const httpError = error as ResponseError; + this.logger.error( + `Could not get listings for facility ${facilityId}. Failed with status ${httpError.status}, error: ${ + httpError.response ? JSON.stringify(httpError.response.body) : '' + }` + ); + throw error; + } + } + + public async update(facilityId: string, tenantArticleId: string, action: ModifyListingAction): Promise { + try { + action.action = ModifyListingAction.ActionEnum.ModifyListing; + const listing = await this.get(facilityId, tenantArticleId); + const listingPatchActions = { + actions: [action], + version: listing?.version, + }; + return await this.apiClient.patch(`facilities/${facilityId}/${this.path}/${tenantArticleId}`, { + ...listingPatchActions, + }); + } catch (err) { + const httpError = err as ResponseError; + this.logger.error( + `Could not update listing ${tenantArticleId} for facility ${facilityId}. Failed with status ${ + httpError.status + }, error: ${httpError.response ? JSON.stringify(httpError.response.body) : ''}` + ); + + throw err; + } + } + + public async delete(facilityId: string, tenantArticleId: string): Promise { + try { + return await this.apiClient.delete(`facilities/${facilityId}/${this.path}/${tenantArticleId}`); + } catch (err) { + const httpError = err as ResponseError; + this.logger.error( + `Could not delete listing ${tenantArticleId} for facility ${facilityId}. Failed with status ${ + httpError.status + }, error: ${httpError.response ? JSON.stringify(httpError.response.body) : ''}` + ); + + throw err; + } + } + + public async deleteAll(facilityId: string): Promise { + try { + return await this.apiClient.delete(`facilities/${facilityId}/${this.path}`); + } catch (err) { + const httpError = err as ResponseError; + this.logger.error( + `Could not delete listings for facility ${facilityId}. Failed with status ${httpError.status}, error: ${ + httpError.response ? JSON.stringify(httpError.response.body) : '' + }` + ); + + throw err; + } + } +} diff --git a/src/fft-api/listing/index.ts b/src/fft-api/listing/index.ts new file mode 100644 index 0000000..a675484 --- /dev/null +++ b/src/fft-api/listing/index.ts @@ -0,0 +1 @@ +export * from './fftListingService'; diff --git a/src/fft-api/types/api-ctl.sh b/src/fft-api/types/api-ctl.sh index 94ea975..e8c24d3 100755 --- a/src/fft-api/types/api-ctl.sh +++ b/src/fft-api/types/api-ctl.sh @@ -4,7 +4,7 @@ SCRIPTDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )" TARGET_DIR="${SCRIPTDIR}/typescript-fetch-client" apiUrl="https://raw.githubusercontent.com/fulfillmenttools/fulfillmenttools-api-reference/master/api.swagger.yaml" -openApiVersion="3.0.54" +openApiVersion="3.0.57" swaggerFile="swagger-codegen-cli-${openApiVersion}.jar" localSwaggerFile="${SCRIPTDIR}/${swaggerFile}" swaggerCodeGenUrl="https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/${openApiVersion}/${swaggerFile}" diff --git a/src/fft-api/types/api.swagger.yaml b/src/fft-api/types/api.swagger.yaml index 59533e2..3d2d35c 100644 --- a/src/fft-api/types/api.swagger.yaml +++ b/src/fft-api/types/api.swagger.yaml @@ -313,6 +313,7 @@ paths: - $ref: '#/components/schemas/DpdChCarrierConfiguration' - $ref: '#/components/schemas/DhlV2CarrierConfiguration' - $ref: '#/components/schemas/VceCarrierConfiguration' + - $ref: '#/components/schemas/PostNlCarrierConfiguration' description: >- Carrier Configuration was found & you were allowed to access it. The result is in the body. @@ -362,8 +363,10 @@ paths: - $ref: '#/components/schemas/GlsCarrierConfiguration' - $ref: '#/components/schemas/FedexCarrierConfiguration' - $ref: '#/components/schemas/BringCarrierConfiguration' + - $ref: '#/components/schemas/DpdChCarrierConfiguration' - $ref: '#/components/schemas/DhlV2CarrierConfiguration' - $ref: '#/components/schemas/VceCarrierConfiguration' + - $ref: '#/components/schemas/PostNlCarrierConfiguration' description: >- Carrier Configuration was found & you were allowed to access it. The result is in the body. @@ -403,8 +406,10 @@ paths: - $ref: '#/components/schemas/GlsCarrierConfiguration' - $ref: '#/components/schemas/FedexCarrierConfiguration' - $ref: '#/components/schemas/BringCarrierConfiguration' + - $ref: '#/components/schemas/DpdChCarrierConfiguration' - $ref: '#/components/schemas/DhlV2CarrierConfiguration' - $ref: '#/components/schemas/VceCarrierConfiguration' + - $ref: '#/components/schemas/PostNlCarrierConfiguration' description: Carrier Configuration required: true summary: Update a carrier configuration with the given ID @@ -1160,15 +1165,54 @@ paths: under our SLA regulations. For details on this topic please check our documentation

- operationId: putHandoverConfiguration + operationId: upsertHandoverConfiguration requestBody: content: application/json: schema: - $ref: '#/components/schemas/HandoverConfiguration' + $ref: '#/components/schemas/HandoverConfigurationForCreate' description: Desired HandoverConfiguration required: true summary: Change the handover configuration + /api/configurations/handover/refusereasons: + get: + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AvailableRefusedReason' + description: Existing refuse reasons + '400': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: Invalid input. See response for details + '401': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: Your user is not allowed to operate against this API instance + '403': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: >- + Your user, although recognized, is not authorized to use this + endpoint + tags: + - Fulfillment Operations - Handover + description: '' + operationId: getAllRefuseReasons + summary: Get all tenant wide refuse reasons /api/configurations/tags/packjob: get: responses: @@ -1682,87 +1726,6 @@ paths: $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: @@ -1995,15 +1958,15 @@ paths: description: Desired default locale configuration to put required: true summary: Change the tenant wide default locale configuration - /api/configurations/orderrouting: + /api/configurations/oidcproviders: get: responses: '200': content: application/json: schema: - $ref: '#/components/schemas/OrderRoutingConfiguration' - description: The Order Routing Configuration can be found in the body. + $ref: '#/components/schemas/OidcProviders' + description: existing oidc providers. '401': content: application/json: @@ -2021,39 +1984,85 @@ paths: 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. + - 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: getOrderRoutingConfiguration - summary: Get the tenant wide order routing configuration - put: + 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/OrderRoutingConfiguration' - description: The order routing configuration was successfully updated. - '201': + $ref: '#/components/schemas/StrippedOidcProvider' + description: Provider was updated successfully + '401': content: application/json: schema: - $ref: '#/components/schemas/OrderRoutingConfiguration' - description: The order routing configuration was successfully created. - '400': + items: + $ref: '#/components/schemas/ApiError' + description: Your user is not allowed to operate against this API instance + '403': content: application/json: schema: items: $ref: '#/components/schemas/ApiError' - description: Invalid input. See response for details + 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: @@ -2070,27 +2079,47 @@ paths: 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: '' - operationId: putOrderRoutingConfiguration + - 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/OrderRoutingConfiguration' - description: Desired order routing configuration to create/update - required: true - summary: Change the tenant wide order routing configuration - /api/configurations/oidcproviders: - get: + $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/OidcProviders' - description: existing oidc providers. + $ref: '#/components/schemas/OidcProviderForUpdate' + description: Provider was updated successfully '401': content: application/json: @@ -2107,6 +2136,13 @@ paths: 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: |- @@ -2118,180 +2154,20 @@ paths: 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' +

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': - 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. + description: OIDC Provider was found & you were allowed to delete it. '401': content: application/json: @@ -2501,31 +2377,15 @@ paths: description: Desired return note configuration to create/update required: true summary: Change the tenant wide return note configuration - /api/configurations/routing: + /api/configurations/stock: 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. + $ref: '#/components/schemas/StockConfiguration' + description: StockConfiguration config found. '401': content: application/json: @@ -2548,74 +2408,35 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Routing configuration not found + description: Entity not found tags: - - DOMS - Routing Plans - description: '' - operationId: getRoutingConfiguration - summary: Get a tenant routing config - patch: + - 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/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': + $ref: '#/components/schemas/StockConfiguration' + description: The stockConfiguration was successfully created. + '400': 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 + description: Invalid input. See response for details '401': content: application/json: @@ -2632,40 +2453,27 @@ paths: 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 + - Inventory Management - Stocks + description: '' + operationId: putStockConfiguration requestBody: content: application/json: schema: - $ref: '#/components/schemas/RoutingConfiguration' + $ref: '#/components/schemas/StockConfiguration' + description: Desired stock configuration to put required: true - summary: Update routing configuration of a tenant - /api/configurations/routing/rerouteshortpick: + summary: Change the tenant wide stock configuration + /api/configurations/substitution: 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. + $ref: '#/components/schemas/SubstitutionConfiguration' + description: Substitution config found. '401': content: application/json: @@ -2688,9 +2496,9 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Reroute configuration not found + description: Entity not found tags: - - DOMS - Routing Plans + - Fulfillment Operations - Picking description: >-
documentation

- operationId: getRerouteShortPickConfiguration - summary: Get a tenant reroute short pick config + operationId: getSubstitutionConfiguration + summary: Get the current configuration for substitution put: responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RerouteShortPickConfiguration' - description: Reroute short pick configuration was written successfully + $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: @@ -2726,43 +2547,34 @@ paths: description: >- Your user, although recognized, is not authorized to use this endpoint - '404': + '409': content: application/json: schema: items: $ref: '#/components/schemas/ApiError' - description: Reroute short pick configuration not found + description: Facility version conflict 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 + - Fulfillment Operations - Picking + description: '' + operationId: putSubstitutionConfiguration requestBody: content: application/json: schema: - $ref: '#/components/schemas/RerouteShortPickConfiguration' + $ref: '#/components/schemas/SubstitutionConfiguration' + description: Desired substitution configuration to create/update required: true - summary: Update reroute short pick configuration of a tenant - /api/configurations/routing/reroutetimetriggered: + summary: Change the tenant wide substitution configuration + /api/configurations/supportedlocales: 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. + $ref: '#/components/schemas/SupportedLocales' + description: The supported locales can be found in the body. '401': content: application/json: @@ -2779,34 +2591,20 @@ paths: 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: + - 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/RerouteTimeTriggeredConfiguration' - description: Reroute time triggered configuration was written successfully + $ref: '#/components/schemas/PackingContainerRequiredConfiguration' + description: The requirement of containers in packing can be found in the body. '401': content: application/json: @@ -2829,79 +2627,42 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Reroute configuration not found + description: Entity not found tags: - - DOMS - Routing Plans + - 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: 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: + src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'>
+
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/ManualRerouteConfiguration' + $ref: '#/components/schemas/PackingContainerRequiredConfiguration' 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': + The packing container requirement configuration was successfully + updated. + '201': content: application/json: schema: - items: - $ref: '#/components/schemas/ApiError' + $ref: '#/components/schemas/PackingContainerRequiredConfiguration' description: >- - Your user, although recognized, is not authorized to use this - endpoint - '404': + The packing container requirement configuration was successfully + created. + '400': 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 + description: Invalid input. See response for details '401': content: application/json: @@ -2918,121 +2679,110 @@ paths: 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 + - Fulfillment Operations - Packing description: >-

This endpoint is deprecated and has been replaced.

Deprecated, use GlobalManualRerouteConfiguration in - /api/configurations/routing + />
Deprecated, will be replaced with /api/configurations/packing deprecated: true - operationId: putManualRerouteConfiguration + operationId: putPackingContainerRequirement requestBody: content: application/json: schema: - $ref: '#/components/schemas/ManualRerouteConfiguration' + $ref: '#/components/schemas/PackingContainerRequiredConfiguration' + description: Validation picking scan code to activate/deactivate required: true - summary: Update manual order reroute configuration of a tenant - /api/configurations/promises: - get: + summary: Change the tenant wide packing container requirement configuration + /api/deliverynotes: + post: + parameters: + - description: >- + Provide the localized values for the delivery note. If not provided + the default locale is used. For example de_DE + in: query + name: locale + schema: + type: string responses: - '200': + '201': content: - application/json: + application/pdf: schema: - $ref: '#/components/schemas/PromisesConfiguration' - description: >- - Promises configuration was found & you were allowed to access it. - The result is in the body. + $ref: '#/components/schemas/DeliveryNote' + description: Successfully created the delivery note. '401': content: - application/json: + application/pdf: schema: items: $ref: '#/components/schemas/ApiError' description: Your user is not allowed to operate against this API instance '403': content: - application/json: + application/pdf: schema: items: $ref: '#/components/schemas/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 + - Fulfillment Operations - Shipments + operationId: createDeliveryNote requestBody: content: application/json: schema: - $ref: '#/components/schemas/PromisesConfiguration' - description: Desired promises configuration to put + $ref: '#/components/schemas/DeliveryNote' required: true - summary: Change the tenant wide promises configuration - /api/configurations/stock: + 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/StockConfiguration' - description: StockConfiguration config found. + $ref: '#/components/schemas/StrippedFacilities' + description: Facilities are found. '401': content: application/json: @@ -3049,34 +2799,21 @@ paths: 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: + - Core - Facilities + description: '' + operationId: getAllFacilities + summary: Return all facilities + post: responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/StockConfiguration' - description: The stockConfiguration was successfully created. + $ref: '#/components/schemas/Facility' + description: >- + The facility was successfully created. The Location header contains + the URL of the facility. '400': content: application/json: @@ -3101,26 +2838,36 @@ paths: Your user, although recognized, is not authorized to use this endpoint tags: - - Inventory Management - Stocks + - Core - Facilities description: '' - operationId: putStockConfiguration + operationId: addFacility requestBody: content: application/json: schema: - $ref: '#/components/schemas/StockConfiguration' - description: Desired stock configuration to put + $ref: '#/components/schemas/FacilityForCreation' + description: Representation that describes the facility required: true - summary: Change the tenant wide stock configuration - /api/configurations/substitution: - get: + 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': - content: - application/json: - schema: - $ref: '#/components/schemas/SubstitutionConfiguration' - description: Substitution config found. + description: Facility was found & you were allowed to delete it. '401': content: application/json: @@ -3143,41 +2890,74 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found + description: Facility 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: + - 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/SubstitutionConfiguration' - description: The substitution configuration was successfully updated. - '201': + $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: - $ref: '#/components/schemas/SubstitutionConfiguration' - description: The substitution configuration was successfully created. - '400': + items: + $ref: '#/components/schemas/ApiError' + description: Your user is not allowed to operate against this API instance + '403': content: application/json: schema: items: $ref: '#/components/schemas/ApiError' - description: Invalid input. See response for details + 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: @@ -3194,6 +2974,13 @@ paths: 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: @@ -3202,26 +2989,38 @@ paths: $ref: '#/components/schemas/ApiError' description: Facility version conflict tags: - - Fulfillment Operations - Picking + - Core - Facilities description: '' - operationId: putSubstitutionConfiguration + operationId: patchFacility requestBody: content: application/json: schema: - $ref: '#/components/schemas/SubstitutionConfiguration' - description: Desired substitution configuration to create/update + $ref: '#/components/schemas/FacilityPatchActions' + description: Patch set required: true - summary: Change the tenant wide substitution configuration - /api/configurations/supportedlocales: - get: + 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/SupportedLocales' - description: The supported locales can be found in the body. + $ref: '#/components/schemas/Facility' + description: Updated Facility in the body. '401': content: application/json: @@ -3239,19 +3038,27 @@ paths: 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: + - 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/PackingContainerRequiredConfiguration' - description: The requirement of containers in packing can be found in the body. + $ref: '#/components/schemas/StrippedCarriers' + description: >- + Carriers are found & you were allowed to access it. The result is in + the body. '401': content: application/json: @@ -3272,37 +3079,67 @@ paths: content: application/json: schema: - items: - $ref: '#/components/schemas/ApiError' - description: Entity not found + $ref: '#/components/schemas/ApiError' + description: Carriers not found tags: - - Fulfillment Operations - Packing + - Core - Facilities 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: + src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png' + />
This part of the API is currently under development. + That means that this endpoint, model, etc. can contain breaking changes + and / or might not be available at all times in your API instance. 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}/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/PackingContainerRequiredConfiguration' - description: >- - The packing container requirement configuration was successfully - updated. - '201': + $ref: '#/components/schemas/FacilityStockConfiguration' + description: Configuration for stock routing was found. + '404': content: application/json: schema: - $ref: '#/components/schemas/PackingContainerRequiredConfiguration' + 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: >- - The packing container requirement configuration was successfully - created. + Facility was found & patch-set has been applied. The patched + facility configuration is in the body. '400': content: application/json: @@ -3326,46 +3163,79 @@ paths: 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: - - Fulfillment Operations - Packing - description: >- -
-
This endpoint is deprecated and has been replaced.

Deprecated, will be replaced with /api/configurations/packing - deprecated: true - operationId: putPackingContainerRequirement + - Inventory Management - Stocks + description: '' + operationId: patchFacilityConfiguration requestBody: content: application/json: schema: - $ref: '#/components/schemas/PackingContainerRequiredConfiguration' - description: Validation picking scan code to activate/deactivate + $ref: '#/components/schemas/StockConfigurationPatchActions' + description: Patch set required: true - summary: Change the tenant wide packing container requirement configuration - /api/configurations/routing/toolkit/fences: + summary: Patches a facility configuration with the given ID + /api/facilities/{facilityId}/listings: get: parameters: - - description: all entities + - 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 entities to show + - 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/ToolkitFencesTransporter' - description: The current list of available toolkit fences + $ref: '#/components/schemas/StrippedListings' + description: >- + Facility was found & you were allowed to access it. The results are + in the body. '401': content: application/json: @@ -3388,34 +3258,31 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: No more elements available + description: Facility 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: getToolkitFences - summary: Returns all toolkit fences - post: - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ToolkitFenceForCreation' + - 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/ToolkitFence' - description: Toolkit Fence was created successfully. + $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: @@ -3438,38 +3305,32 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found + description: Facility listing not found tags: - - DOMS - Routing Plans + - 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: postToolkitFence - summary: Creates a toolkit fence - /api/configurations/routing/toolkit/fences/{toolkitFenceId}: - get: + 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 the toolkit fence you want to get + - description: ID of facility you want to delete all listings of in: path - name: toolkitFenceId + name: facilityId 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. + description: Facility listings were found and successfully deleted '401': content: application/json: @@ -3492,42 +3353,30 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: User not found + description: Facility listing 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: + - 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 the toolkit fence you want to update + - description: ID of facility you want to delete a listing of in: path - name: toolkitFenceId + 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 - 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. + description: Facility listing was found and successfully deleted '401': content: application/json: @@ -3550,31 +3399,42 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Toolkit fence not found + description: Facility listing 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: + - 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 the toolkit fence you want to delete + - description: ID of facility you want to get listing in: path - name: toolkitFenceId + name: facilityId + required: true + schema: + type: string + - description: tenantArticleId of listing you want to get + in: path + name: tenantArticleId required: true schema: type: string + - description: >- + Provide the localized names and descriptions for the listing. If not + provided the default locale is used., for example de_DE. + in: query + name: locale + schema: + type: string responses: '200': - description: Toolkit fence was found & you were allowed to delete it. + 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: @@ -3597,43 +3457,42 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Toolkit fence not found + description: Listings 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: + - Core - Listings + description: '' + operationId: getListing + summary: Get a Listings with the given ID + patch: parameters: - - description: all entities - in: query - name: startAfterId - required: false + - description: ID of facility you want to patch a listing of + in: path + name: facilityId + required: true schema: type: string - - description: number of entities to show - in: query - name: size - required: false + - description: tenant ID of the articles listing you want to patch + in: path + name: tenantArticleId + required: true schema: - default: 25 - type: integer + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ToolkitRatingTransporter' - description: The current list of available toolkit fences + 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: @@ -3656,34 +3515,58 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: No more elements available + description: Facility listing not found + '409': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: Listing version conflict 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: + - Core - Listings + description: '' + operationId: patchFacilityListing requestBody: content: application/json: schema: - $ref: '#/components/schemas/ToolkitRatingForCreation' + $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/ToolkitRating' - description: Toolkit Rating was created successfully. + $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: @@ -3706,38 +3589,36 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found + description: Facility or Listing not found tags: - - DOMS - Routing Plans - description: >- + - Core - Listings + operationId: getFacilityListingPartialStock + summary: Get a partial stocks for a listing + put: + deprecated: true + 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: + src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'> +
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 the tag you want to get + - description: ID of facility you want to get listing in: path - name: toolkitRatingId + 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: - $ref: '#/components/schemas/ToolkitRating' - description: >- - ToolkitRating was found & you were allowed to access it. The result - is in the body. + description: Facility listing was found & you were allowed to update it. '401': content: application/json: @@ -3760,42 +3641,53 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: User not found + description: Facility listing not found tags: - - DOMS - Routing Plans - description: >- + - 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 part of the API is currently under development. - That means that this endpoint, model, etc. can contain breaking changes - and / or might not be available at all times in your API instance. 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: + src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'> +
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 the toolkit rating you want to update + - description: ID of facility you want to patch the partial stocks in: path - name: toolkitRatingId + name: facilityId + required: true + schema: + type: string + - description: ID of listing you want to get partial stocks + in: path + name: tenantArticleId required: true schema: type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/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. + description: Facility listing was found & you were allowed to update it. '401': content: application/json: @@ -3818,31 +3710,43 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Toolkit rating not found + description: Facility listing not found tags: - - DOMS - Routing Plans + - 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 part of the API is currently under development. - That means that this endpoint, model, etc. can contain breaking changes - and / or might not be available at all times in your API instance. 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: + src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'> +
This endpoint is deprecated and has been replaced.

This endpoint is deprecated. Use /api/stocks endpoints instead. parameters: - - description: ID of the toolkit rating you want to delete + - description: ID of facility from whom you want to delete the partial stock in: path - name: toolkitRatingId + 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: Toolkit rating was found & you were allowed to delete it. + description: >- + Facility listing was found & you were allowed to delete the partial + stock. '401': content: application/json: @@ -3865,107 +3769,60 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Toolkit rating not found + description: Facility listing 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: + - Core - Listings + operationId: deleteFacilityListingPartialStock + summary: Delete partial stocks of a listings of a facility with the given ID + /api/validations/postalcodes: 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': + '200': + description: The given postal code is valid for the given country + '400': content: - application/pdf: + application/json: schema: items: $ref: '#/components/schemas/ApiError' - description: Your user is not allowed to operate against this API instance + description: The given postal code is invalid for the given country '403': content: - application/pdf: + 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: - - Fulfillment Operations - Shipments - operationId: createDeliveryNote + - Core - Validations + description: '' + operationId: validatePostalCode + summary: Validate a given postal code for a given country requestBody: content: application/json: schema: - $ref: '#/components/schemas/DeliveryNote' + $ref: '#/components/schemas/PostalCodeValidation' + description: Branding object required: true - summary: Create delivery note - /api/facilities: + /api/features: 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. + $ref: '#/components/schemas/Features' + description: The available feature for all active modules '401': content: application/json: @@ -3983,27 +3840,34 @@ paths: Your user, although recognized, is not authorized to use this endpoint tags: - - Core - Facilities - description: '' - operationId: getAllFacilities - summary: Return all facilities - post: + - 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: - '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': + '200': content: application/json: schema: - items: - $ref: '#/components/schemas/ApiError' - description: Invalid input. See response for details + $ref: '#/components/schemas/Feature' + description: The requested feature '401': content: application/json: @@ -4020,43 +3884,49 @@ paths: 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: '' - 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: + - 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: ID of facility you want to delete + - description: Name of the feature requested in: path - name: facilityId + name: featureName 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' + $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: @@ -4073,17 +3943,76 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Facility not found + description: Entity not found + '409': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: Entity version conflict tags: - - Core - Facilities + - 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/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: deleteFacility - summary: deletes a facility with the given ID + 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 facility you want to get + - description: id of pickRun in: path - name: facilityId + name: pickRunId required: true schema: type: string @@ -4092,10 +4021,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Facility' - description: >- - Facility was found & you were allowed to access it. The result is in - the body. + $ref: '#/components/schemas/PickRun' + description: PickRun is found. '401': content: application/json: @@ -4112,23 +4039,16 @@ paths: 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 + - Fulfillment Operations - Picking description: '' - operationId: getFacility - summary: Get a facility with the given ID + operationId: getPickRun + summary: Return a PickRun patch: parameters: - - description: ID of facility you want to patch + - description: id of pickRun in: path - name: facilityId + name: pickRunId required: true schema: type: string @@ -4137,10 +4057,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Facility' - description: >- - Facility was found & patch-set has been applied. The patched - facility is in the body. + $ref: '#/components/schemas/PickRun' + description: The updated PickRun. '401': content: application/json: @@ -4157,53 +4075,40 @@ paths: 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 + description: Version conflict tags: - - Core - Facilities + - Fulfillment Operations - Picking description: '' - operationId: patchFacility + operationId: patchPickRun requestBody: content: application/json: schema: - $ref: '#/components/schemas/FacilityPatchActions' - description: Patch set + $ref: '#/components/schemas/PickRunPatchAction' required: true - summary: Patches a facility with the given ID - /api/facilities/{facilityId}/actions: - post: - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/FacilityActionsParameter' + /api/pickruns/{pickRunId}/pickjobs: + patch: parameters: - - description: Reference to the facility you want to call the action for + - description: id of pickRun in: path - name: facilityId + name: pickRunId required: true schema: type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PickRunPickJobsPatchAction' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Facility' - description: Updated Facility in the body. + description: Pick job was successfully from pick run removed. '401': content: application/json: @@ -4221,15 +4126,21 @@ paths: 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: + - 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: ID of facility you want to get + - description: Reference to the pick run you want to call the action for in: path - name: facilityId + name: pickRunId required: true schema: type: string @@ -4238,10 +4149,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/StrippedCarriers' - description: >- - Carriers are found & you were allowed to access it. The result is in - the body. + $ref: '#/components/schemas/PickRun' + description: Updated Pick Run in the body. '401': content: application/json: @@ -4258,59 +4167,112 @@ paths: 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}: + - Fulfillment Operations - Picking + operationId: pickRunAction + summary: Call a single action on a given pickRun + /api/handoverjobs: get: parameters: - - description: ID of facility you want to get listing - in: path - name: facilityId - required: true + - 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: >- - The ID that describes the connection of this facility to the - referenced carrier - in: path - name: carrierRef - required: true + This query can be used to find handoverjobs for a referenced + shipment + in: query + name: shipmentRef + required: false 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. + Reference to the facility you want to get the corresponding + handoverJobs in: query - name: locale + name: facilityRef + required: false + schema: + type: string + - description: >- + Reference to the status you want to get the corresponding + handoverJobs + explode: true + in: query + name: status + required: false + schema: + items: + type: string + type: array + - description: >- + Reference to the carriers you want to get the corresponding + handoverJobs + in: query + name: carrierRefs + required: false + schema: + type: array + items: + type: string + - description: >- + Reference to the channel you want to get the corresponding + handoverJobs + in: query + name: channel + required: false + schema: + type: string + - description: Parameter to filter anonymized handover jobs + in: query + name: anonymized + required: false + schema: + type: boolean + - description: Perform full text search over all searchable attributes + in: query + name: searchTerm + required: false + schema: + type: string + - description: Start date range for pick jobs + in: query + name: startTargetTime + required: false + schema: + type: string + example: '2020-02-03T08:45:50.525Z' + format: date-time + - description: End date range for pick jobs + in: query + name: endTargetTime + required: false schema: type: string + example: '2020-02-03T08:45:50.525Z' + format: date-time responses: '200': content: application/json: schema: - $ref: '#/components/schemas/FacilityCarrierConnection' - description: >- - Carrier to facility connections was found & you were allowed to - access it. The result is in the body. + $ref: '#/components/schemas/StrippedHandoverjobs' + description: Handoverjobs are found. '401': content: application/json: @@ -4327,57 +4289,28 @@ paths: description: >- Your user, although recognized, is not authorized to use this endpoint - '404': + tags: + - Fulfillment Operations - Handover + description: '' + operationId: getAllHandoverjobs + summary: Return all handoverjobs + post: + responses: + '201': content: application/json: schema: - items: - $ref: '#/components/schemas/ApiError' + $ref: '#/components/schemas/Handoverjob' 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': + The handoverjob was successfully created. The Location header + contains the URL of it. + '400': content: application/json: schema: - $ref: '#/components/schemas/FacilityCarrierConnection' - description: Creation was successful. + items: + $ref: '#/components/schemas/ApiError' + description: Invalid input. See response for details '401': content: application/json: @@ -4394,66 +4327,34 @@ paths: 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 + - Fulfillment Operations - Handover + operationId: addHandoverjob requestBody: content: application/json: schema: - $ref: '#/components/schemas/FacilityCarrierConnectionForCreation' - description: Representation that describes the facility + $ref: '#/components/schemas/HandoverjobForCreation' required: true - summary: >- - Create a connection of a configured carrier to the facility with given - ID - put: + summary: Add a new handoverjob + /api/handoverjobs/{handoverjobId}: + get: parameters: - - description: ID of facility you want to get - in: path - name: facilityId - required: true - schema: - type: string - - description: The referenced carrier ID + - description: ID of the handoverjob you want to get in: path - name: carrierRef + name: handoverjobId 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. + $ref: '#/components/schemas/Handoverjob' + description: >- + Handoverjob was found & you were allowed to access it. The result is + in the body. '401': content: application/json: @@ -4476,63 +4377,17 @@ paths: 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 + description: Entity not found tags: - - Inventory Management - Stocks - operationId: getFacilityStockConfiguration - summary: >- - Gets the facility's current configuration for stock related order - distribution + - Fulfillment Operations - Handover + description: '' + operationId: getHandoverjob + summary: Get a Handoverjob with the given ID patch: parameters: - - description: ID of facility you want to get + - description: ID of handoverjob you want to patch in: path - name: facilityId + name: handoverjobId required: true schema: type: string @@ -4541,17 +4396,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FacilityStockConfiguration' + $ref: '#/components/schemas/Handoverjob' 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 + Handoverjob was found & patch-set has been applied. The patched + entity is in the body. '401': content: application/json: @@ -4574,73 +4422,99 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Facility Configuration not found + description: Entity not found '409': content: application/json: schema: items: $ref: '#/components/schemas/ApiError' - description: Facility version conflict + description: Entity version conflict tags: - - Inventory Management - Stocks + - Fulfillment Operations - Handover description: '' - operationId: patchFacilityConfiguration + operationId: patchHandoverjob requestBody: content: application/json: schema: - $ref: '#/components/schemas/StockConfigurationPatchActions' + $ref: '#/components/schemas/HandoverjobPatchActions' description: Patch set required: true - summary: Patches a facility configuration with the given ID - /api/facilities/{facilityId}/listings: - get: + summary: Patches a handoverjob with the given ID + /api/handoverjobs/{handoverJobId}/actions: + post: + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HandoverJobActionsParameter' parameters: - - description: ID of facility you want to get listing + - description: Reference to the handover job you want to call the action for in: path - name: facilityId + name: handoverJobId required: true schema: type: string - - description: all entities after given Id + 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: startAfterId + name: pickJobRef 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 + - description: Load unit ids + explode: true in: query - name: tenantArticleIds + name: id 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 + type: array 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. + $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: @@ -4663,18 +4537,45 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Facility not found + 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: - - Core - Listings - description: '' - operationId: getFacilityListing - summary: Get a facility with the given ID - put: + - Fulfillment Operations - Picking + operationId: deleteLoadUnits + summary: Delete loadunits by pickJobRef + get: parameters: - - description: ID of facility you want to put listings to - in: path - name: facilityId - required: true + - 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: @@ -4682,12 +4583,8 @@ paths: 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. + $ref: '#/components/schemas/LoadUnits' + description: Load units are found. '401': content: application/json: @@ -4704,38 +4601,67 @@ paths: description: >- Your user, although recognized, is not authorized to use this endpoint - '404': + 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: Facility listing not found + 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 - 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 + - Fulfillment Operations - Picking + operationId: addLoadUnit requestBody: content: application/json: schema: - $ref: '#/components/schemas/ListingsForReplacement' - description: listings for put + $ref: '#/components/schemas/LoadUnitsForCreation' + description: Representation that describes the unit load required: true - summary: Create or Update listings of a facility with the given ID + summary: Add new load units + /api/loadunits/{loadUnitId}: delete: parameters: - - description: ID of facility you want to delete all listings of - in: path - name: facilityId + - in: path + name: loadUnitId required: true schema: type: string responses: '200': - description: Facility listings were found and successfully deleted + content: + application/json: + schema: + $ref: '#/components/schemas/LoadUnit' + description: Successfully deleted load unit. '401': content: application/json: @@ -4758,30 +4684,33 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Facility listing not found + description: Entity 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: + - Fulfillment Operations - Picking + operationId: deleteLoadUnit + summary: Delete load unit + get: parameters: - - description: ID of facility you want to delete a listing of - in: path - name: facilityId + - in: path + name: loadUnitId required: true schema: type: string - - description: tenant ID of the articles listing you want to delete - in: path - name: tenantArticleId - required: true + - 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': - description: Facility listing was found and successfully deleted + content: + application/json: + schema: + $ref: '#/components/schemas/LoadUnit' + description: The found load unit. '401': content: application/json: @@ -4804,24 +4733,24 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Facility listing not found + description: Entity not found tags: - - Core - Listings - description: '' - operationId: deleteFacilityListing - summary: deletes a listing with the given ID of a facility with the given ID - get: + - Fulfillment Operations - Picking + operationId: getLoadUnitByID + summary: Get a loadUnit by its ID + patch: parameters: - - description: ID of facility you want to get listing - in: path - name: facilityId + - in: path + name: loadUnitId required: true schema: type: string - - description: tenantArticleId of listing you want to get - in: path - name: tenantArticleId - required: true + - 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: @@ -4829,10 +4758,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Listing' - description: >- - Listing is found & you were allowed to access it. The result is in - the body. + $ref: '#/components/schemas/LoadUnit' + description: The found load unit. '401': content: application/json: @@ -4855,24 +4782,50 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Listings not found + description: Entity not found tags: - - Core - Listings - description: '' - operationId: getListing - summary: Get a Listings with the given ID - patch: + - 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: ID of facility you want to patch a listing of - in: path - name: facilityId - required: true + - description: all entities after given Id + in: query + name: startAfterId + required: false schema: type: string - - description: tenant ID of the articles listing you want to patch - in: path - name: tenantArticleId - required: true + - 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: @@ -4880,17 +4833,8 @@ paths: 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 + $ref: '#/components/schemas/LoadUnitTypes' + description: All load unit types. '401': content: application/json: @@ -4913,45 +4857,66 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Facility listing not found - '409': + 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: Listing version conflict + 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 - Listings - description: '' - operationId: patchFacilityListing + - Fulfillment Operations - Picking + operationId: createLoadUnitTypes requestBody: content: application/json: schema: - $ref: '#/components/schemas/ListingPatchActions' - description: listings for put + $ref: '#/components/schemas/LoadUnitTypeForCreation' required: true - summary: Update a listing with the given ID of a facility with the given ID - /api/facilities/{facilityId}/listings/{tenantArticleId}/partialstocks: + summary: Create new load unit type + /api/loadunittypes/{loadUnitTypeId}: 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 + - in: path + name: loadUnitTypeId required: true schema: type: string - - description: ID of listing you want to get partial stocks - in: path - name: tenantArticleId - required: true + - 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: @@ -4959,12 +4924,8 @@ paths: 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. + $ref: '#/components/schemas/LoadUnitType' + description: The found load unit type. '401': content: application/json: @@ -4987,36 +4948,25 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Facility or Listing not found + description: Entity 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 + - Fulfillment Operations - Picking + operationId: getLoadUnitTypeByID + summary: Get a loadUnitType by its ID + patch: 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 + - in: path + name: loadUnitTypeId required: true schema: type: string responses: '200': - description: Facility listing was found & you were allowed to update it. + content: + application/json: + schema: + $ref: '#/components/schemas/LoadUnitType' + description: Successfully updated load unit type. '401': content: application/json: @@ -5039,53 +4989,39 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Facility listing not found + description: Entity not found tags: - - Core - Listings - operationId: putFacilityListingPartialStock + - Fulfillment Operations - Picking + operationId: updateLoadUnitType requestBody: content: application/json: schema: - $ref: '#/components/schemas/PartialStocksForReplacement' + $ref: '#/components/schemas/LoadUnitTypePatchActions' 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. + summary: Update load unit type + /api/loadunittypes/{loadUnitTypeId}/icon: + put: 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 + - in: path + name: loadUnitTypeId required: true schema: type: string responses: '200': - description: Facility listing was found & you were allowed to update it. + 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: @@ -5108,43 +5044,54 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Facility listing not found + description: Entity not found tags: - - Core - Listings - operationId: patchFacilityListingPartialStock + - Fulfillment Operations - Picking + operationId: uploadLoadUnitTypeIcon requestBody: content: application/json: schema: - $ref: '#/components/schemas/PartialStockPatchActions' - description: Patch set + $ref: '#/components/schemas/NamedFile' + description: Base64 encoded icon to upload 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. + summary: Upload icon for load unit type. + /api/measurementunits: + get: parameters: - - description: ID of facility from whom you want to delete the partial stock - in: path - name: facilityId - required: true + - description: all entities after given Id + in: query + name: startAfterId + required: false schema: type: string - - description: ID of listing you want to get partial stocks - in: path - name: tenantArticleId - required: true + - 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': - description: >- - Facility listing was found & you were allowed to delete the partial - stock. + content: + application/json: + schema: + $ref: '#/components/schemas/MeasurementUnits' + description: The found measurementUnit. '401': content: application/json: @@ -5167,23 +5114,35 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Facility listing not found + description: Entity not found tags: - Core - Listings - operationId: deleteFacilityListingPartialStock - summary: Delete partial stocks of a listings of a facility with the given ID - /api/validations/postalcodes: + 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: - '200': - description: The given postal code is valid for the given country - '400': + '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: The given postal code is invalid for the given country + description: Your user is not allowed to operate against this API instance '403': content: application/json: @@ -5193,52 +5152,64 @@ paths: description: >- Your user, although recognized, is not authorized to use this endpoint - '422': + '404': content: application/json: schema: items: $ref: '#/components/schemas/ApiError' - description: The given country can't be validated + description: Entity not found tags: - - Core - Validations - description: '' - operationId: validatePostalCode - summary: Validate a given postal code for a given country + - 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: - content: - application/json: - schema: - $ref: '#/components/schemas/PostalCodeValidation' - description: Branding object - required: true - /api/features: - get: + $ref: '#/components/requestBodies/MeasurementUnitForCreation' + summary: Create measurementUnit + /api/measurementunits/{measurementUnitId}: + delete: + parameters: + - in: path + name: measurementUnitId + required: true + schema: + type: string responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Features' - description: The available feature for all active modules + description: Successfully deleted 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: + '*/*': + schema: + items: + $ref: '#/components/schemas/ApiError' + description: Entity not found tags: - - Infrastructure - Features + - Core - Listings description: >-
documentation

- operationId: getFeatures - summary: Returns all features grouped by active modules - /api/features/{featureName}: + operationId: deleteMeasurementUnit + summary: Delete measurementUnit get: parameters: - - description: Name of the feature requested - in: path - name: featureName + - in: path + name: measurementUnitId required: true schema: type: string @@ -5264,8 +5233,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Feature' - description: The requested feature + $ref: '#/components/schemas/MeasurementUnit' + description: The found measurementUnit. '401': content: application/json: @@ -5290,7 +5259,7 @@ paths: $ref: '#/components/schemas/ApiError' description: Entity not found tags: - - Infrastructure - Features + - Core - Listings description: >-
documentation

- operationId: getFeature - summary: Returns a feature - patch: + operationId: getMeasurementUnitByID + summary: Get a measurementUnit by its ID + put: parameters: - - description: Name of the feature requested - in: path - name: featureName + - in: path + name: measurementUnitId required: true schema: type: string @@ -5315,10 +5283,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Feature' - description: >- - Module was found & patch-set has been applied. The patched entity is - in the body. + $ref: '#/components/schemas/MeasurementUnit' + description: Successfully updated the measurementUnit. '401': content: application/json: @@ -5342,15 +5308,8 @@ paths: 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 + - Core - Listings description: >-
documentation

- operationId: patchFeature + operationId: updateMeasurementUnit requestBody: content: application/json: schema: - $ref: '#/components/schemas/FeaturePatchActions' - description: Patch set + $ref: '#/components/schemas/MeasurementUnitForCreation' required: true - summary: Patches a feature - /api/fulfillability: - post: + summary: Update measurementUnit + /api/parcels: + get: + parameters: + - description: all entities after given Id + in: query + name: startAfterId + required: false + schema: + type: string + - description: number of entities to show + in: query + name: size + required: false + schema: + default: 25 + type: integer responses: '200': content: application/json: schema: - $ref: '#/components/schemas/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 + $ref: '#/components/schemas/StrippedParcels' + description: Parcels are found. '401': content: application/json: @@ -5406,44 +5367,22 @@ paths: 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: + - 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': - 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 + description: Parcel was successfully deleted '401': content: application/json: @@ -5460,96 +5399,35 @@ paths: 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': + '404': content: application/json: schema: items: $ref: '#/components/schemas/ApiError' - description: >- - Your user, although recognized, is not authorized to use this - endpoint + description: Entity not found 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: + - 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: - 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 + $ref: '#/components/schemas/Parcel' + description: >- + Parcel was found & you were allowed to access it. The result is in + the body. '401': content: application/json: @@ -5566,43 +5444,33 @@ paths: 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': + '404': content: application/json: schema: - $ref: '#/components/schemas/ResponseForDeliveryPromise' - description: The order promise was created URL of the order promse. - '400': + 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: - items: - $ref: '#/components/schemas/ApiError' - description: Invalid input. See response for details + $ref: '#/components/schemas/Parcel' + description: Successfully updated the parcel. '401': content: application/json: @@ -5619,269 +5487,235 @@ paths: 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': + '404': content: application/json: schema: items: $ref: '#/components/schemas/ApiError' - description: Your user is not allowed to operate against this API instance + description: Entity not found tags: - - Fulfillment Operations - Picking + - Fulfillment Operations - Shipments description: '' - operationId: addPickRun + operationId: patchParcel requestBody: content: application/json: schema: - $ref: '#/components/schemas/PickRunForCreation' + $ref: '#/components/schemas/ParcelPatchActions' + description: Patch set required: true - summary: Add a new PickRun - /api/pickruns/{pickRunId}: + summary: Patches a parcel with the given ID + /api/parcels/{parcelId}/labels/{labelDocument}: get: parameters: - - description: id of pickRun + - description: ID of the parcel you want to get a label for in: path - name: pickRunId + 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/json: - schema: - $ref: '#/components/schemas/PickRun' - description: PickRun is found. + application/pdf: {} + description: >- + Parcel was found & you were allowed to access it. The label is in + the body. '401': content: - application/json: + application/pdf: schema: items: $ref: '#/components/schemas/ApiError' description: Your user is not allowed to operate against this API instance '403': content: - application/json: + 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 + - Fulfillment Operations - Shipments description: '' - operationId: getPickRun - summary: Return a PickRun - patch: + operationId: getLabelForParcel + summary: Get a label for the parcel with the given ID + /api/parcels/{parcelId}/deliverynote: + get: parameters: - - description: id of pickRun + - description: ID of parcel you want to retrieve deliveryNote for in: path - name: pickRunId + 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/json: + application/pdf: schema: - $ref: '#/components/schemas/PickRun' - description: The updated PickRun. + $ref: '#/components/schemas/DeliveryNote' + description: Get delivery note as pdf. '401': content: - application/json: + application/pdf: schema: items: $ref: '#/components/schemas/ApiError' description: Your user is not allowed to operate against this API instance '403': content: - application/json: + application/pdf: schema: items: $ref: '#/components/schemas/ApiError' description: >- Your user, although recognized, is not authorized to use this endpoint - '409': + '404': content: - application/json: + application/pdf: schema: items: $ref: '#/components/schemas/ApiError' - description: Version conflict + description: Parcel not found tags: - - Fulfillment Operations - Picking - description: '' - operationId: patchPickRun - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PickRunPatchAction' - required: true - /api/pickruns/{pickRunId}/pickjobs: - patch: + - Fulfillment Operations - Shipments + operationId: getParcelDeliveryNote + summary: Get deliveryNote for a parcel + /api/parcels/{parcelId}/returnnote: + get: parameters: - - description: id of pickRun + - description: ID of parcel you want to retrieve returnNote for in: path - name: pickRunId + name: parcelId 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 + - 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/json: + application/pdf: schema: - $ref: '#/components/schemas/PickRun' - description: Updated Pick Run in the body. + $ref: '#/components/schemas/ReturnNote' + description: Get delivery note as pdf. '401': content: - application/json: + application/pdf: schema: items: $ref: '#/components/schemas/ApiError' description: Your user is not allowed to operate against this API instance '403': content: - application/json: + 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 - Picking - operationId: pickRunAction - summary: Call a single action on a given pickRun - /api/handoverjobs: + - Fulfillment Operations - Shipments + operationId: getParcelReturnNote + summary: Get returnNote for a parcel + /api/pickjobs: get: parameters: - - description: all entities after given Id + - 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: startAfterId + name: searchTerm required: false schema: type: string - - description: number of entities to show + - description: Reference to the carrier you want to get the corresponding pickjobs + explode: false in: query - name: size + name: carrierKeys required: false schema: - default: 25 - type: integer - - description: This query can be used to find handoverjobs for a referenced pickjob + items: + type: string + maxItems: 100 + type: array + - description: >- + Reference to the orderDate you want to get the corresponding + pickjobs in: query - name: pickJobRef + name: startOrderDate required: false schema: type: string - description: >- - This query can be used to find handoverjobs for a referenced - shipment + Reference to the orderDate you want to get the corresponding + pickjobs in: query - name: shipmentRef + name: endOrderDate required: false schema: type: string - - description: >- - Reference to the facility you want to get the corresponding - handoverJobs + - 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 - handoverJobs - explode: true + - description: Reference to the status you want to get the corresponding pickjobs + explode: false in: query name: status required: false @@ -5889,37 +5723,122 @@ paths: items: type: string type: array - - description: >- - Reference to the carriers you want to get the corresponding - handoverJobs + - description: Reference to the zones you want to get the corresponding pickjobs + explode: false in: query - name: carrierRefs + name: zoneRefs required: false schema: - type: array items: type: string + type: array - description: >- - Reference to the channel you want to get the corresponding - handoverJobs + 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: Parameter to filter anonymized handover jobs + - 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/StrippedHandoverjobs' - description: Handoverjobs are found. + $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: @@ -5937,20 +5856,19 @@ paths: Your user, although recognized, is not authorized to use this endpoint tags: - - Fulfillment Operations - Handover - description: '' - operationId: getAllHandoverjobs - summary: Return all handoverjobs + - Fulfillment Operations - Picking + operationId: queryPickJobs + summary: Simple query interface to find pickjobs post: responses: '201': content: application/json: schema: - $ref: '#/components/schemas/Handoverjob' + $ref: '#/components/schemas/PickJob' description: >- - The handoverjob was successfully created. The Location header - contains the URL of it. + The pick job was successfully created. The Location header contains + the URL of the pickjob. '400': content: application/json: @@ -5975,21 +5893,39 @@ paths: Your user, although recognized, is not authorized to use this endpoint tags: - - Fulfillment Operations - Handover - operationId: addHandoverjob + - Fulfillment Operations - Picking + description: '' + operationId: addPickJob requestBody: content: application/json: schema: - $ref: '#/components/schemas/HandoverjobForCreation' + $ref: '#/components/schemas/PickJobForCreation' + description: Pick job object required: true - summary: Add a new handoverjob - /api/handoverjobs/{handoverjobId}: + summary: Add a new pick job for fulfillment + /api/documents/{documentId}/file: get: parameters: - - description: ID of the handoverjob you want to get + - 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: handoverjobId + name: documentSetRef required: true schema: type: string @@ -5998,10 +5934,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Handoverjob' - description: >- - Handoverjob was found & you were allowed to access it. The result is - in the body. + $ref: '#/components/schemas/DocumentSet' + description: Documents were found. The results are in the body. '401': content: application/json: @@ -6018,35 +5952,34 @@ paths: 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: + - 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: ID of handoverjob you want to patch + - description: Reference to the documentSet you want to add a file to in: path - name: handoverjobId + name: documentSetRef required: true schema: type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalPrintableDocumentForCreation' + required: true responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/Handoverjob' - description: >- - Handoverjob was found & patch-set has been applied. The patched - entity is in the body. + $ref: '#/components/schemas/PrintableDocument' + description: Document was found. The results are in the body. '401': content: application/json: @@ -6070,46 +6003,40 @@ paths: 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' + - 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 handover job you want to call the action for + - description: Reference to the documentSet you want to update in: path - name: handoverJobId + 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/Handoverjob' - description: Updated Handover job in the body. + $ref: '#/components/schemas/PrintableDocument' + description: Document was found. The results are in the body. '401': content: application/json: @@ -6126,42 +6053,72 @@ paths: 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 - operationId: handoverJobAction - summary: Call a single action on a given Handover job - /api/loadunits: - delete: + - 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 pickJob of which you want to delete the loadUnits - in: query - name: pickJobRef - required: false + - description: Reference to the documentSet you want to download a file from + in: path + name: documentSetRef + required: true schema: type: string - - description: Load unit ids - explode: true - in: query - name: id - required: false + - description: Reference to the single document you want to download + in: path + name: documentRef + required: true schema: - items: - type: string - type: array + 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/LoadUnits' - description: Load units are successfully deleted. - '400': - content: - application/json: - schema: - items: - $ref: '#/components/schemas/ApiError' - description: Invalid input. See response for details + $ref: '#/components/schemas/PrintableDocument' + description: Changed Document '401': content: application/json: @@ -6185,53 +6142,72 @@ paths: items: $ref: '#/components/schemas/ApiError' description: Entity not found - '422': + 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: LoadUnits could not be removed due to failing conditions + description: Your user is not allowed to operate against this 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: 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 + - 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: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/LoadUnits' - description: Load units are found. + $ref: '#/components/schemas/PrintableDocument' + description: Document was found. The results are in the body. '401': content: application/json: @@ -6248,25 +6224,45 @@ paths: 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': + '404': content: application/json: schema: - $ref: '#/components/schemas/LoadUnits' - description: Load units are successfully created. - '400': + 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: - items: - $ref: '#/components/schemas/ApiError' - description: Invalid input. See response for details + $ref: '#/components/schemas/PrintableDocument' + description: Document was found. The results are in the body. '401': content: application/json: @@ -6283,32 +6279,68 @@ paths: 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: addLoadUnit + - 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/LoadUnitsForCreation' - description: Representation that describes the unit load + $ref: '#/components/schemas/ExternalDocumentContentForUpdate' + description: Document Content with id and version 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. + $ref: '#/components/schemas/PrintableDocument' + description: Changed Document '401': content: application/json: @@ -6333,31 +6365,29 @@ paths: $ref: '#/components/schemas/ApiError' description: Entity not found tags: - - Fulfillment Operations - Picking - operationId: deleteLoadUnit - summary: Delete load unit - get: + - Core - Document Sets + operationId: addContentToDocument + /api/pickjobs/{pickJobId}/actions: + post: + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PickJobActionsParameter' parameters: - - in: path - name: loadUnitId + - description: Reference to the pick job you want to call an action for + in: path + name: pickJobId 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. + $ref: '#/components/schemas/PickJob' + description: Updated PickJob in the body. '401': content: application/json: @@ -6374,30 +6404,25 @@ paths: 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: + operationId: pickJobAction + summary: Call a single action on a given pickJob + /api/pickjobs/{pickJobId}/picklineitems/{pickLineItemId}/availablesubstitutes: + get: parameters: - - in: path - name: loadUnitId + - description: Reference to the pick job you to get the available substitutes for + in: path + name: pickJobId 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 + Reference to the pickLineItem you to get the available substitutes + for + in: path + name: pickLineItemId + required: true schema: type: string responses: @@ -6405,8 +6430,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LoadUnit' - description: The found load unit. + $ref: '#/components/schemas/ResolvedSubstitutes' + description: Available substitutes for given pickLineItem '401': content: application/json: @@ -6423,56 +6448,28 @@ paths: 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: + 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: 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 + Reference to the pick job you want to get the corresponding + loadunits + in: path + name: pickJobId + required: true schema: type: string responses: @@ -6480,8 +6477,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LoadUnitTypes' - description: All load unit types. + $ref: '#/components/schemas/LoadUnits' + description: Loadunits were found. The results are in the body. '401': content: application/json: @@ -6498,25 +6495,18 @@ paths: 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 + operationId: queryPickJobLoadUnits + summary: Simple query interface to find load units of a pickjob post: responses: '201': content: application/json: schema: - $ref: '#/components/schemas/LoadUnitType' - description: Successfully created resource. + $ref: '#/components/schemas/PickingLoadUnit' + description: The load units was successfully created. '400': content: application/json: @@ -6542,37 +6532,43 @@ paths: endpoint tags: - Fulfillment Operations - Picking - operationId: createLoadUnitTypes + 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/LoadUnitTypeForCreation' + $ref: '#/components/schemas/PickingLoadUnitForCreation' + description: Pick job load unit object required: true - summary: Create new load unit type - /api/loadunittypes/{loadUnitTypeId}: + summary: Add a new load unit for pick job + /api/pickjobs/{pickJobId}: get: parameters: - - in: path - name: loadUnitTypeId + - description: ID of the pickjob you want to get + in: path + name: pickJobId 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. + $ref: '#/components/schemas/PickJob' + description: >- + PickJob was found & you were allowed to access it. The result is in + the body. '401': content: application/json: @@ -6598,12 +6594,14 @@ paths: description: Entity not found tags: - Fulfillment Operations - Picking - operationId: getLoadUnitTypeByID - summary: Get a loadUnitType by its ID + description: '' + operationId: getPickJob + summary: Get a pick job with the given ID patch: parameters: - - in: path - name: loadUnitTypeId + - description: ID of the pickjob you want to get + in: path + name: pickJobId required: true schema: type: string @@ -6612,8 +6610,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LoadUnitType' - description: Successfully updated load unit type. + $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: @@ -6636,49 +6636,50 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found + description: PickJob not found + '409': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: PickJob version conflict tags: - Fulfillment Operations - Picking - operationId: updateLoadUnitType + description: '' + operationId: patchPickJob requestBody: content: application/json: schema: - $ref: '#/components/schemas/LoadUnitTypePatchActions' + $ref: '#/components/schemas/PickingPatchActions' description: Patch set required: true - summary: Update load unit type - /api/loadunittypes/{loadUnitTypeId}/icon: - put: + summary: Patches a pick job with the given ID + /api/pickjobs/{pickjobId}/returnnote: + get: parameters: - - in: path - name: loadUnitTypeId + - description: ID of the Pickjob + in: path + name: pickjobId 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. + application/pdf: {} + description: Returns a return note for the pickjob. '401': content: - application/json: + application/pdf: schema: items: $ref: '#/components/schemas/ApiError' description: Your user is not allowed to operate against this API instance '403': content: - application/json: + application/pdf: schema: items: $ref: '#/components/schemas/ApiError' @@ -6687,47 +6688,28 @@ paths: endpoint '404': content: - application/json: + application/pdf: 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: + description: '' + operationId: getReturnNotesForPickjob + summary: Get the return note for the pickjob with the given ID + /api/pickjobs/{pickJobId}/deliverynote: 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 + - 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 names for the measurementUnit. If not provided - the default locale is used., for example de_DE. + 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: @@ -6735,10 +6717,8 @@ paths: responses: '200': content: - application/json: - schema: - $ref: '#/components/schemas/MeasurementUnits' - description: The found measurementUnit. + application/pdf: {} + description: The deliverynote for the given pickjob '401': content: application/json: @@ -6763,26 +6743,57 @@ paths: $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: + - 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: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/MeasurementUnit' - description: Successfully created the measurementUnit. + $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: @@ -6807,7 +6818,7 @@ paths: $ref: '#/components/schemas/ApiError' description: Entity not found tags: - - Core - Listings + - Core - Processes description: >-
documentation

- operationId: createMeasurementUnit - requestBody: - $ref: '#/components/requestBodies/MeasurementUnitForCreation' - summary: Create measurementUnit - /api/measurementunits/{measurementUnitId}: - delete: + operationId: getProcesses + summary: >- + Returns a process belonging to the given parameters. At least one + parameter needs to be supplied. + /api/processes: + get: parameters: - - in: path - name: measurementUnitId - required: true + - 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': - description: Successfully deleted the measurementUnit. + 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 - '404': - content: - '*/*': - schema: - items: - $ref: '#/components/schemas/ApiError' - description: Entity not found tags: - - Core - Listings + - Core - Processes description: >-
documentation

- operationId: deleteMeasurementUnit - summary: Delete measurementUnit - get: + 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: - - in: path - name: measurementUnitId + - description: ID of process you want to patch + in: path + name: processId required: true schema: type: string @@ -6880,8 +7171,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MeasurementUnit' - description: The found measurementUnit. + $ref: '#/components/schemas/Process' + description: >- + Process was found & patch-set has been applied. The patched process + is in the body. '401': content: application/json: @@ -6904,24 +7197,30 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found + description: Process not found + '409': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: Process version conflict 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: + - 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: measurementUnitId + name: processId required: true schema: type: string @@ -6930,8 +7229,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MeasurementUnit' - description: Successfully updated the measurementUnit. + $ref: '#/components/schemas/Process' + description: The found process. '401': content: application/json: @@ -6956,7 +7255,7 @@ paths: $ref: '#/components/schemas/ApiError' description: Entity not found tags: - - Core - Listings + - Core - Processes description: >-
documentation

- operationId: updateMeasurementUnit - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MeasurementUnitForCreation' - required: true - summary: Update measurementUnit - /api/orders: - get: + operationId: getProcessByID + summary: Get a process by its ID + /api/processes/{processId}/reroute: + post: parameters: - - description: all entities after given Id - in: query - name: startAfterId - required: false + - description: ID of process you want to reroute + in: path + name: processId + required: true schema: type: string - - description: number of entities to show + - description: Version of process you want to reroute in: query - name: size - required: false + name: version + required: true schema: - default: 25 - type: integer - - description: filter orders by tenantOrderId + type: number + - description: The id of the rerouteDescription in: query - name: tenantOrderId + name: rerouteDescriptionId required: false schema: type: string @@ -7001,8 +7293,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/StrippedOrders' - description: Orders are found. + $ref: '#/components/schemas/Process' + description: >- + Process was found the corresponding reroute operations have been + triggered. '401': content: application/json: @@ -7019,149 +7313,154 @@ paths: 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': + '404': content: application/json: schema: items: $ref: '#/components/schemas/ApiError' - description: Your user is not allowed to operate against this API instance - '403': + description: Process not found + '409': content: application/json: schema: items: $ref: '#/components/schemas/ApiError' - description: >- - Your user, although recognized, is not authorized to use this - endpoint + description: Process version conflict tags: - - DOMS - Orders + - Core - Processes 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: + operationId: postProcess + summary: Reroutes a process with the given ID + /api/processes/{processId}/documents: + post: parameters: - - description: ID of order you want to get - in: path - name: orderId + - in: path + name: processId 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': + '201': content: application/json: schema: - items: - $ref: '#/components/schemas/ApiError' - description: >- - Your user, although recognized, is not authorized to use this - endpoint - '404': + $ref: '#/components/schemas/ExternalDocument' + description: The document was successfully created + '400': 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: + description: Invalid input. See response for details 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 + $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/json: - schema: - $ref: '#/components/schemas/Order' - description: Updated Order in the body. - '401': + 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: - items: - $ref: '#/components/schemas/ApiError' - description: Your user is not allowed to operate against this API instance - '403': + $ref: '#/components/schemas/ExternalDocument' + description: The document was successfully updated + '400': content: application/json: schema: items: $ref: '#/components/schemas/ApiError' - description: >- - Your user, although recognized, is not authorized to use this - endpoint + description: Invalid input. See response for details + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalDocumentForUpdate' + description: '' + required: true tags: - - DOMS - Orders - operationId: orderAction - summary: Call a single action on a given order - /api/orders/{orderId}/cancel: - post: + - 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: - - description: ID of order you want to cancel - in: path - name: orderId + - in: path + name: processId + required: true + schema: + type: string + - in: path + name: documentId required: true schema: type: string @@ -7170,8 +7469,32 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Order' - description: Order was cancelled sucessfully + $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: @@ -7188,25 +7511,9 @@ paths: 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: + - Fulfillment Operations - Returns + operationId: getReturnJobs parameters: - description: all entities after given Id in: query @@ -7214,53 +7521,55 @@ paths: required: false schema: type: string - - description: number of entities to show + - 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: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/StrippedParcels' - description: Parcels are found. - '401': + '201': content: application/json: schema: - items: - $ref: '#/components/schemas/ApiError' - description: Your user is not allowed to operate against this API instance - '403': + $ref: '#/components/schemas/ReturnJob' + description: The return was successfully created + '400': 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 + description: Invalid input. See response for details '401': content: application/json: @@ -7277,23 +7586,29 @@ paths: 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 + - 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 parcel you want to get + - description: ID of the return you want to get in: path - name: parcelId + name: returnId required: true schema: type: string @@ -7302,9 +7617,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Parcel' + $ref: '#/components/schemas/ReturnJob' description: >- - Parcel was found & you were allowed to access it. The result is in + Return was found & you were allowed to access it. The result is in the body. '401': content: @@ -7328,17 +7643,22 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found + description: User not found tags: - - Fulfillment Operations - Shipments - description: '' - operationId: getParcel - summary: Get a parcel with the given ID + - 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 the parcel you want to get + - description: ID of return you want to patch in: path - name: parcelId + name: returnId required: true schema: type: string @@ -7347,8 +7667,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Parcel' - description: Successfully updated the parcel. + $ref: '#/components/schemas/ReturnJob' + description: >- + Return was found & patch-set has been applied. The patched entity is + in the body. '401': content: application/json: @@ -7372,159 +7694,56 @@ paths: 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: patchParcel + - Fulfillment Operations - Returns + description: >- +
+
This endpoint is deprecated and has been replaced.

+ operationId: patchReturn requestBody: content: application/json: schema: - $ref: '#/components/schemas/ParcelPatchActions' + $ref: '#/components/schemas/ReturnPatchActions' 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: + summary: Patches a return with the given ID + deprecated: true + /api/scopedcapabilities: 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. + - description: id of the facility in: query - name: locale + name: facilityId + required: false schema: type: string responses: '200': content: - application/pdf: + application/json: schema: - $ref: '#/components/schemas/ReturnNote' - description: Get delivery note as pdf. + $ref: '#/components/schemas/ScopedCapabilities' + description: All ScopedCapabilities whic are at least inactive '401': content: - application/pdf: + application/json: schema: items: $ref: '#/components/schemas/ApiError' description: Your user is not allowed to operate against this API instance '403': content: - application/pdf: + application/json: schema: items: $ref: '#/components/schemas/ApiError' @@ -7533,66 +7752,72 @@ paths: endpoint '404': content: - application/pdf: + application/json: schema: items: $ref: '#/components/schemas/ApiError' - description: Parcel not found + description: Entity not found tags: - - Fulfillment Operations - Shipments - operationId: getParcelReturnNote - summary: Get returnNote for a parcel - /api/pickjobs: + - 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: >- - Search term you want to get the corresponding pickjobs. Search will - be performed on multiple fields, like tenantOrderId, consumerName, - tenantArticleId and more + - description: all entities after given Id in: query - name: searchTerm + name: startAfterId required: false schema: type: string - - description: Reference to the carrier you want to get the corresponding pickjobs - explode: false + - description: number of entities to show in: query - name: carrierKeys + name: size required: false schema: - items: - type: string - maxItems: 100 - type: array - - description: >- - Reference to the orderDate you want to get the corresponding - pickjobs + default: 25 + type: integer + - description: This query can be used to find shipments for a referenced pickjob in: query - name: startOrderDate + name: pickJobRef required: false schema: type: string - description: >- - Reference to the orderDate you want to get the corresponding - pickjobs + This query can be used to find shipments belonging to the referenced + facility in: query - name: endOrderDate + name: facilityRef required: false schema: type: string - - description: Reference to the order you want to get the corresponding pickjobs + - description: This query can be used to find shipments for a referenced carrier in: query - name: orderRef + name: carrierRef required: false schema: type: string - - description: Reference to the facility you want to get the corresponding pickjobs + - description: Find shipments with one the the given carriers + explode: false in: query - name: facilityRef + name: carrierKeys required: false schema: - type: string - - description: Reference to the status you want to get the corresponding pickjobs + items: + type: string + type: array + - description: Find shipments in one of the given status explode: false in: query name: status @@ -7601,82 +7826,16 @@ paths: items: type: string type: array - - description: Reference to the zones you want to get the corresponding pickjobs + - description: Find shipments with parcels in one of the given status explode: false in: query - name: zoneRefs + name: parcelStatus 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 + - description: Start date range for shipments in: query name: startTargetTime required: false @@ -7684,7 +7843,7 @@ paths: type: string example: '2020-02-03T08:45:50.525Z' format: date-time - - description: End date range for pick jobs + - description: End date range for shipments in: query name: endTargetTime required: false @@ -7692,19 +7851,19 @@ paths: type: string example: '2020-02-03T08:45:50.525Z' format: date-time - - description: Reference to pickjobs - explode: false + - description: Parameter to filter anonymized shipments in: query - name: pickJobRefs + name: anonymized required: false schema: - items: - type: string - maxItems: 100 - type: array - - description: Reference to the user ID you want to get the corresponding pickjobs + 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: modifiedByUsername + name: searchTerm required: false schema: type: string @@ -7713,10 +7872,8 @@ paths: 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. + $ref: '#/components/schemas/StrippedShipments' + description: Shipments are found. '401': content: application/json: @@ -7734,19 +7891,24 @@ paths: Your user, although recognized, is not authorized to use this endpoint tags: - - Fulfillment Operations - Picking - operationId: queryPickJobs - summary: Simple query interface to find pickjobs + - Fulfillment Operations - Shipments + description: '' + operationId: getAllShipments + summary: Return all shipments post: responses: '201': content: application/json: schema: - $ref: '#/components/schemas/PickJob' + $ref: '#/components/schemas/Shipment' description: >- - The pick job was successfully created. The Location header contains - the URL of the pickjob. + 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: @@ -7771,39 +7933,22 @@ paths: Your user, although recognized, is not authorized to use this endpoint tags: - - Fulfillment Operations - Picking - description: '' - operationId: addPickJob + - Fulfillment Operations - Shipments + operationId: addShipment requestBody: content: application/json: schema: - $ref: '#/components/schemas/PickJobForCreation' - description: Pick job object + $ref: '#/components/schemas/ShipmentForCreation' + description: Shipment object supplied by your picking app 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}: + summary: Add a new Shipment + /api/shipments/{shipmentId}: get: parameters: - - description: Reference to the entity you want to get + - description: ID of Shipment you want to get in: path - name: documentSetRef + name: shipmentId required: true schema: type: string @@ -7812,8 +7957,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DocumentSet' - description: Documents were found. The results are in the body. + $ref: '#/components/schemas/Shipment' + description: >- + Shipment was found & you were allowed to access it. The result is in + the body. '401': content: application/json: @@ -7830,34 +7977,35 @@ paths: 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: - - 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: + - Fulfillment Operations - Shipments + description: '' + operationId: getShipment + summary: Get a Shipment with the given ID + patch: parameters: - - description: Reference to the documentSet you want to add a file to + - description: ID of shipment you want to patch in: path - name: documentSetRef + name: shipmentId required: true schema: type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ExternalPrintableDocumentForCreation' - required: true responses: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/PrintableDocument' - description: Document was found. The results are in the body. + $ref: '#/components/schemas/Shipment' + description: >- + Shipment was found & patch-set has been applied. The patched entity + is in the body. '401': content: application/json: @@ -7881,50 +8029,58 @@ paths: items: $ref: '#/components/schemas/ApiError' description: Entity not found + '409': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: Entity version conflict tags: - - Core - Document Sets - operationId: addDocumentDeprecated - deprecated: true - description: Deprecated, use /api/documentsets/{documentSetRef}/documents instead - /api/documentSet/{documentSetRef}/documents/{documentRef}: - patch: + - 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: Reference to the documentSet you want to update + - description: ID of shipment you want to retrieve delivery note for in: path - name: documentSetRef + name: shipmentId required: true schema: type: string - - description: Reference to the single document you want to update - in: path - name: documentRef - required: true + - description: >- + Provide the localized values for the delivery note. If not provided + the default locale is used. For example de_DE. + in: query + name: locale schema: type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PrintableDocumentForUpdate' - description: PartialDocument - required: true responses: '200': content: - application/json: + application/pdf: schema: - $ref: '#/components/schemas/PrintableDocument' - description: Document was found. The results are in the body. + $ref: '#/components/schemas/DeliveryNote' + description: Get delivery note as pdf. '401': content: - application/json: + application/pdf: schema: items: $ref: '#/components/schemas/ApiError' description: Your user is not allowed to operate against this API instance '403': content: - application/json: + application/pdf: schema: items: $ref: '#/components/schemas/ApiError' @@ -7933,70 +8089,40 @@ paths: endpoint '404': content: - application/json: + application/pdf: 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 + description: Shipment not found tags: - - Core - Document Sets - description: '' - operationId: downloadDocumentDeprecated - summary: Download a document - put: + - Fulfillment Operations - Shipments + operationId: getShipmentDeliveryNote + summary: Get delivery note for a shipment + /api/shipments/{shipmentId}/parcels: + post: 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 + - description: ID of shipment you want to create parcel for in: path - name: documentRef + name: shipmentId 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': + '201': content: application/json: schema: - $ref: '#/components/schemas/PrintableDocument' - description: Changed Document + $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: @@ -8013,36 +8139,62 @@ paths: description: >- Your user, although recognized, is not authorized to use this endpoint - '404': + '422': content: application/json: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found + description: Parcel could not be processed due to failing conditions tags: - - Core - Document Sets - operationId: addContentToDocumentDeprecated - deprecated: true - description: >- - Deprecated, use - /api/documentsets/{documentSetRef}/documents/{documentRef}/file instead - /api/documentsets/{documentSetRef}: + - 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: Reference to the entity you want to get - in: path - name: documentSetRef - required: true + - 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/DocumentSet' - description: Documents were found. The results are in the body. + $ref: '#/components/schemas/Subscriptions' + description: All subscriptions. '401': content: application/json: @@ -8060,32 +8212,94 @@ paths: 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: + - 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: - parameters: - - description: Reference to the documentSet you want to add a file to - in: path - name: documentSetRef - required: true - schema: - type: string + 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/ExternalPrintableDocumentForCreation' + $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: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/PrintableDocument' - description: Document was found. The results are in the body. + $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: @@ -8110,37 +8324,36 @@ paths: $ref: '#/components/schemas/ApiError' description: Entity not found tags: - - Core - Document Sets - operationId: addDocument - /api/documentsets/{documentSetRef}/documents/{documentRef}: - patch: + - 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: 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 + - description: the tenantArticleId substitutes are requested for + in: query + name: tenantArticleId 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. + $ref: '#/components/schemas/Substitutes' + description: >- + There are substitutes for the given tenantArticleId. The result can + be found in the body. '401': content: application/json: @@ -8163,62 +8376,70 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found + description: Facility not found tags: - - Core - Document Sets - operationId: updateDocument - summary: Simple query interface to find documents - /api/documentsets/{documentSetRef}/documents/{documentRef}/file: - get: + - Fulfillment Operations - Picking + operationId: getResultingSubstitutesForTenantArticleId + summary: Get the resulting substitutes for a specific tenantArticleId. + /api/substitutes/{tenantArticleId}: + delete: 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 + - description: the tenant article ID the subsitutes should be deleted for in: path - name: documentRef + name: tenantArticleId required: true schema: type: string responses: '200': - description: The document as a stream + 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: - - Core - Document Sets + - Fulfillment Operations - Picking description: '' - operationId: downloadDocument - summary: Download a document - put: + operationId: deleteSubstitutesForTenantArticleId + summary: deletes substitutes for the given tenant article id + get: 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 + - description: '' in: path - name: documentRef + name: tenantArticleId 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 + $ref: '#/components/schemas/Substitutes' + description: >- + The substitutes for the given tenantArticleId can be found in the + body. '401': content: application/json: @@ -8241,21 +8462,17 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found + description: Facility not found tags: - - Core - Document Sets - operationId: addContentToDocument - /api/pickjobs/{pickJobId}/actions: - post: - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PickJobActionsParameter' + - 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: Reference to the pick job you want to call an action for + - description: Tenant article ID of the article the substitutes should be set for in: path - name: pickJobId + name: tenantArticleId required: true schema: type: string @@ -8264,8 +8481,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PickJob' - description: Updated PickJob in the body. + $ref: '#/components/schemas/Substitutes' + description: The substitutes for tenantArticleId were successfully updated '401': content: application/json: @@ -8282,34 +8499,34 @@ paths: 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 - operationId: pickJobAction - summary: Call a single action on a given pickJob - /api/pickjobs/{pickJobId}/picklineitems/{pickLineItemId}/availablesubstitutes: + 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: - 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 + $ref: '#/components/schemas/SupportedEvents' + description: All supported events. '401': content: application/json: @@ -8327,36 +8544,59 @@ paths: 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. + - 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 -

- /api/pickjobs/{pickJobId}/loadunits: + documentation


+ operationId: getEvents + summary: Get a list of supported events you can subscribe to. + /api/users: get: parameters: - - description: >- - Reference to the pick job you want to get the corresponding - loadunits - in: path - name: pickJobId - required: true + - 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/LoadUnits' - description: Loadunits were found. The results are in the body. + $ref: '#/components/schemas/StrippedUsers' + description: User are found. '401': content: application/json: @@ -8374,17 +8614,14 @@ paths: 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 + - Core - User Management + description: '' + operationId: getAllUsers + summary: Return all users post: responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/PickingLoadUnit' - description: The load units was successfully created. + description: The user is successfully created. '400': content: application/json: @@ -8409,44 +8646,36 @@ paths: Your user, although recognized, is not authorized to use this endpoint tags: - - Fulfillment Operations - Picking + - Core - User Management 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 + operationId: createUser requestBody: content: application/json: schema: - $ref: '#/components/schemas/PickingLoadUnitForCreation' - description: Pick job load unit object + $ref: '#/components/schemas/UserForCreation' + description: User object required: true - summary: Add a new load unit for pick job - /api/pickjobs/{pickJobId}: - get: + summary: Create a new user + /api/users/branding/{clientName}: + put: parameters: - - description: ID of the pickjob you want to get + - description: Identifier for the client you want to set the branding for. in: path - name: pickJobId + name: clientName required: true schema: type: string responses: '200': + description: The branding was successfully set. + '400': content: application/json: schema: - $ref: '#/components/schemas/PickJob' - description: >- - PickJob was found & you were allowed to access it. The result is in - the body. + items: + $ref: '#/components/schemas/ApiError' + description: Invalid input. See response for details '401': content: application/json: @@ -8469,29 +8698,42 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found + description: Unknown clientName tags: - - Fulfillment Operations - Picking - description: '' - operationId: getPickJob - summary: Get a pick job with the given ID - patch: + - 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: ID of the pickjob you want to get + - description: The id of the template to sign the request in: path - name: pickJobId + name: templateId required: true schema: type: string responses: '200': + description: The signed request is returned. + '400': 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. + items: + $ref: '#/components/schemas/ApiError' + description: Invalid input. See response for details '401': content: application/json: @@ -8508,56 +8750,82 @@ paths: description: >- Your user, although recognized, is not authorized to use this endpoint - '404': + 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: PickJob not found - '409': + description: Your user is not allowed to operate against this API instance + '403': content: application/json: schema: items: $ref: '#/components/schemas/ApiError' - description: PickJob version conflict + 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 - Picking + - Core - User Management 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: + operationId: deleteUser + summary: Deletes a User with the given ID get: parameters: - - description: ID of the Pickjob + - description: ID of User you want to get in: path - name: pickjobId + name: userId required: true schema: type: string responses: '200': content: - application/pdf: {} - description: Returns a return note for the pickjob. + 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/pdf: + application/json: schema: items: $ref: '#/components/schemas/ApiError' description: Your user is not allowed to operate against this API instance '403': content: - application/pdf: + application/json: schema: items: $ref: '#/components/schemas/ApiError' @@ -8566,37 +8834,38 @@ paths: endpoint '404': content: - application/pdf: + application/json: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found + description: User not found tags: - - Fulfillment Operations - Picking + - Core - User Management description: '' - operationId: getReturnNotesForPickjob - summary: Get the return note for the pickjob with the given ID - /api/pickjobs/{pickJobId}/deliverynote: - get: + operationId: getUser + summary: Get a User with the given ID + patch: parameters: - - description: ID of the pick job for which you want to get a deliverynote + - description: ID of the user you want to patch in: path - name: pickJobId + name: userId 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 + 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: @@ -8613,49 +8882,32 @@ paths: description: >- Your user, although recognized, is not authorized to use this endpoint - '404': + '409': content: application/json: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found + description: Facility version conflict tags: - - Fulfillment Operations - Picking + - Core - User Management description: '' - operationId: getPickJobDeliveryNote - summary: Get a deliverynote for the pick job with the given ID - /api/process: + 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: - - 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 + - description: ID of User you want to get + in: path + name: userId + required: true schema: type: string responses: @@ -8663,15 +8915,50 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Process' - description: Process belonging to the given parameters - '400': + $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: The given parameters are invalid + description: Your user is not allowed to operate against this API instance + '403': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/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: @@ -8694,27 +8981,70 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found + 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 - 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: + - Core - User Management + description: '' + operationId: postAssignedFacilities + summary: Assigns a facility to an user + /api/users/{userId}/assignedFacilities/{assignedFacilityId}: + delete: parameters: - - description: all entities after given Id - in: query + - 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: @@ -8726,251 +9056,168 @@ paths: 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 + 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: >- - Return the Processes which have related pickjobs with a targettime - on or before this date + Provide the localized values for the return note. If not provided + the default locale is used. For example de_DE. in: query - name: endTargetTime - required: false + name: locale schema: type: string - example: '2020-02-03T08:45:50.525Z' - format: date-time - - description: Return the Processes created on or after this date + 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: startDate + name: size 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 + default: 25 + type: integer + - description: all entities after given Id in: query - name: endDate + name: startAfterId 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 + - description: Parameter to filter anonymized pack jobs in: query - name: routingDomainStatus + name: anonymized required: false schema: - type: array - items: - type: string - - description: >- - Reference to the pickingDomainStatus you want to get the - corresponding processes - explode: true + type: boolean + - description: Reference to the status you want to get the corresponding pickjobs + explode: false in: query - name: pickingDomainStatus + name: status 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 + - description: Reference to the facility you want to get the corresponding packjobs in: query - name: shippingDomainStatus + name: facilityRef required: false schema: - type: array - items: - type: string - - description: >- - Reference to the handoverDomainStatus you want to get the - corresponding processes - explode: true + type: string + - description: Term by which to search through the fields in: query - name: handoverDomainStatus + name: searchTerm required: false schema: - type: array - items: - type: string - - description: >- - Reference to the returnDomainStatus you want to get the - corresponding processes - explode: true + type: string + - description: Reference to the channel you want to get the corresponding packjobs in: query - name: returnDomainStatus + name: channel required: false schema: - type: array - items: - type: string - - description: Stickers attached to a order - explode: true + enum: + - COLLECT + - SHIPPING + type: string + - description: filter by packingsourcecontainer containing codes in: query - name: stickers + name: sourceContainerCodes required: false schema: type: array items: type: string - - description: Perform full text search over all searchable attributes + - description: query packjobs orderBy in: query - name: searchTerm + name: orderBy 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' + - description: Start date range for pack jobs in: query - name: locked + name: startTargetTime required: false schema: - type: boolean - - description: Order status for the query + type: string + example: '2020-02-03T08:45:50.525Z' + format: date-time + - description: End date range for pack jobs in: query - name: orderStatus + name: endTargetTime required: false schema: - $ref: '#/components/schemas/OrderStatus' + type: string + example: '2020-02-03T08:45:50.525Z' + format: date-time responses: '200': content: application/json: schema: - $ref: '#/components/schemas/Processes' - description: Process are found. + $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: @@ -8987,33 +9234,35 @@ paths: 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: getAllProcesses - summary: Return all processes - /api/processes/retrynotroutable: + - Fulfillment Operations - Packing + description: '' + operationId: getPackJobs + summary: Get all pack jobs post: responses: - '204': + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/PackJob' description: >- - The retry for all not routable proceses has been succesfully - triggered + 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: The retry task can not be triggered due to a conflicting operation + description: Invalid input. See response for details '401': content: application/json: @@ -9031,28 +9280,35 @@ paths: Your user, although recognized, is not authorized to use this endpoint tags: - - Core - Processes + - Fulfillment Operations - Packing 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 + 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: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/Process' + $ref: '#/components/schemas/PackingContainerType' description: >- - Process was found & patch-set has been applied. The patched process - is in the body. + 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: @@ -9069,46 +9325,56 @@ paths: 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 + - Fulfillment Operations - Packing description: '' - operationId: patchProcess + operationId: addPackingContainerType requestBody: content: application/json: schema: - $ref: '#/components/schemas/ProcessPatchActions' - description: Patch set + $ref: '#/components/schemas/PackingContainerTypeForCreation' + description: Packing type object required: true - summary: Patches a process with the given ID + summary: Add a new packing container type get: parameters: - - in: path - name: processId - required: true + - 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: - $ref: '#/components/schemas/Process' - description: The found process. + 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: @@ -9125,45 +9391,68 @@ paths: description: >- Your user, although recognized, is not authorized to use this endpoint - '404': + 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: Entity not found + 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 - 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: + - Fulfillment Operations - Packing + description: '' + operationId: getPackingContainerType + summary: Get a packing container type by its id + patch: parameters: - - description: ID of process you want to reroute + - description: ID of the packingcontainertype you want to change in: path - name: processId - required: true - schema: - type: string - - description: Version of process you want to reroute - in: query - name: version + name: packingContainerTypeId required: true - schema: - type: number - - description: The id of the rerouteDescription - in: query - name: rerouteDescriptionId - required: false schema: type: string responses: @@ -9171,10 +9460,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Process' + $ref: '#/components/schemas/PackingContainerType' description: >- - Process was found the corresponding reroute operations have been - triggered. + PackingContainerType was found & patch-set has been applied. The + patched PackingContainerType is in the body. '401': content: application/json: @@ -9197,102 +9486,86 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Process not found + description: PackingContainerType not found '409': content: application/json: schema: items: $ref: '#/components/schemas/ApiError' - description: Process version conflict + description: PackingContainerType version conflict tags: - - Core - Processes + - Fulfillment Operations - Packing description: '' - operationId: postProcess - summary: Reroutes a process with the given ID - /api/processes/{processId}/documents: - post: + 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: - - in: path - name: processId + - description: ID of the pick job you want to get document handling information + in: path + name: pickJobId required: true schema: type: string responses: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/ExternalDocument' - description: The document was successfully created - '400': + $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: 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': + description: Your user is not allowed to operate against this API instance + '403': content: - application/pdf: {} - description: The document with given id attached to the selected process + application/json: + schema: + items: + $ref: '#/components/schemas/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: downloadDocumentInProcess - summary: Read a document on this process - put: + - Fulfillment Operations - Picking + description: '' + operationId: getPickJobDocumentHandling + summary: Get a pick job document handling information with the given ID + /api/packingsourcecontainers/{packingSourceContainerId}: + get: parameters: - - in: path - name: processId + - description: ID of the packingSourceContainer + in: path + name: packingSourceContainerId required: true schema: type: string - - in: path - name: documentId - required: true + - 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: @@ -9300,8 +9573,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ExternalDocument' - description: The document was successfully updated + items: + $ref: '#/components/schemas/PackingSourceContainer' + type: array + description: Found packingSourceContainer '400': content: application/json: @@ -9309,50 +9584,31 @@ paths: 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': + '401': content: application/json: schema: - $ref: '#/components/schemas/ExternalDocument' + items: + $ref: '#/components/schemas/ApiError' + description: Your user is not allowed to operate against this API instance + '403': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' description: >- - The document meta information with given id attached to the selected - process + 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 + - Fulfillment Operations - Packing description: >-
documentation

- operationId: readDocumentMetaInProcess - summary: Read meta information about document on this process - /api/returns: - get: + documentation

Get PackingSourceContainer by ID. + operationId: getPackingSourceContainerById + summary: Get a single packingSourceContainer + /api/packingsourcecontainers: + post: responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/ReturnJobs' - description: Return Jobs that were found in response body. + $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: @@ -9390,57 +9655,77 @@ paths: Your user, although recognized, is not authorized to use this endpoint tags: - - Fulfillment Operations - Returns - operationId: getReturnJobs + - 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: all entities after given Id + - 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 (max 500 per request) + - description: number of entities to show in: query name: size required: false schema: default: 25 type: integer - - description: Reference to the facility you want to filter for + maximum: 500 + - description: filter by packJobRef in: query - name: facilityRef + name: packJobRef required: false schema: type: string - - description: >- - Reference to the status you want to get the corresponding return - jobs to + - description: filter by facilityRef in: query - name: status + name: facilityRef + required: true + schema: + type: string + - description: filter by scannablecodes + in: query + name: codes required: false schema: + type: array 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': + '200': content: application/json: schema: - $ref: '#/components/schemas/ReturnJob' - description: The return was successfully created + items: + $ref: '#/components/schemas/PaginatedPackingSourceContainers' + type: array + description: Found Packing Source Container '400': content: application/json: @@ -9465,28 +9750,25 @@ paths: 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}: + - 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 return you want to get + - description: ID of the pack job you want to get document handling information in: path - name: returnId + name: packJobId required: true schema: type: string @@ -9495,10 +9777,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ReturnJob' + $ref: '#/components/schemas/DocumentHandling' description: >- - Return was found & you were allowed to access it. The result is in - the body. + Pack job document handling was found & you were allowed to access + it. The result is in the body. '401': content: application/json: @@ -9521,22 +9803,18 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: User not found + description: Entity 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: + - 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 return you want to patch + - description: ID of the pack job you want to get in: path - name: returnId + name: packJobId required: true schema: type: string @@ -9545,10 +9823,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ReturnJob' + $ref: '#/components/schemas/PackJob' description: >- - Return was found & patch-set has been applied. The patched entity is - in the body. + Pack job was found & you were allowed to access it. The result is in + the body. '401': content: application/json: @@ -9572,77 +9850,17 @@ paths: 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: + - Fulfillment Operations - Packing + description: '' + operationId: getPackJob + summary: Get a pack job with the given ID + patch: parameters: - - description: >- - Reference to the order you want to get the corresponding routing - plan. - in: query - name: orderRef + - description: ID of the packjob you want to get + in: path + name: packJobId + required: true schema: type: string responses: @@ -9650,9 +9868,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RoutingPlans' + $ref: '#/components/schemas/PackJob' description: >- - Routing plan was found & you were allowed to access it. The result + PackJob was found & patch-set has been applied. The patched pack job is in the body. '401': content: @@ -9676,40 +9894,57 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found, please look at details. + description: PackJob not found + '409': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: PackJob version conflict tags: - - DOMS - Routing Plans + - Fulfillment Operations - Packing description: '' - operationId: getRoutingPlanBaseOnOrderRef - summary: Get a routing plan regarding to orderRef - /api/routingplans/{routingplanId}: + 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 routing plan want to get + - description: ID of the PackJob in: path - name: routingplanId + 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/json: - schema: - $ref: '#/components/schemas/RoutingPlan' - description: >- - Routing plan was found & you were allowed to access it. The result - is in the body. + application/pdf: {} + description: Returns a return note for the packjob. '401': content: - application/json: + application/pdf: schema: items: $ref: '#/components/schemas/ApiError' description: Your user is not allowed to operate against this API instance '403': content: - application/json: + application/pdf: schema: items: $ref: '#/components/schemas/ApiError' @@ -9718,33 +9953,37 @@ paths: endpoint '404': content: - application/json: + application/pdf: schema: items: $ref: '#/components/schemas/ApiError' - description: Not found, please look at details. + description: Entity not found tags: - - DOMS - Routing Plans + - Fulfillment Operations - Packing description: '' - operationId: getRoutingPlan - summary: Get a routing plan with the given ID - patch: + operationId: getReturnNotesForPackJob + summary: Get the return note for the packjob with the given ID + /api/packjobs/{packJobId}/deliverynote: + get: parameters: - - description: ID of routing plan you want to patch + - description: ID of the pack job for which you want to get a deliverynote in: path - name: routingplanId + 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/json: - schema: - $ref: '#/components/schemas/RoutingPlan' - description: >- - Routing plan was found & patch-set has been applied. The patched - entity is in the body. + application/pdf: {} + description: The deliverynote for the given packjob '401': content: application/json: @@ -9767,48 +10006,43 @@ paths: 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 + description: Entity not found tags: - - DOMS - Routing Plans + - Fulfillment Operations - Packing 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}: + operationId: getPackJobDeliveryNote + summary: Get a deliverynote for the pack job with the given ID + /api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}: get: parameters: - - description: ID of the routing plan you want to get it's decision log + - 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: routingplanId + name: packJobId required: true schema: type: string - - description: ID of the decision log you want to get + - description: ID of the target container you want to get in: path - name: routingRun + name: targetcontainerId required: true schema: - type: integer + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DecisionLog' - description: Decision log was found. + $ref: '#/components/schemas/PackingTargetContainer' + description: >- + Entity was found & you were allowed to access it. The result is in + the body. '401': content: application/json: @@ -9831,37 +10065,44 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Decision log not found + description: Entity not found tags: - - DOMS - Routing Plans - description: '' - operationId: getDecisionlog - summary: Get decision log of a routing plan with the given ID - /api/reroutedescriptions: - get: + - 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: all entities after given Id - in: query - name: startAfterId - required: false + - description: ID of corresponding packJob you want to patch + in: path + name: packJobId + required: true schema: type: string - - description: number of entities to show - in: query - name: size - required: false + - description: ID of container you want to patch + in: path + name: targetcontainerId + required: true schema: - default: 25 - type: integer + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RerouteDescriptions' + $ref: '#/components/schemas/PackingTargetContainer' description: >- - RerouteDescription were found & you were allowed to access it. The - result is in the body. + Container was found & patch-set has been applied. The patched entity + is in the body. '401': content: application/json: @@ -9884,34 +10125,56 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: User not found + description: Entity not found + '409': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: Entity version conflict tags: - - DOMS - Routing Plans - description: >- -

This part of the API is currently under development. + - Fulfillment Operations - Packing + operationId: patchTargetcontainer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PackingTargetContainerPatchActions' + description: Patch set + required: true + summary: Patches a packing container with the given ID + description: |- +
+ +

This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and / or might not be available at all times in your API instance. 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 + 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/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. + $ref: '#/components/schemas/PackingTargetContainer' + description: The packing container was successfully created. '400': content: application/json: @@ -9936,43 +10199,43 @@ paths: Your user, although recognized, is not authorized to use this endpoint tags: - - DOMS - Routing Plans - operationId: postRerouteDescription + - 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/RerouteDescriptionForCreation' - description: The RerouteDescription + $ref: '#/components/schemas/PackingTargetContainerLineItemForCreation' + description: Packing Container line item object 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: + summary: Add a new packing container line item + delete: parameters: - - description: Id of the reroute description you wish to retrieve + - description: ID of corresponding packJob you want to patch in: path - name: rerouteDescriptionId + name: packJobId + required: true + schema: + type: string + - description: ID of container you want to delete + in: path + name: targetcontainerId required: true schema: type: string responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/RerouteDescription' - description: >- - RerouteDescription was found & you were allowed to access it. The - result is in the body. + description: Container was found & you were allowed to delete it. '401': content: application/json: @@ -9995,42 +10258,51 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: User not found + description: Entity not found tags: - - DOMS - Routing Plans - description: >- -

This part of the API is currently under development. + - 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: getRerouteDescriptionById - summary: Get a reroute description with the given key - put: + documentation +


+ operationId: deletePackingTargetContainer + summary: deletes a packing target container with the given ID + /api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}/lineitems/{lineItemId}: + patch: parameters: - - description: ID of the reroute description you intend to modify + - description: ID of corresponding packJob you want to patch in: path - name: rerouteDescriptionId + name: packJobId + required: true + schema: + type: string + - description: ID of container you want to patch + in: path + name: targetcontainerId + required: true + schema: + type: string + - description: ID of line item you want to patch + in: path + name: lineItemId required: true schema: type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RerouteDescriptionForModification' responses: '200': content: application/json: schema: - $ref: '#/components/schemas/RerouteDescription' + $ref: '#/components/schemas/PackingTargetContainer' description: >- - RerouteDescription rating was found & you were allowed to access it. - The result is in the body. + Container was found & patch-set has been applied. The patched entity + is in the body. '401': content: application/json: @@ -10053,33 +10325,58 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: RerouteDescription not found + description: Entity not found + '409': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: Entity version conflict tags: - - DOMS - Routing Plans - description: >- -

This part of the API is currently under development. + - 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: putRerouteDescription - summary: Update a reroute description + documentation +


Patch line item of a packing container + operationId: patchTargetContainerLineItem + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PackingTargetContainerActionsParameter' + description: Patch set + required: true + summary: Patches a packing container with the given ID delete: parameters: - - description: ID of the reroute description you intend to delete + - description: ID of corresponding packJob you want to patch in: path - name: rerouteDescriptionId + 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: >- - The reroute description was found, and you have been granted - permission to delete it. + description: LineItem was found & you were allowed to delete it. '401': content: application/json: @@ -10102,27 +10399,28 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: RerouteDescription not found + description: Facility not found tags: - - DOMS - Routing Plans - description: >- -

This part of the API is currently under development. + - 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: deleteRerouteDescription - summary: Delete a reroute description - /api/scopedcapabilities: + 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 facility - in: query - name: facilityId - required: false + - description: ID of the pack job you want to get + in: path + name: packJobId + required: true schema: type: string responses: @@ -10130,8 +10428,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ScopedCapabilities' - description: All ScopedCapabilities whic are at least inactive + items: + $ref: '#/components/schemas/PackingTargetContainer' + description: >- + Entity was found & you were allowed to access it. The result is in + the body. '401': content: application/json: @@ -10156,24 +10457,82 @@ paths: $ref: '#/components/schemas/ApiError' description: Entity not found tags: - - Infrastructure - Features - description: >- -

This part of the API is currently under development. + - 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: getCapabilities - summary: >- - Returns all scopedcapabilities which are at least inactive and available - to a facility/user - /api/shipments: + 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/PackingTargetContainer' + description: The packing container was successfully created. + '400': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: Invalid input. See response for details + '401': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: Your user is not allowed to operate against this API instance + '403': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: >- + Your user, although recognized, is not authorized to use this + endpoint + tags: + - Fulfillment Operations - Packing + description: |- +
+ +

This part of the API is currently under development. + That means that this endpoint, model, etc. can contain breaking changes + and / or might not be available at all times in your API instance. 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/PackingTargetContainerForCreation' + description: Packing Container object + required: true + summary: Add a new packing container + /api/tags: get: parameters: - - description: all entities after given Id + - description: all entities in: query name: startAfterId required: false @@ -10186,92 +10545,13 @@ paths: 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. + $ref: '#/components/schemas/StrippedTags' + description: The current list of available tags '401': content: application/json: @@ -10288,25 +10568,26 @@ paths: 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: - - Fulfillment Operations - Shipments + - Core - Tags description: '' - operationId: getAllShipments - summary: Return all shipments + operationId: getTags + summary: Returns all tags 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. + $ref: '#/components/schemas/Tag' + description: The tag was successfully created. '400': content: application/json: @@ -10331,22 +10612,23 @@ paths: Your user, although recognized, is not authorized to use this endpoint tags: - - Fulfillment Operations - Shipments - operationId: addShipment + - Core - Tags + description: '' + operationId: addTag requestBody: content: application/json: schema: - $ref: '#/components/schemas/ShipmentForCreation' - description: Shipment object supplied by your picking app + $ref: '#/components/schemas/TagForCreation' + description: Tag object required: true - summary: Add a new Shipment - /api/shipments/{shipmentId}: + summary: Add a new tag + /api/tags/{tagRef}: get: parameters: - - description: ID of Shipment you want to get + - description: Id of the tag you want to get in: path - name: shipmentId + name: tagRef required: true schema: type: string @@ -10355,10 +10637,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Shipment' + $ref: '#/components/schemas/Tag' description: >- - Shipment was found & you were allowed to access it. The result is in - the body. + Tag was found & you were allowed to access it. The result is in the + body. '401': content: application/json: @@ -10381,17 +10663,17 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Shipment not found + description: User not found tags: - - Fulfillment Operations - Shipments + - Core - Tags description: '' - operationId: getShipment - summary: Get a Shipment with the given ID + operationId: getTag + summary: Get a tag with the given key patch: parameters: - - description: ID of shipment you want to patch + - description: Id of the tag you want to update in: path - name: shipmentId + name: tagRef required: true schema: type: string @@ -10400,10 +10682,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Shipment' + $ref: '#/components/schemas/Tag' description: >- - Shipment was found & patch-set has been applied. The patched entity - is in the body. + Tag was found & you were allowed to access it. The result is in the + body. '401': content: application/json: @@ -10426,101 +10708,37 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found - '409': - content: - application/json: - schema: - items: - $ref: '#/components/schemas/ApiError' - description: Entity version conflict + description: Tag not found tags: - - Fulfillment Operations - Shipments + - Core - Tags description: '' - operationId: patchShipment + operationId: putTag requestBody: content: application/json: schema: - $ref: '#/components/schemas/ShipmentPatchActions' - description: Patch set + $ref: '#/components/schemas/TagPatchActions' + description: Tag patch action 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: + summary: Update a tag with the given key + /api/tags/packing/needspacking: post: - parameters: - - description: ID of shipment you want to create parcel for - in: path - name: shipmentId - required: true - schema: - type: string + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/TagReference' 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': + '200': content: application/json: schema: items: - $ref: '#/components/schemas/ApiError' - description: Invalid input. See response for details + $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: @@ -10537,42 +10755,33 @@ paths: description: >- Your user, although recognized, is not authorized to use this endpoint - '422': + '404': 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 + description: Entity not found tags: - - Infrastructure - Health + - Fulfillment Operations - Packing description: '' - operationId: status - summary: A public status endpoint that renders general availability information - /api/subscriptions: + 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 @@ -10591,8 +10800,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Subscriptions' - description: All subscriptions. + $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: @@ -10610,7 +10821,7 @@ paths: Your user, although recognized, is not authorized to use this endpoint tags: - - Core - Eventing + - Fulfillment Operations - Restow description: >-
documentation

- operationId: getSubscriptions - summary: Get all subscriptions - post: + 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: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Subscription' - description: Subscription is successfully created. - '400': + '200': content: application/json: schema: - items: - $ref: '#/components/schemas/ApiError' - description: Invalid input. See response for details + $ref: '#/components/schemas/RestowItem' + description: >- + RestowItem was found & you were allowed to access it. The result is + in the body. '401': content: application/json: @@ -10653,8 +10867,15 @@ paths: 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 + - Fulfillment Operations - Restow description: >-
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: + operationId: getRestowItem + summary: Get a restow item with the given ID + patch: parameters: - - description: ID of the subscription you want to delete + - description: ID of the restow item you want to update in: path - name: subscriptionId + name: restowItemId required: true schema: type: string @@ -10689,15 +10900,10 @@ paths: 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 + $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: @@ -10720,9 +10926,16 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found + description: RestowItem not found + '409': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: RestowItem version conflict tags: - - Core - Eventing + - Fulfillment Operations - Restow description: >-
documentation

- operationId: deleteSubscription - summary: Delete subscription by Id - /api/substitutes: + 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: - 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. + $ref: '#/components/schemas/PickingConfigurations' + description: Central Configuration of all picking related things '401': content: application/json: @@ -10774,25 +10985,32 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Facility not found + description: Entity 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 + operationId: getPickingConfigurations + summary: Get the picking configurations + patch: responses: '200': - description: >- - The substitutes for the given tenantArticleId were successfully - deleted + 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: @@ -10809,35 +11027,27 @@ paths: 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 + 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: - 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. + $ref: '#/components/schemas/PickJobTagConfiguration' + description: pickjob tag config is in response body. '401': content: application/json: @@ -10860,27 +11070,27 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Facility not found + description: Entity 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 + description: '' + operationId: getPickJobTagConfiguration + summary: Read tag configuration for pickjobs 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 + $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: @@ -10897,34 +11107,32 @@ paths: 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 + operationId: putPickJobTagConfigurations requestBody: content: application/json: schema: - $ref: '#/components/schemas/SubstitutesForUpsert' - description: substitutes to set + $ref: '#/components/schemas/PickJobTagConfiguration' + description: Desired Tag Configuration for Pickjobs required: true - summary: Set possible substitutes for a tenant article ID - /api/supportedevents: - get: + 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/SupportedEvents' - description: All supported events. + $ref: '#/components/schemas/RemoteConfiguration' + description: Created entity in the body. '401': content: application/json: @@ -10942,7 +11150,8 @@ paths: Your user, although recognized, is not authorized to use this endpoint tags: - - Core - Eventing + - Core - Remote Configuration + operationId: createRemoteConfiguration description: >-
documentation

- operationId: getEvents - summary: Get a list of supported events you can subscribe to. - /api/users: + summary: Create a new remote configuration get: parameters: - description: all entities after given Id @@ -10970,31 +11177,34 @@ paths: 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 + - description: facility to filter to in: query name: facilityId required: false schema: type: string - - description: include admin users without a facility + - description: groups to filter to in: query - name: includeAdminUsers + name: groups required: false schema: - type: boolean + 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: - $ref: '#/components/schemas/StrippedUsers' - description: User are found. + items: + $ref: '#/components/schemas/RemoteConfiguration' + description: Central RemoteConfiguration '401': content: application/json: @@ -11011,69 +11221,42 @@ paths: 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': + '404': content: application/json: schema: items: $ref: '#/components/schemas/ApiError' - description: >- - Your user, although recognized, is not authorized to use this - endpoint + description: Entity not found 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: + - 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: Identifier for the client you want to set the branding for. + - description: Reference to the remote config you want to get in: path - name: clientName + name: id 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 + $ref: '#/components/schemas/RemoteConfiguration' + description: Central RemoteConfiguration '401': content: application/json: @@ -11096,42 +11279,31 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Unknown clientName + description: Entity not found tags: - - Core - User Management - operationId: putBranding - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Branding' - description: Branding object - required: true - summary: 'Sets the branding ' + - Core - Remote Configuration + operationId: getRemoteConfiguration description: >-
-
This endpoint is deprecated and has been replaced.

Deprecated, will be replaced by /api/configurations/tenant - /api/users/sign/transloadit/{templateId}: - get: + src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png' + />

This part of the API is currently under development. + That means that this endpoint, model, etc. can contain breaking changes + and / or might not be available at all times in your API instance. 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: The id of the template to sign the request + - description: Reference to the remote config you want to delete in: path - name: templateId + name: id 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 + description: Successfully Deleted '401': content: application/json: @@ -11148,27 +11320,42 @@ paths: 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 - User Management + - Core - Remote Configuration + operationId: deleteRemoteConfiguration 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: + src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png' + />

This part of the API is currently under development. + That means that this endpoint, model, etc. can contain breaking changes + and / or might not be available at all times in your API instance. 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: user ID of the user you want to delete + - description: Reference to the remote config you want to change in: path - name: userId + name: id required: true schema: type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RemoteConfigurationForUpdate' responses: '200': - description: User was found and successfully deleted + description: Successfully Changed '401': content: application/json: @@ -11191,29 +11378,37 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: User not found + description: Entity not found tags: - - Core - User Management - description: '' - operationId: deleteUser - summary: Deletes a User with the given ID - get: + - 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: ID of User you want to get + - description: Reference to the remote config you want to change in: path - name: userId + name: id required: true schema: type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RemoteConfigurationForPut' 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. + description: Successfully Changed '401': content: application/json: @@ -11236,34 +11431,42 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: User not found + description: Entity not found tags: - - Core - User Management - description: '' - operationId: getUser - summary: Get a User with the given ID - patch: + - 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: ID of the user you want to patch + - description: Reference to the remote config you want to change in: path - name: userId + 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/User' - description: The user is successfully modified. - '400': - content: - application/json: - schema: - items: - $ref: '#/components/schemas/ApiError' - description: Invalid input. See response for details + $ref: '#/components/schemas/RemoteConfiguration' + description: Updated RemoteConfiguration in the body. '401': content: application/json: @@ -11280,31 +11483,31 @@ paths: 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: + - 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: ID of User you want to get + - description: Reference to the remote config you want to alter in: path - name: userId + 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 @@ -11313,10 +11516,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Roles' - description: >- - User was found & you were allowed to access it. The result is in the - body. + $ref: '#/components/schemas/RemoteConfiguration' + description: Successfully Deleted '401': content: application/json: @@ -11339,24 +11540,29 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: User not found + description: Entity 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 + - 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': - description: The facility was correctly assigned + content: + application/json: + schema: + $ref: '#/components/schemas/LocalizedReturnConfiguration' + description: Return config found. '401': content: application/json: @@ -11379,37 +11585,41 @@ paths: 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 + description: Entity not found 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 + - 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': - description: The assigned facility was correctly removed from the user. + 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: @@ -11426,22 +11636,72 @@ paths: description: >- Your user, although recognized, is not authorized to use this endpoint - '404': + '409': content: application/json: schema: items: $ref: '#/components/schemas/ApiError' - description: User not found + description: Entity version conflict tags: - - Core - User Management - description: '' - operationId: deleteAssignedFacilities - summary: Removes an assigned facility from the user - /api/brands: + - 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/itemreturns: get: parameters: - - description: all entities after given Id + - description: >- + Search term you want to get the corresponding item returns. Search + will be performed on multiple fields, including return id, tenant + order id, customer name, tenant article ids, artile titles + in: query + name: searchTerm + required: false + schema: + type: string + - description: facilities to filter the results + in: query + name: facilityRefs + required: false + schema: + type: array + items: + type: string + - description: ItemReturnStatus of an included ItemReturn to filter the results + in: query + name: itemReturnStatus + required: false + schema: + type: array + items: + type: string + - description: >- + ItemReturnLineItemStatus of an included itemReturnLineItem to filter + the results + in: query + name: itemReturnLineItemStatus + required: false + schema: + type: array + items: + type: string + - description: entity to start after in: query name: startAfterId required: false @@ -11459,8 +11719,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/StrippedBrands' - description: All brands on listings for this tenant + items: + $ref: '#/components/schemas/ItemReturn' + description: All Item Returns matching the given parameters '401': content: application/json: @@ -11478,144 +11739,171 @@ paths: Your user, although recognized, is not authorized to use this endpoint tags: - - Core - Processes - description: '' - operationId: getAllBrands - summary: Return all brands - /api/returnnotes: - post: + - 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: findItemReturns + summary: Get all Item Returns + /api/itemreturnjobs/{itemReturnJobId}/itemreturns: + get: parameters: - - description: >- - Provide the localized values for the return note. If not provided - the default locale is used. For example de_DE. + - 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: locale + 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: - '201': + '200': content: - application/pdf: + application/json: schema: - $ref: '#/components/schemas/ReturnNote' - description: Successfully created the return note. + items: + $ref: '#/components/schemas/ItemReturn' + description: Get all item returns for a given item return job '401': content: - application/pdf: + application/json: schema: items: $ref: '#/components/schemas/ApiError' description: Your user is not allowed to operate against this API instance '403': content: - application/pdf: + application/json: schema: items: $ref: '#/components/schemas/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: createReturnNote - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ReturnNote' - required: true - summary: Create return note - /api/packjobs: - get: + - 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: 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 + - description: Id of the item return job to create the item return for + in: path + name: itemReturnJobId + required: true schema: type: string - - description: Reference to the channel you want to get the corresponding packjobs - in: query - name: channel - required: false + 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: - 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 + - description: id of the item return you want to read + in: path + name: itemReturnId + required: true schema: type: string - - description: Start date range for pack jobs + - description: entity to start after in: query - name: startTargetTime + name: startAfterId required: false schema: type: string - example: '2020-02-03T08:45:50.525Z' - format: date-time - - description: End date range for pack jobs + - description: number of entities to show in: query - name: endTargetTime + name: size required: false schema: - type: string - example: '2020-02-03T08:45:50.525Z' - format: date-time + default: 25 + type: integer 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. + $ref: '#/components/schemas/ItemReturn' + description: Get a specific item return '401': content: application/json: @@ -11640,27 +11928,48 @@ paths: $ref: '#/components/schemas/ApiError' description: Entity not found tags: - - Fulfillment Operations - Packing - description: '' - operationId: getPackJobs - summary: Get all pack jobs - post: + - 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: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/PackJob' + $ref: '#/components/schemas/ItemReturn' 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 + item return was found and successfully deleted. Updated item return + job is returned. '401': content: application/json: @@ -11677,29 +11986,56 @@ paths: 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: addPackJob + - 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/PackJobForCreation' - description: Pack job object - required: true - summary: Add a new pack job - /api/packingcontainertypes: - post: + $ref: '#/components/schemas/ReplaceReturnedLineItems' responses: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/PackingContainerType' + $ref: '#/components/schemas/ItemReturnJob' description: >- - The packing container type was successfully created. The Location - header contains the URL of the packing container type. + The returned line items were successfully updated. Updated item + return job is returned. '400': content: application/json: @@ -11723,28 +12059,75 @@ paths: 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 - 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 + - 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: >- - Provide the localized values for the entity. If not provided the - default locale is used. For example de_DE. + - description: facility to filter the results in: query - name: locale + name: facilityId + required: false schema: type: string - - description: all entities after given id + - 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 @@ -11763,16 +12146,8 @@ paths: 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 + $ref: '#/components/schemas/ItemReturnJob' + description: All Item Return Jobs matching the given parameters '401': content: application/json: @@ -11790,40 +12165,32 @@ paths: 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 + - 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/PackingContainerType' - description: Found PackingContainerType - '400': - content: - application/json: - schema: - items: - $ref: '#/components/schemas/ApiError' - description: Invalid input. See response for details + $ref: '#/components/schemas/ItemReturnJob' + description: Created entity '401': content: application/json: @@ -11841,15 +12208,25 @@ paths: 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: + - 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 packingcontainertype you want to change + - description: id of the item return job in: path - name: packingContainerTypeId + name: itemReturnJobId required: true schema: type: string @@ -11858,10 +12235,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PackingContainerType' - description: >- - PackingContainerType was found & patch-set has been applied. The - patched PackingContainerType is in the body. + $ref: '#/components/schemas/ItemReturnJob' + description: Returns Item Return Job with the provided id '401': content: application/json: @@ -11884,44 +12259,42 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: PackingContainerType not found - '409': - content: - application/json: - schema: - items: - $ref: '#/components/schemas/ApiError' - description: PackingContainerType version conflict + description: Entity not found 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: + - 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 pick job you want to get document handling information + - description: id of the Item Return Job in: path - name: pickJobId + 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/DocumentHandling' - description: >- - Pick job document handling was found & you were allowed to access - it. The result is in the body. + $ref: '#/components/schemas/ItemReturnJob' + description: Updated entity '401': content: application/json: @@ -11946,35 +12319,116 @@ paths: $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: + - 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 packingSourceContainer + - description: id of the Item Return Job in: path - name: packingSourceContainerId + name: itemReturnJobId 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: + - 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/PackingSourceContainer' - type: array - description: Found packingSourceContainer + $ref: '#/components/schemas/ApiError' + description: Your user is not allowed to operate against this API instance + '403': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/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/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/returnedlineitems/{returnedLineItemId}: + patch: + parameters: + - description: id of the Item Return Job + in: path + name: itemReturnJobId + required: true + schema: + type: string + - description: id of the Item Return + in: path + name: itemReturnId + required: true + schema: + type: string + - description: id of the returnedLineItem + in: path + name: returnedLineItemId + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ItemReturnLineItemForUpdate' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/ItemReturnJob' + description: Updated ItemReturnJob '400': content: application/json: @@ -12006,29 +12460,79 @@ paths: $ref: '#/components/schemas/ApiError' description: Entity not found tags: - - Fulfillment Operations - Packing - description: >- -

This part of the API is currently under development. + - 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


Get PackingSourceContainer by ID. - operationId: getPackingSourceContainerById - summary: Get a single packingSourceContainer - /api/packingsourcecontainers: - post: + documentation +


+ operationId: updateItemReturnLineItem + summary: Patch for a ItemReturn LineItem + /api/configurations/expiry: + get: responses: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/PackingSourceContainer' + $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: >- - The packing source container was successfully created. The Location - header contains the URL of the packing source container. + 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: @@ -12052,85 +12556,89 @@ paths: 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 - Packing - description: >- -

This part of the API is currently under development. + - 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


Creating new packingSourceContainer. - operationId: addPackingSourceContainer + documentation +


+ operationId: upsertExpiryConfiguration requestBody: content: application/json: schema: - $ref: '#/components/schemas/PackingSourceContainerForCreation' - description: Packing type object + $ref: '#/components/schemas/ExpiryConfiguration' + description: Desired configuration to create/update required: true - summary: Add a new packingSourceContainer + summary: Change the tenant wide configuration + /api/expiries: get: parameters: - - description: >- - Provide the localized values for the entity. If not provided the - default locale is used. For example de_DE. + - description: Status to filter the results in: query - name: locale + name: status + required: false schema: - type: string - - description: all entities after given id + $ref: '#/components/schemas/ExpiryEntityStatus' + - description: ProcessRef to filter the results in: query - name: startAfterId + name: processRef required: false schema: type: string - - description: number of entities to show + - description: >- + StartDate to filter the results. Expiry Date of results is after or + equals the given value in: query - name: size + name: startDate required: false schema: - default: 25 - type: integer - maximum: 500 - - description: filter by packJobRef + 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: packJobRef + name: endDate required: false schema: type: string - - description: filter by facilityRef + - description: entity to start after in: query - name: facilityRef - required: true + name: startAfterId + required: false schema: type: string - - description: filter by scannablecodes + - description: number of entities to show in: query - name: codes + name: size required: false schema: - type: array - items: - type: string + default: 25 + type: integer 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 + $ref: '#/components/schemas/ExpiryEntity' + description: found entities in the result. '401': content: application/json: @@ -12148,7 +12656,7 @@ paths: Your user, although recognized, is not authorized to use this endpoint tags: - - Fulfillment Operations - Packing + - Core - Expiries description: |-
@@ -12158,27 +12666,22 @@ paths: 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 +

+ 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/DocumentHandling' - description: >- - Pack job document handling was found & you were allowed to access - it. The result is in the body. + $ref: '#/components/schemas/ExpiryEntity' + description: created entity in the result. '401': content: application/json: @@ -12195,24 +12698,26 @@ paths: 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}: + - 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 of the pack job you want to get + - description: id for the searched entity in: path - name: packJobId + name: expiryId required: true schema: type: string @@ -12221,10 +12726,8 @@ paths: 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. + $ref: '#/components/schemas/ExpiryEntity' + description: found entity in the result. '401': content: application/json: @@ -12241,35 +12744,40 @@ paths: 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 + - 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 packjob you want to get + - description: id of the entity to be changed in: path - name: packJobId + 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/PackJob' - description: >- - PackJob was found & patch-set has been applied. The patched pack job - is in the body. + $ref: '#/components/schemas/ExpiryEntity' + description: changed entity in the result. '401': content: application/json: @@ -12286,63 +12794,70 @@ paths: 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: + - 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/externalactions: get: parameters: - - description: ID of the PackJob - in: path - name: packJobId - required: true + - description: all entities after given Id. + in: query + name: startAfterId + required: false schema: type: string - - description: >- - Provide the localized values for the delivery note. If not provided - the default locale is used. For example de_DE. + - description: number of entities to show in: query - name: locale + name: size + required: false + schema: + default: 25 + type: integer + - description: Filter by the given group or groups + explode: true + in: query + name: groups + required: false + schema: + type: array + items: + type: string + - description: Filter by the given processRef + in: query + name: processRef + required: false schema: type: string responses: '200': content: - application/pdf: {} - description: Returns a return note for the packjob. + application/json: + schema: + items: + $ref: '#/components/schemas/ExternalAction' + type: array + description: Returning the list of external actions available. '401': content: - application/pdf: + application/json: schema: items: $ref: '#/components/schemas/ApiError' description: Your user is not allowed to operate against this API instance '403': content: - application/pdf: + application/json: schema: items: $ref: '#/components/schemas/ApiError' @@ -12351,37 +12866,32 @@ paths: endpoint '404': content: - application/pdf: + application/json: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found + description: External action 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 + - Core - Processes - External Actions + 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

Returns a list with all external actions. + operationId: getExternalActions + summary: Get the external actions related to a process + post: responses: - '200': + '201': content: - application/pdf: {} - description: The deliverynote for the given packjob + application/json: + schema: + $ref: '#/components/schemas/ExternalAction' + description: The external action was successfully created. '401': content: application/json: @@ -12404,31 +12914,25 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found + description: External action 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}: + - Core - Processes - External Actions + description: Creates a new external action for a process. + operationId: postExternalAction + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalActionForCreation' + description: The external action to be created + required: true + summary: Create an external action + /api/externalactions/{externalActionId}: get: parameters: - - description: >- - 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 + - description: Id of the external action you want to get in: path - name: targetcontainerId + name: externalActionId required: true schema: type: string @@ -12437,10 +12941,12 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PackingContainer' + items: + $ref: '#/components/schemas/ExternalAction' + type: array description: >- - Entity was found & you were allowed to access it. The result is in - the body. + External action was found & you are allowed to get it. The result is + in the body. '401': content: application/json: @@ -12463,44 +12969,31 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found + description: External action not found tags: - - Fulfillment Operations - Packing - description: |- -
- -

This part of the API is currently under development. + - Core - Processes - External Actions + 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: + documentation


Returns an external action with the given id if found. + operationId: getExternalAction + summary: Get an external action + delete: parameters: - - description: ID of corresponding packJob you want to patch + - description: ID of the external action that you want delete in: path - name: packJobId - required: true - schema: - type: string - - description: ID of container you want to patch - in: path - name: targetcontainerId + name: externalActionId 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. + description: External action was found & you were allowed to delete it. '401': content: application/json: @@ -12523,63 +13016,36 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found - '409': - content: - application/json: - schema: - items: - $ref: '#/components/schemas/ApiError' - description: Entity version conflict + description: External action not found 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. + - Core - Processes - External Actions + 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: + documentation


+ operationId: deleteExternalAction + summary: Delete an external action with the given id. + put: parameters: - - description: ID of the pack job you want to get + - description: ID of the external action that you want update 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 + name: externalActionId required: true schema: type: string responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/PackingContainer' - description: The packing container was successfully created. - '400': + '200': content: application/json: schema: items: - $ref: '#/components/schemas/ApiError' - description: Invalid input. See response for details + $ref: '#/components/schemas/ExternalAction' + description: External action was found & you are allowed to update it. '401': content: application/json: @@ -12596,57 +13062,49 @@ paths: 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. + - Core - Processes - External Actions + 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 + documentation


Replaces the external action with the provided in the body. + operationId: putExternalAction requestBody: content: application/json: schema: - $ref: '#/components/schemas/PackingContainerLineItemForCreation' - description: Packing Container line item object + $ref: '#/components/schemas/ExternalActionForReplacement' + description: Updates an external action required: true - summary: Add a new packing container line item - /api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}/lineitems/{lineItemId}: - patch: + summary: Replace an external action + /api/externalactions/{externalActionId}/logs: + post: 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 + - description: ID of the external action you want to create the log for in: path - name: lineItemId + name: externalActionId required: true schema: type: string responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/PackingContainer' - description: >- - Container was found & patch-set has been applied. The patched entity - is in the body. + $ref: '#/components/schemas/ExternalActionLog' + description: The log for the external action was successfully created. '401': content: application/json: @@ -12669,58 +13127,51 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found - '409': - content: - application/json: - schema: - items: - $ref: '#/components/schemas/ApiError' - description: Entity version conflict + description: External action 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 -


Patch line item of a packing container - operationId: patchTargetContainerLineItem + - Core - Processes - External Actions Logs + description: Creates a new external action log. + operationId: postExternalActionLog requestBody: content: application/json: schema: - $ref: '#/components/schemas/PackingContainerActionsParameter' - description: Patch set + $ref: '#/components/schemas/ExternalActionLogForCreation' + description: The external action log to be created required: true - summary: Patches a packing container with the given ID - delete: + summary: Creates a log for an external action + get: parameters: - - description: ID of corresponding packJob you want to patch - in: path - name: packJobId - required: true + - description: all entities after given Id + in: query + name: startAfterId + required: false schema: type: string - - description: ID of container you want to patch - in: path - name: targetcontainerId - required: true + - description: number of entities to show + in: query + name: size + required: false schema: - type: string - - description: ID of line item you want to patch + default: 25 + type: integer + - description: Id of the external action you want to get the logs from in: path - name: lineItemId + name: externalActionId required: true schema: type: string responses: '200': - description: LineItem was found & you were allowed to delete it. + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ExternalActionLogs' + type: array + description: >- + Logs were found & you are allowed to get it. The result is in the + body. '401': content: application/json: @@ -12743,40 +13194,54 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Facility not found + description: External action logs not found tags: - - Fulfillment Operations - Packing - description: |- -
- -

This part of the API is currently under development. + - Core - Processes - External Actions Logs + 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: + documentation


Returns the logs related with the given external action. + operationId: getExternalActionLogs + summary: Get the logs for an external action + /api/facilities/{facilityId}/carriers/{carrierRef}: get: parameters: - - description: ID of the pack job you want to get + - description: ID of facility you want to get listing in: path - name: packJobId + 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: - items: - $ref: '#/components/schemas/PackingContainer' + $ref: '#/components/schemas/FacilityCarrierConnection' description: >- - Entity was found & you were allowed to access it. The result is in - the body. + Carrier to facility connections was found & you were allowed to + access it. The result is in the body. '401': content: application/json: @@ -12799,43 +13264,51 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found + description: >- + There is no connection to a carrier with this facility referenced by + the provided facilityCarrierConnectionId tags: - - Fulfillment Operations - Packing - description: |- -
- -

This part of the API is currently under development. + - 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: getAllTargetcontainers - summary: Get all packing container on given packJob + documentation


+ operationId: getFacilityCarrier + summary: Get the details for a carrier related to the facility with the given ID post: parameters: - - description: ID of the pack job you want to get + - description: ID of facility you want to get in: path - name: packJobId + 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: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/PackingContainer' - description: The packing container was successfully created. - '400': + '200': content: application/json: schema: - items: - $ref: '#/components/schemas/ApiError' - description: Invalid input. See response for details + $ref: '#/components/schemas/FacilityCarrierConnection' + description: Creation was successful. '401': content: application/json: @@ -12852,50 +13325,66 @@ paths: 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: - - Fulfillment Operations - Packing - description: |- -
- -

This part of the API is currently under development. + - 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: addTargetContainers + documentation


+ operationId: createCarrierToFacility requestBody: content: application/json: schema: - $ref: '#/components/schemas/PackingContainerForCreation' - description: Packing Container object + $ref: '#/components/schemas/FacilityCarrierConnectionForCreation' + description: Representation that describes the facility required: true - summary: Add a new packing container - /api/tags: - get: + summary: >- + Create a connection of a configured carrier to the facility with given + ID + put: parameters: - - description: all entities - in: query - name: startAfterId - required: false + - description: ID of facility you want to get + in: path + name: facilityId + required: true schema: type: string - - description: number of entities to show + - 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: size - required: false + name: locale schema: - default: 25 - type: integer + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/StrippedTags' - description: The current list of available tags + $ref: '#/components/schemas/FacilityCarrierConnection' + description: Modification was successful. '401': content: application/json: @@ -12918,27 +13407,38 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: No more elements available + description: >- + There is no connection to a carrier with this facility referenced by + the provided facilityCarrierConnectionId. tags: - - Core - Tags - description: '' - operationId: getTags - summary: Returns all tags - post: + - 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/health: + get: responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Tag' - description: The tag was successfully created. - '400': + '200': content: application/json: schema: - items: - $ref: '#/components/schemas/ApiError' - description: Invalid input. See response for details + $ref: '#/components/schemas/HealthResult' + description: Result of all tested dependencies for their health status '401': content: application/json: @@ -12955,36 +13455,57 @@ paths: 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: - - Core - Tags + - Infrastructure - Health 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}: + operationId: healthCheck + summary: Do a health check + /api/facilities/{facilityId}/storagelocations: get: parameters: - - description: Id of the tag you want to get + - description: ID of facility from whom you want to get the storage locations in: path - name: tagRef + 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: - $ref: '#/components/schemas/Tag' + items: + $ref: '#/components/schemas/StorageLocation' + type: array description: >- - Tag was found & you were allowed to access it. The result is in the - body. + Facility was found & you are allowed to get the storage locations. + The result is in the body. '401': content: application/json: @@ -13007,29 +13528,27 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: User not found + description: Facility not found tags: - - Core - Tags + - Core - Facilities description: '' - operationId: getTag - summary: Get a tag with the given key - patch: + operationId: getFacilityStorageLocations + summary: Get the storage locations of this facility + post: parameters: - - description: Id of the tag you want to update + - description: ID of facility from whom you want to create the storage location in: path - name: tagRef + name: facilityId required: true schema: type: string responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/Tag' - description: >- - Tag was found & you were allowed to access it. The result is in the - body. + $ref: '#/components/schemas/StorageLocation' + description: The storage location was successfully created. '401': content: application/json: @@ -13052,37 +13571,45 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Tag not found + description: Facility not found tags: - - Core - Tags - description: '' - operationId: putTag + - Core - Facilities + description: Creates a new storage location in this facility. + operationId: postFacilityStorageLocations requestBody: content: application/json: schema: - $ref: '#/components/schemas/TagPatchActions' - description: Tag patch action + $ref: '#/components/schemas/StorageLocationForCreation' + description: Patch set 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' + 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/NeedsPacking' + $ref: '#/components/schemas/StorageLocation' + type: array description: >- - NeedsPacking information for this tag was found & you were allowed - to access it. The result is in the body. + Facility was found & you are allowed to get the storage locations. + The result is in the body. '401': content: application/json: @@ -13105,50 +13632,30 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found + description: Facility not found tags: - - Fulfillment Operations - Packing + - Core - Facilities description: '' - operationId: getNeedsPacking - summary: Get packing information for given Tag - /api/restowitems: - get: + operationId: getFacilityStorageLocation + summary: Get the storage location of this facility + delete: parameters: - - description: Reference to the facility you want to get the corresponding restows - in: query - name: facilityRef - required: false + - description: ID of facility from whom you want to delete the storage location + in: path + name: facilityId + required: true 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 + - description: ID of the storageLocation you want to delete + in: path + name: storageLocationId + required: true 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': + description: Storage location was found & you were allowed to delete it. + '401': content: application/json: schema: @@ -13164,25 +13671,29 @@ paths: 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: - - 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: + - Core - Facilities + description: '' + operationId: deleteFacilityStorageLocation + summary: Delete a storage location of a facility with the given ID + put: parameters: - - description: ID of the restow item you want to get + - description: ID of facility from whom you want to put the storage locations in: path - name: restowItemId + name: facilityId + required: true + schema: + type: string + - description: the ID of the storageLocation + in: path + name: storageLocationId required: true schema: type: string @@ -13191,10 +13702,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RestowItem' - description: >- - RestowItem was found & you were allowed to access it. The result is - in the body. + $ref: '#/components/schemas/StorageLocation' + description: Storage location was found & you were allowed to update it. '401': content: application/json: @@ -13217,25 +13726,32 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found + description: Facility or Storage Location not found tags: - - Fulfillment Operations - Restow + - 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: getRestowItem - summary: Get a restow item with the given ID + 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 the restow item you want to update + - description: ID of facility you want to patch the storage locations in: path - name: restowItemId + name: facilityId + required: true + schema: + type: string + - description: the ID of the storageLocation + in: path + name: storageLocationId required: true schema: type: string @@ -13244,10 +13760,8 @@ paths: 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. + $ref: '#/components/schemas/StorageLocation' + description: Storage location was found & you were allowed to update it. '401': content: application/json: @@ -13270,43 +13784,64 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: RestowItem not found - '409': - content: - application/json: - schema: - items: - $ref: '#/components/schemas/ApiError' - description: RestowItem version conflict + description: Facility or Storage location 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: patchRestowItem + - 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/RestowItemPatchActions' + $ref: '#/components/schemas/StorageLocationPatchActions' description: Patch set required: true - summary: Patches a restow item with the given ID - /api/configurations/picking: + 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: - $ref: '#/components/schemas/PickingConfigurations' - description: Central Configuration of all picking related things + 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: @@ -13329,32 +13864,27 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found + description: Facility not found tags: - - Fulfillment Operations - Picking - operationId: getPickingConfigurations - summary: Get the picking configurations - patch: + - 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: - '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 + $ref: '#/components/schemas/Zone' + description: The zone was successfully created. '401': content: application/json: @@ -13371,27 +13901,51 @@ paths: 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: - - Fulfillment Operations - Picking - description: '' - operationId: putPickingConfigurations + - Core - Facilities + description: Creates a new zone in this facility. + operationId: postFacilityZone requestBody: content: application/json: schema: - $ref: '#/components/schemas/PickingConfigurations' - description: create/update picking central configuration + $ref: '#/components/schemas/ZoneForCreation' + description: The zone to be created required: true - summary: Change the tenant wide picking central configuration - /api/configurations/tags/pickjob: + 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: - $ref: '#/components/schemas/PickJobTagConfiguration' - description: pickjob tag config is in response body. + 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: @@ -13414,27 +13968,29 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found + description: Facility not found tags: - - Fulfillment Operations - Picking + - Core - Facilities description: '' - operationId: getPickJobTagConfiguration - summary: Read tag configuration for pickjobs - put: + 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': - 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 + description: Zone was found & you were allowed to delete it. '401': content: application/json: @@ -13451,94 +14007,30 @@ paths: 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': + '404': content: application/json: schema: items: $ref: '#/components/schemas/ApiError' - description: >- - Your user, although recognized, is not authorized to use this - endpoint + description: Facility or storage location not found 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: + - Core - Facilities + description: '' + operationId: deleteFacilityZone + summary: Delete a zone of a facility with the given ID + put: 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 + - description: ID of facility from whom you want to put the zone + in: path name: facilityId - required: false + required: true 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 + - description: the ID of the zone + in: path + name: zoneId + required: true schema: type: string responses: @@ -13547,8 +14039,8 @@ paths: application/json: schema: items: - $ref: '#/components/schemas/RemoteConfiguration' - description: Central RemoteConfiguration + $ref: '#/components/schemas/Zone' + description: Zone was found & you are allowed to update it. '401': content: application/json: @@ -13571,26 +14063,27 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found + description: Facility not found tags: - - Core - Remote Configuration - operationId: getAllRemoteConfigurations + - 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

- summary: Get all remote configurations - /api/remoteconfigs/{id}: - get: + 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: Reference to the remote config you want to get + - description: ID of custom service you want to patch in: path - name: id + name: customServiceId required: true schema: type: string @@ -13599,8 +14092,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RemoteConfiguration' - description: Central RemoteConfiguration + $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: @@ -13623,31 +14118,50 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found + description: custom service not found + '409': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: custom service version conflict tags: - - Core - Remote Configuration - operationId: getRemoteConfiguration - description: >- -

This part of the API is currently under development. + - 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


- summary: Get a single remote configuration - delete: + documentation +


+ get: parameters: - - description: Reference to the remote config you want to delete + - description: ID of custom service you want to get in: path - name: id + name: customServiceId required: true schema: type: string responses: '200': - description: Successfully Deleted + content: + application/json: + schema: + $ref: '#/components/schemas/CustomService' + description: Custom service config could be found in response body. '401': content: application/json: @@ -13672,34 +14186,48 @@ paths: $ref: '#/components/schemas/ApiError' description: Entity not found tags: - - Core - Remote Configuration - operationId: deleteRemoteConfiguration - description: >- -

This part of the API is currently under development. + - 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


- summary: Delete a single remote configuration - patch: + documentation +


+ operationId: getCustomService + summary: Get requested Custom service + /api/customservices/{customServiceId}/additionalinformation: + post: parameters: - - description: Reference to the remote config you want to change + - description: ID of custom service you want to create service job for in: path - name: id + name: customServiceId required: true schema: type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RemoteConfigurationForUpdate' responses: '200': - description: Successfully Changed + 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: @@ -13716,16 +14244,8 @@ paths: 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 + - Core - Custom Services description: |-
@@ -13736,81 +14256,50 @@ paths: under our SLA regulations. For details on this topic please check our documentation

- summary: Update a single remote configuration - put: + 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: Reference to the remote config you want to change + - description: ID of custom service in: path - name: id + 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 - 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': + $ref: '#/components/schemas/CustomService' + description: The custom service was successfully updated. + '201': content: application/json: schema: - items: - $ref: '#/components/schemas/ApiError' - description: >- - Your user, although recognized, is not authorized to use this - endpoint - '404': + $ref: '#/components/schemas/CustomService' + description: The custom service was successfully created. + '400': 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. + description: Invalid input. See response for details '401': content: application/json: @@ -13828,30 +14317,30 @@ paths: 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. + - 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


- summary: add a new scope to a remote configuration - /api/remoteconfigs/{id}/scopes/{scopeId}: - delete: + documentation +


+ operationId: deleteAdditionalInfo + summary: Delete a custom service + put: parameters: - - description: Reference to the remote config you want to alter + - description: ID of custom service in: path - name: id + name: customServiceId required: true schema: type: string - - description: Reference to the remote config scope you want to delete + - description: ID of additional information you want to put in: path - name: scopeId + name: additionalInformationId required: true schema: type: string @@ -13860,8 +14349,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RemoteConfiguration' - description: Successfully Deleted + $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: @@ -13878,35 +14380,50 @@ paths: 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. + - 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


- summary: Delete a scope from a given remote configuration - /api/configurations/return: + 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/LocalizedReturnConfiguration' - description: Return config found. + $ref: '#/components/schemas/StrippedCustomServices' + description: Custom service config could be found in response body. '401': content: application/json: @@ -13931,32 +14448,33 @@ paths: $ref: '#/components/schemas/ApiError' description: Entity not found tags: - - Fulfillment Operations - Returns - description: >- -

This part of the API is currently under development. + - 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: getReturnConfiguration - summary: Get the current configuration for returns - put: + documentation +


+ operationId: getCustomServices + summary: Get Custom services + post: responses: '200': content: application/json: schema: - $ref: '#/components/schemas/LocalizedReturnConfiguration' - description: The return configuration was successfully updated. + $ref: '#/components/schemas/CustomService' + description: The custom service was successfully updated. '201': content: application/json: schema: - $ref: '#/components/schemas/LocalizedReturnConfiguration' - description: The return configuration was successfully created. + $ref: '#/components/schemas/CustomService' + description: The custom service was successfully created. '400': content: application/json: @@ -13980,43 +14498,37 @@ paths: 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. + - 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: upsertReturnConfiguration + documentation +


+ operationId: createCustomService requestBody: content: application/json: schema: - $ref: '#/components/schemas/ReturnConfiguration' - description: Desired return configuration to create/update + $ref: '#/components/schemas/CustomServiceForCreation' + description: Desired custom service to create required: true - summary: Change the tenant wide return configuration - /api/itemreturnjobs/{itemReturnJobId}/itemreturns: + summary: Create a custom service + /api/facilities/{facilityId}/customservices: get: parameters: - - description: item return job to read the item return for + - description: ID of facility in: path - name: itemReturnJobId + name: facilityId required: true schema: type: string - - description: entity to start after + - description: all entities after given Id in: query name: startAfterId required: false @@ -14034,9 +14546,8 @@ paths: content: application/json: schema: - items: - $ref: '#/components/schemas/ItemReturn' - description: Get all item returns for a given item return job + $ref: '#/components/schemas/StrippedFacilityCustomServiceConnections' + description: Custom service connections could be found in response body. '401': content: application/json: @@ -14061,39 +14572,41 @@ paths: $ref: '#/components/schemas/ApiError' description: Entity not found tags: - - Fulfillment Operations - Returns - description: >- -

This part of the API is currently under development. + - 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: getItemReturns - summary: Get item returns - post: + documentation +


+ operationId: getFacilityCustomServiceConnections + summary: Get requested Custom service connection for a facility + /api/facilities/{facilityId}/customservices/{customServiceId}: + get: parameters: - - description: Id of the item return job to create the item return for + - description: ID of facility in: path - name: itemReturnJobId + name: facilityId + required: true + schema: + type: string + - description: ID of the custom service + in: path + name: customServiceId required: true schema: type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AddItemReturnToItemReturnJob' - required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/ItemReturnJob' - description: ItemReturnJob containing the newly created item return + $ref: '#/components/schemas/FacilityCustomServiceConnection' + description: Custom service connection could be found in response body. '401': content: application/json: @@ -14110,8 +14623,15 @@ paths: 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 + - Core - Facilities description: |-
@@ -14121,44 +14641,37 @@ paths: 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: +

+ operationId: getFacilityCustomService + summary: Get requested Custom service connection for a facility + patch: parameters: - - description: item return job to read the item return for + - description: ID of facility in: path - name: itemReturnJobId + name: facilityId required: true schema: type: string - - description: id of the item return you want to read + - description: ID of the custom service in: path - name: itemReturnId + name: customServiceId 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 + $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: @@ -14175,15 +14688,8 @@ paths: 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 + - Core - Facilities description: |-
@@ -14194,37 +14700,43 @@ paths: under our SLA regulations. For details on this topic please check our documentation

- operationId: getItemReturn - summary: Get item return by id - delete: + 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 the item return job to delete the item return for + - description: ID of facility in: path - name: itemReturnJobId + name: facilityId required: true schema: type: string - - description: id of the item return you want to delete + - description: ID of the custom service in: path - name: itemReturnId + name: customServiceId 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': + '201': content: application/json: schema: - $ref: '#/components/schemas/ItemReturn' - description: >- - item return was found and successfully deleted. Updated item return - job is returned. + $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: @@ -14241,15 +14753,8 @@ paths: 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 + - Core - Facilities description: |-
@@ -14259,38 +14764,33 @@ paths: 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: +

+ 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 the item return job the item return belongs to + - description: ID of facility in: path - name: itemReturnJobId + name: facilityId required: true schema: type: string - - description: id of the item return the returned line items belong to + - description: ID of the custom service in: path - name: itemReturnId + name: customServiceId 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. + description: The custom service connection was successfully deleted. '400': content: application/json: @@ -14314,15 +14814,8 @@ paths: 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 + - Core - Facilities description: |-
@@ -14332,77 +14825,18 @@ paths: 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: +

+ operationId: deleteFacilityCustomServiceConnection + summary: Delete a facility custom service connection + /api/servicejobs: 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 + $ref: '#/components/schemas/ServiceJobs' + description: Service Jobs could be found in response body. '401': content: application/json: @@ -14420,7 +14854,70 @@ paths: Your user, although recognized, is not authorized to use this endpoint tags: - - Fulfillment Operations - Returns + - 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: |-
@@ -14431,21 +14928,21 @@ paths: 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': + '201': content: application/json: schema: - $ref: '#/components/schemas/ItemReturnJob' - description: Created entity + $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: @@ -14463,7 +14960,16 @@ paths: Your user, although recognized, is not authorized to use this endpoint tags: - - Fulfillment Operations - Returns + - 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: |-
@@ -14474,14 +14980,12 @@ paths: under our SLA regulations. For details on this topic please check our documentation

- operationId: createItemReturnJob - summary: Creates a new ItemReturnJob - /api/itemreturnjobs/{itemReturnJobId}: + /api/servicejobs/{serviceJobId}: get: parameters: - - description: id of the item return job + - description: ID of service job you want to get in: path - name: itemReturnJobId + name: serviceJobId required: true schema: type: string @@ -14490,8 +14994,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ItemReturnJob' - description: Returns Item Return Job with the provided id + $ref: '#/components/schemas/ServiceJob' + description: Service Job could be found in response body. '401': content: application/json: @@ -14516,7 +15020,9 @@ paths: $ref: '#/components/schemas/ApiError' description: Entity not found tags: - - Fulfillment Operations - Returns + - Fulfillment Operations - Custom Services + operationId: getServiceJob + summary: Get requested service job description: |-
@@ -14527,29 +15033,29 @@ paths: 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: + /api/servicejobs/{serviceJobId}/actions: post: parameters: - - description: id of the Item Return Job + - description: ID of service job you want to update in: path - name: itemReturnJobId + name: serviceJobId 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 + $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: @@ -14566,15 +15072,125 @@ paths: description: >- Your user, although recognized, is not authorized to use this endpoint - '404': + 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: Entity not found + description: Your user is not allowed to operate against this 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 + - 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: |-
@@ -14585,35 +15201,22 @@ paths: 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: + /api/linkedservicejobs/{linkedServiceJobsId}: + get: parameters: - - description: id of the Item Return Job - in: path - name: itemReturnJobId - required: true - schema: - type: string - - description: id of the Item Return + - description: ID of LinkedServiceJobs you want to get in: path - name: itemReturnId + name: linkedServiceJobsId 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 + $ref: '#/components/schemas/LinkedServiceJobs' + description: LinkedServiceJobs could be found in response body. '401': content: application/json: @@ -14638,7 +15241,9 @@ paths: $ref: '#/components/schemas/ApiError' description: Entity not found tags: - - Fulfillment Operations - Returns + - Fulfillment Operations - Custom Services + operationId: getLinkedServiceJobsById + summary: Get requested LinkedServiceJobs description: |-
@@ -14649,17 +15254,29 @@ paths: under our SLA regulations. For details on this topic please check our documentation

- operationId: itemReturnActions - summary: Actions for a ItemReturn - /api/configurations/expiry: - get: + /api/linkedservicejobs/{linkedServiceJobsId}/servicejoblinks: + post: + parameters: + - description: ID of LinkedServiceJobs you want to alter + in: path + name: linkedServiceJobsId + required: true + schema: + type: string responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/ExpiryConfiguration' - description: config found. + $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: @@ -14676,15 +15293,17 @@ paths: 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 + - 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: |-
@@ -14695,22 +15314,32 @@ paths: under our SLA regulations. For details on this topic please check our documentation

- operationId: getExpiryConfiguration - summary: Get the current configuration - put: + /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: - '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. + $ref: '#/components/schemas/LinkedServiceJobs' + description: >- + The ServiceJobLink was successfully added nested inside the + LinkedServiceJobs. '400': content: application/json: @@ -14734,15 +15363,17 @@ paths: 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 + - 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: |-
@@ -14753,46 +15384,13 @@ paths: 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: + /api/operativeprocesses: 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 + - description: facility to filter the results in: query - name: endDate - required: false + name: facilityId + required: true schema: type: string - description: entity to start after @@ -14808,15 +15406,23 @@ paths: schema: default: 25 type: integer + maximum: 500 + minimum: 1 responses: '200': content: application/json: schema: - type: array items: - $ref: '#/components/schemas/ExpiryEntity' - description: found entities in the result. + $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: @@ -14833,8 +15439,15 @@ paths: 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 - Expiries + - Fulfillment Operations - Operative Process description: |-
@@ -14845,21 +15458,31 @@ paths: 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' + 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/ExpiryEntity' - description: created entity in the result. + $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: @@ -14876,8 +15499,15 @@ paths: 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 - Expiries + - Fulfillment Operations - Operative Process description: |-
@@ -14888,24 +15518,33 @@ paths: under our SLA regulations. For details on this topic please check our documentation

- operationId: createExpiry - summary: Create Expiry - /api/expiries/{expiryId}: + operationId: getOperativeProcessById + summary: Get operativeProcess by ID + /api/cancelationreasons: get: parameters: - - description: id for the searched entity - in: path - name: expiryId - required: true + - 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/ExpiryEntity' - description: found entity in the result. + $ref: '#/components/schemas/CancelationReasons' + description: >- + Cancelation reasons were found & you were allowed to access them. + The result is in the body. '401': content: application/json: @@ -14922,8 +15561,15 @@ paths: 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 - Expiries + - DOMS - Cancelation reasons description: |-
@@ -14934,28 +15580,29 @@ paths: 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' + operationId: getCancelationReasons + summary: Get a list with all cancelation reasons + post: responses: - '200': + '201': content: application/json: schema: - $ref: '#/components/schemas/ExpiryEntity' - description: changed entity in the result. + $ref: '#/components/schemas/CancelationReason' + description: >- + The cancelation reason has been successfully created. The Location + header includes the URL of the document. + '303': + description: >- + The Cancelation Reason already exists. The Location header contains + the URL of the document. + '400': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: Invalid input. See response for details '401': content: application/json: @@ -14973,7 +15620,16 @@ paths: Your user, although recognized, is not authorized to use this endpoint tags: - - Core - Expiries + - DOMS - Cancelation reasons + operationId: postCancelationReason + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelationReasonForCreation' + description: Cancelation reason + required: true + summary: Post a new cancelation reason description: |-
@@ -14984,17 +15640,24 @@ paths: under our SLA regulations. For details on this topic please check our documentation

- operationId: updateExpiry - summary: Update Expiry - /api/health: + /api/cancelationreasons/{cancelationReasonId}: get: + parameters: + - description: Id of the cancelation reason you wish to retrieve + in: path + name: cancelationReasonId + required: true + schema: + type: string responses: '200': content: application/json: schema: - $ref: '#/components/schemas/HealthResult' - description: Result of all tested dependencies for their health status + $ref: '#/components/schemas/CancelationReason' + description: >- + Cancelation reason was found & you were allowed to access it. The + result is in the body. '401': content: application/json: @@ -15017,51 +15680,42 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Manual reroute configuration not found + description: User not found tags: - - Infrastructure - Health - description: '' - operationId: healthCheck - summary: Do a health check - /api/facilities/{facilityId}/storagelocations: - get: + - DOMS - Cancelation reasons + 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: getCancelationReasonById + summary: Get a cancelation reason with the given id + put: parameters: - - description: ID of facility from whom you want to get the storage locations + - description: ID of the cancelation reason you intend to modify in: path - name: facilityId + name: cancelationReasonId 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CancelationReasonForModification' responses: '200': content: application/json: schema: - items: - $ref: '#/components/schemas/StorageLocation' - type: array + $ref: '#/components/schemas/CancelationReason' description: >- - Facility was found & you are allowed to get the storage locations. - The result is in the body. + Cancelation reason was found & you were allowed to access it. The + result is in the body. '401': content: application/json: @@ -15084,27 +15738,34 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Facility not found + description: Cancelation reason not found tags: - - Core - Facilities - description: '' - operationId: getFacilityStorageLocations - summary: Get the storage locations of this facility - post: + - DOMS - Cancelation reasons + 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: putCancelationReason + summary: Update a reroute description + delete: parameters: - - description: ID of facility from whom you want to create the storage location + - description: ID of the cancelation reason you intend to delete in: path - name: facilityId + name: cancelationReasonId required: true schema: type: string responses: - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/StorageLocation' - description: The storage location was successfully created. + '200': + description: >- + The cancelation reason was found, and you have been granted + permission to delete it. '401': content: application/json: @@ -15127,45 +15788,44 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Facility not found + description: Cancelation reason 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}: + - DOMS - Cancelation reasons + 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: deleteCancelationReason + summary: Delete a cancelation reason + /api/configurations/routing/toolkit/fences: get: parameters: - - description: ID of facility from whom you want to get the storage locations - in: path - name: facilityId - required: true + - description: all entities + in: query + name: startAfterId + required: false schema: type: string - - description: the ID of the storageLocation - in: path - name: storageLocationId - required: true + - description: number of entities to show + in: query + name: size + required: false schema: - type: string + default: 25 + type: integer 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. + $ref: '#/components/schemas/ToolkitFencesTransporter' + description: The current list of available toolkit fences '401': content: application/json: @@ -15188,29 +15848,34 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Facility not found + description: No more elements available 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 + - 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': - description: Storage location was found & you were allowed to delete it. + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ToolkitFence' + description: Toolkit Fence was created successfully. '401': content: application/json: @@ -15233,23 +15898,26 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Facility or storage location not found + description: Entity not found tags: - - Core - Facilities - description: '' - operationId: deleteFacilityStorageLocation - summary: Delete a storage location of a facility with the given ID - put: + - 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 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 + - description: Id of the toolkit fence you want to get in: path - name: storageLocationId + name: toolkitFenceId required: true schema: type: string @@ -15258,8 +15926,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/StorageLocation' - description: Storage location was found & you were allowed to update it. + $ref: '#/components/schemas/ToolkitFence' + description: >- + ToolkitFence was found & you were allowed to access it. The result + is in the body. '401': content: application/json: @@ -15282,42 +15952,42 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Facility or Storage Location not found + description: User not found tags: - - Core - Facilities + - DOMS - Routing Plans 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: +

This part of the API is currently under development. + That means that this endpoint, model, etc. can contain breaking changes + and / or might not be available at all times in your API instance. 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 facility you want to patch the storage locations - in: path - name: facilityId - required: true - schema: - type: string - - description: the ID of the storageLocation + - description: ID of the toolkit fence you want to update in: path - name: storageLocationId + 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/StorageLocation' - description: Storage location was found & you were allowed to update it. + $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: @@ -15340,64 +16010,31 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Facility or Storage location not found + description: Toolkit fence 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: + - 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 facility from whom you want to get the zones + - description: ID of the toolkit fence you want to delete in: path - name: facilityId + name: toolkitFenceId 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. + description: Toolkit fence was found & you were allowed to delete it. '401': content: application/json: @@ -15420,27 +16057,43 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Facility not found + description: Toolkit fence not found tags: - - Core - Facilities - description: '' - operationId: getFacilityZones - summary: Get the zones of this facility - post: + - 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: ID of facility from whom you want to create the zone - in: path - name: facilityId - required: true + - 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: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/Zone' - description: The zone was successfully created. + $ref: '#/components/schemas/ToolkitRatingTransporter' + description: The current list of available toolkit fences '401': content: application/json: @@ -15463,45 +16116,34 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Zone not found + description: No more elements available tags: - - Core - Facilities - description: Creates a new zone in this facility. - operationId: postFacilityZone + - 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/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 + $ref: '#/components/schemas/ToolkitRatingForCreation' 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. + $ref: '#/components/schemas/ToolkitRating' + description: Toolkit Rating was created successfully. '401': content: application/json: @@ -15524,29 +16166,40 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Facility not found + description: Entity 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 + - 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/fulfillability: + post: responses: '200': - description: Zone was found & you were allowed to delete it. + 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: @@ -15563,40 +16216,45 @@ paths: 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 + - 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/Zone' - description: Zone was found & you are allowed to update it. + $ref: '#/components/schemas/ApiError' + description: Invalid input. See response for details '401': content: application/json: @@ -15613,45 +16271,43 @@ paths: 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 + - DOMS - Checkout Options + deprecated: true description: >- - Replaces the current zone of this Facility with the provided in the - body. - operationId: putFacilityZone +
+
This endpoint is deprecated and has been replaced.

Deprecated: use /api/promises instead + operationId: queryFulfillabilityClickAndCollect requestBody: content: application/json: schema: - $ref: '#/components/schemas/ZoneForReplacement' - description: Patch set + $ref: '#/components/schemas/FulfillabilityClickAndCollectQuery' + description: Representation that describes the fulfillability query 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 + 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/CustomService' - description: >- - custom service was found & patch-set has been applied. The patched - custom service is in the body. + $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: @@ -15668,56 +16324,43 @@ paths: 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 + - 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/CustomServicePatchActions' - description: Patch set + $ref: '#/components/schemas/FulfillabilityShipFromStoreQuery' + description: Representation that describes the fulfillability query 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 + summary: >- + Provides information which kind of fulfillment is possible under given + circumstances. + /api/promises/checkoutoptions: + post: responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CustomService' - description: Custom service config could be found in response body. + 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: @@ -15734,15 +16377,8 @@ paths: 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 + - DOMS - Orders description: |-
@@ -15753,30 +16389,26 @@ paths: under our SLA regulations. For details on this topic please check our documentation

- operationId: getCustomService - summary: Get requested Custom service - /api/customservices/{customServiceId}/additionalinformation: + operationId: postCheckoutOptions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CheckoutOptionsInput' + description: The CheckoutOptionsInput + required: true + summary: Evaluate a checkout options input against the DOMS + /api/promises/checkoutoptions/delivery/timepoint: post: - 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. + $ref: '#/components/schemas/CheckoutOptionsDeliveryTimePointResponse' + description: |- + + The request could be evaluated. '400': content: application/json: @@ -15801,7 +16433,17 @@ paths: Your user, although recognized, is not authorized to use this endpoint tags: - - Core - Custom Services + - DOMS - Checkout Options + operationId: checkoutOptionsTimepoint + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CheckoutOptionsDeliveryTimePointRequest' + required: true + summary: >- + This endpoint is to be used to get information about the possible + delivery of items description: |-
@@ -15812,28 +16454,26 @@ paths: 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: + /api/orders: + get: parameters: - - description: ID of custom service - in: path - name: customServiceId - required: true + - description: all entities after given Id + in: query + name: startAfterId + required: false schema: type: string - - description: ID of additional information you want to delete - in: path - name: additionalInformationId - required: true + - 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: @@ -15841,21 +16481,8 @@ paths: 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 + $ref: '#/components/schemas/StrippedOrders' + description: Orders are found. '401': content: application/json: @@ -15873,46 +16500,20 @@ paths: 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 + - DOMS - Orders + description: '' + operationId: getAllOrders + summary: Return all orders + 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. + $ref: '#/components/schemas/Order' + description: >- + The order was successfully created. The Location header contains the + URL of the order. '400': content: application/json: @@ -15937,49 +16538,35 @@ paths: 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 + - DOMS - Orders + description: '' + operationId: addOrder requestBody: content: application/json: schema: - $ref: '#/components/schemas/AdditionalInformationForCreation' - description: Desired custom service to create + $ref: '#/components/schemas/OrderForCreation' + description: Order object supplied by your shop instance required: true - summary: Update a custom service additional information - /api/customservices: + summary: Add a new order for future fulfillment + /api/orders/{orderId}: get: parameters: - - description: all entities after given Id - in: query - name: startAfterId - required: false + - description: ID of order you want to get + in: path + name: orderId + required: true 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. + $ref: '#/components/schemas/Order' + description: >- + Order was found & you were allowed to access it. The result is in + the body. '401': content: application/json: @@ -16004,106 +16591,109 @@ paths: $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 + - 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/CustomService' - description: The custom service was successfully updated. - '201': + $ref: '#/components/schemas/Order' + description: Updated Order in the body. + '401': content: application/json: schema: - $ref: '#/components/schemas/CustomService' - description: The custom service was successfully created. - '400': + items: + $ref: '#/components/schemas/ApiError' + description: Your user is not allowed to operate against this API instance + '403': content: application/json: schema: items: $ref: '#/components/schemas/ApiError' - description: Invalid input. See response for details + 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/routing/commands/reroute: + post: + responses: + '200': + description: Rerouting was successfully 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 tags: - - Core - Custom Services - description: |- -
- -

This part of the API is currently under development. + - 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: createCustomService + documentation


+ operationId: reRoute requestBody: content: application/json: schema: - $ref: '#/components/schemas/CustomServiceForCreation' - description: Desired custom service to create + $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: Create a custom service - /api/facilities/{facilityId}/customservices: + summary: Triggers rerouting of failed routing plans + /api/routingplans: get: parameters: - - description: ID of facility - in: path - name: facilityId - required: true - schema: - type: string - - description: all entities after given Id + - description: >- + Reference to the order you want to get the corresponding routing + plan. in: query - name: startAfterId - required: false + name: orderRef 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. + $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: @@ -16126,33 +16716,18 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found + description: Entity not found, please look at details. 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}: + - DOMS - Routing Plans + description: '' + operationId: getRoutingPlanBaseOnOrderRef + summary: Get a routing plan regarding to orderRef + /api/routingplans/{routingplanId}: get: parameters: - - description: ID of facility - in: path - name: facilityId - required: true - schema: - type: string - - description: ID of the custom service + - description: ID of the routing plan want to get in: path - name: customServiceId + name: routingplanId required: true schema: type: string @@ -16161,9 +16736,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FacilityCustomServiceConnection' - description: Custom service connection could be found in response body. - '401': + $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: @@ -16185,32 +16762,17 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found + description: Not found, please look at details. 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 + - DOMS - Routing Plans + description: '' + operationId: getRoutingPlan + summary: Get a routing plan with the given ID patch: parameters: - - description: ID of facility - in: path - name: facilityId - required: true - schema: - type: string - - description: ID of the custom service + - description: ID of routing plan you want to patch in: path - name: customServiceId + name: routingplanId required: true schema: type: string @@ -16219,15 +16781,10 @@ paths: 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 + $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: @@ -16244,116 +16801,54 @@ paths: 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': + '404': content: application/json: schema: items: $ref: '#/components/schemas/ApiError' - description: Your user is not allowed to operate against this API instance - '403': + description: Entity not found, for more information please look at details. + '409': content: application/json: schema: items: $ref: '#/components/schemas/ApiError' - description: >- - Your user, although recognized, is not authorized to use this - endpoint + description: Entity version conflict 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 + - DOMS - Routing Plans + description: '' + operationId: patchRoutingPlan requestBody: content: application/json: schema: - $ref: '#/components/schemas/FacilityCustomServiceConnectionForCreation' - description: Desired custom service connection to create/update + $ref: '#/components/schemas/RoutingPlanPatchActions' + description: Patch set required: true - summary: Create a facility custom service connection - delete: + summary: Patches a routing plan with the given ID + /api/routingplans/{routingplanId}/decisionlogs/{routingRun}: + get: parameters: - - description: ID of facility + - description: ID of the routing plan you want to get it's decision log in: path - name: facilityId + name: routingplanId required: true schema: type: string - - description: ID of the custom service + - description: ID of the decision log you want to get in: path - name: customServiceId + name: routingRun required: true schema: - type: string + type: integer 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 + $ref: '#/components/schemas/DecisionLog' + description: Decision log was found. '401': content: application/json: @@ -16370,29 +16865,43 @@ paths: 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: - - 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: + - 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/ServiceJobs' - description: Service Jobs could be found in response body. + $ref: '#/components/schemas/RerouteDescriptions' + description: >- + RerouteDescription were found & you were allowed to access it. The + result is in the body. '401': content: application/json: @@ -16409,89 +16918,40 @@ paths: 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 - 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. + - 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 -

+ documentation


+ operationId: getRerouteDescriptions + summary: Get a list with all reroute descriptions post: responses: '201': content: application/json: schema: - $ref: '#/components/schemas/ServiceJob' - description: The service job was successfully created. + $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: @@ -16516,32 +16976,31 @@ paths: Your user, although recognized, is not authorized to use this endpoint tags: - - Fulfillment Operations - Custom Services - operationId: createServiceJob + - DOMS - Routing Plans + operationId: postRerouteDescription requestBody: content: application/json: schema: - $ref: '#/components/schemas/ServiceJobForCreation' - description: Desired service job to create + $ref: '#/components/schemas/RerouteDescriptionForCreation' + description: The RerouteDescription required: true - summary: Create a service job - description: |- -
- -

This part of the API is currently under development. + 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/servicejobs/{serviceJobId}: + documentation


+ /api/reroutedescriptions/{rerouteDescriptionId}: get: parameters: - - description: ID of service job you want to get + - description: Id of the reroute description you wish to retrieve in: path - name: serviceJobId + name: rerouteDescriptionId required: true schema: type: string @@ -16550,8 +17009,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServiceJob' - description: Service Job could be found in response body. + $ref: '#/components/schemas/RerouteDescription' + description: >- + RerouteDescription was found & you were allowed to access it. The + result is in the body. '401': content: application/json: @@ -16574,44 +17035,42 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found + description: User not found tags: - - Fulfillment Operations - Custom Services - operationId: getServiceJob - summary: Get requested service job - description: |- -
- -

This part of the API is currently under development. + - 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 -

- /api/servicejobs/{serviceJobId}/actions: - post: + documentation


+ operationId: getRerouteDescriptionById + summary: Get a reroute description with the given key + put: parameters: - - description: ID of service job you want to update + - description: ID of the reroute description you intend to modify in: path - name: serviceJobId + 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/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 + $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: @@ -16628,151 +17087,39 @@ paths: 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': + '404': content: application/json: schema: items: $ref: '#/components/schemas/ApiError' - description: >- - Your user, although recognized, is not authorized to use this - endpoint + description: RerouteDescription not found 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. + - 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 -

- /api/linkedservicejobs/{linkedServiceJobsId}: - get: + documentation


+ operationId: putRerouteDescription + summary: Update a reroute description + delete: parameters: - - description: ID of LinkedServiceJobs you want to get + - description: ID of the reroute description you intend to delete in: path - name: linkedServiceJobsId + name: rerouteDescriptionId required: true schema: type: string responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/LinkedServiceJobs' - description: LinkedServiceJobs could be found in response body. + description: >- + The reroute description was found, and you have been granted + permission to delete it. '401': content: application/json: @@ -16795,44 +17142,67 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found + description: RerouteDescription not found tags: - - Fulfillment Operations - Custom Services - operationId: getLinkedServiceJobsById - summary: Get requested LinkedServiceJobs - description: |- -
- -

This part of the API is currently under development. + - 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 -

- /api/linkedservicejobs/{linkedServiceJobsId}/servicejoblinks: - post: - parameters: - - description: ID of LinkedServiceJobs you want to alter - in: path - name: linkedServiceJobsId - required: true - schema: - type: string + documentation


+ operationId: deleteRerouteDescription + summary: Delete a reroute description + /api/configurations/capacityplanningtimeframe: + get: responses: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/LinkedServiceJobs' - description: The ServiceJobLink was successfully added to the LinkedServiceJobs. - '400': + $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: Invalid input. See response for details + description: Your user is not allowed to operate against this API instance + '403': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/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: @@ -16849,53 +17219,92 @@ paths: 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 - Custom Services - operationId: addServiceJobLink + - DOMS - Routing Plans + description: '' + operationId: putCapacityPlanningTimeframeConfiguration requestBody: content: application/json: schema: - $ref: '#/components/schemas/ServiceJobLinkForAdding' - description: Desired ServiceJobLink to add + $ref: '#/components/schemas/CapacityPlanningTimeframeConfiguration' 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}: + summary: Update capacity planning timeframe configuration of a tenant + /api/orders/{orderId}/cancel: 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 + - description: ID of order you want to cancel in: path - name: serviceJobLinkId + name: orderId required: true schema: type: string responses: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/LinkedServiceJobs' + $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: >- - The ServiceJobLink was successfully added nested inside the - LinkedServiceJobs. + Your user, although recognized, is not authorized to use this + endpoint + '404': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: Entity not found + tags: + - DOMS - Orders + operationId: cancelOrder + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + cancelationReasonId: + description: ID of the cancelation reason + type: string + summary: Cancel an order with the given ID + deprecated: true + description: >- +
+
This endpoint is deprecated and has been replaced.

Deprecated: Use /actions with "CANCEL" instead. + /api/promises/deliverypromise: + post: + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/ResponseForDeliveryPromise' + description: The order promise was created URL of the order promse. '400': content: application/json: @@ -16920,16 +17329,7 @@ paths: 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 + - DOMS - Orders description: |-
@@ -16940,45 +17340,33 @@ paths: under our SLA regulations. For details on this topic please check our documentation

- /api/operativeprocesses: + operationId: postDeliveryPromise + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OrderForCreation' + description: Order object supplied by your shop instance + required: true + summary: Add a new order for future fulfillment + /api/configurations/routing/toolkit/ratings/{toolkitRatingId}: get: parameters: - - description: facility to filter the results - in: query - name: facilityId + - description: Id of the tag you want to get + in: path + name: toolkitRatingId 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 + $ref: '#/components/schemas/ToolkitRating' + description: >- + ToolkitRating was found & you were allowed to access it. The result + is in the body. '401': content: application/json: @@ -17001,44 +17389,42 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found + description: User not found tags: - - Fulfillment Operations - Operative Process - description: |- -
- -

This part of the API is currently under development. + - 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: getOperativeProcesses - summary: Get all operativeProcesses - /api/operativeprocesses/{operativeProcessId}: - get: + documentation


+ operationId: getToolkitRatingById + summary: Get a tag with the given key + put: parameters: - - description: id of the operativeProcess you want to retrieve + - description: ID of the toolkit rating you want to update in: path - name: operativeProcessId + 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/OperativeProcess' - description: Found operativeProcess by given ID - '400': - content: - application/json: - schema: - items: - $ref: '#/components/schemas/ApiError' - description: Invalid input. See response for details + $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: @@ -17061,611 +17447,617 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Entity not found + description: Toolkit rating not found tags: - - Fulfillment Operations - Operative Process - description: |- -
- -

This part of the API is currently under development. + - 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: 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.

+ documentation


+ operationId: putToolkitRating + summary: Update a toolkit rating + delete: 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 + - description: ID of the toolkit rating you want to delete + in: path + name: toolkitRatingId + required: true schema: - minLength: 1 type: string responses: '200': - description: >- - Articles search result according to the request. The result is in - the body. + description: Toolkit rating was found & you were allowed to delete it. + '401': content: application/json: schema: - $ref: '#/components/schemas/InventoryArticlePaginatedResult' - '401': + items: + $ref: '#/components/schemas/ApiError' description: Your user is not allowed to operate against this API instance + '403': content: application/json: schema: - $ref: '#/components/schemas/ApiError' - '403': - description: Your user, although recognized, is not authorized to use this + 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' + items: + $ref: '#/components/schemas/ApiError' + description: Toolkit rating not found 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. + - 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 -

- parameters: - - name: tenantArticleId - required: true - in: path - schema: - type: string - - name: period - required: false - in: query - schema: - enum: - - DAILY - type: string + documentation


+ operationId: deleteToolkitRating + summary: Delete a toolkit rating + /api/configurations/routing/rerouteshortpick: + get: 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' + $ref: '#/components/schemas/RerouteShortPickConfiguration' + description: >- + Reroute short pick configuration was found & you were allowed to + access it. The result is in the body. '401': - description: Your user is not allowed to operate against this API instance content: application/json: schema: - $ref: '#/components/schemas/ApiError' + 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 content: application/json: schema: - $ref: '#/components/schemas/ApiError' + items: + $ref: '#/components/schemas/ApiError' + description: >- + Your user, although recognized, is not authorized to use this + endpoint '404': - description: The requested entity was not found content: application/json: schema: - $ref: '#/components/schemas/ApiError' + items: + $ref: '#/components/schemas/ApiError' + description: Reroute configuration not found 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 + - 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': - description: Purchase Order entity content: application/json: schema: - $ref: '#/components/schemas/PurchaseOrder' + $ref: '#/components/schemas/RerouteShortPickConfiguration' + description: Reroute short pick configuration was written successfully '401': - description: Your user is not allowed to operate against this API instance content: application/json: schema: - $ref: '#/components/schemas/ApiError' + 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 content: application/json: schema: - $ref: '#/components/schemas/ApiError' + items: + $ref: '#/components/schemas/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: - - 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 + - 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: - required: true content: application/json: schema: - $ref: '#/components/schemas/PurchaseOrderForUpdate' + $ref: '#/components/schemas/RerouteShortPickConfiguration' + required: true + summary: Update reroute short pick configuration of a tenant + /api/configurations/routing/reroutetimetriggered: + get: responses: '200': - description: Updated/created Purchase Order entity content: application/json: schema: - $ref: '#/components/schemas/PurchaseOrder' + $ref: '#/components/schemas/RerouteTimeTriggeredConfiguration' + description: >- + Reroute time triggered configuration was found & you were allowed to + access it. The result is in the body. '401': - description: Your user is not allowed to operate against this API instance content: application/json: schema: - $ref: '#/components/schemas/ApiError' + 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 content: application/json: schema: - $ref: '#/components/schemas/ApiError' + items: + $ref: '#/components/schemas/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: - - 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' + - 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': - description: Updated Purchase Order entity content: application/json: schema: - $ref: '#/components/schemas/PurchaseOrder' + $ref: '#/components/schemas/RerouteTimeTriggeredConfiguration' + description: Reroute time triggered configuration was written successfully '401': - description: Your user is not allowed to operate against this API instance content: application/json: schema: - $ref: '#/components/schemas/ApiError' + 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 content: application/json: schema: - $ref: '#/components/schemas/ApiError' + items: + $ref: '#/components/schemas/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: - - Inventory Management - Inbound - /api/purchaseorders: - post: - operationId: createPurchaseOrder - summary: Create a new Purchase Order - deprecated: false - description: '' - parameters: [] + - 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: - required: true content: application/json: schema: - $ref: '#/components/schemas/PurchaseOrderForCreation' + $ref: '#/components/schemas/RerouteTimeTriggeredConfiguration' + required: true + summary: Update reroute time triggered configuration of a tenant + /api/configurations/routing/manualreroute: + get: responses: - '201': - description: Created Purchase Order entity + '200': content: application/json: schema: - $ref: '#/components/schemas/PurchaseOrder' + $ref: '#/components/schemas/ManualRerouteConfiguration' + description: >- + Manual reroute configuration was found & you were allowed to access + it. The result is in the body. '401': - description: Your user is not allowed to operate against this API instance content: application/json: schema: - $ref: '#/components/schemas/ApiError' + 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 content: application/json: schema: - $ref: '#/components/schemas/ApiError' + items: + $ref: '#/components/schemas/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: - - 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 + - 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': - description: Paginated result containing the matching Inbound Process entities content: application/json: schema: - $ref: '#/components/schemas/InboundProcessPaginatedResult' + $ref: '#/components/schemas/ManualRerouteConfiguration' + description: Manual order reroute configuration was written successfully '401': - description: Your user is not allowed to operate against this API instance content: application/json: schema: - $ref: '#/components/schemas/ApiError' + 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 content: application/json: schema: - $ref: '#/components/schemas/ApiError' + items: + $ref: '#/components/schemas/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: - - Inventory Management - Inbound - post: - operationId: createInboundProcess - summary: Create a new Inbound Process - deprecated: false - description: '' - parameters: [] + - DOMS - Routing Plans + description: >- +
+
This endpoint is deprecated and has been replaced.

Deprecated, use GlobalManualRerouteConfiguration in + /api/configurations/routing + deprecated: true + operationId: putManualRerouteConfiguration requestBody: - required: true content: application/json: schema: - $ref: '#/components/schemas/InboundProcessForCreation' + $ref: '#/components/schemas/ManualRerouteConfiguration' + required: true + summary: Update manual order reroute configuration of a tenant + /api/configurations/promises: + get: responses: '200': - description: Created Inbound Process entity content: application/json: schema: - $ref: '#/components/schemas/InboundProcess' + $ref: '#/components/schemas/PromisesConfiguration' + description: >- + Promises configuration was found & you were allowed to access it. + The result is in the body. '401': - description: Your user is not allowed to operate against this API instance content: application/json: schema: - $ref: '#/components/schemas/ApiError' + 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 content: application/json: schema: - $ref: '#/components/schemas/ApiError' + items: + $ref: '#/components/schemas/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: - - Inventory Management - Inbound - /api/inboundprocesses/{inboundProcessId}: - get: - operationId: getInboundProcess - summary: Get an Inbound Process by ID - deprecated: false + - DOMS - Orders description: '' - parameters: - - name: inboundProcessId - required: true - in: path - schema: - type: string + operationId: getPromisesConfiguration + summary: Get a tenant promises config + put: responses: '200': - description: Requested Inbound Process entity content: application/json: schema: - $ref: '#/components/schemas/InboundProcess' + $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': - description: Your user is not allowed to operate against this API instance content: application/json: schema: - $ref: '#/components/schemas/ApiError' + 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 content: application/json: schema: - $ref: '#/components/schemas/ApiError' + items: + $ref: '#/components/schemas/ApiError' + description: >- + Your user, although recognized, is not authorized to use this + endpoint tags: - - Inventory Management - Inbound - delete: - operationId: deleteInboundProcess - summary: Delete an Inbound Process by ID - deprecated: false + - DOMS - Orders description: '' + operationId: putPromisesConfiguration + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PromisesConfiguration' + description: Desired promises configuration to put + required: true + summary: Change the tenant wide promises configuration + /api/configurations/routing: + get: parameters: - - name: inboundProcessId - required: true - in: path + - 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': - description: Inbound Process successfully deleted + 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': - description: Your user is not allowed to operate against this API instance content: application/json: schema: - $ref: '#/components/schemas/ApiError' + 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 content: application/json: schema: - $ref: '#/components/schemas/ApiError' + items: + $ref: '#/components/schemas/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: - - Inventory Management - Inbound + - DOMS - Routing Plans + description: '' + operationId: getRoutingConfiguration + summary: Get a tenant routing config 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 + content: + application/json: + schema: + $ref: '#/components/schemas/RoutingConfiguration' + description: Routing configuration was found & patch-set has been applied. '401': - description: Your user is not allowed to operate against this API instance content: application/json: schema: - $ref: '#/components/schemas/ApiError' + 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 content: application/json: schema: - $ref: '#/components/schemas/ApiError' + items: + $ref: '#/components/schemas/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: - - 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 + - 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

- parameters: - - name: inboundProcessId - required: true - in: path - schema: - type: string + 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: - required: true content: application/json: schema: - $ref: '#/components/schemas/InboundProcessPurchaseOrderForUpsert' + $ref: '#/components/schemas/RoutingConfigurationsPatchActions' + description: Patch set + required: true + summary: Patches routing configuration + put: 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' + $ref: '#/components/schemas/RoutingConfiguration' + description: Routing configuration was written successfully '401': - description: Your user is not allowed to operate against this API instance content: application/json: schema: - $ref: '#/components/schemas/ApiError' + 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 content: application/json: schema: - $ref: '#/components/schemas/ApiError' + items: + $ref: '#/components/schemas/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: - - Inventory Management - Inbound - /api/inboundprocesses/{inboundProcessId}/receipts: - post: - operationId: addReceiptToInboundProcess - summary: Adds a receipt to an inbound process. - deprecated: false + - 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/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: >-
documentation

- parameters: - - name: inboundProcessId - required: true - in: path - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/InboundReceiptForCreation' + 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': - description: Receipt was added to the inbound process content: application/json: schema: - $ref: '#/components/schemas/InboundReceipt' + $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': - description: Your user is not allowed to operate against this API instance content: application/json: schema: - $ref: '#/components/schemas/ApiError' + 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 content: application/json: schema: - $ref: '#/components/schemas/ApiError' + items: + $ref: '#/components/schemas/ApiError' + description: >- + Your user, although recognized, is not authorized to use this + endpoint tags: - - Inventory Management - Inbound - /api/inboundreceiptjobs: + - 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/articles: 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 -


+ 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 @@ -17741,53 +18146,33 @@ paths: 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 + - name: searchTerm required: false in: query schema: minLength: 1 type: string - - name: fromDate + - name: locale required: false in: query schema: - format: date-time type: string - - name: toDate + $ref: '#/components/schemas/SupportedLocale' + - name: tenantArticleId required: false in: query schema: - format: date-time type: string responses: '200': - description: Paginated Inbound Receipt Jobs + description: >- + Articles search result according to the request. The result is in + the body. content: application/json: schema: - $ref: '#/components/schemas/InboundReceiptJobPaginatedResult' + $ref: '#/components/schemas/InventoryArticlePaginatedResult' '401': description: Your user is not allowed to operate against this API instance content: @@ -17801,11 +18186,11 @@ paths: schema: $ref: '#/components/schemas/ApiError' tags: - - Inventory Management - Inbound - /api/inboundreceiptjobs/{inboundEntryId}: + - Inventory Management - Stocks + /api/articles/{tenantArticleId}/forecasts: get: - operationId: getInboundReceiptJob - summary: Get an Inbound Receipt Job by ID + operationId: getForecastsForArticle + summary: Get the forecast for a specific tenantArticleId deprecated: false description: |-
@@ -17818,18 +18203,29 @@ paths: documentation

parameters: - - name: inboundEntryId + - name: tenantArticleId required: true in: path schema: type: string + - name: period + required: false + in: query + schema: + enum: + - DAILY + type: string responses: '200': - description: '' + description: >- + Forecast for the specified tenantArticleId. The result is in the + body. content: application/json: schema: - $ref: '#/components/schemas/InboundReceiptJob' + type: array + items: + $ref: '#/components/schemas/ArticleStockForecast' '401': description: Your user is not allowed to operate against this API instance content: @@ -17842,37 +18238,33 @@ paths: 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/receipts: - post: - operationId: createReceipt - summary: Creates a receipt + - Inventory Management - Stocks + /api/purchaseorders/{purchaseOrderId}: + get: + operationId: getPurchaseOrder + summary: Get a Purchase Order 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: [] - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/ReceiptForCreation' + description: '' + parameters: + - name: purchaseOrderId + required: true + in: path + schema: + type: string responses: - '201': - description: Created inbound receipt + '200': + description: Purchase Order entity content: application/json: schema: - $ref: '#/components/schemas/Receipt' + $ref: '#/components/schemas/PurchaseOrder' '401': description: Your user is not allowed to operate against this API instance content: @@ -17887,34 +18279,30 @@ paths: $ref: '#/components/schemas/ApiError' tags: - Inventory Management - Inbound - /api/receipts/{receiptId}: - get: - operationId: getReceipt - summary: Get receipt by id + put: + operationId: upsertPurchaseOrder + summary: Update or create a Purchase Order 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 -


+ description: '' parameters: - - name: receiptId + - name: purchaseOrderId required: true in: path schema: type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PurchaseOrderForUpdate' responses: '200': - description: '' + description: Updated/created Purchase Order entity content: application/json: schema: - $ref: '#/components/schemas/Receipt' + $ref: '#/components/schemas/PurchaseOrder' '401': description: Your user is not allowed to operate against this API instance content: @@ -17927,30 +18315,15 @@ paths: 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 + patch: + operationId: patchPurchaseOrder + summary: Partially updates a Purchase Order using a selection of fields 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 -


+ description: '' parameters: - - name: receiptId + - name: purchaseOrderId required: true in: path schema: @@ -17960,14 +18333,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InboundReceiptForUpdate' + $ref: '#/components/schemas/PurchaseOrderForPartialUpdate' responses: '200': - description: '' + description: Updated Purchase Order entity content: application/json: schema: - $ref: '#/components/schemas/Receipt' + $ref: '#/components/schemas/PurchaseOrder' '401': description: Your user is not allowed to operate against this API instance content: @@ -17980,47 +18353,28 @@ paths: 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 + /api/purchaseorders: + post: + operationId: createPurchaseOrder + summary: Create a new Purchase Order 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 + description: '' + parameters: [] requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/InboundReceiptForPatch' + $ref: '#/components/schemas/PurchaseOrderForCreation' responses: - '200': - description: '' + '201': + description: Created Purchase Order entity content: application/json: schema: - $ref: '#/components/schemas/Receipt' + $ref: '#/components/schemas/PurchaseOrder' '401': description: Your user is not allowed to operate against this API instance content: @@ -18033,46 +18387,127 @@ paths: 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 + /api/inboundprocesses: + get: + operationId: getInboundProcesses + summary: Get multiple Inbound Processes 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 -


+ description: '' parameters: - - name: receiptId - required: true - in: path + - 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: version - required: true + - name: sort + required: false in: query schema: - type: number + 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: '' + description: Paginated result containing the matching Inbound Process entities content: application/json: schema: - $ref: '#/components/schemas/Receipt' + $ref: '#/components/schemas/InboundProcessPaginatedResult' '401': description: Your user is not allowed to operate against this API instance content: @@ -18085,43 +18520,27 @@ paths: 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 + post: + operationId: createInboundProcess + summary: Create a new 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 -


+ description: '' parameters: [] requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/InventoryConfigurationForPatch' + $ref: '#/components/schemas/InboundProcessForCreation' responses: '200': - description: Requested Inventory Configuration + description: Created Inbound Process entity content: application/json: schema: - $ref: '#/components/schemas/InventoryConfiguration' + $ref: '#/components/schemas/InboundProcess' '401': description: Your user is not allowed to operate against this API instance content: @@ -18135,29 +18554,26 @@ paths: schema: $ref: '#/components/schemas/ApiError' tags: - - Inventory Management - Stocks + - Inventory Management - Inbound + /api/inboundprocesses/{inboundProcessId}: get: - operationId: getInventoryConfigurations - summary: Get Inventory Configuration + operationId: getInboundProcess + summary: Get 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: [] + description: '' + parameters: + - name: inboundProcessId + required: true + in: path + schema: + type: string responses: '200': - description: Requested Inventory Configuration + description: Requested Inbound Process entity content: application/json: schema: - $ref: '#/components/schemas/InventoryConfiguration' + $ref: '#/components/schemas/InboundProcess' '401': description: Your user is not allowed to operate against this API instance content: @@ -18171,41 +18587,21 @@ paths: schema: $ref: '#/components/schemas/ApiError' tags: - - Inventory Management - Stocks - /api/facilities/{facilityId}/configurations/inventory: - patch: - operationId: upsertInventoryFacilityConfigurations - summary: Update Inventory Configuration for a Facility + - Inventory Management - Inbound + delete: + operationId: deleteInboundProcess + summary: Delete 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 -


+ description: '' parameters: - - name: facilityId + - name: inboundProcessId 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' + description: Inbound Process successfully deleted '401': description: Your user is not allowed to operate against this API instance content: @@ -18219,10 +18615,10 @@ paths: schema: $ref: '#/components/schemas/ApiError' tags: - - Inventory Management - Stocks - get: - operationId: getInventoryFacilityConfigurations - summary: Get Inventory Configuration for a Facility + - Inventory Management - Inbound + patch: + operationId: Patch InboundProcess + summary: Patch an Inbound Process by ID deprecated: false description: |-
@@ -18235,18 +18631,20 @@ paths: documentation

parameters: - - name: facilityId + - name: inboundProcessId required: true in: path schema: type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/InboundProcessForPatch' responses: '200': - description: Requested Inventory Facility Configuration - content: - application/json: - schema: - $ref: '#/components/schemas/InventoryFacilityConfiguration' + description: Inbound Process successfully patched '401': description: Your user is not allowed to operate against this API instance content: @@ -18260,39 +18658,48 @@ paths: 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 + - 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. + 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 -

+ documentation


parameters: - - name: stockId + - name: inboundProcessId required: true in: path schema: type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/InboundProcessPurchaseOrderForUpsert' responses: '200': - description: >- - List of Storage Locations sorted by the stock sum ascending. The - result is in the body. + description: Purchase order successfully updated on inbound process content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/StorageLocationRecommendation' + $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: @@ -18306,36 +18713,40 @@ paths: schema: $ref: '#/components/schemas/ApiError' tags: - - Inventory Management - Stocks - /api/inboundprocesses/attachments: + - Inventory Management - Inbound + /api/inboundprocesses/{inboundProcessId}/receipts: post: - operationId: createAttachment - summary: Creates an attachment + operationId: addReceiptToInboundProcess + summary: Adds a receipt to an inbound process. deprecated: false - description: |- -
- -

This part of the API is currently under development. + 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: [] + documentation


+ parameters: + - name: inboundProcessId + required: true + in: path + schema: + type: string requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/InboundAttachmentForCreation' + $ref: '#/components/schemas/InboundReceiptForCreation' responses: '201': - description: Created attachment + description: Receipt was added to the inbound process content: application/json: schema: - $ref: '#/components/schemas/InboundAttachment' + $ref: '#/components/schemas/InboundReceipt' '401': description: Your user is not allowed to operate against this API instance content: @@ -18350,10 +18761,10 @@ paths: $ref: '#/components/schemas/ApiError' tags: - Inventory Management - Inbound - /api/inboundprocesses/attachments/{attachmentId}/signedurl: + /api/inboundreceiptjobs: get: - operationId: getSignedAttachmentUrl - summary: Retrieves a signed url for an attachment + operationId: getInboundReceiptJobs + summary: Get InboundReceiptJobs deprecated: false description: |-
@@ -18365,39 +18776,6 @@ paths: 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 @@ -18412,18 +18790,14 @@ paths: in: query schema: type: string - - name: facilityServiceTypes + - name: facilityRef required: false in: query - explode: false schema: type: array items: type: string - enum: - - SHIP_FROM_STORE - - PICKUP - - name: facilityStatus + - name: status required: false in: query explode: false @@ -18432,52 +18806,41 @@ paths: items: type: string enum: - - ONLINE - - SUSPENDED - - OFFLINE - - name: facilityRefs + - OPEN + - PARTIAL_DELIVERY + - ON_HOLD + - CLOSED + - name: searchTerm required: false in: query - explode: true schema: - type: array - items: - type: string - - name: allowStale + minLength: 1 + type: string + - name: searchTermExact required: false in: query schema: - type: boolean - - name: tenantArticleIds + minLength: 1 + type: string + - name: fromDate required: false in: query - explode: true schema: - type: array - items: - type: string - - name: channelRefs + format: date-time + type: string + - name: toDate 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 + format: date-time + type: string responses: '200': - description: >- - Stock summaries was loaded & you were allowed to access it. The - result is in the body. + description: Paginated Inbound Receipt Jobs content: application/json: schema: - $ref: '#/components/schemas/StockSummaries' + $ref: '#/components/schemas/InboundReceiptJobPaginatedResult' '401': description: Your user is not allowed to operate against this API instance content: @@ -18491,97 +18854,35 @@ paths: schema: $ref: '#/components/schemas/ApiError' tags: - - Inventory Management - Stocks - /api/inventory/stocks/summaries: + - Inventory Management - Inbound + /api/inboundreceiptjobs/{inboundEntryId}: 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.

+ 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: size - required: false - in: query - schema: - minimum: 1 - maximum: 100 - default: 25 - type: number - - name: startAfterId - required: false - in: query + - name: inboundEntryId + required: true + in: path 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. + description: '' content: application/json: schema: - $ref: '#/components/schemas/StockSummaries' + $ref: '#/components/schemas/InboundReceiptJob' '401': description: Your user is not allowed to operate against this API instance content: @@ -18595,89 +18896,36 @@ paths: 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 + - Inventory Management - Inbound + /api/receipts: + post: + operationId: createReceipt + summary: Creates a receipt deprecated: false - description: >- -

This part of the API is currently under development. + 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 + documentation +


+ parameters: [] + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ReceiptForCreation' responses: - '200': - description: >- - Stock distribution was loaded & you were allowed to access it. The - result is in the body. + '201': + description: Created inbound receipt content: application/json: schema: - $ref: '#/components/schemas/StockDistribution' + $ref: '#/components/schemas/Receipt' '401': description: Your user is not allowed to operate against this API instance content: @@ -18691,47 +18939,35 @@ paths: schema: $ref: '#/components/schemas/ApiError' tags: - - Inventory Management - Stocks - /api/facilities/{facilityId}/stocks: + - Inventory Management - Inbound + /api/receipts/{receiptId}: 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 + 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: 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 + - name: receiptId required: true in: path schema: type: string responses: '200': - description: Stock was loaded and you were allowed to access it. + description: '' content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/FacilityStock' + $ref: '#/components/schemas/Receipt' '401': description: Your user is not allowed to operate against this API instance content: @@ -18744,21 +18980,30 @@ paths: 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 + - Inventory Management - Inbound 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 + 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: facilityId + - name: receiptId required: true in: path schema: @@ -18768,16 +19013,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FacilityStockBulkOperations' + $ref: '#/components/schemas/InboundReceiptForUpdate' responses: - '207': - description: Update Result of each targeted tenantArticleId + '200': + description: '' content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/FacilityStockBulkResult' + $ref: '#/components/schemas/Receipt' '401': description: Your user is not allowed to operate against this API instance content: @@ -18790,140 +19033,47 @@ paths: 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 + '404': + description: The requested entity was not found content: application/json: schema: $ref: '#/components/schemas/ApiError' tags: - - Inventory Management - Stocks - get: - operationId: getStocks - summary: Get stocks + - Inventory Management - Inbound + patch: + operationId: patchReceipt + summary: Patch receipt by id deprecated: false - description: >- -

This part of the API is currently under development. + 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


+ 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 + - name: receiptId + required: true + in: path 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' + $ref: '#/components/schemas/InboundReceiptForPatch' responses: '200': - description: Stock upsert result + description: '' content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/StockUpsertOperationResult' + $ref: '#/components/schemas/Receipt' '401': description: Your user is not allowed to operate against this API instance content: @@ -18936,108 +19086,46 @@ paths: 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 + '404': + description: The requested entity was not found content: application/json: schema: $ref: '#/components/schemas/ApiError' tags: - - Inventory Management - Stocks + - Inventory Management - Inbound delete: - operationId: deleteStock - summary: Delete stock + operationId: deleteReceipt + summary: Delete receipt by id deprecated: false - description: '' + 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 + - name: receiptId 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 + - name: version required: true - in: path + in: query schema: - type: string + type: number responses: '200': - description: Stock + description: '' content: application/json: schema: - $ref: '#/components/schemas/Stock' + $ref: '#/components/schemas/Receipt' '401': description: Your user is not allowed to operate against this API instance content: @@ -19050,36 +19138,43 @@ paths: 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/stocks/actions: - post: - operationId: performStocksActions - summary: Perform stocks actions + - 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. + 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


+ documentation +


parameters: [] requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/StockAction' + $ref: '#/components/schemas/InventoryConfigurationForPatch' responses: '200': - description: Stock action result + description: Requested Inventory Configuration content: application/json: schema: - $ref: '#/components/schemas/StockActionResult' + $ref: '#/components/schemas/InventoryConfiguration' '401': description: Your user is not allowed to operate against this API instance content: @@ -19094,43 +19189,28 @@ paths: $ref: '#/components/schemas/ApiError' tags: - Inventory Management - Stocks - /api/safetystocks: get: - operationId: getSafetyStocks - summary: Get all Safety Stocks + operationId: getInventoryConfigurations + summary: Get Inventory Configuration 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 + 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: Available Safety Stocks + description: Requested Inventory Configuration content: application/json: schema: - $ref: '#/components/schemas/SafetyStocksPaginatedResult' + $ref: '#/components/schemas/InventoryConfiguration' '401': description: Your user is not allowed to operate against this API instance content: @@ -19145,25 +19225,40 @@ paths: $ref: '#/components/schemas/ApiError' tags: - Inventory Management - Stocks - put: - operationId: bulkUpdateSafetyStock - summary: Update Safety Stocks in bulk + /api/facilities/{facilityId}/configurations/inventory: + patch: + operationId: upsertInventoryFacilityConfigurations + summary: Update Inventory Configuration for a Facility deprecated: false - description: '' - parameters: [] + 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/SafetyStockBulkOperations' + $ref: '#/components/schemas/InventoryFacilityConfigurationForPatch' responses: - '207': - description: Result of the bulk operations + '200': + description: Requested Inventory Facility Configuration content: application/json: schema: - $ref: '#/components/schemas/SafetyStockBulkOperationResult' + $ref: '#/components/schemas/InventoryFacilityConfiguration' '401': description: Your user is not allowed to operate against this API instance content: @@ -19178,21 +19273,33 @@ paths: $ref: '#/components/schemas/ApiError' tags: - Inventory Management - Stocks - /api/safetystocks/{safetyStockId}: - delete: - operationId: deleteSafetyStock - summary: Delete a single Safety Stock + get: + operationId: getInventoryFacilityConfigurations + summary: Get Inventory Configuration for a Facility deprecated: false - description: '' + 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: safetyStockId + - name: facilityId required: true in: path schema: type: string responses: '200': - description: Result of the bulk operations + 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: @@ -19205,18 +19312,12 @@ paths: 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: + /api/stocks/{stockId}/locationrecommendations: get: - operationId: getNotificationCenterConfig - summary: Returns the notification center configuration. + operationId: getStorageLocationRecommendations + summary: Get the Storage Location recommendations for a specific Stock deprecated: false description: |-
@@ -19228,14 +19329,23 @@ paths: under our SLA regulations. For details on this topic please check our documentation

- parameters: [] + parameters: + - name: stockId + required: true + in: path + schema: + type: string responses: '200': - description: The notification center configuration was successfully returned. + description: >- + List of Storage Locations sorted by the stock sum ascending. The + result is in the body. content: application/json: schema: - $ref: '#/components/schemas/NotificationCenterConfig' + type: array + items: + $ref: '#/components/schemas/StorageLocationRecommendation' '401': description: Your user is not allowed to operate against this API instance content: @@ -19248,17 +19358,12 @@ paths: 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. + - Inventory Management - Stocks + /api/inboundprocesses/attachments: + post: + operationId: createAttachment + summary: Creates an attachment deprecated: false description: |-
@@ -19276,33 +19381,14 @@ paths: content: application/json: schema: - oneOf: - - $ref: '#/components/schemas/NotificationCenterConfigForUpdate' - - type: object - allOf: - - $ref: '#/components/schemas/NotificationCenterConfigForCreation' - not: - required: - - version + $ref: '#/components/schemas/InboundAttachmentForCreation' 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. + description: Created attachment content: application/json: schema: - $ref: '#/components/schemas/ApiError' + $ref: '#/components/schemas/InboundAttachment' '401': description: Your user is not allowed to operate against this API instance content: @@ -19315,18 +19401,12 @@ paths: 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. + - Inventory Management - Inbound + /api/inboundprocesses/attachments/{attachmentId}/signedurl: + get: + operationId: getSignedAttachmentUrl + summary: Retrieves a signed url for an attachment deprecated: false description: |-
@@ -19339,25 +19419,18 @@ paths: documentation

parameters: - - name: channelId + - name: attachmentId 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. + description: Signed url content: application/json: schema: - $ref: '#/components/schemas/ApiError' + type: string '401': description: Your user is not allowed to operate against this API instance content: @@ -19370,57 +19443,94 @@ paths: 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. + - Inventory Management - Inbound + /api/stocks/summaries: + get: + operationId: getStockSummaries + summary: Get the accumulated Stock for each Article 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' + 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: Notification center configuration action was successfully executed. - content: - application/json: - schema: - $ref: '#/components/schemas/NotificationCenterConfig' - '400': - description: Invalid input. See response for details. + description: >- + Stock summaries was loaded & you were allowed to access it. The + result is in the body. content: application/json: schema: - $ref: '#/components/schemas/ApiError' + $ref: '#/components/schemas/StockSummaries' '401': description: Your user is not allowed to operate against this API instance content: @@ -19433,44 +19543,98 @@ paths: 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: + - Inventory Management - Stocks + /api/inventory/stocks/summaries: 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 -


+ 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: facilityRef - required: true - in: path + - 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: >- - The notification center facility configuration was successfully - returned. + Stock summaries was loaded & you were allowed to access it. The + result is in the body. content: application/json: schema: - $ref: '#/components/schemas/NotificationCenterConfig' + $ref: '#/components/schemas/StockSummaries' '401': description: Your user is not allowed to operate against this API instance content: @@ -19483,68 +19647,90 @@ paths: 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 + - Inventory Management - Stocks + /api/articles/{tenantArticleId}/stockdistribution: + get: + operationId: getStockDistribution summary: >- - Creates or updates an existing notification center facility - configuration. + 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. + 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 -

+ documentation


parameters: - - name: facilityRef + - name: tenantArticleId required: true in: path schema: + minLength: 1 type: string - requestBody: - required: true - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/NotificationCenterConfigForUpdate' - - type: object - allOf: - - $ref: '#/components/schemas/NotificationCenterConfigForCreation' - not: - required: - - version + - 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: 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. + description: >- + Stock distribution was loaded & you were allowed to access it. The + result is in the body. content: application/json: schema: - $ref: '#/components/schemas/ApiError' + $ref: '#/components/schemas/StockDistribution' '401': description: Your user is not allowed to operate against this API instance content: @@ -19557,62 +19743,48 @@ paths: 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 -


+ - 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: facilityRef - required: true - in: path + - 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: channelId + - name: facilityId 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. + description: Stock was loaded and you were allowed to access it. content: application/json: schema: - $ref: '#/components/schemas/ApiError' + type: array + items: + $ref: '#/components/schemas/FacilityStock' '401': description: Your user is not allowed to operate against this API instance content: @@ -19625,39 +19797,21 @@ paths: 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 -


+ - 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: facilityRef + - name: facilityId required: true in: path schema: @@ -19667,24 +19821,16 @@ paths: content: application/json: schema: - oneOf: - - $ref: '#/components/schemas/AddChannelAction' - - $ref: '#/components/schemas/UpdateChannelByIdAction' + $ref: '#/components/schemas/FacilityStockBulkOperations' 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. + '207': + description: Update Result of each targeted tenantArticleId content: application/json: schema: - $ref: '#/components/schemas/ApiError' + type: array + items: + $ref: '#/components/schemas/FacilityStockBulkResult' '401': description: Your user is not allowed to operate against this API instance content: @@ -19697,49 +19843,28 @@ paths: 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: + - Inventory Management - Stocks + /api/stocks: post: - operationId: createAvailabilityChannel - summary: Create a new Availability Channel + operationId: createStock + summary: Create 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 -


+ description: '' parameters: [] requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/AvailabilityChannelForCreation' + $ref: '#/components/schemas/StockForCreation' responses: - '200': - description: The created Availability Channel + '201': + description: Stock was created. content: application/json: schema: - $ref: '#/components/schemas/AvailabilityChannel' + $ref: '#/components/schemas/Stock' '401': description: Your user is not allowed to operate against this API instance content: @@ -19753,41 +19878,42 @@ paths: schema: $ref: '#/components/schemas/ApiError' tags: - - Inventory Management - Channel Availability + - Inventory Management - Stocks get: - operationId: getAvailabilityChannels - summary: Get all Availability Channels + operationId: getStocks + summary: Get stocks deprecated: false - description: |- -
- -

This part of the API is currently under development. + 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 -

+ documentation


parameters: - - name: searchTerm + - name: facilityRef required: false in: query schema: type: string - - name: searchTermExact + - name: tenantArticleId required: false in: query schema: - type: string - - name: strategy + maxItems: 500 + type: array + items: + type: string + - name: locationRef required: false in: query schema: - enum: - - REGULAR - - IRON_RESERVE - - RESTRICT - type: string + maxItems: 500 + type: array + items: + type: string - name: size required: false in: query @@ -19803,11 +19929,11 @@ paths: type: string responses: '200': - description: Available Availability Channels + description: Stocks content: application/json: schema: - $ref: '#/components/schemas/AvailabilityChannelPaginatedResult' + $ref: '#/components/schemas/StockPaginatedResult' '401': description: Your user is not allowed to operate against this API instance content: @@ -19821,24 +19947,58 @@ paths: schema: $ref: '#/components/schemas/ApiError' tags: - - Inventory Management - Channel Availability - /api/availabilitychannels/{availabilityChannelId}: + - Inventory Management - Stocks put: - operationId: replaceAvailabilityChannel - summary: Replace an existing Availability Channel + operationId: upsertStocks + summary: Update and create many stocks at once deprecated: false - description: |- -
- -

This part of the API is currently under development. + 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 -

+ 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: availabilityChannelId + - name: stockId required: true in: path schema: @@ -19848,14 +20008,29 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AvailabilityChannelForReplacement' + 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: The replaced Availability Channel + description: Stock content: application/json: schema: - $ref: '#/components/schemas/AvailabilityChannel' + $ref: '#/components/schemas/Stock' '401': description: Your user is not allowed to operate against this API instance content: @@ -19868,41 +20043,54 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiError' - '404': - description: The requested entity was not found + 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 - Channel Availability + - Inventory Management - Stocks get: - operationId: getAvailabilityChannelById - summary: Get an Availability Channel by its id + operationId: getStock + summary: Get 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 -


+ description: '' parameters: - - name: availabilityChannelId + - name: stockId required: true in: path schema: type: string responses: '200': - description: The Availability Channel + description: Stock content: application/json: schema: - $ref: '#/components/schemas/AvailabilityChannel' + $ref: '#/components/schemas/Stock' '401': description: Your user is not allowed to operate against this API instance content: @@ -19915,37 +20103,36 @@ paths: 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 + - 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. + 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 + documentation


+ parameters: [] + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/StockAction' responses: '200': - description: The deleted Availability Channel + 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: @@ -19958,66 +20145,45 @@ paths: 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: + - Inventory Management - Stocks + /api/safetystocks: get: - operationId: getGroupsUnderChannel - summary: Get Groups under Channel + operationId: getSafetyStocks + summary: Get all Safety 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 -


+ description: '' parameters: - - name: availabilityChannelId - required: true - in: path - schema: - type: string - - name: searchTerm + - name: size required: false in: query schema: - type: string - - name: searchTermExact + minimum: 1 + maximum: 100 + default: 25 + type: number + - name: startAfterId required: false in: query schema: type: string - - name: size + - name: tenantArticleId required: false in: query schema: - minimum: 1 - maximum: 100 - default: 25 - type: number - - name: startAfterId + type: string + - name: facilityRef required: false in: query schema: type: string responses: '200': - description: Available Groups + description: Available Safety Stocks content: application/json: schema: - $ref: >- - #/components/schemas/AvailabilityAllocationGroupPaginatedResult + $ref: '#/components/schemas/SafetyStocksPaginatedResult' '401': description: Your user is not allowed to operate against this API instance content: @@ -20030,48 +20196,27 @@ paths: 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 + - Inventory Management - Stocks + put: + operationId: bulkUpdateSafetyStock + summary: Update Safety Stocks in bulk 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 + description: '' + parameters: [] requestBody: required: true content: application/json: schema: - $ref: >- - #/components/schemas/AvailabilityAllocationGroupForCreationUnderChannel + $ref: '#/components/schemas/SafetyStockBulkOperations' responses: - '200': - description: The created Group + '207': + description: Result of the bulk operations content: application/json: schema: - $ref: '#/components/schemas/AvailabilityAllocationGroup' + $ref: '#/components/schemas/SafetyStockBulkOperationResult' '401': description: Your user is not allowed to operate against this API instance content: @@ -20084,53 +20229,23 @@ paths: 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 + - Inventory Management - Stocks + /api/safetystocks/{safetyStockId}: + delete: + operationId: deleteSafetyStock + summary: Delete a single Safety 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 -


+ description: '' parameters: - - name: availabilityChannelId - required: true - in: path - schema: - type: string - - name: groupId + - name: safetyStockId 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' + description: Result of the bulk operations '401': description: Your user is not allowed to operate against this API instance content: @@ -20150,10 +20265,11 @@ paths: schema: $ref: '#/components/schemas/ApiError' tags: - - Inventory Management - Channel Availability + - Inventory Management - Stocks + /api/configurations/notifications: get: - operationId: getGroupUnderChannelById - summary: Get Groups under Channel by its ID + operationId: getNotificationCenterConfig + summary: Returns the notification center configuration. deprecated: false description: |-
@@ -20165,25 +20281,14 @@ paths: 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 + parameters: [] responses: '200': - description: The Group + description: The notification center configuration was successfully returned. content: application/json: schema: - $ref: >- - #/components/schemas/AvailabilityAllocationGroupPaginatedResult + $ref: '#/components/schemas/NotificationCenterConfig' '401': description: Your user is not allowed to operate against this API instance content: @@ -20203,10 +20308,10 @@ paths: schema: $ref: '#/components/schemas/ApiError' tags: - - Inventory Management - Channel Availability - delete: - operationId: deleteGroupUnderChannel - summary: Delete an existing Group under Channel + - Core - Notification Center + put: + operationId: upsertNotificationCenterConfig + summary: Creates or updates an existing notification center configuration. deprecated: false description: |-
@@ -20218,20 +20323,39 @@ paths: 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 + 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: '' + 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: @@ -20244,18 +20368,18 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiError' - '404': - description: The requested entity was not found + '409': + description: A version conflict occurred. 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 + - Core - Notification Center + /api/configurations/notifications/channels/{channelId}: + delete: + operationId: deleteNotificationCenterConfigChannel + summary: Deletes a notification center config channel. deprecated: false description: |-
@@ -20268,46 +20392,25 @@ paths: documentation

parameters: - - name: groupId + - name: channelId required: true in: path schema: type: string - - name: availabilityChannelId + - name: version 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 + description: Notification center config channel was successfully deleted. + '400': + description: Invalid input. See response for details. content: application/json: schema: - $ref: '#/components/schemas/AvailabilityAllocationPaginatedResult' + $ref: '#/components/schemas/ApiError' '401': description: Your user is not allowed to operate against this API instance content: @@ -20326,11 +20429,18 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiError' + '409': + description: A version conflict occurred. + content: + application/json: + schema: + $ref: '#/components/schemas/ApiError' tags: - - Inventory Management - Channel Availability + - Core - Notification Center + /api/configurations/notifications/actions: post: - operationId: createAllocationUnderGroup - summary: Create a new Allocation under Group + operationId: executeNotificationCenterConfigAction + summary: Executes an action to manipulate the notification center configuration. deprecated: false description: |-
@@ -20342,30 +20452,28 @@ paths: 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 + parameters: [] requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/AvailabilityAllocationForCreationUnderGroup' + oneOf: + - $ref: '#/components/schemas/AddChannelAction' + - $ref: '#/components/schemas/UpdateChannelByIdAction' responses: '200': - description: The created Allocation + description: Notification center configuration action was successfully executed. content: application/json: schema: - $ref: '#/components/schemas/AvailabilityAllocation' + $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: @@ -20378,20 +20486,20 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiError' - '404': - description: The requested entity was not found + '409': + description: A version conflict occurred. 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: |- + - 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. @@ -20402,17 +20510,58 @@ paths: documentation


parameters: - - name: groupId - required: true - in: path - schema: - type: string - - name: allocationId + - name: facilityRef required: true in: path schema: type: string - - name: availabilityChannelId + 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: @@ -20422,14 +20571,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AvailabilityAllocationForReplacement' + oneOf: + - $ref: '#/components/schemas/NotificationCenterConfigForUpdate' + - type: object + allOf: + - $ref: '#/components/schemas/NotificationCenterConfigForCreation' + not: + required: + - version responses: '200': - description: The replaced Allocation + description: Notification center facility configuration was successfully updated. content: application/json: schema: - $ref: '#/components/schemas/AvailabilityAllocation' + $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: @@ -20448,11 +20616,18 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiError' + '409': + description: A version conflict occurred. + 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 + - Core - Notification Center + /api/facilities/{facilityRef}/configurations/notifications/channels/{channelId}: + delete: + operationId: deleteNotificationCenterFacilityConfigChannel + summary: Deletes a notification center facility config channel. deprecated: false description: |-
@@ -20465,28 +20640,104 @@ paths: documentation

parameters: - - name: groupId + - name: facilityRef required: true in: path schema: type: string - - name: allocationId + - name: channelId required: true in: path schema: type: string - - name: availabilityChannelId + - 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: The Allocation + description: >- + Notification center facility configuration action was successfully + executed. content: application/json: schema: - $ref: '#/components/schemas/AvailabilityAllocation' + $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: @@ -20505,11 +20756,60 @@ paths: 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 - delete: - operationId: deleteAllocationUnderGroup - summary: Delete an existing Allocation under Group + get: + operationId: getAvailabilityChannels + summary: Get all Availability Channels deprecated: false description: |-
@@ -20522,16 +20822,128 @@ paths: documentation

parameters: - - name: allocationId - required: true - in: path + - name: searchTerm + required: false + in: query schema: type: string - - name: groupId + - 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 @@ -20539,7 +20951,11 @@ paths: type: string responses: '200': - description: '' + 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: @@ -20560,13 +20976,56 @@ paths: $ref: '#/components/schemas/ApiError' tags: - Inventory Management - Channel Availability - /graphql: - get: + delete: + operationId: deleteAvailabilityChannel + summary: >- + Delete an existing Availability Channel. PLEASE NOTE: This will also + delete all groups and allocations under this channel. + deprecated: false + description: |- +
+ +

This part of the API is currently under development. + That means that this endpoint, model, etc. can contain breaking changes + and / or might not be available at all times in your API instance. 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 GraphQL playground + description: The channel has been deleted + '401': + description: Your user is not allowed to operate against this API instance + content: + application/json: + schema: + $ref: '#/components/schemas/ApiError' + '403': + description: Your user, although recognized, is not authorized to use this + content: + application/json: + schema: + $ref: '#/components/schemas/ApiError' + '404': + description: The requested entity was not found + content: + application/json: + schema: + $ref: '#/components/schemas/ApiError' tags: - - Infrastructure - GraphQL + - Inventory Management - Channel Availability + /api/availabilitychannels/{availabilityChannelId}/groups: + get: + operationId: getGroupsUnderChannel + summary: Get Groups under Channel + deprecated: false description: |-
@@ -20577,16 +21036,67 @@ paths: under our SLA regulations. For details on this topic please check our documentation

- operationId: getGraphQLPlayground - summary: Get the GraphQL playground - post: + 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: The GraphQL command was successfully executed. - '400': - description: GraphQL validation error + 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: - - Infrastructure - GraphQL + - Inventory Management - Channel Availability + post: + operationId: createGroupUnderChannel + summary: Create a Group under Channel + deprecated: false description: |-
@@ -20597,731 +21107,705 @@ paths: 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: + parameters: + - name: availabilityChannelId + required: true + in: path 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: - type: string - required: - - action - type: object - xml: - name: AbstractModificationAction - AbstractModifyCarrierCredentials: - discriminator: - propertyName: key - properties: - key: - type: string - required: - - key - type: object - xml: - name: AbstractModifyCarrierCredentials - AbstractRatingConfiguration: - description: Base Configuration for Ratings. See documentation for Details. - type: object - xml: - name: AbstractRatingConfiguration - Address: - properties: - additionalAddressInfo: - example: 'to care of: Mrs. Müller' - type: string - city: - example: Langenfeld - pattern: ^.+$ - type: string - country: - description: A two-digit country code as per ISO 3166-1 alpha-2 - example: DE - pattern: ^[A-Z]{2}$ - type: string - province: - example: NRW - pattern: ^.+$ - type: string - customAttributes: - description: >- - Attributes that can be added to the address. These attributes cannot - be used within fulfillment processes, but it could be useful to have - the informations carried here. - type: object - houseNumber: - example: 42a - pattern: ^.+$ - type: string - phoneNumbers: - items: - properties: - customAttributes: - description: >- - Attributes that can be added to the phonenumber. These - attributes cannot be used within fulfillment processes, but it - could be useful to have the informations carried here. - type: object - label: - description: >- - Can be used to give a description for the number, like - "private", "business number", etc. - type: string - type: - enum: - - MOBILE - - PHONE - type: string - value: - description: The number itself. We do not enforce any format (yet). - type: string - required: - - value - - type - type: object - type: array - postalCode: - example: '40764' - pattern: ^.+$ - type: string - street: - example: Hauptstr. - pattern: ^.+$ - type: string - required: - - street - - houseNumber - - city - - postalCode - - country - type: object - ArticleAttributeItem: - properties: - category: - description: >- - This category is used by OCFF to customize implemented processes. - Categorized attributes are used by various processes and tools - throughout our platform. For a complete list of possible categories - and the correct use of those please refer to the documentation. - Default value: miscellaneous - enum: - - descriptive - - miscellaneous - - pickingSequence - example: descriptive - type: string - key: - description: >- - Providing the key %%subtitle%% (see example) here will cause the - value to appear for example in the App directly under the title. - With all other attributes also the key will be displayed in the - clients. - example: '%%subtitle%%' - minLength: 1 - type: string - priority: - description: >- - This value gives the priority in the respective attribute category. - The lower the value the higher is the priority, e.g. priority 1 is - higher than priority 10. Attributes that have the highest priority - might be selected for display in different articles of OCFF. Default - Value is 1001. For details please contact the product owners. - example: 100 - format: int64 - maximum: 1000 - minimum: 1 - type: integer - value: - example: 585er Gold - minLength: 1 - type: string - required: - - key - - value - type: object - ArtifactMetadataItem: - properties: - buildDate: - description: Date of the build of the artifact - example: '2020-02-03T08:45:50.525Z' - format: date-time - type: string - download: - properties: - expiration: - description: Expiration date of the download link - example: '2020-02-03T08:45:50.525Z' - format: date-time - type: string - url: - description: URL for the download of the artifact - type: string - type: object - versionCode: - description: Version Code of the artifact - example: 42 - type: number - versionName: - description: Version Name of the artifact - example: 1.0.42 - type: string - required: - - download - - versionCode - - versionName - - buildDate - type: object - ArtifactMetadataItems: - properties: - artifacts: - items: - $ref: '#/components/schemas/ArtifactMetadataItem' - type: array - platform: - description: Platform name for which the artifact list is generated - example: android - type: string - required: - - artifacts - - platform - type: object - Branding: - properties: - logoUrl: - description: The logo URL for the tenant - example: https://ocff-transloadit.storage.googleapis.com/thumbnails/logo.jpg - format: uri - type: string - primaryColor: - description: The hexcode representation of the desired primary color. - example: '#FFC0CB' - pattern: ^#([A-Fa-f0-9]{6})$ - type: string - required: - - primaryColor - - logoUrl - type: object - xml: - name: Branding - CallbackHeader: - properties: - key: - description: 'This is the key of the header. e.g.: `Authorization`' - type: string - value: - description: >- - This is the value for the header. e.g.: `Basic - dXNlcm5hbWU6cGFzc3dvcmQ=` - type: string - required: - - key - - value - type: object - CapabilityStatus: - enum: - - enabled - - inactive - - disabled - type: string - ParcelLabelClassificationForCreation: - additionalProperties: false - properties: - nameLocalized: - description: Localized name for parcel label classification - example: - de_DE: S-Paket - en_US: S-Parcel - ru_RU: S-пакет - $ref: '#/components/schemas/LocaleString' - services: - $ref: '#/components/schemas/ParcelLabelClassificationServices' - dimensions: - $ref: '#/components/schemas/ParcelDimensions' - required: - - nameLocalized - - dimensions - type: object - ParcelLabelClassification: - additionalProperties: false - properties: - name: - description: Name of the parcel label classification - example: S-Parcel - type: string - nameLocalized: - description: Localized name for parcel label classification - example: - de_DE: S-Paket - en_US: S-Parcel - ru_RU: S-пакет - $ref: '#/components/schemas/LocaleString' - services: - $ref: '#/components/schemas/ParcelLabelClassificationServices' - dimensions: - $ref: '#/components/schemas/ParcelDimensions' - required: - - nameLocalized - - dimensions - type: object - ParcelLabelClassificationServices: - additionalProperties: false - properties: - bulkyGoods: - type: boolean - default: false - type: object - Carrier: - allOf: - - $ref: '#/components/schemas/CarrierForCreation' - - $ref: '#/components/schemas/VersionedResource' - - properties: - id: - description: The id of the carrier - example: LGMl2DuvPnfPoSHhYFOm - type: string - deliveryType: - $ref: '#/components/schemas/CarrierDeliveryType' - lifecycle: - $ref: '#/components/schemas/CarrierLifecycle' - parcelLabelClassifications: - items: - $ref: '#/components/schemas/ParcelLabelClassification' - type: array - required: - - id - - status - type: object - xml: - name: Carrier - BringCarrierConfiguration: - allOf: - - $ref: '#/components/schemas/CarrierConfiguration' - properties: - customerId: - type: string - example: '12345' - description: Bring Carrier customer number. - supportPhoneNumber: - type: string - example: '0031121424242' - description: Bring Carrier support phone number. - shipmentProduct: - type: string - example: '5600' - description: Product that will be used for the shipment booking - returnProduct: - type: string - example: '9300' - description: Product that will be used for return - required: - - customerId - - supportPhoneNumber - FedexCarrierConfiguration: - allOf: - - $ref: '#/components/schemas/CarrierConfiguration' - properties: - useEconomyService: - type: boolean - example: true - description: Indicates if the economy services of fedex should be used. - defaultPriceValue: - type: number - example: 10.99 - description: Default value of shipped goods - defaultPriceCurrency: - type: string - example: EUR - description: default currency of shipped goods as 3 letter iso code - pattern: ^[A-Z]{3}$ - defaultManufactureCountry: - description: A two-digit country code as per ISO 3166-1 alpha-2 - example: DE - pattern: ^[A-Z]{2}$ - type: string - defaultCommodityDescription: - type: string - example: Description goes here - description: Describes the shipped goods - required: - - useEconomyService - - defaultPriceCurrency - - defaultPriceValue - - defaultManufactureCountry - - defaultCommodityDescription - DpdChCarrierConfiguration: - allOf: - - $ref: '#/components/schemas/CarrierConfiguration' - properties: - alternativeSendAddress: - $ref: '#/components/schemas/FacilityAddress' - DhlV2CarrierConfiguration: - allOf: - - $ref: '#/components/schemas/CarrierConfiguration' - properties: - alternativeReturnAddress: - $ref: '#/components/schemas/FacilityAddress' - VceCarrierConfiguration: - allOf: - - $ref: '#/components/schemas/CarrierConfiguration' - properties: - alternativeReturnAddress: - $ref: '#/components/schemas/FacilityAddress' - GlsCarrierConfiguration: - allOf: - - $ref: '#/components/schemas/CarrierConfiguration' - properties: - alternativeSendAddressLocationId: - type: string - minLength: 1 - alternativeReturnAddressLocationId: - type: string - minLength: 1 - CarrierDeliveryType: - description: 'Provided delivery of this CEP. Default: DELIVERY' - enum: - - SAMEDAY - - DELIVERY - type: string - CarrierForCreation: - additionalProperties: false + 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 and all its allocations 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: The Group has been deleted. + '401': + description: Your user is not allowed to operate against this API instance + content: + application/json: + schema: + $ref: '#/components/schemas/ApiError' + '403': + description: Your user, although recognized, is not authorized to use this + content: + application/json: + schema: + $ref: '#/components/schemas/ApiError' + '404': + description: The requested entity was not found + content: + application/json: + schema: + $ref: '#/components/schemas/ApiError' + tags: + - Inventory Management - Channel Availability + /api/availabilitychannels/{availabilityChannelId}/groups/{groupId}/allocations: + get: + operationId: getAllocationsUnderGroup + summary: Get Allocations under Group + deprecated: false + description: |- +
+ +

This part of the API is currently under development. + That means that this endpoint, model, etc. can contain breaking changes + and / or might not be available at all times in your API instance. 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: The Allocation has been deleted + '401': + description: Your user is not allowed to operate against this API instance + content: + application/json: + schema: + $ref: '#/components/schemas/ApiError' + '403': + description: Your user, although recognized, is not authorized to use this + content: + application/json: + schema: + $ref: '#/components/schemas/ApiError' + '404': + description: The requested entity was not found + content: + application/json: + schema: + $ref: '#/components/schemas/ApiError' + tags: + - Inventory Management - Channel Availability + /graphql: + get: + responses: + '200': + description: The GraphQL playground + tags: + - Infrastructure - GraphQL + description: |- +
+ +

This part of the API is currently under development. + That means that this endpoint, model, etc. can contain breaking changes + and / or might not be available at all times in your API instance. 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: + AbstractCarrierCredentials: + discriminator: + propertyName: key properties: - credentials: - $ref: '#/components/schemas/AbstractCarrierCredentials' key: - description: >- - References the KEP. Currently allowed values are DHL_V2, DPD_CH, - ANGEL, GLS, FEDEX, POSTNL, BRING, UPS, POST_NORD, DHL_EXPRESS, - CUSTOM and to distinct between multiple custom carriers one can use - CUSTOM_ combined with a unique name. - example: DHL_V2 - type: string - logoUrl: - minLength: 1 - type: string - name: - description: >- - This is the well known name for a supported CEP partner. Can be - adapted to the clients needs. - example: DHL Köln type: string - status: - $ref: '#/components/schemas/CarrierStatus' - defaultParcelWeightInGram: - description: Default weight for a parcel in gram - default: 1000 - type: number - parcelLabelClassifications: - items: - $ref: '#/components/schemas/ParcelLabelClassificationForCreation' - type: array - productValueNeeded: - type: boolean - example: true - description: >- - Setting to enable the Client to ask for the parcel product value - while ordering a label. This information is mandatory for sending - parcels between different countries (customs declaration) required: - - name - key type: object xml: - name: CarrierForCreation - CarrierLifecycle: - description: >- - Used to determine if a carrier is available for configuration. GA - carriers are generally available and are covered by our SLA. BETA - carriers are available, but subject to change and not covered by SLA. - ALPHA carriers are not implemented completely, yet. Default: GA - enum: - - GA - - BETA - - ALPHA - type: string - CarrierPatchActions: - properties: - actions: - items: - $ref: '#/components/schemas/ModifyCarrierAction' - minItems: 1 - type: array - version: - description: >- - The version of the document to be used in optimistic locking - mechanisms. - example: 42 - format: int64 - type: integer - required: - - version - - actions - type: object - xml: - name: ShipmentPatchActions - SortDirection: - enum: - - ASCENDING - - DESCENDING - type: string - SortParameter: - type: object - properties: - sortDirection: - $ref: '#/components/schemas/SortDirection' - sortParameterName: - $ref: '#/components/schemas/SortParameterName' - required: - - sortDirection - - sortParameterName - SortParameterName: - enum: - - NAME - - ADDRESS - - STATUS - - OPERATIVESTATUS - - SERVICETYPE - - ORDEREDAMOUNT - - ORDERDATE - - ORDERID - type: string - CarrierStatus: - description: 'It is taken into consideration for all carriers. Default: INACTIVE' - enum: - - ACTIVE - - INACTIVE - type: string - ClickAndCollectRerouteConfiguration: - properties: - active: - type: boolean - rerouteType: - $ref: '#/components/schemas/RerouteType' - default: REROUTE - required: - - active - type: object - ClosingDay: - description: At this day the facility is closed and does not do picking + name: AbstractCarrierCredentials + AbstractModificationAction: + discriminator: + propertyName: action properties: - date: - description: The day at which the Facility is closed - example: '2020-02-03T09:45:51.525Z' - format: date-time - type: string - reason: - description: The reason why the Facility is closed on this day - type: string - recurrence: + action: + description: '' enum: - - YEARLY - - NONRECURRING + - AddAllowedValueToTag + - ModifyPickJob + - ModifyPickJobLastEditor + - RestartPickJob + - ResetPickJob + - CancelPickRun + - CancelHandoverjob + - AbortPickJob + - FinishPickRun + - StartPickRun + - ModifyPickLineItem + - ModifyPickRunLineItem + - ModifyPackJob + - PausePackJob + - ModifyPackLineItem + - ModifyFacility + - ModifyListing + - ModifyRetainedOfflineStock + - ModifyListingReactivationAfter + - ModifyUser + - ModifyShipment + - ModifyHandoverjob + - ModifyCarrier + - ModifyShortpick + - ModifyReturn + - ModifyReturnLineItem + - ModifyRoutingPlan + - ModifyFence + - ModifyRating + - ModifyTimingMode + - ModifyGlobalRoutingConfiguration + - ModifyOrderSplit + - ModifyPrioritization + - ModifyLoadUnitType + - ModifyFeature + - ModifyParcel + - ModifyParcelLoadUnit + - ModifyRestowItem + - RemovePickJobFromPickRunAction + - ModifyPartialStock + - AddTagsToProcess + - AssignFacilityToProcess + - ModifyStorageLocation + - ModifyPackingContainerType + - ModifyPackingContainerTypeIcon + - ReplaceCodesInPackingTargetContainer + - ReplaceLoadUnitLineItems + - AddLineItemToPackingTargetContainer + - RemoveLineItemFromPackingTargetContainer + - UpdateLineItemOnPackingTargetContainer + - ModifyCustomService + - UnlockOrder + example: type: string required: - - reason - - date - - recurrence + - action type: object - CollectDelivery: + xml: + name: AbstractModificationAction + AbstractModifyCarrierCredentials: + discriminator: + propertyName: key properties: - facilityRef: - description: >- - Reference to the facility where the consumer expects to collect the - items + key: type: string - paid: - default: false - description: Indicates if the order is already paid. - type: boolean - supplyingFacilities: - description: DEPRECATED - items: - description: Reference of a Facility - example: 928f3730-bc48-4d85-b83f-3fd86b776178 - type: string - type: array - supplyingFacilitiesConfigurations: - description: >- - References of facility that could supply contents of the order to - another facility with specific configuration of its usage - items: - description: Reference of a Facility - example: 928f3730-bc48-4d85-b83f-3fd86b776178 - $ref: '#/components/schemas/SupplyingFacilityConfiguration' - type: array required: - - facilityRef + - key type: object - SupplyingFacilityConfiguration: - properties: - facilityRef: - type: string - deliveryEvents: - items: - description: configuration of a delivery event - $ref: '#/components/schemas/DeliveryEvent' - type: array - required: - - facilityRef - - deliveryEvents - DeliveryEvent: + xml: + name: AbstractModifyCarrierCredentials + Address: properties: - deliveryTarget: - $ref: '#/components/schemas/DeliveryTarget' - deliveryTrigger: - enum: - - DEFAULT + additionalAddressInfo: + example: 'to care of: Mrs. Müller' type: string - required: - - deliveryTarget - - deliveryTrigger - CompanyAddress: - properties: city: example: Langenfeld pattern: ^.+$ type: string country: - example: Germany + description: A two-digit country code as per ISO 3166-1 alpha-2 + example: DE + pattern: ^[A-Z]{2}$ + type: string + province: + example: NRW pattern: ^.+$ type: string + customAttributes: + description: >- + Attributes that can be added to the address. These attributes cannot + be used within fulfillment processes, but it could be useful to have + the informations carried here. + type: object houseNumber: example: 42a pattern: ^.+$ type: string - name: - example: OC fulfillment GmbH - pattern: ^.+$ - type: string + phoneNumbers: + items: + properties: + customAttributes: + description: >- + Attributes that can be added to the phonenumber. These + attributes cannot be used within fulfillment processes, but it + could be useful to have the informations carried here. + type: object + label: + description: >- + Can be used to give a description for the number, like + "private", "business number", etc. + type: string + type: + enum: + - MOBILE + - PHONE + type: string + value: + description: The number itself. We do not enforce any format (yet). + type: string + required: + - value + - type + type: object + type: array postalCode: example: '40764' pattern: ^.+$ @@ -21331,704 +21815,660 @@ components: pattern: ^.+$ type: string required: - - name - street - - houseNumber - - postalCode - city + - postalCode - country type: object - ConsumerAddress: - allOf: - - $ref: '#/components/schemas/Address' - properties: - companyName: - example: Speedy Boxales Ltd. - type: string - firstName: - example: Maxine - type: string - lastName: - example: Muller - type: string - salutation: - example: Frau - type: string - email: - type: string - minLength: 1 - format: email - example: test@try.de - addressType: - $ref: '#/components/schemas/AddressType' - coordinates: - $ref: '#/components/schemas/Coordinates' - type: object - CheckoutOptionsConsumerAddress: + ArtifactMetadataItem: properties: - city: - example: Langenfeld - pattern: ^.+$ - type: string - country: - description: A two-digit country code as per ISO 3166-1 alpha-2 - example: DE - pattern: ^[A-Z]{2}$ - type: string - province: - example: NRW - pattern: ^.+$ - type: string - houseNumber: - example: 42a - pattern: ^.+$ - type: string - postalCode: - example: '40764' - pattern: ^.+$ + buildDate: + description: Date of the build of the artifact + example: '2020-02-03T08:45:50.525Z' + format: date-time type: string - street: - example: Hauptstr. - pattern: ^.+$ + download: + properties: + expiration: + description: Expiration date of the download link + example: '2020-02-03T08:45:50.525Z' + format: date-time + type: string + url: + description: URL for the download of the artifact + type: string + type: object + versionCode: + description: Version Code of the artifact + example: 42 + type: number + versionName: + description: Version Name of the artifact + example: 1.0.42 type: string - type: object required: - - country - Coordinates: - description: >- - Coordinates of the WGS84 geodetic reference system in Mercator - projection, as used e.g. by the Google Maps API + - download + - versionCode + - versionName + - buildDate + type: object + ArtifactMetadataItems: properties: - lat: - description: Latitude value - example: 50.937531 - type: number - lon: - description: Longitude value - example: 6.960279 - type: number + artifacts: + items: + $ref: '#/components/schemas/ArtifactMetadataItem' + type: array + platform: + description: Platform name for which the artifact list is generated + example: android + type: string required: - - lat - - lon + - artifacts + - platform type: object - Roles: - description: A list of all rolenames and permissions assigned to the user - type: array - items: - type: object - properties: - name: - $ref: '#/components/schemas/UserRoleNames' - facilityRefs: - type: array - items: - type: string - permissions: - type: array - items: - type: string - required: - - name - - permissions - CustomClaims: - description: Include all different claims could be assigned to a user + Branding: properties: - roles: - $ref: '#/components/schemas/UserRoles' + logoUrl: + description: The logo URL for the tenant + example: https://ocff-transloadit.storage.googleapis.com/thumbnails/logo.jpg + format: uri + type: string + primaryColor: + description: The hexcode representation of the desired primary color. + example: '#FFC0CB' + pattern: ^#([A-Fa-f0-9]{6})$ + type: string required: - - roles + - primaryColor + - logoUrl type: object xml: - name: CustomClaims - CustomPrioritizationRule: - allOf: - - $ref: '#/components/schemas/PrioritizationRule' - description: >- - You can supply a CUSTOM Prioritization rule. In order to successfully - supply such a rule you also need to provide an evaluatable Expression in - vmExpression. This expression needs to return an integer value that adds - additional priority to an order. + name: Branding + CallbackHeader: properties: - vmExpression: - example: >- - order.customAttributes && order.customAttributes.amazon === true ? - 100 : 0 + key: + description: 'This is the key of the header. e.g.: `Authorization`' + type: string + value: + description: >- + This is the value for the header. e.g.: `Basic + dXNlcm5hbWU6cGFzc3dvcmQ=` type: string required: - - vmExpression + - key + - value type: object - xml: - name: CustomPrioritizationRule - CutoffTime: + CapabilityStatus: + enum: + - enabled + - inactive + - disabled + type: string + ParcelLabelClassificationForCreation: + additionalProperties: false properties: - hour: - default: 12 - example: 16 - type: number - minute: - default: 0 - example: 30 - type: number + nameLocalized: + description: Localized name for parcel label classification + example: + de_DE: S-Paket + en_US: S-Parcel + ru_RU: S-пакет + $ref: '#/components/schemas/LocaleString' + services: + $ref: '#/components/schemas/ParcelLabelClassificationServices' + dimensions: + $ref: '#/components/schemas/ParcelDimensions' required: - - hour - - minute - type: object - TenantConfiguration: + - nameLocalized + - dimensions type: object + ParcelLabelClassification: additionalProperties: false - allOf: - - $ref: '#/components/schemas/VersionedResource' properties: - clearName: + name: + description: Name of the parcel label classification + example: S-Parcel type: string + nameLocalized: + description: Localized name for parcel label classification + example: + de_DE: S-Paket + en_US: S-Parcel + ru_RU: S-пакет + $ref: '#/components/schemas/LocaleString' + services: + $ref: '#/components/schemas/ParcelLabelClassificationServices' + dimensions: + $ref: '#/components/schemas/ParcelDimensions' required: - - clearName - TenantConfigurationForUpsert: + - nameLocalized + - dimensions type: object + ParcelLabelClassificationServices: additionalProperties: false + properties: + bulkyGoods: + type: boolean + default: false + type: object + Carrier: allOf: + - $ref: '#/components/schemas/CarrierForCreation' - $ref: '#/components/schemas/VersionedResource' + - properties: + id: + description: The id of the carrier + example: LGMl2DuvPnfPoSHhYFOm + type: string + deliveryType: + $ref: '#/components/schemas/CarrierDeliveryType' + lifecycle: + $ref: '#/components/schemas/CarrierLifecycle' + parcelLabelClassifications: + items: + $ref: '#/components/schemas/ParcelLabelClassification' + type: array + required: + - id + - status + type: object + xml: + name: Carrier + BringCarrierConfiguration: + allOf: + - $ref: '#/components/schemas/CarrierConfiguration' properties: - clearName: + customerId: + type: string + example: '12345' + description: Bring Carrier customer number. + supportPhoneNumber: + type: string + example: '0031121424242' + description: Bring Carrier support phone number. + shipmentProduct: + type: string + example: '5600' + description: Product that will be used for the shipment booking + returnProduct: + type: string + example: '9300' + description: Product that will be used for return + trackAndTraceUrl: + type: string + webhookFftHost: type: string - version: - type: number required: - - clearName - - version - CutoffTimeConfiguration: + - customerId + - supportPhoneNumber + FedexCarrierConfiguration: allOf: - - $ref: '#/components/schemas/VersionedResource' + - $ref: '#/components/schemas/CarrierConfiguration' properties: - clickAndCollect: - $ref: '#/components/schemas/CutoffTime' - shipFromStore: - $ref: '#/components/schemas/CutoffTime' - id: + useEconomyService: + type: boolean + example: true + description: Indicates if the economy services of fedex should be used. + defaultPriceValue: + type: number + example: 10.99 + description: Default value of shipped goods + defaultPriceCurrency: + type: string + example: EUR + description: default currency of shipped goods as 3 letter iso code + pattern: ^[A-Z]{3}$ + defaultManufactureCountry: + description: A two-digit country code as per ISO 3166-1 alpha-2 + example: DE + pattern: ^[A-Z]{2}$ + type: string + defaultCommodityDescription: + type: string + example: Description goes here + description: Describes the shipped goods + trackAndTraceUrl: type: string required: - - shipFromStore - - clickAndCollect - type: object - DecisionLogRef: + - useEconomyService + - defaultPriceCurrency + - defaultPriceValue + - defaultManufactureCountry + - defaultCommodityDescription + DpdChCarrierConfiguration: + allOf: + - $ref: '#/components/schemas/CarrierConfiguration' properties: - routingRun: - type: number - url: - description: A reference to the finalizer decision log - example: /api/routingplans/{routingPlanId}/decisionlogs/{routingRun} + alternativeSendAddress: + $ref: '#/components/schemas/FacilityAddress' + trackAndTraceUrl: type: string - required: - - url - - finalizeRun - type: object - xml: - name: DecisionLogRef - DefaultPickingTimesConfiguration: + DhlV2CarrierConfiguration: allOf: - - $ref: '#/components/schemas/VersionedResource' + - $ref: '#/components/schemas/CarrierConfiguration' properties: - pickingTimes: - $ref: '#/components/schemas/PickingTimes' - description: The default picking times are Mo-Sa 09:00-17:00 - required: - - pickingTimes - type: object - DecisionLog: + alternativeReturnAddress: + $ref: '#/components/schemas/FacilityAddress' + trackAndTraceUrl: + type: string + VceCarrierConfiguration: allOf: - - $ref: '#/components/schemas/VersionedResource' + - $ref: '#/components/schemas/CarrierConfiguration' properties: - id: + alternativeReturnAddress: + $ref: '#/components/schemas/FacilityAddress' + GlsCarrierConfiguration: + allOf: + - $ref: '#/components/schemas/CarrierConfiguration' + properties: + alternativeSendAddressLocationId: type: string - routingRun: - type: number - facilityDecisions: - items: - $ref: '#/components/schemas/FacilityDecision' - type: array - orderSplitDecision: - $ref: '#/components/schemas/OrderSplitDecision' - statistics: - $ref: '#/components/schemas/RoutingStatistics' - results: - $ref: '#/components/schemas/RoutingResults' - routingPlanRef: + minLength: 1 + alternativeReturnAddressLocationId: type: string - required: - - id - - routingPlanRef - - facilityDecisions - - routingRun - - statistics - - results - - created - - lastModified - - version - type: object - xml: - name: DecisionLog - DecisionLogFacilityInfo: - properties: - name: + minLength: 1 + trackAndTraceUrl: type: string - facilityRef: + trackAndTraceWsdlUrl: type: string - required: - - name - - facilityRef - RoutingResults: - properties: - assignedItems: - type: array - items: - $ref: '#/components/schemas/AssignmentItem' - bestRatedFacility: - $ref: '#/components/schemas/DecisionLogFacilityInfo' - bestAvailableFacility: - $ref: '#/components/schemas/DecisionLogFacilityInfo' - bestReassignmentFacility: - $ref: '#/components/schemas/DecisionLogFacilityInfo' - routingPlanStatus: - $ref: '#/components/schemas/RoutingPlanStatus' - required: - - assignedItems - RoutingStatistics: - properties: - fenceStatistics: - type: array - items: - $ref: '#/components/schemas/FenceStatistic' - ratingStatistics: - type: array - items: - $ref: '#/components/schemas/RatingStatistic' - durationMs: - type: number - required: - - fenceStatistics - - ratingStatistics - - lineItemFenceStatistics - FenceStatistic: + PostNlCarrierConfiguration: + allOf: + - $ref: '#/components/schemas/CarrierConfiguration' properties: - name: + trackAndTraceUrl: type: string - rejectedAmount: - type: number - passedAmount: - type: number - passedPercentage: - type: number - durationMs: - description: Duration in Milliseconds - type: number - required: - - name - - rejectedAmount - - passedAmount - - passedPercentage - - durationMs - RatingStatistic: + CarrierDeliveryType: + description: 'Provided delivery of this CEP. Default: DELIVERY' + enum: + - SAMEDAY + - DELIVERY + type: string + CarrierForCreation: + additionalProperties: false properties: + credentials: + $ref: '#/components/schemas/AbstractCarrierCredentials' + key: + description: >- + References the KEP. Currently allowed values are DHL_V2, DPD_CH, + ANGEL, GLS, FEDEX, POSTNL, BRING, UPS, POST_NORD, DHL_EXPRESS, + CUSTOM and to distinct between multiple custom carriers one can use + CUSTOM_ combined with a unique name. + example: DHL_V2 + type: string + logoUrl: + minLength: 1 + type: string name: + description: >- + This is the well known name for a supported CEP partner. Can be + adapted to the clients needs. + example: DHL Köln type: string - maxScore: - type: number - minScore: - type: number - maxPenalty: - type: number - durationMs: - description: Duration in Milliseconds + status: + $ref: '#/components/schemas/CarrierStatus' + defaultParcelWeightInGram: + description: Default weight for a parcel in gram + default: 1000 type: number + parcelLabelClassifications: + items: + $ref: '#/components/schemas/ParcelLabelClassificationForCreation' + type: array + productValueNeeded: + type: boolean + example: true + description: >- + Setting to enable the Client to ask for the parcel product value + while ordering a label. This information is mandatory for sending + parcels between different countries (customs declaration) required: - name - - maxPenalty - - durationMs - SplitResultType: + - key + type: object + xml: + name: CarrierForCreation + CarrierLifecycle: + description: >- + Used to determine if a carrier is available for configuration. GA + carriers are generally available and are covered by our SLA. BETA + carriers are available, but subject to change and not covered by SLA. + ALPHA carriers are not implemented completely, yet. Default: GA enum: - - SPLIT - - DO_NOT_SPLIT - - DO_NOT_SPLIT_USE_BEST_RATED - - DO_NOT_SPLIT_BECAUSE_AVAILABILITY_USE_BEST_RATED - - DO_NOT_SPLIT_USE_BEST_AVAILABLE - - REASSIGN_TO_PARENT - - REASSIGN_TO_PARENT_COMPLETELY - - FAIL - - INVALID_SPLIT - - PARK_IN_WAITING_ROOM - OrderSplitDecision: - properties: - split: - $ref: '#/components/schemas/SplitInformation' - reassignment: - $ref: '#/components/schemas/ReassignmentInformation' - splitType: - $ref: '#/components/schemas/SplitResultType' - required: - - splitType - ReassignmentInformation: + - GA + - BETA + - ALPHA + type: string + CarrierPatchActions: properties: - sourceFacility: - $ref: '#/components/schemas/DecisionLogFacilityInfo' - reassignedItems: - type: array + actions: items: - $ref: '#/components/schemas/AssignmentItem' - required: - - sourceFacility - - reassignedItems - AssignmentItem: - properties: - tenantArticleId: - type: string - articleTitle: - type: string - quantity: - type: number - required: - - tenantArticleId - - quantity - SplitInformation: - properties: - targetFacility: - $ref: '#/components/schemas/DecisionLogFacilityInfo' - targetRoutingPlanRef: - type: string - splitCount: - type: number - splittedItems: + $ref: '#/components/schemas/ModifyCarrierAction' + minItems: 1 type: array - items: - $ref: '#/components/schemas/AssignmentItem' + version: + description: >- + The version of the document to be used in optimistic locking + mechanisms. + example: 42 + format: int64 + type: integer required: - - splitCount - - targetRoutingPlanRef - - splittedItems - FacilityDecision: + - version + - actions + type: object + xml: + name: ShipmentPatchActions + NonDeliveryDaysPerCountryAndProvince: + type: object + additionalProperties: false properties: - facility: - $ref: '#/components/schemas/DecisionLogFacilityInfo' - orderFences: - type: array - items: - $ref: '#/components/schemas/OrderFenceDecision' - orderLineItemFences: + country: + type: string + nonDeliveryDays: type: array items: - $ref: '#/components/schemas/OrderLineItemFenceDecisions' - orderRatings: + $ref: '#/components/schemas/NonDeliveryDays' + recurringNonDeliveryWeekdays: type: array items: - $ref: '#/components/schemas/OrderRatingDecision' - availabilities: + $ref: '#/components/schemas/WeekDay' + nonDeliveryDaysPerProvince: type: array items: - $ref: '#/components/schemas/AvailabilityDuringRouting' - totalPenalty: - type: number - rank: - type: number - isBestRated: - type: boolean - isBestAvailable: - type: boolean - isBestReassignmentCandidate: - type: boolean + $ref: '#/components/schemas/NonDeliveryDaysPerProvince' required: - - facility - - orderFences - - orderLineItemFences - - orderRatings - - orderLineItemRatings - - availabilities - OrderRatingDecision: + - country + - nonDeliveryDays + - recurringNonDeliveryWeekdays + - nonDeliveryDaysPerProvince + NonDeliveryDaysPerProvince: type: object + additionalProperties: false properties: - name: + province: type: string - score: - type: number - normalizedScore: - type: number - maxPenalty: - type: number - details: + nonDeliveryDays: type: array items: - anyOf: - - $ref: '#/components/schemas/ToolkitDecisionDetail' - - $ref: '#/components/schemas/ToolkitComparisonDecisionDetail' - required: - - name - - normalizedScore - - maxPenalty - AvailabilityDuringRouting: - properties: - tenantArticleId: - type: string - articleTitle: - type: string - requestedQuantity: - type: number - stockInformation: - $ref: '#/components/schemas/AvailabilityDuringRoutingStock' - rerouteInformation: - $ref: '#/components/schemas/AvailabilityDuringRerouteStock' - stockInformationPostRerouteAdjustment: - $ref: '#/components/schemas/AvailabilityDuringRoutingStock' - bundleInformation: + $ref: '#/components/schemas/NonDeliveryDays' + recurringNonDeliveryWeekdays: type: array items: - $ref: '#/components/schemas/BundleInformation' + $ref: '#/components/schemas/WeekDay' required: - - tenantArticleId - - requestedQuantity - - stockInformation - BundleInformation: + - province + - nonDeliveryDays + - recurringNonDeliveryWeekdays + NonDeliveryDays: + type: object + additionalProperties: false properties: - customServiceNodeId: + nonDeliveryType: + $ref: '#/components/schemas/NonDeliveryType' + default: SINGLE + nonDeliveryDay: + example: '2020-02-03T08:45:50.525Z' + format: date-time type: string - requestedQuantity: - type: number required: - - customServiceNodeId - - requestedQuantity - AvailabilityDuringRerouteStock: + - nonDeliveryDay + NonDeliveryType: + type: string + enum: + - SINGLE + - RECURRING + SortDirection: + enum: + - ASCENDING + - DESCENDING + type: string + SortParameter: + type: object properties: - rerouteReason: - $ref: '#/components/schemas/RerouteReason' - pickedQuantity: - type: number - AvailabilityDuringRoutingStock: + sortDirection: + $ref: '#/components/schemas/SortDirection' + sortParameterName: + $ref: '#/components/schemas/SortParameterName' + required: + - sortDirection + - sortParameterName + SortParameterName: + enum: + - NAME + - ADDRESS + - STATUS + - OPERATIVESTATUS + - SERVICETYPE + - ORDEREDAMOUNT + - ORDERDATE + - ORDERID + type: string + CarrierStatus: + description: 'It is taken into consideration for all carriers. Default: INACTIVE' + enum: + - ACTIVE + - INACTIVE + type: string + ClosingDay: + description: At this day the facility is closed and does not do picking properties: - stock: - type: number - stockConsideringOfflineStock: - type: number - reserved: - type: number - available: - type: number + date: + description: The day at which the Facility is closed + example: '2020-02-03T09:45:51.525Z' + format: date-time + type: string + reason: + description: The reason why the Facility is closed on this day + type: string + recurrence: + enum: + - YEARLY + - NONRECURRING + type: string required: - - available - - reserved - - stock - - stockConsideringOfflineStock - OrderFenceDecision: + - reason + - date + - recurrence type: object + CompanyAddress: properties: + city: + example: Langenfeld + pattern: ^.+$ + type: string + country: + example: Germany + pattern: ^.+$ + type: string + houseNumber: + example: 42a + pattern: ^.+$ + type: string name: + example: OC fulfillment GmbH + pattern: ^.+$ + type: string + postalCode: + example: '40764' + pattern: ^.+$ + type: string + street: + example: Hauptstr. + pattern: ^.+$ type: string - decision: - $ref: '#/components/schemas/FenceResultStatus' - details: - type: array - items: - anyOf: - - $ref: '#/components/schemas/OrderFenceDecisionDetail' - - $ref: '#/components/schemas/ToolkitDecisionDetail' - - $ref: '#/components/schemas/ToolkitComparisonDecisionDetail' required: - name - - decision - - details - BaseDecisionDetail: + - street + - postalCode + - city + - country + type: object + ConsumerAddress: + allOf: + - $ref: '#/components/schemas/Address' properties: - decisionType: - $ref: '#/components/schemas/DecisionType' - required: - - decisionType - DecisionType: - enum: - - FENCE - - TOOLKIT - - TOOLKITCOMPARISON - - RATING - ToolkitPredicateDecisionDetail: + companyName: + example: Speedy Boxales Ltd. + type: string + firstName: + example: Maxine + type: string + lastName: + example: Muller + type: string + salutation: + example: Frau + type: string + email: + type: string + minLength: 1 + format: email + example: test@try.de + addressType: + $ref: '#/components/schemas/AddressType' + coordinates: + $ref: '#/components/schemas/Coordinates' + type: object + Coordinates: + description: >- + Coordinates of the WGS84 geodetic reference system in Mercator + projection, as used e.g. by the Google Maps API properties: - originalValue: - type: array - items: - type: string - transformedValue: - type: array - items: - type: string - evaluationResult: - type: boolean - predicate: - $ref: '#/components/schemas/ToolkitPredicate' + lat: + description: Latitude value + example: 50.937531 + type: number + lon: + description: Longitude value + example: 6.960279 + type: number required: - - originalValue - - transformedValue - - evaluationResult - - predicate - ToolkitPredicatesDecisionDetail: + - lat + - lon + type: object + Roles: + description: A list of all rolenames and permissions assigned to the user + type: array + items: + type: object + properties: + name: + $ref: '#/components/schemas/UserRoleNames' + facilityRefs: + type: array + items: + type: string + permissions: + type: array + items: + type: string + required: + - name + - permissions + CustomClaims: + description: Include all different claims could be assigned to a user properties: - connector: - $ref: '#/components/schemas/ToolkitPredicateConnector' - predicates: - type: array - items: - $ref: '#/components/schemas/ToolkitPredicateDecisionDetail' + roles: + $ref: '#/components/schemas/UserRoles' required: - - connector - - predicates - ToolkitComparisonDecisionDetail: + - roles + type: object + xml: + name: CustomClaims + CustomPrioritizationRule: allOf: - - $ref: '#/components/schemas/BaseDecisionDetail' + - $ref: '#/components/schemas/PrioritizationRule' + description: >- + You can supply a CUSTOM Prioritization rule. In order to successfully + supply such a rule you also need to provide an evaluatable Expression in + vmExpression. This expression needs to return an integer value that adds + additional priority to an order. properties: - predicates: - type: array - items: - $ref: '#/components/schemas/ToolKitComparisonDetails' - predicateConnector: - $ref: '#/components/schemas/ToolkitPredicateConnector' - description: + vmExpression: + example: >- + order.customAttributes && order.customAttributes.amazon === true ? + 100 : 0 type: string - explanation: - $ref: >- - #/components/schemas/ToolkitRuleComparePropertiesOperatorResultExplanation - required: - - predicates - - result - - predicateConnector - - description - ToolKitComparisonDetails: - properties: - leftPart: - $ref: '#/components/schemas/ToolKitComparisonPart' - rightPart: - $ref: '#/components/schemas/ToolKitComparisonPart' - evaluationResult: - type: boolean - predicate: - $ref: '#/components/schemas/ToolkitComparisonPredicate' required: - - leftPart - - rightPart - - evaluationResult - - predicate - ToolKitComparisonPart: + - vmExpression + type: object + xml: + name: CustomPrioritizationRule + CutoffTime: properties: - originalValue: - type: array - items: - type: string - transformedValue: - type: array - items: - type: string + hour: + default: 12 + example: 16 + type: number + minute: + default: 0 + example: 30 + type: number required: - - originalValue - - transformedValue - ToolkitDecisionDetail: + - hour + - minute + type: object + TenantConfiguration: + type: object + additionalProperties: false allOf: - - $ref: '#/components/schemas/BaseDecisionDetail' + - $ref: '#/components/schemas/VersionedResource' properties: - leftSideEvaluation: - type: boolean - leftPredicatesDetail: - $ref: '#/components/schemas/ToolkitPredicatesDecisionDetail' - rightSideEvaluation: - type: boolean - rightPredicatesDetail: - $ref: '#/components/schemas/ToolkitPredicatesDecisionDetail' - comparisonOperator: - $ref: '#/components/schemas/ToolkitRuleComparisonOperatorType' - description: + clearName: type: string - explanation: - $ref: '#/components/schemas/ToolkitRuleOperatorResultExplanation' required: - - decisionType - - result - - leftSideEvaluation - - description - ToolkitRuleOperatorResultExplanation: - enum: - - SKIPPED - - BOTH_CONDITIONS_MET - - ONLY_FIRST_CONDITION_MET - - ONLY_SECOND_CONDITION_MET - - SKIPPED_BECAUSE_OF_ERROR - ToolkitRuleComparePropertiesOperatorResultExplanation: - enum: - - ALL_PREDICATES_MET - - NOT_ALL_PREDICATES_MET - - SKIPPED_BECAUSE_OF_ERROR - OrderFenceDecisionDetail: + - clearName + TenantConfigurationForUpsert: + type: object + additionalProperties: false allOf: - - $ref: '#/components/schemas/BaseDecisionDetail' + - $ref: '#/components/schemas/VersionedResource' properties: - contextReference: - $ref: '#/components/schemas/ContextReference' - expectedValue: - type: string - actualValue: + clearName: type: string - reactiveErrorReason: - $ref: '#/components/schemas/ReactiveErrorReason' + version: + type: number required: - - expectedValue - - facilityValue - - decisionType - ContextReference: + - clearName + - version + CutoffTimeConfiguration: + allOf: + - $ref: '#/components/schemas/VersionedResource' properties: - reference: + clickAndCollect: + $ref: '#/components/schemas/CutoffTime' + shipFromStore: + $ref: '#/components/schemas/CutoffTime' + id: type: string - routingDecisionContext: - $ref: '#/components/schemas/RoutingDecisionContext' required: - - reference - - routingDecisionContext - RoutingDecisionContext: - enum: - - LISTING - - CARRIER - FenceResultStatus: - enum: - - FAILED - - PASSED - - REACTIVE_PASSING_POSSIBLE - ReactiveErrorReason: - enum: - - BACKORDER_LISTING - - PREORDER_LISTING - OrderLineItemFenceDecisions: + - shipFromStore + - clickAndCollect + type: object + DefaultPickingTimesConfiguration: + allOf: + - $ref: '#/components/schemas/VersionedResource' properties: - name: - type: string - orderLineItems: - type: array - items: - $ref: '#/components/schemas/OrderLineItemFenceDecision' + pickingTimes: + $ref: '#/components/schemas/PickingTimes' + description: The default picking times are Mo-Sa 09:00-17:00 required: - - name - - orderLineItems - OrderLineItemFenceDecision: + - pickingTimes type: object + DeliveryAddressWithType: + allOf: + - $ref: '#/components/schemas/DeliveryAddress' properties: - tenantArticleId: - type: string - articleTitle: - type: string - decision: - $ref: '#/components/schemas/FenceResultStatus' - details: - type: array - items: - anyOf: - - $ref: '#/components/schemas/OrderFenceDecisionDetail' - - $ref: '#/components/schemas/ToolkitDecisionDetail' - - $ref: '#/components/schemas/ToolkitComparisonDecisionDetail' - reactiveErrorReason: - $ref: '#/components/schemas/ReactiveErrorReason' + addressType: + $ref: '#/components/schemas/AddressType' required: - - tenantArticleId - - articleTitle - - decision - - details + - street + - houseNumber + - postalCode + - city + - addressType + type: object DeliveryAddress: properties: city: @@ -22061,7 +22501,6 @@ components: type: string required: - street - - houseNumber - postalCode - city type: object @@ -22085,7 +22524,16 @@ components: companyAddress: $ref: '#/components/schemas/CompanyAddress' deliveryAddress: + description: use this if no deliveryAddresses are passed. $ref: '#/components/schemas/DeliveryAddress' + deliveryAddresses: + description: >- + if this field is filled, the delivery address will be taken from + here according to this sorting: PARCEL_LOCKER > POSTAL_ADDRESS > + INVOICE_ADDRESS. Each type is only allowed once. + items: + $ref: '#/components/schemas/DeliveryAddressWithType' + type: array items: items: $ref: '#/components/schemas/DeliveryNoteItem' @@ -22094,7 +22542,6 @@ components: $ref: '#/components/schemas/OrderInformation' required: - orderInformation - - deliveryAddress - items type: object DeliveryNoteConfiguration: @@ -22208,6 +22655,14 @@ components: $ref: '#/components/schemas/OrderInformation' deliveryAddress: $ref: '#/components/schemas/DeliveryAddress' + deliveryAddresses: + description: >- + if this field is filled, the delivery address will be taken from + here according to this sorting: INVOICE_ADDRESS > POSTAL_ADDRESS. + Each type is only allowed once. + items: + $ref: '#/components/schemas/DeliveryAddressWithType' + type: array qrCodeContent: type: string items: @@ -22238,53 +22693,6 @@ components: enum: - STATUS_TARGET_TIME_LAST_MODIFIED_DATE - TARGET_TIME_ASC - DeliveryPreferences: - properties: - collect: - items: - $ref: '#/components/schemas/CollectDelivery' - maxItems: 1 - type: array - shipping: - properties: - preferredCarriers: - items: - $ref: '#/components/schemas/PreferredCarrier' - type: array - preferredCarriersWithProduct: - items: - $ref: '#/components/schemas/PreferredCarrierWithProduct' - type: array - preselectedFacilities: - items: - $ref: '#/components/schemas/PreselectedFacility' - type: array - serviceLevel: - description: >- - DELIVERY: The parcel will reach the recipient according to the - cycle time of the carrier, typically 1-3 days when shipping - nationaly. SAMEDAY: The parcel will reach the recipient the same - day when ordering. - enum: - - DELIVERY - - SAMEDAY - type: string - carrierProductCategory: - $ref: '#/components/schemas/CarrierProductCategory' - type: object - supplyingFacilities: - description: '@deprecated Use supplyingFacilities under collect' - items: - description: Reference of a Facility - example: 928f3730-bc48-4d85-b83f-3fd86b776178 - type: string - type: array - targetTime: - description: At which time the result is expected. - example: '2020-02-03T09:45:51.525Z' - format: date-time - type: string - type: object TenantConnectorConfigurations: allOf: - $ref: '#/components/schemas/VersionedResource' @@ -22314,10 +22722,10 @@ components: example: GTasGTHJZ_ku_gaad_P2A4KRDQW_MM_-AS-Lglk firebaseAppId: type: string - example: 8474038f-91e7-4c60-9148-dcb814ff8349 + example: 1:180217824890:android:f1fbf11eb8a613cbda9ee4 firebaseAppIdDebug: type: string - example: 3674a3ef-d044-4338-a2a5-a8ffdadc33e4 + example: 1:180217824890:android:c861c7b58d938e05da9ee4 additionalProperties: false required: - app @@ -22332,25 +22740,9 @@ components: enum: - PICKING - INVENTORY + - OPERATIONS_ANDROID + - OPERATIONS_IOS type: string - PreferredCarrier: - description: Keys of the preferred carriers to handle out the order - type: string - PreferredCarrierWithProduct: - additionalProperties: false - properties: - carrierKey: - type: string - example: DPD - carrierProduct: - type: string - example: WORLDWIDE - carrierServices: - type: array - items: - $ref: '#/components/schemas/CarrierServices' - required: - - carrierKey CarrierServices: example: SIGNATURE description: Services which should be booked from carrier @@ -22515,6 +22907,14 @@ components: type: array items: $ref: '#/components/schemas/OfferedStickersByTag' + ExpectedPickLineItemForCreation: + allOf: + - $ref: '#/components/schemas/PickLineItemForCreation' + properties: + transferId: + type: string + required: + - transferId PickLineItemForCreation: properties: article: @@ -22600,6 +23000,11 @@ components: format: int64 minimum: 0 type: integer + pickedAt: + description: Date when the line has been picked. + example: '2024-02-03T08:45:51.525Z' + format: date-time + type: string status: $ref: '#/components/schemas/PickLineItemStatus' substituteLineItems: @@ -22652,69 +23057,30 @@ components: items: $ref: '#/components/schemas/ScanningRuleValue' type: array + shortPickReason: + $ref: '#/components/schemas/PickLineShortPickReason' required: - id - picked - status type: object - ShortPickReason: - additionalProperties: false - properties: - id: - type: string - version: - description: >- - The version of the document to be used in optimistic locking - mechanisms. - example: 42 - format: int64 - created: - description: >- - The date this entity was created at the platform. This value is - generated by the service. - example: '2020-02-03T08:45:51.525Z' - format: date-time - type: string - lastModified: - description: >- - The date this entity was modified last. This value is generated by - the service. - example: '2020-02-03T09:45:51.525Z' - format: date-time - type: string - active: - type: boolean - example: true - description: Flag to mark a reason as active or inactive - reason: - description: translated reasonLocalized according to the given locale - type: string - reasonLocalized: - description: Localized reason - example: '{ en_US: ''SomeName'' }' - $ref: '#/components/schemas/LocaleString' - required: - - id - - version - - lastModified - - active - - created - - reasonLocalized + ExpectedPickLineItem: + allOf: + - $ref: '#/components/schemas/ExpectedPickLineItemForCreation' + - properties: + id: + description: >- + The id of this lineItem. It is generated during creation + automatically and suits as the primary identifier of the + described entity. + example: climk4dcQFiPdA5ULuhS + type: string + required: + - id + type: object PickLineShortPickReason: additionalProperties: false properties: - id: - type: string - version: - description: >- - The version of the document to be used in optimistic locking - mechanisms. - example: 42 - format: int64 - active: - type: boolean - example: true - description: Flag to mark a reason as active or inactive reason: description: translated reasonLocalized according to the given locale type: string @@ -22723,9 +23089,6 @@ components: example: '{ en_US: ''SomeName'' }' $ref: '#/components/schemas/LocaleString' required: - - id - - version - - active - reasonLocalized PickingScanningConfigurationEnum: example: MUST_SCAN_FIRST @@ -22959,69 +23322,6 @@ components: type: object xml: name: DpdChCarrierCredentials - DhlV2FacilityCarrierConfiguration: - allOf: - - $ref: '#/components/schemas/AbstractFacilityCarrierConfiguration' - properties: - alternativeReturnAddress: - $ref: '#/components/schemas/FacilityAddress' - xml: - name: DhlV2FacilityCarrierConfiguration - VceFacilityCarrierConfiguration: - allOf: - - $ref: '#/components/schemas/AbstractFacilityCarrierConfiguration' - properties: - alternativeReturnAddress: - $ref: '#/components/schemas/FacilityAddress' - xml: - name: VceFacilityCarrierConfiguration - AngelFacilityCarrierConfiguration: - allOf: - - $ref: '#/components/schemas/AbstractFacilityCarrierConfiguration' - - properties: - pickupLocationId: - description: The id of the Pickup Location - type: string - pattern: ^[A-z0-9-]{15}$ - type: object - xml: - name: AngelFacilityCarrierConfiguration - PostNLFacilityCarrierConfiguration: - allOf: - - $ref: '#/components/schemas/AbstractFacilityCarrierConfiguration' - - properties: - customerId: - type: string - customerCode: - type: string - type: object - required: - - customerId - - customerCode - xml: - name: PostNLFacilityCarrierConfiguration - GlsFacilityCarrierConfiguration: - allOf: - - $ref: '#/components/schemas/AbstractFacilityCarrierConfiguration' - - properties: - contactId: - type: string - pattern: ^[A-z0-9-]{15}$ - returnContactId: - type: string - pattern: ^[A-z0-9-]{15}$ - type: object - xml: - name: GlsFacilityCarrierConfiguration - DpdChFacilityCarrierConfiguration: - allOf: - - $ref: '#/components/schemas/AbstractFacilityCarrierConfiguration' - - properties: - depot: - type: string - type: object - xml: - name: DpdChFacilityCarrierConfiguration AngelCarrierCredentials: allOf: - $ref: '#/components/schemas/AbstractCarrierCredentials' @@ -23155,10 +23455,6 @@ components: - properties: resolvedTimeZone: $ref: '#/components/schemas/TimeZone' - description: >- - The resolved timezone of this facility - optional read-only - property that is filled when the facility is first used in - routing calculations type: object type: object FacilityAddressForCreation: @@ -23189,187 +23485,29 @@ components: $ref: '#/components/schemas/Coordinates' description: >- The coordinates correspond to the address of this facility. If - the coordinates are not provided during the creation or updating - of the facility, they are automatically resolved by the backend - system - required: - - companyName - type: object - type: object - PostalCodeValidation: - properties: - country: - description: Country in Format [A-Z]{2} - example: DE - type: string - postalCode: - description: Postal code for validation - example: '50667' - type: string - required: - - country - - postalCode - type: object - xml: - name: PostalCodeValidation - FacilityCarrierConnection: - allOf: - - $ref: '#/components/schemas/VersionedResource' - properties: - carrierRef: - description: ID that references the configured carrier. - type: string - deliveryType: - $ref: '#/components/schemas/CarrierDeliveryType' - key: - type: string - configuration: - description: Facility specific configuration for this carrier - anyOf: - - $ref: '#/components/schemas/GlsFacilityCarrierConfiguration' - - $ref: '#/components/schemas/AngelFacilityCarrierConfiguration' - - $ref: '#/components/schemas/PostNLFacilityCarrierConfiguration' - - $ref: '#/components/schemas/DpdChFacilityCarrierConfiguration' - - $ref: '#/components/schemas/DhlV2FacilityCarrierConfiguration' - - $ref: '#/components/schemas/VceFacilityCarrierConfiguration' - credentials: - description: Facility specific credentials for this carrier - anyOf: - - $ref: '#/components/schemas/DHLV2BusinessCredentials' - - $ref: '#/components/schemas/DpdChCarrierCredentials' - - $ref: '#/components/schemas/PostNLCarrierCredentials' - - $ref: '#/components/schemas/VceCarrierCredentials' - cutoffTime: - $ref: '#/components/schemas/CutoffTime' - deliveryAreas: - items: - $ref: '#/components/schemas/DeliveryArea' - type: array - name: - description: >- - This is the well known name for a supported CEP partner. Can be - adapted to the clients needs. - example: DHL Köln - type: string - status: - $ref: '#/components/schemas/CarrierStatus' - parcelLabelClassifications: - items: - $ref: '#/components/schemas/ParcelLabelClassification' - type: array - tags: - type: array - minItems: 1 - items: - $ref: '#/components/schemas/TagReference' - validDeliveryTargets: - type: array - minItems: 1 - items: - $ref: '#/components/schemas/DeliveryTarget' - required: - - carrierRef - - key - - status + the coordinates are not provided during the creation or updating + of the facility, they are automatically resolved by the backend + system + required: + - companyName + type: object type: object - FacilityCarrierConnectionForCreation: - additionalProperties: false + PostalCodeValidation: properties: - credentials: - description: Facility specific credentials for this carrier - anyOf: - - $ref: '#/components/schemas/DHLV2BusinessCredentials' - - $ref: '#/components/schemas/DpdChCarrierCredentials' - - $ref: '#/components/schemas/PostNLCarrierCredentials' - configuration: - description: Facility specific configuration for this carrier - anyOf: - - $ref: '#/components/schemas/GlsFacilityCarrierConfiguration' - - $ref: '#/components/schemas/AngelFacilityCarrierConfiguration' - - $ref: '#/components/schemas/PostNLFacilityCarrierConfiguration' - - $ref: '#/components/schemas/DpdChFacilityCarrierConfiguration' - - $ref: '#/components/schemas/DhlV2FacilityCarrierConfiguration' - - $ref: '#/components/schemas/VceFacilityCarrierConfiguration' - cutoffTime: - $ref: '#/components/schemas/CutoffTime' - deliveryAreas: - items: - $ref: '#/components/schemas/DeliveryArea' - type: array - name: - description: >- - This is the well known name for a supported CEP partner. Can be - adapted to the clients needs. - example: DHL Köln + country: + description: Country in Format [A-Z]{2} + example: DE type: string - status: - $ref: '#/components/schemas/CarrierStatus' - parcelLabelClassifications: - items: - $ref: '#/components/schemas/ParcelLabelClassificationForCreation' - type: array - tags: - type: array - minItems: 1 - items: - $ref: '#/components/schemas/TagReference' - validDeliveryTargets: - type: array - minItems: 1 - items: - $ref: '#/components/schemas/DeliveryTarget' - type: object - FacilityCarrierConnectionForModification: - additionalProperties: false - properties: - credentials: - description: Facility specific credentials for this carrier - anyOf: - - $ref: '#/components/schemas/DHLV2BusinessCredentials' - - $ref: '#/components/schemas/DpdChCarrierCredentials' - - $ref: '#/components/schemas/PostNLCarrierCredentials' - - $ref: '#/components/schemas/VceCarrierCredentials' - configuration: - description: Facility specific configuration for this carrier - anyOf: - - $ref: '#/components/schemas/GlsFacilityCarrierConfiguration' - - $ref: '#/components/schemas/AngelFacilityCarrierConfiguration' - - $ref: '#/components/schemas/PostNLFacilityCarrierConfiguration' - - $ref: '#/components/schemas/DpdChFacilityCarrierConfiguration' - - $ref: '#/components/schemas/DhlV2FacilityCarrierConfiguration' - - $ref: '#/components/schemas/VceFacilityCarrierConfiguration' - cutoffTime: - $ref: '#/components/schemas/CutoffTime' - deliveryAreas: - items: - $ref: '#/components/schemas/DeliveryArea' - type: array - name: - description: >- - This is the well known name for a supported CEP partner. Can be - adapted to the clients needs. - example: DHL Köln + postalCode: + description: Postal code for validation + example: '50667' type: string - status: - $ref: '#/components/schemas/CarrierStatus' - parcelLabelClassifications: - items: - $ref: '#/components/schemas/ParcelLabelClassificationForCreation' - type: array - tags: - type: array - items: - $ref: '#/components/schemas/TagReference' - version: - type: number - validDeliveryTargets: - type: array - minItems: 1 - items: - $ref: '#/components/schemas/DeliveryTarget' required: - - version + - country + - postalCode type: object + xml: + name: PostalCodeValidation DeliveryTarget: type: string description: The destination for a delivery @@ -23432,558 +23570,208 @@ components: - WAREHOUSE - EXTERNAL type: string - name: - example: Hamburg NW2 - type: string - capacityPlanningTimeframe: - description: >- - The range in days per facility which defines how many days in the - future the capacity of the facility can be planned - type: integer - minimum: 1 - pickingTimes: - $ref: '#/components/schemas/PickingTimes' - description: >- - Time ranges defining the picking times per weekday. No overlapping - ranges are allowed - pickingMethods: - description: Picking Methods supported by this facility. - items: - $ref: '#/components/schemas/PickingMethodEnum' - type: array - scanningRule: - $ref: '#/components/schemas/ScanningRuleConfiguration' - services: - items: - properties: - type: - $ref: '#/components/schemas/FacilityServiceType' - required: - - type - type: object - type: array - status: - $ref: '#/components/schemas/FacilityStatus' - tenantFacilityId: - description: The id of the facility in the tenants own system - example: K12345 - type: string - capacityEnabled: - type: boolean - default: false - description: >- - Indicates that configured capacity limits for picking times are - considered - tags: - type: array - minItems: 1 - items: - $ref: '#/components/schemas/TagReference' - required: - - name - - address - type: object - FacilityPatchActions: - properties: - actions: - items: - $ref: '#/components/schemas/ModifyFacilityAction' - minItems: 1 - type: array - version: - description: >- - The version of the document to be used in optimistic locking - mechanisms. - example: 42 - format: int64 - type: integer - required: - - version - - actions - type: object - xml: - name: FacilityPatchActions - FacilityStatus: - description: >- - The state of the facility. ONLINE means that this facility can process - new orders and pickjobs, SUSPENDED means it cannot get new orders but is - able to fulfill the current workload and OFFLINE means that it cannot - fulfill any new or existing orders. Processes already running might be - rescheduled to another facility depending on the preferences. - enum: - - ONLINE - - SUSPENDED - - OFFLINE - type: string - FacilityStockConfiguration: - allOf: - - $ref: '#/components/schemas/VersionedResource' - - properties: - id: - type: string - listingReactivationAfter: - properties: - active: - default: true - description: The disabling of listings is enabled or disabled. - type: boolean - value: - default: 24 - description: >- - Time in hours that has to pass for a deactivated listing - (e.g. due to manual deactivation or as a result of a - shortpick ) to be become active again. - type: number - type: object - retainedOfflineStock: - properties: - active: - description: The retained Offline Stock is enabled or disabled. - type: boolean - value: - default: 0.2 - description: >- - The overall percentage of stock that should be reserved to - offline clients. - example: 0.15 - maximum: 1 - minimum: 0.01 - type: number - type: object - shortpick: - properties: - active: - default: true - description: >- - Inventory adjustment in the case of insufficient order - picking - type: boolean - required: - - active - type: object - required: - - retainedOfflineStock - - listingReactivationAfter - - shortpick - - id - type: object - Feature: - allOf: - - $ref: '#/components/schemas/VersionedResource' - properties: - name: - type: string - status: - $ref: '#/components/schemas/FeatureStatus' - required: - - name - - status - type: object - FeaturePatchActions: - properties: - actions: - items: - $ref: '#/components/schemas/ModifyFeatureAction' - minItems: 1 - type: array - version: - description: >- - The version of the document to be used in optimistic locking - mechanisms. - example: 42 - format: int64 - type: integer - required: - - version - - actions - type: object - xml: - name: FeaturePatchActions - FeatureStatus: - enum: - - enabled - - inactive - - disabled - type: string - Features: - properties: - features: - items: - $ref: '#/components/schemas/Feature' - type: array - total: - description: Total number of found entities for this query - example: 42 - type: integer - type: object - Fence: - additionalProperties: false - properties: - active: - type: boolean - description: - type: string - id: - description: >- - This value identifies this very instance of the fence. It is set - autmatically by the server when the configuration is updated. - example: f937bc6b-d78b-46a3-913f-ecbba5f9f65d - type: string - implementation: - $ref: '#/components/schemas/FenceImplementation' - name: - type: string - supportedModes: - type: array - items: - $ref: '#/components/schemas/FenceMode' - activeMode: - $ref: '#/components/schemas/FenceMode' - required: - - active - - implementation - - id - type: object - FenceMode: - enum: - - static - - reactive - type: string - FenceImplementation: - 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 - enum: - - FACILITY-BUSINESSTYPE - - STOCK-AVAILABILITY - - FACILITY-CARRIERAVAILABILITY - - FACILITY-COUNTRY - - FACILITY-PICKING-TIME-CAPACITY - - PRESELECTED-FACILITY - - SAMEDAY-POSSIBLE - - AVOID-ZERO-STOCK - type: string - xml: - name: FenceImplementation - NamedFile: - additionalProperties: false - properties: - content: - description: File content base64 encoded - example: >- - JVBERi0xLjEKJcKlwrHDqwoKMSAwIG9iagogIDw8IC9UeXBlIC9DYXRhbG9nCiAgICAgL1BhZ2VzIDIgMCBSCiAgPj4KZW5kb2JqCgoyIDAgb2JqCiAgPDwgL1R5cGUgL1BhZ2VzCiAgICAgL0tpZHMgWzMgMCBSXQogICAgIC9Db3VudCAxCiAgICAgL01lZGlhQm94IFswIDAgMzAwIDE0NF0KICA+PgplbmRvYmoKCjMgMCBvYmoKICA8PCAgL1R5cGUgL1BhZ2UKICAgICAgL1BhcmVudCAyIDAgUgogICAgICAvUmVzb3VyY2VzCiAgICAgICA8PCAvRm9udAogICAgICAgICAgIDw8IC9GMQogICAgICAgICAgICAgICA8PCAvVHlwZSAvRm9udAogICAgICAgICAgICAgICAgICAvU3VidHlwZSAvVHlwZTEKICAgICAgICAgICAgICAgICAgL0Jhc2VGb250IC9UaW1lcy1Sb21hbgogICAgICAgICAgICAgICA+PgogICAgICAgICAgID4+CiAgICAgICA+PgogICAgICAvQ29udGVudHMgNCAwIFIKICA+PgplbmRvYmoKCjQgMCBvYmoKICA8PCAvTGVuZ3RoIDU1ID4+CnN0cmVhbQogIEJUCiAgICAvRjEgMTggVGYKICAgIDAgMCBUZAogICAgKEhlbGxvIFdvcmxkKSBUagogIEVUCmVuZHN0cmVhbQplbmRvYmoKCnhyZWYKMCA1CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAxOCAwMDAwMCBuIAowMDAwMDAwMDc3IDAwMDAwIG4gCjAwMDAwMDAxNzggMDAwMDAgbiAKMDAwMDAwMDQ1NyAwMDAwMCBuIAp0cmFpbGVyCiAgPDwgIC9Sb290IDEgMCBSCiAgICAgIC9TaXplIDUKICA+PgpzdGFydHhyZWYKNTY1CiUlRU9GCg== - type: string - name: - description: File name with extension - example: example.pdf - type: string - required: - - name - - content - type: object - xml: - name: NamedFile - FixedCountConfiguration: - 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

Configuration of fixed count split. - properties: - maxSplitCount: - description: >- - This setting defines how often an order split might be performed to - fulfill the order. - minimum: 1 - type: number - required: - - maxSplitCount - type: object - Fulfillability: - description: The response to a fulfillability request. - properties: - collect: - properties: - facilities: - items: - $ref: '#/components/schemas/FulfillabilityFacility' - type: array - type: object - shipping: - description: >- - Results for the fulfillment of a shipping order for the parameters - provided in the query - properties: - DELIVERY: - description: Depicts wether the servicelevel DELIVERY is available. - properties: - available: - description: Depicts wether the servicelevel DELIVERY is available - example: false - type: boolean - required: - - available - type: object - SAMEDAY: - description: >- - This service level means, that the consumer expects a package - the same day. - properties: - available: - description: Depicts wether the servicelevel SAMEDAY is available - example: true - type: boolean - validUntil: - description: >- - This information is most likely valid until this date (there - are circumstances when this information becomes stale - earlier). - example: '2020-02-03T08:45:50.525Z' - format: date-time - type: string - required: - - available - type: object - type: object - type: object - FulfillabilityResult: - properties: - fulfillability: - type: array - items: - $ref: '#/components/schemas/FulfillabilityDetail' - required: - - details - FulfillabilityDetail: - properties: - facilityRef: - type: string - tenantFacilityId: - type: string - facilityName: - type: string - closingDays: - type: array - items: - $ref: '#/components/schemas/ClosingDay' - pickingTimes: - $ref: '#/components/schemas/PickingTimes' - address: - $ref: '#/components/schemas/FacilityAddress' - targetTime: - type: string - format: date-time - articleAvailabilities: - type: array - items: - $ref: '#/components/schemas/ArticleAvailability' - required: - - facilityRef - - facilityName - - address - - articleAvailabilities - ArticleAvailability: - properties: - tenantArticleId: - type: string - availableStock: - type: number - outOfStockBehaviour: - enum: - - BACKORDER - type: string - availabilityTimeframe: - $ref: '#/components/schemas/AvailabilityTimeframe' - required: - - tenantArticleId - - availableStock - FulfillabilityFacility: - allOf: - - $ref: '#/components/schemas/StrippedFacility' - FulfillabilityItemsConstraintValue: - properties: - items: - description: >- - The shortened description of an article, that would be part of the - order. - items: - properties: - amount: - description: The required amount - example: 5 - type: integer - tenantArticleId: - description: The article ID, that is used in corresponding listings. - example: RO-57665956-6-XL - type: string - type: object - type: array - mode: - description: >- - The mode this constraint is evaluated in. ITEMS_COMPLETE means, that - all the items in the desired quantities have to be listed in a - resulting facility. - enum: - - ITEMS_COMPLETE - example: ITEMS_COMPLETE + name: + example: Hamburg NW2 type: string - required: - - mode - - items - type: object - FulfillabilityShipFromStoreQuery: - description: >- - Provides the paramters you are interested in. You must supply at least - the articles you are interested in - properties: - geoFence: - $ref: '#/components/schemas/GeoFence' - facilityRefs: - type: array + capacityPlanningTimeframe: + description: >- + The range in days per facility which defines how many days in the + future the capacity of the facility can be planned + type: integer + minimum: 1 + pickingTimes: + $ref: '#/components/schemas/PickingTimes' + description: >- + Time ranges defining the picking times per weekday. No overlapping + ranges are allowed + pickingMethods: + description: Picking Methods supported by this facility. items: - type: string - articles: + $ref: '#/components/schemas/PickingMethodEnum' type: array - minItems: 1 + scanningRule: + $ref: '#/components/schemas/ScanningRuleConfiguration' + services: items: - type: object properties: - tenantArticleId: - type: string - quantity: - type: number + type: + $ref: '#/components/schemas/FacilityServiceType' required: - - tenantArticleId - deliveryPreferences: - $ref: '#/components/schemas/DeliveryPreferences' - deliveryCountry: - description: A two-digit country code as per ISO 3166-1 alpha-2 - example: DE - pattern: ^[A-Z]{2}$ - type: string - deliveryPostalCode: - type: string - required: - - articles - FulfillabilityClickAndCollectQuery: - description: >- - Provides the paramters you are interested in. You must supply at least - the articles you are interested in - properties: - geoFence: - $ref: '#/components/schemas/GeoFence' - facilityRefs: + - type + type: object type: array - items: - type: string - deliveryPreferences: - $ref: '#/components/schemas/DeliveryPreferences' - deliveryCountry: - description: A two-digit country code as per ISO 3166-1 alpha-2 - example: DE - pattern: ^[A-Z]{2}$ - type: string - deliveryPostalCode: + status: + $ref: '#/components/schemas/FacilityStatus' + tenantFacilityId: + description: The id of the facility in the tenants own system + example: K12345 type: string - articles: + capacityEnabled: + type: boolean + default: false + description: >- + Indicates that configured capacity limits for picking times are + considered + tags: type: array minItems: 1 items: - type: object - properties: - tenantArticleId: - type: string - quantity: - type: number - required: - - tenantArticleId + $ref: '#/components/schemas/TagReference' required: - - articles - FulfillabilityQuery: - description: >- - Provides the paramters you are interested in. You must supply at least - either the shipping or the collect attribute as the description of the - last mile expectation. + - name + - address + type: object + FacilityPatchActions: properties: - collect: + actions: + items: + $ref: '#/components/schemas/ModifyFacilityAction' + minItems: 1 + type: array + version: description: >- - The geofence (a gps coordinate and a radius around that coordinate) - for considered facilities to collect the goods. - properties: - geoFence: - $ref: '#/components/schemas/GeoFence' + The version of the document to be used in optimistic locking + mechanisms. + example: 42 + format: int64 + type: integer + required: + - version + - actions + type: object + xml: + name: FacilityPatchActions + FacilityStatus: + description: >- + The state of the facility. ONLINE means that this facility can process + new orders and pickjobs, SUSPENDED means it cannot get new orders but is + able to fulfill the current workload and OFFLINE means that it cannot + fulfill any new or existing orders. Processes already running might be + rescheduled to another facility depending on the preferences. + enum: + - ONLINE + - SUSPENDED + - OFFLINE + type: string + FacilityStockConfiguration: + allOf: + - $ref: '#/components/schemas/VersionedResource' + - properties: + id: + type: string + listingReactivationAfter: + properties: + active: + default: true + description: The disabling of listings is enabled or disabled. + type: boolean + value: + default: 24 + description: >- + Time in hours that has to pass for a deactivated listing + (e.g. due to manual deactivation or as a result of a + shortpick ) to be become active again. + type: number + type: object + retainedOfflineStock: + properties: + active: + description: The retained Offline Stock is enabled or disabled. + type: boolean + value: + default: 0.2 + description: >- + The overall percentage of stock that should be reserved to + offline clients. + example: 0.15 + maximum: 1 + minimum: 0.01 + type: number + type: object + shortpick: + properties: + active: + default: true + description: >- + Inventory adjustment in the case of insufficient order + picking + type: boolean + required: + - active + type: object required: - - geoFence + - retainedOfflineStock + - listingReactivationAfter + - shortpick + - id type: object - constraints: - description: >- - Constraints can be used to further cut down the list of resulting - facilities. Important: ALL of the given constraints will be matched - against the resulting list of facilities! + Feature: + allOf: + - $ref: '#/components/schemas/VersionedResource' + properties: + name: + type: string + status: + $ref: '#/components/schemas/FeatureStatus' + required: + - name + - status + type: object + FeaturePatchActions: + properties: + actions: items: - $ref: '#/components/schemas/AbstractFulfillabilityConstraintType' + $ref: '#/components/schemas/ModifyFeatureAction' + minItems: 1 type: array - estimatedOrderDate: - description: >- - The point in time when the order estimated to be supplied to - fulfillmenttools platform, e.g. calling this endpoint during - checkout, you would most likely put the timestamp for 'now' in here. - example: '2020-02-03T08:45:50.525Z' - format: date-time - type: string - shipping: + version: description: >- - You want information about the shipping possibility - more detailed - parameters can be described here. - properties: - serviceLevels: - description: >- - The kind of servicelevel you want to query as being part of the - consumer expectation of delivery - items: - $ref: '#/components/schemas/CarrierDeliveryType' - minItems: 1 - type: array - targetAddress: - $ref: '#/components/schemas/StrippedShippingTargetAddress' - description: The target of the shipping (defined by postalcode and country) - required: - - serviceLevels - - targetAddress - type: object + The version of the document to be used in optimistic locking + mechanisms. + example: 42 + format: int64 + type: integer required: - - estimatedOrderDate + - version + - actions type: object - GeoFence: - description: >- - Center (described with lon and lat attributes) and a circular geofence - (described as radius around the center) + xml: + name: FeaturePatchActions + FeatureStatus: + enum: + - enabled + - inactive + - disabled + type: string + Features: properties: - lat: - description: The latitude of the center, provided as decimal coordinate - example: 50.968713 - type: number - lon: - description: The longitude of the center, provided as decimal coordinate - example: 7.011375 - type: number - radius: - description: Radius around the center in kilometers (km, max. 100) - minimum: 1 - type: number + features: + items: + $ref: '#/components/schemas/Feature' + type: array + total: + description: Total number of found entities for this query + example: 42 + type: integer + type: object + NamedFile: + additionalProperties: false + properties: + content: + description: File content base64 encoded + example: >- + JVBERi0xLjEKJcKlwrHDqwoKMSAwIG9iagogIDw8IC9UeXBlIC9DYXRhbG9nCiAgICAgL1BhZ2VzIDIgMCBSCiAgPj4KZW5kb2JqCgoyIDAgb2JqCiAgPDwgL1R5cGUgL1BhZ2VzCiAgICAgL0tpZHMgWzMgMCBSXQogICAgIC9Db3VudCAxCiAgICAgL01lZGlhQm94IFswIDAgMzAwIDE0NF0KICA+PgplbmRvYmoKCjMgMCBvYmoKICA8PCAgL1R5cGUgL1BhZ2UKICAgICAgL1BhcmVudCAyIDAgUgogICAgICAvUmVzb3VyY2VzCiAgICAgICA8PCAvRm9udAogICAgICAgICAgIDw8IC9GMQogICAgICAgICAgICAgICA8PCAvVHlwZSAvRm9udAogICAgICAgICAgICAgICAgICAvU3VidHlwZSAvVHlwZTEKICAgICAgICAgICAgICAgICAgL0Jhc2VGb250IC9UaW1lcy1Sb21hbgogICAgICAgICAgICAgICA+PgogICAgICAgICAgID4+CiAgICAgICA+PgogICAgICAvQ29udGVudHMgNCAwIFIKICA+PgplbmRvYmoKCjQgMCBvYmoKICA8PCAvTGVuZ3RoIDU1ID4+CnN0cmVhbQogIEJUCiAgICAvRjEgMTggVGYKICAgIDAgMCBUZAogICAgKEhlbGxvIFdvcmxkKSBUagogIEVUCmVuZHN0cmVhbQplbmRvYmoKCnhyZWYKMCA1CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAxOCAwMDAwMCBuIAowMDAwMDAwMDc3IDAwMDAwIG4gCjAwMDAwMDAxNzggMDAwMDAgbiAKMDAwMDAwMDQ1NyAwMDAwMCBuIAp0cmFpbGVyCiAgPDwgIC9Sb290IDEgMCBSCiAgICAgIC9TaXplIDUKICA+PgpzdGFydHhyZWYKNTY1CiUlRU9GCg== + type: string + name: + description: File name with extension + example: example.pdf + type: string required: - - lat - - lon - - radius + - name + - content type: object + xml: + name: NamedFile FulfillmentProcessBufferConfiguration: allOf: - $ref: '#/components/schemas/VersionedResource' @@ -23999,23 +23787,6 @@ components: required: - minutes type: object - CapacityPlanningTimeframeConfiguration: - allOf: - - $ref: '#/components/schemas/VersionedResource' - properties: - days: - default: 100 - description: >- - The range in days per facility which defines how many days in the - future the capacity of the facility can be planned - example: '240' - minimum: 1 - type: integer - id: - type: string - required: - - days - type: object GdprConfiguration: additionalProperties: false allOf: @@ -24041,93 +23812,22 @@ components: - retentionTime - version type: object - GlobalRoutingConfiguration: - description: Global configuration for routing - properties: - manualReroute: - $ref: '#/components/schemas/GlobalManualRerouteConfiguration' - defaultPrice: - default: 10 - description: Default price which is used if no price exists in order or listings - type: number - routingTimeout: - deprecated: true - default: 8 - description: >- -
-
This endpoint is deprecated and has been replaced.

@deprecated Default amount of hours after which a routing - plan is marked not routable. This field is deprecated in favour of - stopRoutingAttemptsAfterTime - type: number - stopRoutingAttemptsAfterTime: - default: PT8H - description: >- - Default amount of time in ISO 8601 duration format after which a - routing plan is marked not routable. The duration need to be a - multiple of 60 seconds. - type: string - pattern: ^P(?:(\d+W)|(\d+Y)?(\d+M)?(\d+D)?(?:T(\d+H)?(\d+M)?(\d+S)?)?)$ - fallbackFacilityConfiguration: - $ref: '#/components/schemas/FallbackFacilityConfiguration' - required: - - defaultPrice - type: object - FallbackFacilityConfigurationForPatch: - properties: - facilityRefs: - type: array - items: - type: string - maxItems: 1 - minItems: 1 - active: - type: boolean - fallbackAfterTime: - description: >- - Default amount of time in ISO 8601 duration format after which a not - routable routingplan is routed to a configured fallback facility. - type: string - pattern: ^P(?:(\d+W)|(\d+Y)?(\d+M)?(\d+D)?(?:T(\d+H)?(\d+M)?(\d+S)?)?)$ - FallbackFacilityConfiguration: - properties: - facilityRefs: - type: array - items: - type: string - maxItems: 1 - minItems: 1 - active: - type: boolean - default: false - fallbackAfterTime: - default: PT0H - description: >- - Default amount of time in ISO 8601 duration format after which a not - routable routingplan is routed to a configured fallback facility. - type: string - pattern: ^P(?:(\d+W)|(\d+Y)?(\d+M)?(\d+D)?(?:T(\d+H)?(\d+M)?(\d+S)?)?)$ - required: - - facilityRefs - - active - - fallbackAfterTime HandoverLineItem: properties: article: $ref: '#/components/schemas/HandoverLineItemArticle' - handedOverQuantity: - description: The amount of articles that were picked for this handover line item. - example: 20 - format: int64 - minimum: 0 - type: integer quantity: - description: quantity of the specific article that has been ordered + description: quantity of the specific item that has been provided for handover example: 21 format: int64 minimum: 1 type: integer + handedOverQuantity: + description: quantity of the specific item that has been handed over + example: 20 + format: int64 + minimum: 0 + type: integer substituteLineItems: description: >-
documentation

items: - $ref: '#/components/schemas/SubstituteLineItem' + $ref: '#/components/schemas/HandoverSubstituteLineItem' type: array tags: items: @@ -24160,11 +23860,34 @@ components: - properties: attributes: items: - $ref: '#/components/schemas/OrderArticleAttributeItem' + $ref: '#/components/schemas/ArticleAttributeItem' type: array type: object xml: name: HandoverLineItemArticle + HandoverSubstituteLineItem: + allOf: + - $ref: '#/components/schemas/SubstituteLineItem' + - properties: + quantity: + description: >- + quantity of the specific item to substitute the original line + item that has been provided for handover + example: 21 + format: int64 + minimum: 1 + type: integer + handedOverQuantity: + description: >- + quantity of the specific item to substitute the original line + item that has been handed over + example: 20 + format: int64 + minimum: 0 + type: integer + required: + - quantity + - article Handoverjob: allOf: - $ref: '#/components/schemas/VersionedResource' @@ -24253,6 +23976,8 @@ components: Id of the global process related to this entity. For example used for starting the GDPR process and others. type: string + operativeProcessRef: + type: string shipmentRef: description: The reference to the shipment belonging to the handoverjob example: Esb20gpHBL94X5NdMp3C @@ -24302,6 +24027,11 @@ components: fullIdentifier: type: string description: An information to identify the recipient + transfers: + type: array + minItems: 0 + items: + $ref: '#/components/schemas/OperativeTransfer' required: - facilityRef - targetTime @@ -24350,12 +24080,23 @@ components: availableRefusedReasons: items: $ref: '#/components/schemas/AvailableRefusedReason' + type: object + HandoverConfigurationForCreate: + additionalProperties: false + properties: + version: + type: number + availableRefusedReasons: + items: + $ref: '#/components/schemas/AvailableRefuseReasonForCreation' required: - - availableRefusedReasons + - version type: object AvailableRefusedReason: additionalProperties: false properties: + active: + type: boolean refusedReasonLocalized: $ref: '#/components/schemas/LocaleString' refusedReason: @@ -24364,17 +24105,68 @@ components: type: string required: - refusedReasonLocalized - ItemsFulfillabilityConstraintType: - allOf: - - $ref: '#/components/schemas/AbstractFulfillabilityConstraintType' + - active + AvailableRefuseReasonForCreation: + additionalProperties: false properties: - type: - enum: - - ITEMS - type: string - value: - $ref: '#/components/schemas/FulfillabilityItemsConstraintValue' - type: object + active: + type: boolean + example: true + refusedReasonLocalized: + description: Localized reason + example: '{ en_US: ''SomeName'' }' + $ref: '#/components/schemas/LocaleString' + required: + - active + - refusedReasonLocalized + AvailableRefuseReasonForUpdate: + additionalProperties: false + properties: + active: + type: boolean + example: true + version: + type: number + description: >- + The version of the document to be used in optimistic locking + mechanisms. + example: 42 + format: int64 + refusedReasonLocalized: + description: Localized reason + example: '{ en_US: ''SomeName'' }' + $ref: '#/components/schemas/LocaleString' + required: + - active + - refusedReasonLocalized + - version + UpdateRefuseReasonParameter: + additionalProperties: false + properties: + handoverConfigurationVersion: + type: number + availableRefuseReasonForUpdate: + $ref: '#/components/schemas/AvailableRefuseReasonForUpdate' + required: + - handoverConfigurationVersion + - availableRefuseReasonForUpdate + DeleteRefuseReasonParameter: + additionalProperties: false + properties: + handoverConfigurationVersion: + type: number + required: + - handoverConfigurationVersion + AddRefuseReasonParameter: + additionalProperties: false + properties: + handoverConfigurationVersion: + type: number + availableRefuseReasonForCreation: + $ref: '#/components/schemas/AvailableRefuseReasonForCreation' + required: + - handoverConfigurationVersion + - availableRefuseReasonForCreation LinkedConfiguration: properties: ref: @@ -24436,6 +24228,11 @@ components: ListingAttributeItem: allOf: - $ref: '#/components/schemas/ArticleAttributeItem' + properties: + keyLocalized: + $ref: '#/components/schemas/LocaleString' + valueLocalized: + $ref: '#/components/schemas/LocaleString' BrandForCreation: properties: name: @@ -24548,10 +24345,13 @@ components: description: This is a reference to an article Id example: '4711' type: string + minLength: 1 title: description: a title describing the article example: Adidas Superstar type: string + titleLocalized: + $ref: '#/components/schemas/LocaleString' partialStocks: type: array deprecated: true @@ -24603,6 +24403,8 @@ components: type: object additionalProperties: $ref: '#/components/schemas/StockPropertyDefinition' + stockAvailableUntil: + $ref: '#/components/schemas/AvailableUntilDefinition' legal: $ref: '#/components/schemas/ListingLegal' customAttributes: @@ -24652,6 +24454,32 @@ components: - inputType - required type: object + AvailableUntilDefinition: + properties: + calculationBase: + $ref: '#/components/schemas/AvailableUntilCalculationBase' + modifier: + description: >- + Moves the calculated date by the given period, defined in ISO-8601 + duration notation. Use negative values to move the date backwards. + Example: "-P30D" places the "availableUntil" value 30 days before + the calculated date. + type: string + pattern: ^-?P(?:(\d+W)|(\d+Y)?(\d+M)?(\d+D)?(?:T(\d+H)?(\d+M)?(\d+S)?)?)$ + example: '-P30D' + required: + - calculationBase + AvailableUntilCalculationBase: + description: >- + The base for the calculation of the available until date. If it can't be + resolved into a valid date (i.e. missing expiry value), an undefined + "availableUntil" is the result + enum: + - EXPIRY + - CREATION + type: string + xml: + name: AvailableUntilCalculationBase AvailabilityTimeframe: properties: start: @@ -25155,14 +24983,6 @@ components: US: en_US RU: ru_RU type: object - LocaleString: - additionalProperties: - type: string - example: - de_DE: Wert - en_US: Value - ru_RU: значение - type: object MeasurementUnit: additionalProperties: false allOf: @@ -25233,6 +25053,10 @@ components: example: DE pattern: ^[A-Z]{2}$ type: string + province: + example: Nordrhein-Westfalen + pattern: ^.+$ + type: string customAttributes: description: >- Attributes that can be added to the address. These attributes cannot @@ -25678,6 +25502,14 @@ components: description: The result of the parcel customAttributes: type: object + carrierProduct: + nullable: true + type: string + description: Only changable on status OPEN or FAILED of the existing Parcel + services: + nullable: true + $ref: '#/components/schemas/ParcelServices' + description: Only changable on status OPEN or FAILED of the existing Parcel required: - action type: object @@ -25788,70 +25620,6 @@ components: type: object xml: name: ModifyFeatureAction - ModifyFenceAction: - allOf: - - $ref: '#/components/schemas/AbstractModificationAction' - - properties: - action: - description: Use value 'ModifyFence', because you want to modify a fence. - enum: - - ModifyFence - type: string - active: - type: boolean - id: - type: string - activeMode: - $ref: '#/components/schemas/FenceMode' - required: - - action - - id - type: object - xml: - name: ModifyFenceAction - ModifyGlobalRoutingConfigurationAction: - allOf: - - $ref: '#/components/schemas/AbstractModificationAction' - - properties: - action: - description: >- - Use value 'ModifyGlobalRoutingConfiguration', because you want - to modify global routing configuration. - enum: - - ModifyGlobalRoutingConfiguration - type: string - defaultPrice: - default: 10 - description: >- - Default price which is used if no price exists in order or - listings - type: number - manualRerouteConfiguration: - $ref: '#/components/schemas/GlobalManualRerouteConfiguration' - routingTimeout: - deprecated: true - default: 8 - description: >- -
-
This endpoint is deprecated and has been - replaced.

@deprecated Default amount of hours - after which a routing plan is marked not routable. This field is - deprecated in favour of stopRoutingAttemptsAfterTime - type: number - stopRoutingAttemptsAfterTime: - default: PT8H - description: >- - Default amount of time in ISO 8601 duration format after which a - routing plan is marked not routable. The duration need to be a - multiple of 60 seconds. - type: string - pattern: ^P(?:(\d+W)|(\d+Y)?(\d+M)?(\d+D)?(?:T(\d+H)?(\d+M)?(\d+S)?)?)$ - fallbackFacilityConfiguration: - $ref: '#/components/schemas/FallbackFacilityConfigurationForPatch' - required: - - action - type: object ModifyHandoverjobAction: allOf: - $ref: '#/components/schemas/AbstractModificationAction' @@ -25959,6 +25727,8 @@ components: description: a title describing the article example: Adidas Superstar type: string + titleLocalized: + $ref: '#/components/schemas/LocaleString' tags: type: array minItems: 0 @@ -25988,6 +25758,8 @@ components: nullable: true additionalProperties: $ref: '#/components/schemas/StockPropertyDefinition' + stockAvailableUntil: + $ref: '#/components/schemas/AvailableUntilDefinition' legal: $ref: '#/components/schemas/ListingLegal' customAttributes: @@ -26002,1289 +25774,3009 @@ components: - action type: object xml: - name: ModifyListingAction - ModifyListingReactivationAfterAction: + name: ModifyListingAction + ModifyListingReactivationAfterAction: + allOf: + - $ref: '#/components/schemas/AbstractModificationAction' + - properties: + action: + description: >- + Use value 'ModifyListingReactivationAfter', if you want to + modify the listingReactivationAfter of a facility + enum: + - ModifyListingReactivationAfter + type: string + listingReactivationAfter: + properties: + active: + default: true + description: The disabling of listings is enabled or disabled. + type: boolean + value: + default: 24 + description: >- + Time in hours that has to pass for a deactivated listing + (e.g. due to manual deactivation or as a result of a + shortpick ) to be become active again. + type: number + type: object + required: + - action + type: object + xml: + name: ModifyListingReactivationAfterAction + ModifyLoadUnitTypeAction: + allOf: + - $ref: '#/components/schemas/AbstractModificationAction' + - additionalProperties: false + properties: + action: + description: >- + Use value 'ModifyLoadUnitType', because you want to modify a + LoadUnitType + enum: + - ModifyLoadUnitType + type: string + descriptionLocalized: + $ref: '#/components/schemas/LocaleString' + nameLocalized: + $ref: '#/components/schemas/LocaleString' + priority: + description: >- + This value gives the priority in the respective loadUnitType. + The lower the value the higher is the priority, e.g. priority 1 + is higher than priority 10. The priority can be used to order + loadUnityTypes. + example: 100 + format: int64 + maximum: 10000 + minimum: 1 + type: integer + dimensions: + $ref: '#/components/schemas/LoadUnitDimensions' + weightLimitInG: + description: 'Maximal weight in gramm(gr) the loadunit can handle. ' + type: number + minimum: 1 + required: + - action + type: object + xml: + name: ModifyLoadUnitTypeAction + RestartPickJobAction: + deprecated: true + description: >- +
+
This endpoint is deprecated and has been replaced.

@deprecated Use api/pickjobs/:id/actions instead + allOf: + - $ref: '#/components/schemas/AbstractModificationAction' + - additionalProperties: false + properties: + action: + description: >- + Use value 'RestartPickJob' to restart the pickJob and set it + back to status IN_PROGRESS. + enum: + - RestartPickJob + type: string + required: + - action + type: object + xml: + name: RestartPickJobAction + ResetPickJobAction: + deprecated: true + description: >- +
+
This endpoint is deprecated and has been replaced.

@deprecated Use api/pickjobs/:id/actions instead + allOf: + - $ref: '#/components/schemas/AbstractModificationAction' + - additionalProperties: false + properties: + action: + description: >- + Use value 'ResetPickJobAction' to reset the pickJob and set it + back to status OPEN and reset the pick line items. + enum: + - ResetPickJob + type: string + required: + - action + type: object + xml: + name: ResetPickJobAction + ModifyPickJobLastEditorAction: + allOf: + - $ref: '#/components/schemas/AbstractModificationAction' + - additionalProperties: false + properties: + action: + description: >- + Use value 'ModifyPickJobLastEditorAction' to set the last editor + to your user and therefor take over the pickjob. + enum: + - ModifyPickJobLastEditor + type: string + required: + - action + type: object + xml: + name: ModifyPickJobLastEditorAction + ModifyPickJobAction: + allOf: + - $ref: '#/components/schemas/AbstractModificationAction' + - additionalProperties: false + properties: + action: + description: Use value 'ModifyPickJob', because you want to modify a pickjob + enum: + - ModifyPickJob + type: string + preferredPickingMethods: + description: Preferred way of picking a given pickJob. + items: + $ref: '#/components/schemas/PickingMethodEnum' + type: array + paymentInformation: + $ref: '#/components/schemas/PaymentInformation' + customAttributes: + description: >- + Attributes that can be added to the pickJob. These attributes + cannot be used within fulfillment processes, but it could be + useful to have the informations carried here. + type: object + status: + $ref: '#/components/schemas/PickJobStatusUnprotected' + required: + - action + type: object + xml: + name: ModifyPickJobAction + AbortPickJobAction: + deprecated: true + description: >- +
+
This endpoint is deprecated and has been replaced.

@deprecated Use api/pickjobs/:id/actions instead + allOf: + - $ref: '#/components/schemas/AbstractModificationAction' + - additionalProperties: false + properties: + action: + description: Use value 'AbortPickJob', because you want to cancel a pickjob + enum: + - AbortPickJob + type: string + required: + - action + type: object + xml: + name: AbortPickJobAction + ModifyPickLineItemAction: + allOf: + - $ref: '#/components/schemas/AbstractModificationAction' + - properties: + action: + description: >- + Use value 'ModifyPickLineItem', because you want to modify a + pick line item + enum: + - ModifyPickLineItem + type: string + id: + description: >- + The id of this lineItem. It is generated during creation + automatically and suits as the primary identifier of the + described entity. + example: climk4dcQFiPdA5ULuhS + type: string + picked: + description: The amount of articles that were picked for this pickline. + example: 20 + format: int64 + minimum: 0 + type: integer + pickedAt: + description: Date when the line has been picked. + example: '2024-02-03T08:45:51.525Z' + format: date-time + type: string + customAttributes: + description: >- + Attributes that can be added to the pick ine item. These + attributes cannot be used within fulfillment processes, but it + could be useful to have the informations carried here. + type: object + stockEmptied: + example: true + type: boolean + stickers: + items: + $ref: '#/components/schemas/Sticker' + type: array + partialStockLocations: + items: + $ref: >- + #/components/schemas/PickJobLineItemPartialStockLocationForUpdate + scannedCodes: + description: Scanned Codes of the given picked line item + items: + $ref: '#/components/schemas/PickLineItemScannedCode' + minItems: 0 + status: + $ref: '#/components/schemas/PickLineItemStatus' + secondaryPicked: + type: integer + substituteLineItems: + description: >- +

This part of the API is currently under development. + That means that this endpoint, model, etc. can contain breaking changes + and / or might not be available at all times in your API instance. 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

+ items: + $ref: '#/components/schemas/SubstituteLineItemForCreation' + type: array + shortPickReasonLocalized: + description: Localized reason + example: '{ en_US: ''SomeName'' }' + nullable: true + $ref: '#/components/schemas/LocaleString' + required: + - id + - action + type: object + additionalProperties: false + xml: + name: ModifyPickLineItemAction + ModifyRetainedOfflineStockAction: + deprecated: true allOf: - $ref: '#/components/schemas/AbstractModificationAction' - properties: action: description: >- - Use value 'ModifyListingReactivationAfter', if you want to - modify the listingReactivationAfter of a facility + Use value 'ModifyRetainedOfflineStock', if you want to modify + the retained offline stocks of a facility enum: - - ModifyListingReactivationAfter + - ModifyRetainedOfflineStock type: string - listingReactivationAfter: - properties: - active: - default: true - description: The disabling of listings is enabled or disabled. - type: boolean - value: - default: 24 - description: >- - Time in hours that has to pass for a deactivated listing - (e.g. due to manual deactivation or as a result of a - shortpick ) to be become active again. - type: number - type: object + active: + description: The retained Offline Stock is enabled or disabled. + type: boolean + value: + default: 0.2 + description: >- + The overall percentage of stock that should be reserved to + offline clients. + example: 0.15 + maximum: 1 + minimum: 0.01 + type: number required: - action type: object xml: - name: ModifyListingReactivationAfterAction - ModifyLoadUnitTypeAction: + name: ModifyRetainedOfflineStockAction + ModifyReturnAction: allOf: - $ref: '#/components/schemas/AbstractModificationAction' - additionalProperties: false properties: action: - description: >- - Use value 'ModifyLoadUnitType', because you want to modify a - LoadUnitType enum: - - ModifyLoadUnitType + - ModifyReturn type: string - descriptionLocalized: - $ref: '#/components/schemas/LocaleString' - nameLocalized: - $ref: '#/components/schemas/LocaleString' - priority: - description: >- - This value gives the priority in the respective loadUnitType. - The lower the value the higher is the priority, e.g. priority 1 - is higher than priority 10. The priority can be used to order - loadUnityTypes. - example: 100 - format: int64 - maximum: 10000 - minimum: 1 - type: integer - dimensions: - $ref: '#/components/schemas/LoadUnitDimensions' - weightLimitInG: - description: 'Maximal weight in gramm(gr) the loadunit can handle. ' - type: number - minimum: 1 + status: + $ref: '#/components/schemas/ReturnStatus' required: - action type: object xml: - name: ModifyLoadUnitTypeAction - ModifyOrderSplitAction: + name: ModifyReturnAction + ModifyReturnLineItemAction: allOf: - $ref: '#/components/schemas/AbstractModificationAction' - properties: action: description: >- - Use value 'ModifyOrderSplit', because you want to modify the - configuration for the an order split. + Use value 'ModifyReturnLineItem', because you want to modify a + return line item enum: - - ModifyOrderSplit + - ModifyReturnLineItem type: string - active: - default: false - type: boolean - shouldUseWaitingRoomForPreBackOrderItems: - default: false - type: boolean - activeForSameDay: - default: false - type: boolean - fixedCountConfiguration: - $ref: '#/components/schemas/FixedCountConfiguration' - orderSplitType: - $ref: '#/components/schemas/OrderSplitType' + id: + description: Id of the return line item you want to update + type: string + returned: + $ref: '#/components/schemas/Returned' + status: + $ref: '#/components/schemas/ReturnLineStatus' required: + - id - action + - returned type: object xml: - name: ModifyOrderSplitAction - RestartPickJobAction: - deprecated: true - description: >- -
-
This endpoint is deprecated and has been replaced.

@deprecated Use api/pickjobs/:id/actions instead + name: ModifyReturnLineItemAction + ModifyShipmentAction: allOf: - $ref: '#/components/schemas/AbstractModificationAction' - additionalProperties: false properties: action: description: >- - Use value 'RestartPickJob' to restart the pickJob and set it - back to status IN_PROGRESS. + Use value 'ModifyShipment', because you want to modify a + shipment enum: - - RestartPickJob + - ModifyShipment + type: string + carrierRef: + description: >- + The reference to the carrier for which the shipment is assigned + to + example: ca525716-7208-4a63-a2a6-11274eb37f67-0 + type: string + carrierProduct: + description: Desired product of given carrier to choose when ordering a label type: string + example: EXPRESS + pickJobRef: + description: >- + The reference to the pickjob for which the shipment is assigned + to + example: ca525716-7208-4a63-a2a6-11274eb37f67-0 + type: string + paymentInformation: + $ref: '#/components/schemas/PaymentInformation' + status: + $ref: '#/components/schemas/ShipmentStatus' + targetAddress: + $ref: '#/components/schemas/ConsumerAddress' required: - action type: object xml: - name: RestartPickJobAction - ResetPickJobAction: - deprecated: true - description: >- -
-
This endpoint is deprecated and has been replaced.

@deprecated Use api/pickjobs/:id/actions instead + name: ModifyShipmentAction + ModifyShortpickAction: allOf: - $ref: '#/components/schemas/AbstractModificationAction' - - additionalProperties: false - properties: + - properties: action: description: >- - Use value 'ResetPickJobAction' to reset the pickJob and set it - back to status OPEN and reset the pick line items. + Use value 'ModifyShortpick', if you want to modify the + ModifyShortPick of a facility enum: - - ResetPickJob + - ModifyShortpick type: string + active: + default: true + description: Inventory adjustment in the case of insufficient order picking + type: boolean required: - action type: object xml: - name: ResetPickJobAction - ModifyPickJobLastEditorAction: + name: ModifyShortpickAction + ModifyUserAction: allOf: - $ref: '#/components/schemas/AbstractModificationAction' - additionalProperties: false properties: action: - description: >- - Use value 'ModifyPickJobLastEditorAction' to set the last editor - to your user and therefor take over the pickjob. + description: Use value 'ModifyUser', because you want to modify a user enum: - - ModifyPickJobLastEditor + - ModifyUser + type: string + firstname: + example: Alex + type: string + lastname: + example: Schneider + type: string + locale: + $ref: '#/components/schemas/SupportedLocale' + password: + example: fsdf6556 + minLength: 6 type: string + roles: + $ref: '#/components/schemas/UserRoles' + assignedFacilities: + items: + $ref: '#/components/schemas/UserAssignedFacilityForCreation' + type: array + customAttributes: + nullable: true + description: >- + Attributes that can be added to the user. These attributes + **cannot** be used within fulfillment processes, but enable you + to attach custom data from your systems to fulfillmenttools + entities. + type: object required: - action type: object xml: - name: ModifyPickJobLastEditorAction - ModifyPickJobAction: + name: ModifyUserAction + OrderInformation: + properties: + orderDate: + description: The date the order was created. + example: '2020-02-03T08:45:50.525Z' + format: date-time + type: string + orderNumber: + description: An identifier for the order. + example: R456728546 + pattern: ^.+$ + type: string + type: object + MeasurementValidation: + properties: + shortPickSoftTolerancePercentage: + description: Allowed soft short pick deviation tolerance. + example: 10 + minimum: 0 + maximum: 100 + type: number + shortPickHardTolerancePercentage: + description: Allowed hard short pick deviation tolerance. + example: 15 + minimum: 0 + maximum: 100 + type: number + overPickSoftTolerancePercentage: + description: Allowed soft over pick deviation tolerance. + example: 15 + minimum: 0 + type: number + overPickHardTolerancePercentage: + description: Allowed hard over pick deviation tolerance. + example: 20 + minimum: 0 + type: number + OrderStatus: + description: The state of the order. Initially it is OPEN. + enum: + - OPEN + - CANCELLED + - PROMISED + - LOCKED + - OBSOLETE + type: string + ParcelDimensions: + properties: + height: + description: The height of the package (in cm) + example: 50 + type: number + length: + description: The length of the package (in cm) + example: 100 + type: number + weight: + description: The weight of the package (in g) + example: 1700 + type: number + width: + description: The width of the package (in cm) + example: 25 + type: number + type: object + ParcelServices: + additionalProperties: false + properties: + bulkyGoods: + type: boolean + signature: + type: boolean + Parcel: + additionalProperties: false allOf: - - $ref: '#/components/schemas/AbstractModificationAction' - - additionalProperties: false - properties: - action: - description: Use value 'ModifyPickJob', because you want to modify a pickjob - enum: - - ModifyPickJob + - $ref: '#/components/schemas/VersionedResource' + - properties: + anonymized: + description: Indicates if gdpr related data was anonymized + example: false + type: boolean + carrierRef: + description: Reference to the carrier this parcel should be send by + example: cf00e102-34f2-45c1-a846-6a21f384321e type: string - preferredPickingMethods: - description: Preferred way of picking a given pickJob. - items: - $ref: '#/components/schemas/PickingMethodEnum' - type: array - paymentInformation: - $ref: '#/components/schemas/PaymentInformation' + carrierProduct: + description: Desired product of given carrier to choose when ordering a label + type: string + example: EXPRESS customAttributes: description: >- - Attributes that can be added to the pickJob. These attributes + Attributes that can be added to the parcel. These attributes cannot be used within fulfillment processes, but it could be - useful to have the informations carried here. + useful to have the information carried here. type: object + dimensions: + $ref: '#/components/schemas/ParcelDimensions' + services: + $ref: '#/components/schemas/ParcelServices' + id: + description: >- + The id of this parcel. It is generated during creation + automatically and suits as the primary identifier of the + described entity. + example: 95EWrieX09OmeriXIUbb + type: string + documentsRef: + description: Reference to the documents collection from this entity + type: string + loadUnitRefs: + description: Reference to array of load unit Refs + items: + type: string + type: array + recipient: + $ref: '#/components/schemas/ConsumerAddress' + invoice: + $ref: '#/components/schemas/ConsumerAddress' + processRef: + type: string + operativeProcessRef: + type: string + items: + items: + $ref: '#/components/schemas/ParcelItem' + type: array + postalCharges: + $ref: '#/components/schemas/ParcelPostalCharge' + returnAddress: + $ref: '#/components/schemas/FacilityAddress' + result: + $ref: '#/components/schemas/ParcelResult' + sender: + $ref: '#/components/schemas/FacilityAddress' + shipmentRef: + description: The id of this shipment this parcel has been created for. + example: 95EWrieX09OmeriXIUbb + type: string status: - $ref: '#/components/schemas/PickJobStatusUnprotected' + $ref: '#/components/schemas/ParcelStatus' + paymentInformation: + $ref: '#/components/schemas/PaymentInformation' + pickUpInformation: + $ref: '#/components/schemas/ParcelPickUpInformation' + productValue: + description: >- + Monetary value of all goods in this parcel. Needed for sending + cross border packages (customs) To be interpreted as money in + the currency given under paymentInformation.currency + type: number + example: 12.5 + transfers: + type: array + minItems: 0 + items: + $ref: '#/components/schemas/OperativeTransfer' required: - - action + - id + - status + - carrierRef + - shipmentRef + - processRef + - sender + - recipient + - loadUnitRefs + type: object + ParcelForCreation: + additionalProperties: false + properties: + status: + $ref: '#/components/schemas/ParcelStatus' + carrierProduct: + description: Desired product of given carrier to choose when ordering a label + type: string + example: EXPRESS + customAttributes: + description: >- + Attributes that can be added to the parcel. These attributes cannot + be used within fulfillment processes, but it could be useful to have + the information carried here. type: object + dimensions: + $ref: '#/components/schemas/ParcelDimensions' + services: + $ref: '#/components/schemas/ParcelServices' + loadUnitRefs: + description: Reference to array of load unit Refs + items: + type: string + type: array + items: + items: + $ref: '#/components/schemas/ParcelItem' + type: array + recipient: + $ref: '#/components/schemas/ConsumerAddress' + invoice: + $ref: '#/components/schemas/ConsumerAddress' + sender: + $ref: '#/components/schemas/FacilityAddress' + returnAddress: + $ref: '#/components/schemas/FacilityAddress' + paymentInformation: + $ref: '#/components/schemas/PaymentInformation' + pickUpInformation: + $ref: '#/components/schemas/ParcelPickUpInformation' + productValue: + description: >- + Monetary value of all goods in this parcel. Needed for sending cross + border packages (customs) To be interpreted as money in the currency + given under paymentInformation.currency + type: number + example: 12.5 + result: + $ref: '#/components/schemas/ParcelResult' + transfers: + type: array + minItems: 0 + items: + $ref: '#/components/schemas/OperativeTransfer' + type: object + ParcelPickUpInformation: + additionalProperties: false + properties: + startTime: + description: needs to be before end time + format: date-time + type: string + endTime: + description: needs to be after start time + format: date-time + type: string + required: + - startTime + - endTime + ParcelPostalCharge: + properties: + value: + type: number + description: Monetary Value in the given currency + example: 15.5 + currency: + type: string + description: Currency of the given value + example: EUR + required: + - currency + - value + ParcelItem: + properties: + quantity: + type: integer + minimum: 1 + description: amount of the given items + example: 5 + hsCode: + type: string + maxLength: 50 + description: + description: Description of the given item/items + example: Item Description + type: string + weightInGram: + type: integer + description: Weight of a single item in gram + example: 10000 + parcelItemValue: + $ref: '#/components/schemas/ParcelItemValue' + countryOfManufacture: + type: string + article: + $ref: '#/components/schemas/ParcelItemArticle' + required: + - quantity + type: object xml: - name: ModifyPickJobAction - AbortPickJobAction: - deprecated: true - description: >- -
-
This endpoint is deprecated and has been replaced.

@deprecated Use api/pickjobs/:id/actions instead + name: ParcelItem + ParcelItemArticle: allOf: - - $ref: '#/components/schemas/AbstractModificationAction' - - additionalProperties: false - properties: - action: - description: Use value 'AbortPickJob', because you want to cancel a pickjob - enum: - - AbortPickJob - type: string - required: - - action + - $ref: '#/components/schemas/AbstractArticle' + - properties: + attributes: + items: + $ref: '#/components/schemas/ArticleAttributeItem' + type: array type: object xml: - name: AbortPickJobAction - ModifyPickLineItemAction: + name: ParcelItemArticle + ParcelItemValue: + properties: + value: + type: number + description: Monetary Value of a single item in the given currency + example: 15.5 + currency: + type: string + description: Currency of the given value + example: EUR + required: + - value + - currency + type: object + ParcelStatus: + enum: + - OPEN + - PROCESSING + - DONE + - FAILED + - CANCELED + - OBSOLETE + - WAITING_FOR_INPUT + type: string + UserModificationHistory: + additionalProperties: false + type: object + required: + - modificationDate + - username + properties: + userId: + description: ID of the user who commited this modification + type: string + username: + description: Username of the user who commited this modification + type: string + modificationDate: + format: date-time + type: string + PickJob: allOf: - - $ref: '#/components/schemas/AbstractModificationAction' + - $ref: '#/components/schemas/PickJobForCreation' + - $ref: '#/components/schemas/VersionedResource' - properties: - action: - description: >- - Use value 'ModifyPickLineItem', because you want to modify a - pick line item - enum: - - ModifyPickLineItem - type: string + usersModificationHistory: + type: array + items: + $ref: '#/components/schemas/UserModificationHistory' + anonymized: + description: Indicates if gdpr related data was anonymized + example: false + type: boolean + deliveryinformation: + $ref: '#/components/schemas/PickjobDeliveryInformation' + editor: + $ref: '#/components/schemas/Editor' id: description: >- - The id of this lineItem. It is generated during creation + The id of this pickjob. It is generated during creation automatically and suits as the primary identifier of the described entity. - example: climk4dcQFiPdA5ULuhS + example: Esb20gpHBL94X5NdMp3C type: string - picked: - description: The amount of articles that were picked for this pickline. - example: 20 - format: int64 - minimum: 0 - type: integer - customAttributes: - description: >- - Attributes that can be added to the pick ine item. These - attributes cannot be used within fulfillment processes, but it - could be useful to have the informations carried here. - type: object - stockEmptied: - example: true - type: boolean - stickers: + pickLineItems: items: - $ref: '#/components/schemas/Sticker' + $ref: '#/components/schemas/PickLineItem' type: array - partialStockLocations: - items: - $ref: >- - #/components/schemas/PickJobLineItemPartialStockLocationForUpdate - scannedCodes: - description: Scanned Codes of the given picked line item - items: - $ref: '#/components/schemas/PickLineItemScannedCode' - minItems: 0 - status: - $ref: '#/components/schemas/PickLineItemStatus' - secondaryPicked: - type: integer - substituteLineItems: - description: >- -

This part of the API is currently under development. - That means that this endpoint, model, etc. can contain breaking changes - and / or might not be available at all times in your API instance. 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

+ expectedPickLineItems: items: - $ref: '#/components/schemas/SubstituteLineItemForCreation' + $ref: '#/components/schemas/ExpectedPickLineItem' type: array - required: - - id - - action - type: object - additionalProperties: false - xml: - name: ModifyPickLineItemAction - ModifyPrioritizationAction: - allOf: - - $ref: '#/components/schemas/AbstractModificationAction' - - properties: - action: + shortId: description: >- - Use value 'ModifyPrioritization', because you want to modify - prioritization. - enum: - - ModifyPrioritization + A short identifier that helps assigning a pickJob to a customer. + This is automatically created during creation. + example: AS12 type: string - active: + status: + $ref: '#/components/schemas/PickJobStatus' + pickRunRef: + type: string + description: Pick run id to which the pick job belongs + tags: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/TagReference' + documentHandling: + $ref: '#/components/schemas/DocumentHandling' + resetBlocked: type: boolean - id: + default: false + description: Indicates if pickJob can still be resetted or restarted + documentsRef: + description: Reference to the documents collection from this entity type: string - name: + statusReason: type: string + description: >- + The reason for the current status. Currently, only reroute + reasons are supported. + pickingZones: + type: array + items: + $ref: '#/components/schemas/PickingZone' required: - - action - id + - status + - pickLineItems + - shortId + - deliveryinformation + - documentsRef + type: object + PickJobForCreation: + properties: + operativeProcessRef: + type: string + customAttributes: + description: >- + Attributes that can be added to the pickjob. These attributes cannot + be used within fulfillment processes, but it could be useful to have + the informations carried here. type: object + deliveryinformation: + $ref: '#/components/schemas/PickjobDeliveryInformationForCreation' + facilityRef: + description: >- + The id of the facility reference. The given ID has to be present in + the system. + example: Esb20gpHBL94X5NdMp3C + type: string + orderDate: + description: The date this order was created at the supplying system. + example: '2020-02-03T08:45:50.525Z' + format: date-time + type: string + orderRef: + description: >- + The id of the order reference. The given ID has to be present in the + system. + example: LGMl2DuvPnfPoSHhYFOm + type: string + pickLineItems: + items: + $ref: '#/components/schemas/PickLineItemForCreation' + minItems: 0 + type: array + expectedPickLineItems: + items: + $ref: '#/components/schemas/ExpectedPickLineItemForCreation' + minItems: 0 + type: array + paymentInformation: + $ref: '#/components/schemas/PaymentInformation' + processId: + description: >- + Id of the global process related to this entity. For example used + for starting the GDPR process and others. + type: string + shortId: + description: A short identifier that helps assigning a pick job to a customer. + example: AS12 + type: string + status: + $ref: '#/components/schemas/PickJobStatus' + tenantOrderId: + description: >- + Field can be used as a reference number in foreign systems, for + example as a reference to the source system's identifier for this + order. + example: R456728546 + type: string + tags: + description: >- + Tags can only be set when there is no process related with this + pickJob. Setting processId and tags will lead to an validationError. + type: array + minItems: 1 + items: + $ref: '#/components/schemas/TagReference' + stickers: + type: array + minItems: 0 + items: + $ref: '#/components/schemas/Sticker' + routingPlanRef: + description: Reference to the routingplan which created this pickjob + type: string + preferredPickingMethods: + description: Preferred way of picking a given pickJob. + items: + $ref: '#/components/schemas/PickingMethodEnum' + type: array + transfers: + type: array + minItems: 0 + items: + $ref: '#/components/schemas/OperativeTransfer' + required: + - orderDate + - facilityRef + - pickLineItems + additionalProperties: false + type: object xml: - name: ModifyPrioritizationAction - ModifyRatingAction: + name: Pickjob + PickingZone: + description: Zones from which items can be picked + properties: + zoneRef: + type: string + required: + - zoneRef + PaymentInformation: + properties: + currency: + description: The currency in which the consumer paid with + example: EUR + type: string + type: object + ProductInformation: + properties: + productName: + description: The name of the product used by the carrier + example: Express + type: string + mandatoryShippingAttributes: + type: array + items: + $ref: '#/components/schemas/MandatoryShippingAttribute' + mandatoryShippingItemAttributes: + type: array + items: + $ref: '#/components/schemas/MandatoryShippingItemAttribute' + PickJobStatusUnprotected: + description: >- + The status of a pickjob. These are the status that are still allowed to + be used in the deprecated status field of ModifyPickJob actions + enum: + - OPEN + - IN_PROGRESS + - CLOSED + - PICKED + - REROUTED + - REJECTED + - RESTOWED + - EXPIRED + - WAITING_FOR_INPUT + type: string + xml: + name: PickJobStatusUnprotected + PickJobStatus: + description: The status of a pickjob. + enum: + - ABORTED + - OPEN + - IN_PROGRESS + - CLOSED + - PICKED + - REROUTED + - REJECTED + - RESTOWED + - EXPIRED + - CANCELED + - OBSOLETE + - WAITING_FOR_INPUT + type: string + xml: + name: PickJobStatus + PickJobLineItemPartialStockLocationForUpdate: + properties: + tenantPartialStockId: + type: string + picked: + example: 21 + format: int64 + minimum: 0 + type: number + stockEmptied: + example: true + type: boolean + required: + - tenantPartialStockId + - picked + type: object + PickJobLineItemPartialStockLocation: allOf: - - $ref: '#/components/schemas/AbstractModificationAction' + - $ref: '#/components/schemas/PickJobLineItemPartialStockLocationForCreation' + properties: + picked: + example: 21 + format: int64 + minimum: 0 + type: number + stockEmptied: + example: true + type: boolean + required: + - tenantPartialStockId + type: object + PickJobLineItemPartialStockLocationForCreation: + properties: + tenantPartialStockId: + type: string + quantity: + description: >- + quantity of the specific article that should be picked from given + stockLocation + example: 21 + format: int64 + minimum: 0 + type: number + available: + example: 21 + format: int64 + minimum: 0 + type: number + ratingScore: + type: number + sequenceScore: + type: number + location: + $ref: '#/components/schemas/Location' + stockProperties: + anyOf: + - $ref: '#/components/schemas/PickingStockPropertyPreset' + - $ref: '#/components/schemas/PickingStockProperty' + required: + - tenantPartialStockId + type: object + SubstituteLineItemPartialStockLocation: + properties: + quantity: + example: 21 + format: int64 + minimum: 0 + type: number + location: + $ref: '#/components/schemas/Location' + required: + - location + - quantity + type: object + PickLineItemArticle: + allOf: + - $ref: '#/components/schemas/AbstractArticle' - properties: - action: - description: Use value 'ModifyRating', because you want to modify a rating. - enum: - - ModifyRating - type: string - active: - type: boolean - description: - type: string - id: - type: string - maxPenalty: - example: 100 - type: number - name: - type: string - required: - - action - - id + attributes: + items: + $ref: '#/components/schemas/ArticleAttributeItem' + type: array + prices: + items: + $ref: '#/components/schemas/ArticlePrice' + type: array type: object xml: - name: ModifyRatingAction - ModifyRetainedOfflineStockAction: + name: PickLineItemArticle + ArticlePrice: + additionalProperties: false + type: object + properties: + pricePerUnit: + type: number + example: 9.99 + description: Price value for a given currency per unit + minimum: 0 + currency: + description: The currency of the price as an ISO 4217 code. + example: EUR + nullable: true + allOf: + - $ref: '#/components/schemas/CurrencyCode' + required: + - pricePerUnit + - currency + ReturnedLineItemRefundPrice: + additionalProperties: false + properties: + value: + example: 20.55 + description: 0.0 till line item price that should be refunded + type: number + currency: + description: The currency of the price as an ISO 4217 code. + example: EUR + allOf: + - $ref: '#/components/schemas/CurrencyCode' + required: + - value + - currency + PickingPatchActions: + properties: + actions: + items: + anyOf: + - $ref: '#/components/schemas/ModifyPickLineItemAction' + - $ref: '#/components/schemas/ModifyPickJobAction' + - $ref: '#/components/schemas/ModifyPickJobLastEditorAction' + - $ref: '#/components/schemas/RestartPickJobAction' + - $ref: '#/components/schemas/ResetPickJobAction' + - $ref: '#/components/schemas/AbortPickJobAction' + minItems: 1 + type: array + version: + description: >- + The version of the document to be used in optimistic locking + mechanisms. + example: 42 + format: int64 + type: integer + required: + - version + - actions + type: object + xml: + name: PickingPatchActions + PickRunPatchAction: + properties: + actions: + items: + anyOf: + - $ref: '#/components/schemas/ModifyPickRunLineItemAction' + - $ref: '#/components/schemas/StartPickRunAction' + - $ref: '#/components/schemas/CancelPickRunAction' + - $ref: '#/components/schemas/FinishPickRunAction' + minItems: 1 + type: array + version: + description: >- + The version of the document to be used in optimistic locking + mechanisms. + example: 42 + format: int64 + type: integer + required: + - version + - actions + type: object + xml: + name: PickRunPatchAction + PickRunPickJobsPatchAction: + properties: + actions: + items: + anyOf: + - $ref: '#/components/schemas/RemovePickJobFromPickRunAction' + minItems: 1 + maxItems: 1 + type: array + version: + description: >- + The version of the document to be used in optimistic locking + mechanisms. + example: 42 + format: int64 + type: integer + required: + - version + - actions + type: object + xml: + name: PickRunPickJobsPatchAction + CancelPickRunAction: deprecated: true - allOf: - - $ref: '#/components/schemas/AbstractModificationAction' - - properties: - action: - description: >- - Use value 'ModifyRetainedOfflineStock', if you want to modify - the retained offline stocks of a facility - enum: - - ModifyRetainedOfflineStock - type: string - active: - description: The retained Offline Stock is enabled or disabled. - type: boolean - value: - default: 0.2 - description: >- - The overall percentage of stock that should be reserved to - offline clients. - example: 0.15 - maximum: 1 - minimum: 0.01 - type: number - required: - - action - type: object - xml: - name: ModifyRetainedOfflineStockAction - ModifyReturnAction: + description: >- +
+
This endpoint is deprecated and has been replaced.

@deprecated Use api/pickruns/:id/actions instead allOf: - $ref: '#/components/schemas/AbstractModificationAction' - additionalProperties: false properties: action: + description: Use value 'CancelPickRun', because you want to cancel a pickrun enum: - - ModifyReturn - type: string - status: - $ref: '#/components/schemas/ReturnStatus' - required: - - action - type: object - xml: - name: ModifyReturnAction - ModifyReturnLineItemAction: - allOf: - - $ref: '#/components/schemas/AbstractModificationAction' - - properties: - action: - description: >- - Use value 'ModifyReturnLineItem', because you want to modify a - return line item - enum: - - ModifyReturnLineItem - type: string - id: - description: Id of the return line item you want to update + - CancelPickRun type: string - returned: - $ref: '#/components/schemas/Returned' - status: - $ref: '#/components/schemas/ReturnLineStatus' required: - - id - action - - returned type: object xml: - name: ModifyReturnLineItemAction - ModifyRoutingPlanAction: + name: CancelPickRunAction + StartPickRunAction: + deprecated: true + description: >- +
+
This endpoint is deprecated and has been replaced.

@deprecated Use api/pickruns/:id/actions instead allOf: - $ref: '#/components/schemas/AbstractModificationAction' - additionalProperties: false properties: action: - description: >- - Use value 'ModifyRoutingPlan', because you want to modify a - routing plan + description: Use value 'StartPickRun', because you want to start a pickrun enum: - - ModifyRoutingPlan - type: string - facilityRef: - description: >- - The id of the facility reference. The given ID has to be present - in the system. - example: Esb20gpHBL94X5NdMp3C + - StartPickRun type: string - status: - $ref: '#/components/schemas/RoutingPlanStatus' - description: The new status for the routing plan required: - action type: object xml: - name: ModifyRoutingPlanAction - ModifyShipmentAction: + name: StartPickRunAction + FinishPickRunAction: + deprecated: true + description: >- +
+
This endpoint is deprecated and has been replaced.

@deprecated Use api/pickruns/:id/actions instead allOf: - $ref: '#/components/schemas/AbstractModificationAction' - additionalProperties: false properties: action: - description: >- - Use value 'ModifyShipment', because you want to modify a - shipment + description: Use value 'FinishPickRun', because you want to finish a pickrun enum: - - ModifyShipment - type: string - carrierRef: - description: >- - The reference to the carrier for which the shipment is assigned - to - example: ca525716-7208-4a63-a2a6-11274eb37f67-0 - type: string - carrierProduct: - description: Desired product of given carrier to choose when ordering a label - type: string - example: EXPRESS - pickJobRef: - description: >- - The reference to the pickjob for which the shipment is assigned - to - example: ca525716-7208-4a63-a2a6-11274eb37f67-0 + - FinishPickRun type: string - paymentInformation: - $ref: '#/components/schemas/PaymentInformation' - status: - $ref: '#/components/schemas/ShipmentStatus' - targetAddress: - $ref: '#/components/schemas/ConsumerAddress' required: - action type: object xml: - name: ModifyShipmentAction - ModifyShortpickAction: - allOf: - - $ref: '#/components/schemas/AbstractModificationAction' - - properties: - action: - description: >- - Use value 'ModifyShortpick', if you want to modify the - ModifyShortPick of a facility - enum: - - ModifyShortpick + name: FinishPickRunAction + PickJobActionsParameter: + anyOf: + - $ref: '#/components/schemas/PickJobAbortActionParameter' + - $ref: '#/components/schemas/PickJobRestartActionParameter' + - $ref: '#/components/schemas/PickJobResetActionParameter' + - $ref: '#/components/schemas/PickJobObsoleteActionParameter' + - $ref: '#/components/schemas/ModifyPickLineItemsActionParameter' + PickJobAbortActionParameter: + additionalProperties: false + properties: + name: + $ref: '#/components/schemas/PickJobAbortActionEnum' + version: + description: Version of the entity to be changed + minimum: 0 + type: integer + required: + - name + - version + PickJobAbortActionEnum: + enum: + - ABORT + type: string + PickJobRestartActionParameter: + additionalProperties: false + properties: + name: + $ref: '#/components/schemas/PickJobRestartActionEnum' + version: + description: Version of the entity to be changed + minimum: 0 + type: integer + required: + - name + - version + PickJobRestartActionEnum: + enum: + - RESTART + type: string + PickJobObsoleteActionParameter: + additionalProperties: false + properties: + name: + $ref: '#/components/schemas/PickJobObsoleteActionEnum' + version: + description: Version of the entity to be changed + minimum: 0 + type: integer + required: + - name + - version + ModifyPickLineItemsActionParameter: + additionalProperties: false + properties: + name: + $ref: '#/components/schemas/ModifyPickJobLineItemsActionEnum' + version: + description: Version of the entity to be changed + minimum: 0 + type: integer + pickJobLineItemUpdates: + items: + $ref: '#/components/schemas/PickLineItemUpdate' + minItems: 1 + required: + - name + - version + - pickJobLineItemUpdates + PickLineItemUpdate: + properties: + id: + description: >- + The id of this lineItem. It is generated during creation + automatically and suits as the primary identifier of the described + entity. + example: climk4dcQFiPdA5ULuhS + type: string + picked: + description: The amount of articles that were picked for this pickline. + example: 20 + format: int64 + minimum: 0 + type: integer + pickedAt: + description: >- + Date when the line has been picked. example: + '2024-02-03T08:45:51.525Z' format: date-time type: string + customAttributes: + description: >- + Attributes that can be added to the pick ine item. These attributes + cannot be used within fulfillment processes, but it could be useful + to have the informations carried here. + type: object + stockEmptied: + example: true + type: boolean + stickers: + items: + $ref: '#/components/schemas/Sticker' + type: array + partialStockLocations: + items: + $ref: '#/components/schemas/PickJobLineItemPartialStockLocationForUpdate' + scannedCodes: + description: Scanned Codes of the given picked line item + items: + $ref: '#/components/schemas/PickLineItemScannedCode' + minItems: 0 + status: + $ref: '#/components/schemas/PickLineItemStatus' + secondaryPicked: + type: integer + substituteLineItems: + description: >- +

This part of the API is currently under development. + That means that this endpoint, model, etc. can contain breaking changes + and / or might not be available at all times in your API instance. 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

+ items: + $ref: '#/components/schemas/SubstituteLineItemForCreation' + type: array + shortPickReason: + properties: + reasonLocalized: + description: Localized reason + example: '{ en_US: ''SomeName'' }' + $ref: '#/components/schemas/LocaleString' + required: + - id + type: object + additionalProperties: false + ModifyPickJobLineItemsActionEnum: + enum: + - MODIFY_PICK_JOB_LINE_ITEMS + type: string + PickJobObsoleteActionEnum: + enum: + - OBSOLETE + type: string + PickJobResetActionParameter: + additionalProperties: false + properties: + name: + $ref: '#/components/schemas/PickJobResetActionEnum' + version: + description: Version of the entity to be changed + minimum: 0 + type: integer + required: + - name + - version + PickJobResetActionEnum: + enum: + - RESET + type: string + PackingTargetContainerActionsParameter: + anyOf: + - $ref: '#/components/schemas/UpdatePackingTargetContainerLineItemAction' + - $ref: >- + #/components/schemas/ReplacePackingTargetContainerLineItemCodesAction + UpdatePackingTargetContainerLineItemAction: + additionalProperties: false + properties: + name: + $ref: '#/components/schemas/UpdatePackingTargetContainerLineItemEnum' + version: + description: Version of the entity to be changed + minimum: 0 + type: integer + payload: + additionalProperties: false + properties: + lineItem: + $ref: '#/components/schemas/PackingTargetContainerLineItem' + required: + - lineItem + required: + - version + - payload + - name + UpdatePackingTargetContainerLineItemEnum: + enum: + - UpdateLineItem + type: string + ReplacePackingTargetContainerLineItemCodesEnum: + enum: + - ReplaceLineItemCodes + type: string + ReplacePackingTargetContainerLineItemCodesAction: + additionalProperties: false + properties: + name: + $ref: '#/components/schemas/ReplacePackingTargetContainerLineItemCodesEnum' + version: + description: Version of the entity to be changed + minimum: 0 + type: integer + payload: + additionalProperties: false + properties: + codes: + items: + description: List of codes + type: string + minItems: 1 + type: array + required: + - codes + required: + - payload + - version + - name + PickRunActionsParameter: + anyOf: + - $ref: '#/components/schemas/PickRunStartActionParameter' + - $ref: '#/components/schemas/PickRunFinishActionParameter' + - $ref: '#/components/schemas/PickRunCancelActionParameter' + - $ref: '#/components/schemas/PickRunRemovePickJobActionParameter' + PickRunFinishActionParameter: + additionalProperties: false + properties: + name: + $ref: '#/components/schemas/PickRunFinishActionEnum' + version: + description: Version of the entity to be changed + minimum: 0 + type: integer + required: + - name + - version + PickRunFinishActionEnum: + enum: + - FINISH + type: string + PickRunStartActionParameter: + additionalProperties: false + properties: + name: + $ref: '#/components/schemas/PickRunStartActionEnum' + version: + description: Version of the entity to be changed + minimum: 0 + type: integer + required: + - name + - version + PickRunStartActionEnum: + enum: + - START + type: string + PickRunRemovePickJobActionParameter: + additionalProperties: false + properties: + name: + $ref: '#/components/schemas/PickRunRemovePickJobActionEnum' + version: + description: Version of the entity to be changed + minimum: 0 + type: integer + payload: + additionalProperties: false + properties: + pickJobId: type: string - active: - default: true - description: Inventory adjustment in the case of insufficient order picking - type: boolean + example: 4baaa052-7286-4dc2-937f-6e703ece25ac required: - - action - type: object - xml: - name: ModifyShortpickAction - ModifyTimingModeAction: + - pickJobId + required: + - name + - version + - payload + PickRunRemovePickJobActionEnum: + enum: + - REMOVE_PICK_JOB + type: string + PickRunCancelActionParameter: + additionalProperties: false + properties: + name: + $ref: '#/components/schemas/PickRunCancelActionEnum' + version: + description: Version of the entity to be changed + minimum: 0 + type: integer + required: + - name + - version + PickRunCancelActionEnum: + enum: + - CANCEL + type: string + HandoverJobActionsParameter: + anyOf: + - $ref: '#/components/schemas/HandoverJobCancelActionParameter' + HandoverJobCancelActionParameter: + additionalProperties: false + properties: + name: + $ref: '#/components/schemas/HandoverJobCancelActionEnum' + version: + description: Version of the entity to be changed + minimum: 0 + type: integer + payload: + additionalProperties: false + properties: + handoverJobCancelReason: + $ref: '#/components/schemas/HandoverJobCancelReason' + required: + - handoverJobCancelReason + required: + - name + - version + - payload + HandoverJobCancelActionEnum: + enum: + - CANCEL + type: string + ModifyPickRunLineItemAction: allOf: - $ref: '#/components/schemas/AbstractModificationAction' - properties: action: description: >- - Use value 'ModifyTimingMode', because you want to modify a - timing mode. - enum: - - ModifyTimingMode - type: string - timingMode: - $ref: '#/components/schemas/RoutingConfigurationTiming' - description: Selects the desired routing timing - required: - - action - type: object - xml: - name: ModifyTimingModeAction - ModifyUserAction: - allOf: - - $ref: '#/components/schemas/AbstractModificationAction' - - additionalProperties: false - properties: - action: - description: Use value 'ModifyUser', because you want to modify a user + Use value 'ModifyPickRunLineItem', because you want to modify a + pick line item enum: - - ModifyUser - type: string - firstname: - example: Alex - type: string - lastname: - example: Schneider + - ModifyPickRunLineItem type: string - locale: - $ref: '#/components/schemas/SupportedLocale' - password: - example: fsdf6556 - minLength: 6 + id: + description: >- + The id of this lineItem. It is generated during creation + automatically and suits as the primary identifier of the + described entity. + example: climk4dcQFiPdA5ULuhS type: string - roles: - $ref: '#/components/schemas/UserRoles' - assignedFacilities: + picked: + description: The amount of articles that were picked for this pickline. + example: 20 + format: int64 + minimum: 0 + type: integer + status: + $ref: '#/components/schemas/PickLineItemStatus' + partialStockLocations: items: - $ref: '#/components/schemas/UserAssignedFacilityForCreation' - type: array - customAttributes: - nullable: true - description: >- - Attributes that can be added to the user. These attributes - **cannot** be used within fulfillment processes, but enable you - to attach custom data from your systems to fulfillmenttools - entities. - type: object + $ref: >- + #/components/schemas/PickJobLineItemPartialStockLocationForUpdate required: + - id - action type: object xml: - name: ModifyUserAction - Order: + name: ModifyPickRunLineItemAction + RemovePickJobFromPickRunAction: + deprecated: true + description: >- +
+
This endpoint is deprecated and has been replaced.

@deprecated Use /api/pickruns/{pickRunId}/actions instead allOf: - - $ref: '#/components/schemas/OrderForCreation' - - $ref: '#/components/schemas/VersionedResource' - - properties: - anonymized: - description: Indicates if gdpr related data was anonymized - example: false - type: boolean - id: + - $ref: '#/components/schemas/AbstractModificationAction' + - additionalProperties: false + properties: + action: description: >- - The id of this order. It is generated during creation - automatically and suits as the primary identifier of the - described entity. - example: LGMl2DuvPnfPoSHhYFOm + Use value 'RemovePickJobFromPickRunAction', because you want to + remove a pickjob + enum: + - RemovePickJobFromPickRunAction type: string - orderLineItems: - items: - $ref: '#/components/schemas/OrderLineItem' - type: array - processId: - description: >- - Id of the global process related to this entity. For example - used for starting the GDPR process and others. + pickJobRef: + description: PickJob reference of the PickJob you want to remove. type: string - customServices: - type: array - minItems: 1 - items: - $ref: '#/components/schemas/CustomServiceReference' - schemaVersion: - type: number required: - - id - - status - - orderLineItems - - processId + - action + - pickJobRef type: object xml: - name: Order - OrderArticleAttributeItem: + name: RemovePickJobFromPickRunAction + PickingTimes: + description: There must be no overlaps for time ranges on a day + properties: + friday: + items: + $ref: '#/components/schemas/TimeRange' + type: array + monday: + items: + $ref: '#/components/schemas/TimeRange' + type: array + saturday: + items: + $ref: '#/components/schemas/TimeRange' + type: array + sunday: + items: + $ref: '#/components/schemas/TimeRange' + type: array + thursday: + items: + $ref: '#/components/schemas/TimeRange' + type: array + tuesday: + items: + $ref: '#/components/schemas/TimeRange' + type: array + wednesday: + items: + $ref: '#/components/schemas/TimeRange' + type: array + type: object + PickjobDeliveryInformation: allOf: - - $ref: '#/components/schemas/ArticleAttributeItem' - OrderPaymentInfo: + - $ref: '#/components/schemas/PickjobDeliveryInformationForCreation' + - required: + - targetTime + - channel + PickjobDeliveryInformationForCreation: properties: - currency: - description: The currency in which the consumer paid with - example: EUR + channel: + enum: + - COLLECT + - SHIPPING + type: string + details: + properties: + collect: + properties: + identifier: + description: Includes information about Click & Collect recipient + type: string + paid: + default: false + description: Indicates if the order is already paid. + type: boolean + type: object + shipping: + properties: + carrierKey: + type: string + carrierProduct: + description: >- + Desired product of given carrier to choose when ordering a + label + type: string + example: EXPRESS + carrierServices: + type: array + items: + $ref: '#/components/schemas/CarrierServices' + identifier: + description: >- + Includes information on how to identify Ship from Store + recipient (Name, PIN, Reference number, ...) + type: string + recipientaddress: + $ref: '#/components/schemas/ConsumerAddress' + invoiceAddress: + $ref: '#/components/schemas/ConsumerAddress' + postalAddress: + $ref: '#/components/schemas/ConsumerAddress' + serviceLevel: + description: TBD + enum: + - DELIVERY + - SAMEDAY + type: string + type: object + type: object + targetTime: + description: At which time the result is expected. + example: '2020-02-03T09:45:51.525Z' + format: date-time + type: string + targetTimeBaseDate: + description: The start date for the targetTime calculation. + example: '2020-02-03T08:45:50.525Z' + format: date-time type: string type: object - ArticleItem: - additionalProperties: false + PreselectedFacility: properties: - tenantArticleRef: + facilityRef: + description: Reference to the facility which is supposed to fulfill the order type: string - quantity: - minimum: 1 - type: number + required: + - facilityRef type: object + PrioritizationRule: + description: >- + You can select a default Prioritization Rule from the catalog. When you + decide to select 'CUSTOM' you must also provide a vmExpression to match + the type CustomPrioritizationRule. + properties: + active: + type: boolean + id: + description: >- + This value identifies this very instance of the prioritization rule. + It is set autmatically by the server when the configuration is + updated. + example: 9156fafb-d0b4-4f99-815e-5f231cb50fae + type: string + implementation: + $ref: '#/components/schemas/PrioritizationRuleImplementation' + name: + type: string required: - - quantity - - tenantArticleRef - OrderActionsParameter: - oneOf: - - $ref: '#/components/schemas/OrderUnlockActionParameter' - - $ref: '#/components/schemas/OrderCancelActionParameter' - - $ref: '#/components/schemas/PromiseConfirmActionParameter' - - $ref: '#/components/schemas/PromiseExtendActionParameter' - - $ref: '#/components/schemas/OrderConsumerAddressChangeActionParameter' - - $ref: '#/components/schemas/OrderConsumerAddressesReplaceActionParameter' - AbstractOrderActionsParameter: - discriminator: - propertyName: name + - active + - name + - implementation + type: object + PrioritizationRuleImplementation: + enum: + - CUSTOM + type: string + xml: + name: PrioritizationRuleImplementation + Processes: + properties: + processes: + items: + $ref: '#/components/schemas/Process' + type: array + total: + description: Total number of found entities for this query + example: 42 + type: integer + type: object + DomainStatusHistoryItem: + description: >- + This item represent a process status change triggered by a specific + domain. + properties: + timestamp: + description: >- + Timestamp of the moment at which the state was notified by the + domain. + example: '2020-02-03T08:45:50.525Z' + format: date-time + type: string + domain: + description: The domain of the entity that caused the status change. + $ref: '#/components/schemas/DomainType' + domainRef: + description: The id of the domain entity that caused the status change. + type: string + domainEntityProcessStatus: + description: The assigned status + $ref: '#/components/schemas/DomainStatus' + required: + - timestamp + - domain + - domainEntityProcessStatus + - domainRef + type: object + LastDomainEntityStatusItem: + description: >- + An object holding the last DomainStatus of a given entity and its + corresponding domain. + properties: + domain: + description: The domain of the entity that caused the status change. + $ref: '#/components/schemas/DomainType' + status: + description: The status of the entity. + $ref: '#/components/schemas/DomainStatus' + entityId: + description: The entity id + type: string + required: + - domain + - status + - entityId + type: object + Process: + allOf: + - $ref: '#/components/schemas/VersionedResource' + properties: + tags: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/TagReference' + flatRefs: + description: >- + This field references all IDs of any entity connected to this + process. + items: + type: string + type: array + gdprCleanupDate: + description: >- + The date that defines when the entities will be or have been + anonymized. + example: '2020-02-03T08:45:50.525Z' + format: date-time + type: string + deletionDate: + description: >- + The date that defines when the entities will be or have been + deleted. + example: '2020-02-03T08:45:50.525Z' + format: date-time + type: string + handoverJobRefs: + description: References to Handoverjobs connected to this process (if present). + items: + type: string + type: array + id: + description: ID of this process + type: string + isAnonymized: + description: Indicates if the entities have been anonymized. + type: boolean + orderRef: + description: References to the Order connected to this process (if present). + type: string + routingPlanRefs: + description: >- + References the RoutingPlans that were used during this process (if + present). + items: + type: string + type: array + pickJobRefs: + description: References to the Pickjobs connected to this process (if present). + items: + type: string + type: array + returnRefs: + description: References to the Returns connected to this process (if present). + items: + type: string + type: array + itemReturnJobsRef: + description: >- + References to the Item Return Job connected to this process (if + present). + items: + type: string + type: array + shipmentRefs: + description: References to the Shipments connected to this process (if present). + items: + type: string + type: array + tenantOrderId: + description: The tenantOrderId referencing this process. + type: string + documentRefs: + description: References to documents that are attached to this process. + items: + type: string + type: array + status: + description: Overall status of the process. + $ref: '#/components/schemas/ProcessStatus' + default: CREATED + domsStatus: + description: Overall DOMS status of the process. + $ref: '#/components/schemas/ProcessStatus' + default: CREATED + operativeStatus: + description: Overall operative status of the process + $ref: '#/components/schemas/ProcessStatus' + default: CREATED + returnStatus: + description: Overall return status of the process + $ref: '#/components/schemas/ProcessStatus' + default: NOT_AVAILABLE + domainStatuses: + type: object + description: Overview of the different domain adherent status of the process. + additionalProperties: + $ref: '#/components/schemas/DomainStatus' + lastDomainEntityStatuses: + type: array + description: The last domain statuses of each domain + items: + $ref: '#/components/schemas/LastDomainEntityStatusItem' + packJobRefs: + description: References of the Packjobs connected to this process (if present). + items: + type: string + type: array + facilityRefs: + description: References of the Facilities connected to this process (if any). + items: + type: string + type: array + domainStatusHistory: + description: >- + History of process status changes caused by changes on the related + domains. + type: array + items: + $ref: '#/components/schemas/DomainStatusHistoryItem' + serviceJobRefs: + description: >- + References to the Service Jobs connected to this process (if + present). + items: + type: string + type: array + externalActionRefs: + description: >- + References to the external actions connected to this process (if + any). + items: + type: string + type: array + required: + - gdprCleanupDate + - id + type: object + ProcessProgressLog: + allOf: + - $ref: '#/components/schemas/VersionedResource' + properties: + id: + type: string + processRef: + type: string + domainEntityProcessStatus: + $ref: '#/components/schemas/DomainStatus' + domain: + $ref: '#/components/schemas/DomainType' + domainRef: + type: string + domainStatus: + type: string + domainLastModified: + description: The last modified date of the related domain entity + example: '2020-02-03T09:45:51.525Z' + format: date-time + type: string + domainVersion: + description: The version of the related domain entity + example: 1 + format: int64 + type: integer + attributes: + type: object + required: + - id + - domainVersion + - processRef + - domainEntityProcessStatus + - domain + - domainRef + - domainStatus + DomainStatus: + enum: + - PENDING + - CREATED + - IN_PROGRESS + - STUCK + - FINISHED + - CANCELED + - OBSOLETE + type: string + ProcessStatus: + enum: + - CREATED + - IN_PROGRESS + - FINISHED + - CANCELED + - ERROR + - NOT_AVAILABLE + type: string + DomainType: + enum: + - ORDER + - ROUTING_PLAN + - PICKJOB + - PACKJOB + - SHIPMENT + - HANDOVER + - RETURN + - SERVICE_JOB + - ITEM_RETURN_JOB + type: string + Section: + enum: + - ORDER + - PACKJOB + - PICKJOB + - HANDOVERJOB + - PARCEL + type: string + DocumentType: + enum: + - PDF + - PNG + - JPG + - GIF + - JPEG + type: string + ExternalDocument: + allOf: + - $ref: '#/components/schemas/VersionedResource' properties: + type: + $ref: '#/components/schemas/DocumentType' + section: + $ref: '#/components/schemas/Section' name: type: string - version: - description: Version of the entity to be changed + path: + type: string + id: + type: string + priority: + type: number + minimum: 0 + required: + - type + - section + - id + type: object + ExternalDocumentInSectionForCreation: + additionalProperties: false + properties: + type: + $ref: '#/components/schemas/DocumentType' + file: + $ref: '#/components/schemas/NamedFile' + priority: + type: number + minimum: 0 + required: + - type + type: object + ExternalDocumentForCreation: + additionalProperties: false + properties: + type: + $ref: '#/components/schemas/DocumentType' + section: + $ref: '#/components/schemas/Section' + file: + $ref: '#/components/schemas/NamedFile' + priority: + type: number minimum: 0 - type: integer required: - - name - - version - OrderUnlockActionParameter: + - type + - section + type: object + ExternalDocumentForUpdate: allOf: - - $ref: '#/components/schemas/AbstractOrderActionsParameter' + - $ref: '#/components/schemas/VersionedResource' properties: - name: - enum: - - UNLOCK - type: string + file: + $ref: '#/components/schemas/NamedFile' required: - - name - - version - OrderCancelActionParameter: - allOf: - - $ref: '#/components/schemas/AbstractOrderActionsParameter' + - file + type: object + OidcProviders: properties: - name: - enum: - - CANCEL - type: string + providers: + items: + $ref: '#/components/schemas/StrippedOidcProvider' + type: array + total: + type: number required: - - name - - version - OrderConsumerAddressChangeActionParameter: + - providers + - total + OidcProviderForUpdate: allOf: - - $ref: '#/components/schemas/AbstractOrderActionsParameter' + - $ref: '#/components/schemas/OidcProviderForCreation' properties: - name: - enum: - - CHANGE_CONSUMER_ADDRESS - type: string - consumerAddress: - $ref: '#/components/schemas/ConsumerAddress' - addressType: - $ref: '#/components/schemas/AddressType' + version: + description: >- + The version of the document to be used in optimistic locking + mechanisms. + example: 42 + format: int64 + type: integer required: - - name - version - - consumerAddress - - addressType - OrderConsumerAddressesReplaceActionParameter: - allOf: - - $ref: '#/components/schemas/AbstractOrderActionsParameter' + OidcProviderForCreation: properties: name: - enum: - - REPLACE_CONSUMER_ADDRESSES type: string - consumerAddresses: + minLength: 3 + maxLength: 15 + status: + $ref: '#/components/schemas/OidcProviderStatus' + issuer: + type: string + clientId: + type: string + customParameters: type: array items: - $ref: '#/components/schemas/ConsumerAddress' - required: - - name - - version - - consumerAddresses - PromiseConfirmActionParameter: - allOf: - - $ref: '#/components/schemas/AbstractOrderActionsParameter' - properties: - name: - enum: - - CONFIRM_PROMISE + $ref: '#/components/schemas/OidcProviderCustomParameter' + minItems: 0 + maxItems: 3 + clientSecret: type: string + assignedGroups: + type: array + items: + $ref: '#/components/schemas/AssignedGroup' required: + - clientSecret - name - - version - PromiseExtendActionParameter: - allOf: - - $ref: '#/components/schemas/AbstractOrderActionsParameter' + - status + - issuer + - clientId + - customParameters + - assignedGroups + OidcProviderCustomParameter: + type: object properties: - name: - enum: - - EXTEND_PROMISE + key: + type: string + value: type: string required: - - name - - version - CustomServiceReference: + - key + - value + StrippedOidcProvider: allOf: - - $ref: '#/components/schemas/CustomServiceReferenceForCreation' + - $ref: '#/components/schemas/VersionedResource' properties: id: type: string - customServiceItems: + name: + type: string + minLength: 3 + maxLength: 15 + status: + $ref: '#/components/schemas/OidcProviderStatus' + issuer: + type: string + clientId: + type: string + customParameters: items: - $ref: '#/components/schemas/CustomServiceItem' + $ref: '#/components/schemas/OidcProviderCustomParameter' + minItems: 0 + maxItems: 3 type: array - type: object + assignedGroups: + type: array + items: + $ref: '#/components/schemas/AssignedGroup' required: - - customServiceDefinition - - articleItems - - customServiceItems - id - CustomServiceReferenceForCreation: - additionalProperties: false + - name + - status + - issuer + - clientId + - customParameters + - assignedGroups + OidcProviderStatus: + description: Status of Provider + enum: + - ACTIVE + - INACTIVE + type: string + AssignedGroup: + type: object properties: - customServiceDefinition: - $ref: '#/components/schemas/CustomServiceDefinition' - articleItems: - items: - $ref: '#/components/schemas/ArticleItem' + group: + type: string + minLength: 1 + facilityRefs: type: array - customServiceItems: + minItems: 1 items: - $ref: '#/components/schemas/CustomServiceItemForCreation' - type: array - type: object + type: string required: - - customServiceDefinition - - articleItems - - customServiceItems - CustomServiceItem: + - group + - facilityRefs + RerouteShortPickConfiguration: allOf: - - $ref: '#/components/schemas/CustomServiceItemForCreation' + - $ref: '#/components/schemas/VersionedResource' properties: + blacklistAssignedFacilities: + default: false + description: >- + Does not consider facilities which previously owned the pickjob + during routing. + type: boolean + clickAndCollectReroute: + $ref: '#/components/schemas/ClickAndCollectRerouteConfiguration' + restowAfterMinutes: + description: The amount of minutes after which an automated restow is executed + example: '60' + type: number + shipFromStoreReroute: + $ref: '#/components/schemas/ShipFromStoreRerouteConfiguration' id: type: string - customServiceItems: - items: - $ref: '#/components/schemas/CustomServiceItem' - type: array + rerouteZeroPicksOnly: + default: false + description: Whether or not only pickjobs with zero items picked may be rerouted + type: boolean + required: + - clickAndCollectReroute + - shipFromStoreReroute type: object + ClickAndCollectRerouteConfiguration: + properties: + active: + type: boolean + rerouteType: + $ref: '#/components/schemas/RerouteType' required: - - id - - customServiceItems - - articleItems - - customServiceDefinition - CustomServiceItemForCreation: - additionalProperties: false + - active + type: object + ShipFromStoreRerouteConfiguration: properties: - customServiceDefinition: - $ref: '#/components/schemas/CustomServiceDefinition' - articleItems: + active: + type: boolean + allowManualReroute: + default: false + description: >- + @deprecated This config property is deprecated since 26/02/24. Use + GlobalManualRerouteConfiguration instead. + type: boolean + deprecated: true + facilityWideRerouteOnShortPick: + default: false + type: boolean + rerouteTargetTime: + description: >- + Only pickJobs where the targetTime in not larger than now plus this + number are rerouted + example: '48' + type: number + rerouteType: + $ref: '#/components/schemas/RerouteType' + required: + - active + - rerouteType + type: object + RerouteType: + description: |- + The type of reroute to apply to the order + * `REROUTE`- the complete routing plan is rerouted. + * `ORDERSPLIT`- the order is splitted. The short picked line items will be moved to a new routing plan and rerouted + enum: + - REROUTE + - ORDERSPLIT + type: string + ReturnArticleAttributeItem: + allOf: + - $ref: '#/components/schemas/ArticleAttributeItem' + ReturnConfiguration: + allOf: + - $ref: '#/components/schemas/VersionedResource' + properties: + active: + deprecated: true + default: true + description: >- +
+
This endpoint is deprecated and has been replaced.

Enable or disable legacy returns. Use + returnTypeConfiguration instead + type: boolean + returnTypeConfiguration: + $ref: '#/components/schemas/ReturnTypeConfiguration' + availableItemConditions: items: - $ref: '#/components/schemas/ArticleItem' - type: array - customServiceItems: + $ref: '#/components/schemas/AvailableItemCondition' + availableReturnReasons: items: - $ref: '#/components/schemas/CustomServiceItemForCreation' - type: array + $ref: '#/components/schemas/AvailableReturnReason' + required: + - active type: object + ExpiryConfiguration: + allOf: + - $ref: '#/components/schemas/VersionedResource' + properties: + provisioningTimeOffsetInMinutes: + type: integer + minimum: 0 required: - - customServiceItems - - articleItems - - customServiceDefinition - CustomServiceDefinition: + - provisioningTimeOffsetInMinutes + type: object + AvailableItemCondition: + additionalProperties: false properties: - customServiceRef: + conditionLocalized: + description: Will be translated into 'condition' when requested + $ref: '#/components/schemas/LocaleString' + example: + de_DE: Beschädigt + en_US: Damaged + AvailableReturnReason: + additionalProperties: false + properties: + reasonLocalized: + description: Will be translated into 'reason' when requested + example: + de_DE: Beschädigt + en_US: Damaged + $ref: '#/components/schemas/LocaleString' + required: + - reasonLocalized + LocalizedReturnConfiguration: + allOf: + - $ref: '#/components/schemas/VersionedResource' + properties: + active: + deprecated: true + default: true description: >- - A reference to the custom service to be applied to the orderline - items - type: string - isBundled: - description: if true all articles below this service are intrpreted as a bundle +
+
This endpoint is deprecated and has been replaced.

Enable or disable legacy returns. Use + returnTypeConfiguration instead type: boolean - additionalInformation: + returnTypeConfiguration: + $ref: '#/components/schemas/ReturnTypeConfiguration' + availableItemConditions: items: - properties: - additionalInformationRef: - description: >- - A reference to the specific additional information of the - custom service - type: string - value: - description: The value of the additional information - anyOf: - - type: string - - type: integer - - type: number - - type: boolean - type: object - required: - - additionalInformationRef - description: Additional information necessary to fulfil the custom service - type: array + $ref: '#/components/schemas/LocalizedAvailableItemCondition' + availableReturnReasons: + items: + $ref: '#/components/schemas/LocalizedAvailableReturnReason' + required: + - active type: object + LocalizedAvailableItemCondition: + additionalProperties: false + properties: + condition: + type: string + example: Damaged + description: translated conditionsLocalized + conditionLocalized: + $ref: '#/components/schemas/LocaleString' + example: + de_DE: Beschädigt + en_US: Damaged required: - - customServiceRef - OrderForCreation: + - conditionLocalized + - condition + LocalizedAvailableReturnReason: + allOf: + - $ref: '#/components/schemas/AvailableReturnReason' additionalProperties: false properties: - consumer: - properties: - addresses: + reason: + type: string + example: Damaged + description: translated reasonLocalized + required: + - reasonLocalized + - reason + ReturnTypeConfiguration: + properties: + type: + $ref: '#/components/schemas/ReturnConfigurationType' + required: + - type + ReturnConfigurationType: + type: string + enum: + - RETURN + - ITEM_RETURN + ReturnItemArticle: + allOf: + - $ref: '#/components/schemas/AbstractArticle' + - properties: + attributes: items: - $ref: '#/components/schemas/ConsumerAddress' + $ref: '#/components/schemas/ReturnArticleAttributeItem' type: array - customAttributes: + type: object + xml: + name: ReturnItemArticle + ReturnJob: + allOf: + - $ref: '#/components/schemas/ReturnJobForCreation' + - $ref: '#/components/schemas/VersionedResource' + - properties: + facilityRef: description: >- - Attributes that can be added to the consumer. These attributes - cannot be used within fulfillment processes, but it could be - useful to have the informations carried here. - type: object - email: - description: The email address of the consumer. - example: max@speedyboxales.com - format: email + Reference to the facility which could have been given via + tenantFacilityID while creating + type: string + anonymized: + description: Indicates if gdpr related data was anonymized + example: false + type: boolean + id: + description: >- + The id of this returnJob. It is generated during creation + automatically and suits as the primary identifier of the + described entity. + example: Esb20gpHBL94X5NdMp3C + minItems: 1 type: string required: - - addresses + - id type: object - customAttributes: + xml: + name: ReturnJob + ReturnJobForCreation: + additionalProperties: false + properties: + carrierTrackingNumber: + example: '84168117830018' + type: string + consumerAddress: + $ref: '#/components/schemas/ConsumerAddress' + facilityAddress: + $ref: '#/components/schemas/FacilityAddress' + tenantFacilityId: description: >- - Attributes that can be added to the order. These attributes cannot - be used within fulfillment processes, but it could be useful to have - the informations carried here. - type: object - deliveryPreferences: - $ref: '#/components/schemas/DeliveryPreferences' - orderDate: - description: The date this order was created at the supplying system. - example: '2020-02-03T08:45:50.525Z' - format: date-time + The id of the facility reference. The given ID has to be present in + the system. + example: Esb20gpHBL94X5NdMp3C type: string - orderLineItems: - items: - $ref: '#/components/schemas/OrderLineItemForCreation' - type: array - status: - $ref: '#/components/schemas/OrderStatus' - stickers: - type: array - minItems: 1 - maxItems: 100 - items: - $ref: '#/components/schemas/Sticker' - tenantOrderId: + orderRef: + description: The id of the order + example: LGMl2DuvPnfPoSHhYFOm + type: string + processId: description: >- - Field can be used as a reference number in foreign systems, for - example as a reference to the source system's identifier for this - order. - example: R456728546 + Id of the global process related to this entity. For example used + for starting the GDPR process and others. type: string - tags: - type: array - minItems: 1 + returnLines: items: - $ref: '#/components/schemas/TagReference' - customServices: - type: array + $ref: '#/components/schemas/ReturnLine' minItems: 1 - items: - $ref: '#/components/schemas/CustomServiceReferenceForCreation' - paymentInfo: - $ref: '#/components/schemas/OrderPaymentInfo' - provisioningTime: - description: The point in time by which the order is supposed to be provisioned. - example: '2020-02-03T08:45:50.525Z' - format: date-time - type: string - statusReasons: type: array - items: - $ref: '#/components/schemas/OrderStatusReason' - promisesOptions: - $ref: '#/components/schemas/OrderPromisesOptions' + status: + $ref: '#/components/schemas/ReturnStatus' + tenantOrderId: + type: string + customAttributes: + description: >- + Attributes that can be added to the return job. These attributes + cannot be used within fulfillment processes, but it could be useful + to have the information carried here. required: - - orderDate - - orderLineItems - - consumer + - returnLines type: object - xml: - name: Order - OrderPromisesOptions: - additionalProperties: false + ReturnJobs: + properties: + returnJobs: + items: + $ref: '#/components/schemas/ReturnJob' + type: array + total: + description: Total number of found entities for this query + example: 42 + type: integer required: - - validUntil + - returnJobs + - total + ReturnLine: properties: - validUntil: + article: + $ref: '#/components/schemas/ReturnItemArticle' + delivered: + description: The amount of articles that were delivered + example: 20 + format: int64 + minimum: 0 + type: integer + id: description: >- - The date the promised order will become invalid and is cancelled - automatically, when not transformed into an actual order. - example: '2020-02-03T08:45:50.525Z' - format: date-time + The id of this return Item. It is generated during creation + automatically and suits as the primary identifier of the described + entity. + example: climk4dcQFiPdA5ULuhS type: string - type: object - xml: - name: OrderPromisesOptions - CheckoutOptionsInput: - additionalProperties: false - properties: - consumerAddress: - $ref: '#/components/schemas/CheckoutOptionsConsumerAddress' - deliveryPreferences: - $ref: '#/components/schemas/DeliveryPreferences' - orderLineItems: + pickJobRefs: items: - $ref: '#/components/schemas/OrderLineItemForCreation' - type: array - tags: - type: array + description: List of corresponding pickjob Ids + type: string minItems: 1 - items: - $ref: '#/components/schemas/TagReference' - customServices: type: array - minItems: 1 + returned: + $ref: '#/components/schemas/Returned' + scannableCodes: items: - $ref: '#/components/schemas/CustomServiceReference' - geoFence: - $ref: '#/components/schemas/GeoFence' - filterDuplicates: - type: boolean - default: true + description: Codes, that identify the article + type: string + type: array + status: + $ref: '#/components/schemas/ReturnLineStatus' + customAttributes: + description: >- + Attributes that can be added to the return job. These attributes + cannot be used within fulfillment processes, but it could be useful + to have the information carried here. required: - - orderLineItems - - deliveryPreferences + - pickJobRefs + - id + - status + - delivered + - returned + - scannableCodes + - article type: object - xml: - name: CheckoutOptionsInput - CheckoutOptionsAvailability: + ShortPickReason: additionalProperties: false properties: - tenantArticleId: - type: string - available: - type: number - preOrderReleaseDate: - format: date-time + reason: + description: translated reasonLocalized according to the given locale type: string - isBackOrderable: + active: type: boolean + example: true + description: Flag to mark a reason as active or inactive + reasonLocalized: + description: Localized reason + example: '{ en_US: ''SomeName'' }' + $ref: '#/components/schemas/LocaleString' required: - - tenantArticleId - - available - - isBackOrderable - type: object + - active + - reasonLocalized + ReturnLineStatus: + description: A return item line initially has the status INITIAL. + enum: + - INITIAL + - ADVISED + - ACCEPTED + - DECLINED + - CANCELED + type: string xml: - name: CheckoutOptionsAvailability - PromiseCarrier: - additionalProperties: false + name: ReturnItemStatus + ReturnNoteConfiguration: + allOf: + - $ref: '#/components/schemas/VersionedResource' properties: - carrierKey: - type: string - carrierName: + id: + example: delivery-note type: string - products: - items: - $ref: '#/components/schemas/PromiseDeliveryOptions' - type: array - deliveryPromiseValidUntil: + logoUrl: type: string - format: date-time - required: - - carrierKey - - carrierName - - products - type: object - xml: - name: PromiseCarrier - PromiseDeliveryOptions: - additionalProperties: false - properties: - carrierProductCategory: - $ref: '#/components/schemas/CarrierProductCategory' - transitTime: - $ref: '#/components/schemas/CarrierTransitTime' - estimatedDeliveryTime: - $ref: '#/components/schemas/EstimatedDeliveryTime' - deliveryCosts: + pdfBackgroundConfiguration: + $ref: '#/components/schemas/PdfBackgroundConfiguration' + companyAddress: + $ref: '#/components/schemas/CompanyAddress' + orderDateLabel: + $ref: '#/components/schemas/LocaleString' + orderNumberLabel: + $ref: '#/components/schemas/LocaleString' + headline: + $ref: '#/components/schemas/LocaleString' + quantityLabel: + $ref: '#/components/schemas/LocaleString' + articleIdLabel: + $ref: '#/components/schemas/LocaleString' + articleTitleLabel: + $ref: '#/components/schemas/LocaleString' + returnReasonLabel: + $ref: '#/components/schemas/LocaleString' + returnReasonExplanationHeadline: + $ref: '#/components/schemas/LocaleString' + returnReasonExplanation: + $ref: '#/components/schemas/LocaleString' + reasons: + deprecated: true + description: Deprecated - use ReturnConfiguration.availableReturnReasons instead items: - $ref: '#/components/schemas/DeliveryCost' + $ref: '#/components/schemas/LocaleString' type: array + disclaimerHeadline: + $ref: '#/components/schemas/LocaleString' + disclaimer: + $ref: '#/components/schemas/LocaleString' + displayPageLabel: + type: boolean + default: false + description: Determines if the page label should be shown + pageLabel: + $ref: '#/components/schemas/LocaleString' + substituteText: + $ref: '#/components/schemas/LocaleString' required: - - carrierProductCategory - - deliveryCosts + - id + - orderDateLabel + - orderNumberLabel + - headline + - quantityLabel + - articleIdLabel + - articleTitleLabel + - returnReasonLabel + - disclaimerHeadline + - disclaimer + - pageLabel type: object - xml: - name: PromiseDeliveryOptions - CheckoutOptionsCustomServices: - additionalProperties: false + PdfBackgroundConfiguration: properties: - customServiceRef: + firstPageBackgroundFileUrl: + description: >- + File url of the background image that will be used for the first + page type: string - name: + followingPageBackgroundFileUrl: + description: File url of background image that will be used for 2-n pages type: string - required: - - customServiceRef - - name type: object - xml: - name: CheckoutOptionsCustomServices - CheckoutOptionsFacilityForSFS: + PdfBackgroundConfigurationForUpsert: + properties: + firstPageBackgroundFile: + $ref: '#/components/schemas/NamedFile' + followingPageBackgroundFile: + $ref: '#/components/schemas/NamedFile' + type: object + ReturnNoteConfigurationForUpsert: additionalProperties: false properties: - facilityRef: - type: string - name: - type: string - availabilities: - items: - $ref: '#/components/schemas/CheckoutOptionsAvailability' - type: array - deliveryOptions: + logo: + $ref: '#/components/schemas/NamedFile' + pdfBackgroundConfiguration: + $ref: '#/components/schemas/PdfBackgroundConfigurationForUpsert' + companyAddress: + $ref: '#/components/schemas/CompanyAddress' + orderDateLabel: + $ref: '#/components/schemas/LocaleString' + orderNumberLabel: + $ref: '#/components/schemas/LocaleString' + headline: + $ref: '#/components/schemas/LocaleString' + quantityLabel: + $ref: '#/components/schemas/LocaleString' + articleIdLabel: + $ref: '#/components/schemas/LocaleString' + articleTitleLabel: + $ref: '#/components/schemas/LocaleString' + returnReasonLabel: + $ref: '#/components/schemas/LocaleString' + returnReasonExplanationHeadline: + $ref: '#/components/schemas/LocaleString' + returnReasonExplanation: + $ref: '#/components/schemas/LocaleString' + reasons: + deprecated: true + description: Deprecated - use ReturnConfiguration.availableReturnReasons instead items: - $ref: '#/components/schemas/PromiseCarrier' + $ref: '#/components/schemas/LocaleString' type: array - customServices: + disclaimerHeadline: + $ref: '#/components/schemas/LocaleString' + disclaimer: + $ref: '#/components/schemas/LocaleString' + displayPageLabel: + type: boolean + default: false + description: Determines if the page label should be shown + pageLabel: + $ref: '#/components/schemas/LocaleString' + substituteText: + $ref: '#/components/schemas/LocaleString' + version: + description: >- + The version of the document to be used in optimistic locking + mechanisms. + example: 42 + format: int64 + type: integer + required: + - orderDateLabel + - orderNumberLabel + - headline + - quantityLabel + - articleIdLabel + - articleTitleLabel + - returnReasonLabel + - disclaimerHeadline + - disclaimer + - pageLabel + - version + type: object + ReturnPatchActions: + description: >- + You can choose from patch actions for the ReturnLineItems + (ModifyReturnLineItemAction, action value: 'ModifyReturnLineItem') or + the return itself (ModifyReturnAction, action value 'ModifyReturn'). + properties: + actions: items: - $ref: '#/components/schemas/CheckoutOptionsCustomServices' + anyOf: + - $ref: '#/components/schemas/ModifyReturnAction' + - $ref: '#/components/schemas/ModifyReturnLineItemAction' + minItems: 1 type: array + version: + description: >- + The version of the document to be used in optimistic locking + mechanisms. + example: 42 + format: int64 + type: integer required: - - facilityRef - - name - - availabilities - - deliveryOptions - - customServices + - version + - actions type: object xml: - name: CheckoutOptionsFacilityForSFS - CheckoutOptionsFacilityForCNC: - additionalProperties: false + name: ReturnPatchActions + ReturnStatus: + description: >- + A return initially has the status INITIAL. As soon as one of the + returnlines is returned partly or in full the state changes to CLAIMED. + When the return option voids the state could change to CLOSED. Please + note that this last step might depend on configuration values. + enum: + - INITIAL + - IN_PROGRESS + - CLAIMED + - CLOSED + - CANCELED + type: string + xml: + name: ReturnItemStatus + Returned: properties: - facilityRef: - type: string - name: + reason: + description: Reason of return. + example: Zu klein type: string - address: - $ref: '#/components/schemas/FacilityAddress' - closingDays: - items: - $ref: '#/components/schemas/ClosingDay' - type: array - pickingTimes: - $ref: '#/components/schemas/PickingTimes' - availabilities: + returnedAmount: + description: Amount of item which is returned + example: 5 + minimum: 0 + type: number + required: + - returnedAmount + type: object + ScopedCapabilities: + properties: + capabilities: items: - $ref: '#/components/schemas/CheckoutOptionsAvailability' + $ref: '#/components/schemas/ScopedCapability' type: array - customServices: + total: + description: Total number of found entities for this query + example: 42 + type: integer + type: object + ScopedCapability: + allOf: + - $ref: '#/components/schemas/VersionedResource' + properties: + currentUserPermissions: items: - $ref: '#/components/schemas/CheckoutOptionsCustomServices' + type: string type: array - targetTime: - format: date-time + name: type: string - required: - - facilityRef - - name - - address - - closingDays - - pickingTimes - - availabilities - - customServices - - targetTime - type: object - xml: - name: CheckoutOptionsFacilityForCNC - ResponseForSFSCheckoutOptions: - additionalProperties: false - properties: - facilities: + status: + $ref: '#/components/schemas/CapabilityStatus' + configurations: items: - $ref: '#/components/schemas/CheckoutOptionsFacilityForSFS' + anyOf: + - $ref: '#/components/schemas/SubstitutionConfiguration' + - $ref: '#/components/schemas/CarrierConfiguration' + - $ref: '#/components/schemas/RerouteShortPickConfiguration' + - $ref: '#/components/schemas/ReturnNoteConfiguration' type: array required: - - facilities + - name + - status type: object - xml: - name: ResponseForSFSCheckoutOptions - ResponseForCNCCheckoutOptions: + ShipmentOrderBy: + description: STATUS_TARGET_TIME_LAST_MODIFIED_DATE is depricated + enum: + - STATUS_TARGET_TIME_ORDER_DATE + ShipmentWithSearchPath: + allOf: + - $ref: '#/components/schemas/Shipment' + - properties: + searchPaths: + items: + type: string + type: array + minItems: 0 + additionalProperties: false + type: object + Shipment: + allOf: + - $ref: '#/components/schemas/ShipmentForCreation' + - $ref: '#/components/schemas/VersionedResource' + - properties: + anonymized: + default: false + description: Indicates if gdpr related data was anonymized + example: false + type: boolean + hasActiveCarrier: + default: true + description: >- + Indicates if there is an active carrier configuration to fulfill + this shipment + example: false + type: boolean + carrierKey: + type: string + example: DPD + id: + description: >- + The id of this Shipment. It is generated during creation + automatically and suits as the primary identifier of the + described entity. + example: 95EWrieX09OmeriXIUbb + type: string + lineItems: + items: + $ref: '#/components/schemas/ShipmentLineItem' + type: array + parcels: + items: + $ref: '#/components/schemas/StrippedParcel' + type: array + status: + $ref: '#/components/schemas/ShipmentStatus' + required: + - id + - status + - hasActiveCarrier + type: object + ShipmentForCreation: additionalProperties: false properties: - facilities: - items: - $ref: '#/components/schemas/CheckoutOptionsFacilityForCNC' - type: array - required: - - facilities - type: object - xml: - name: ResponseForCNCCheckoutOptions - DeliveryPromiseLineItem: - type: object - properties: - tenantArticleId: + operativeProcessRef: type: string - title: + carrierLogoUrl: + description: The URL to the carrier logo type: string - quantity: - type: number - available: - type: number - outOfStockBehaviour: - enum: - - BACKORDER + carrierRef: + description: The reference to the carrier for which the shipment is assigned to + example: ca525716-7208-4a63-a2a6-11274eb37f67-0 type: string - availabilityTimeframe: - $ref: '#/components/schemas/AvailabilityTimeframe' - DeliveryPromiseShipment: - additionalProperties: false - allOf: - - $ref: '#/components/schemas/BasicDeliveryPromiseShipment' - properties: - carriers: - items: - $ref: '#/components/schemas/PromiseCarrier' + carrierProduct: + description: Desired product of given carrier to choose when ordering a label + type: string + example: EXPRESS + carrierServices: type: array - required: - - carriers - type: object - xml: - name: DeliveryPromiseShipment - BasicDeliveryPromiseShipmentFacility: - additionalProperties: false - properties: + items: + $ref: '#/components/schemas/CarrierServices' + customAttributes: + description: >- + Attributes that can be added to the shipment. These attributes + cannot be used within fulfillment processes, but it could be useful + to have the informations carried here. + type: object facilityRef: + description: The reference to the facility which the shipment is assigned to. type: string - facilityName: - type: string - required: - - facilityName - - facilityRef - BasicDeliveryPromiseShipment: - additionalProperties: false - properties: lineItems: items: - $ref: '#/components/schemas/DeliveryPromiseLineItem' + $ref: '#/components/schemas/ShipmentLineItemForCreation' type: array - facility: - $ref: '#/components/schemas/BasicDeliveryPromiseShipmentFacility' - required: - - lineItems - - facility - type: object - xml: - name: DeliveryPromiseShipment - DeliveryPromiseCollect: - additionalProperties: false - allOf: - - $ref: '#/components/schemas/BasicDeliveryPromiseShipment' - properties: + orderDate: + description: The date this order was created at the supplying system. + format: date-time + type: string + pickJobRef: + description: The id of the facility reference. + example: Esb20gpHBL94X5NdMp3C + type: string + processId: + description: >- + Id of the global process related to this entity. For example used + for starting the GDPR process and others. + type: string + shortId: + description: The short identifier of the shipment. + type: string + sourceAddress: + $ref: '#/components/schemas/FacilityAddress' + targetAddress: + $ref: '#/components/schemas/ConsumerAddress' + invoiceAddress: + $ref: '#/components/schemas/ConsumerAddress' + postalAddress: + $ref: '#/components/schemas/ConsumerAddress' targetTime: + description: At which time the result is expected. + example: '2020-02-03T09:45:51.525Z' format: date-time type: string - required: - - targetTime - type: object - xml: - name: DeliveryPromiseCollect - ResponseForDeliveryPromise: - additionalProperties: false - properties: - orderRef: + tenantOrderId: + description: Reference to the order in the tenant system. type: string - orderVersion: - type: number - promisesOptions: - $ref: '#/components/schemas/OrderPromisesOptions' - collect: - $ref: '#/components/schemas/DeliveryPromiseCollect' - shipToCustomer: - type: array + targetTimeBaseDate: + description: The start date for the targetTime calculation. + example: '2020-02-03T08:45:50.525Z' + format: date-time + type: string + paymentInformation: + $ref: '#/components/schemas/PaymentInformation' + tags: items: - $ref: '#/components/schemas/DeliveryPromiseShipment' - shipToStore: + $ref: '#/components/schemas/TagReference' + type: array + transfers: type: array + minItems: 0 items: - $ref: '#/components/schemas/DeliveryPromiseShipment' - backOrdered: - $ref: '#/components/schemas/Backordered' + $ref: '#/components/schemas/OperativeTransfer' required: - - orderRef - - orderVersion + - facilityRef + - targetTime + - orderDate type: object xml: - name: ResponseForDeliveryPromise - Backordered: - type: object - properties: - lineItems: - items: - $ref: '#/components/schemas/DeliveryPromiseLineItem' - type: array - required: - - lineItems - OrderStatusReason: - properties: - reason: - description: The reason for setting this order status - type: string - status: - $ref: '#/components/schemas/OrderStatus' - required: - - reason - - status - OrderInformation: - properties: - orderDate: - description: The date the order was created. - example: '2020-02-03T08:45:50.525Z' - format: date-time - type: string - orderNumber: - description: An identifier for the order. - example: R456728546 - pattern: ^.+$ - type: string - type: object - OrderLineItem: + name: Shipment + ShipmentLineItem: allOf: - - $ref: '#/components/schemas/OrderLineItemForCreation' + - $ref: '#/components/schemas/ShipmentLineItemForCreation' - properties: id: description: >- - The id of this orderline. It is generated during creation - automatically by the API and suits as the primary identifier of - the described line. - example: LGMl2DuvPnfPoSHhYFOm + The id of this lineItem. It is generated during creation + automatically and suits as the primary identifier of the + described entity. + example: climk4dcQFiPdA5ULuhS type: string required: - id type: object - OrderLineItemArticle: + ShipmentLineItemArticle: allOf: - $ref: '#/components/schemas/AbstractArticle' - properties: attributes: items: - $ref: '#/components/schemas/OrderArticleAttributeItem' + $ref: '#/components/schemas/ArticleAttributeItem' type: array type: object xml: - name: OrderLineItemArticle - MeasurementValidation: - properties: - shortPickSoftTolerancePercentage: - description: Allowed soft short pick deviation tolerance. - example: 10 - minimum: 0 - maximum: 100 - type: number - shortPickHardTolerancePercentage: - description: Allowed hard short pick deviation tolerance. - example: 15 - minimum: 0 - maximum: 100 - type: number - overPickSoftTolerancePercentage: - description: Allowed soft over pick deviation tolerance. - example: 15 - minimum: 0 - type: number - overPickHardTolerancePercentage: - description: Allowed hard over pick deviation tolerance. - example: 20 - minimum: 0 - type: number - OrderLineItemForCreation: - additionalProperties: false + name: PickLineItemArticle + ShipmentLineItemForCreation: properties: article: - $ref: '#/components/schemas/OrderLineItemArticle' + $ref: '#/components/schemas/ShipmentLineItemArticle' customAttributes: description: >- Attributes that can be added to the orderline. These attributes @@ -27301,729 +28793,1091 @@ components: format: int64 minimum: 1 type: integer - secondaryMeasurementUnitKey: - description: Secondary identifier for items unit of measurement. - example: liter - type: string - secondaryQuantity: - description: Secondary quantity of the specific article that has been ordered - example: 21 - format: int64 - minimum: 0 - type: integer + tags: + items: + $ref: '#/components/schemas/TagReference' + type: array scannableCodes: items: description: Codes, that identify the article type: string type: array - measurementValidation: - $ref: '#/components/schemas/MeasurementValidation' - shopPrice: - description: price per piece of this line item - example: 1200 - type: number - tags: - items: - $ref: '#/components/schemas/TagReference' - type: array - allowedSubstitutes: + required: + - quantity + - article + type: object + ShipmentPatchActions: + properties: + actions: items: - $ref: '#/components/schemas/Substitute' + $ref: '#/components/schemas/ModifyShipmentAction' + minItems: 1 type: array + version: description: >- - Array of allowed substitutes for given orderLineItem. If an empty - array is provided, no substitute is allowed for this orderLineItem. - If allowedSubstitutes is not provided, this configured substitutes - on listing level will be available + The version of the document to be used in optimistic locking + mechanisms. + example: 42 + format: int64 + type: integer required: - - article - - quantity + - version + - actions type: object - OrderRoutingConfiguration: + xml: + name: ShipmentPatchActions + ShipmentStatus: + description: >- + Every newly created shipment is in state INITIAL. When the parcel labels + should be requested the state changes to REQUEST and as soon as all + parcel labels are successfully requested the state changes to CONFIRMED. + The state COMPLETED is set in the end or the process + enum: + - INITIAL + - REQUEST + - RETRYABLE + - CONFIRMED + - COMPLETED + - CANCELED + - OBSOLETE + type: string + Status: + additionalProperties: false + properties: + status: + description: The current state of the API + enum: + - UP + - DEGRADED + - DOWN + type: string + required: + - status + type: object + xml: + name: Status + StockConfiguration: allOf: - $ref: '#/components/schemas/VersionedResource' properties: - infiniteStockEnabled: - description: Config to enable/disable infinite stock + stockModificationEnabled: + default: true + description: Indicates if manual stock modification is allowed + example: true type: boolean id: type: string + required: + - stockModificationEnabled type: object - OrderSplit: - 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

- additionalProperties: false + xml: + name: StockConfiguration + StockConfigurationPatchActions: properties: - active: - default: false - type: boolean - activeForSameDay: - default: false - type: boolean - shouldUseWaitingRoomForPreBackOrderItems: - default: false - type: boolean - fixedCountConfiguration: - $ref: '#/components/schemas/FixedCountConfiguration' - orderSplitType: - $ref: '#/components/schemas/OrderSplitType' + actions: + items: + anyOf: + - $ref: '#/components/schemas/ModifyRetainedOfflineStockAction' + - $ref: '#/components/schemas/ModifyListingReactivationAfterAction' + - $ref: '#/components/schemas/ModifyShortpickAction' + minItems: 1 + type: array + version: + description: >- + The version of the document to be used in optimistic locking + mechanisms. + example: 42 + format: int64 + type: integer required: - - active - - orderSplitType + - version + - actions type: object - OrderSplitType: - description: The type of order split - enum: - - FIXED_COUNT - type: string xml: - name: OrderSplitType - OrderStatus: - description: The state of the order. Initially it is OPEN. - enum: - - OPEN - - CANCELLED - - PROMISED - - LOCKED - - OBSOLETE - type: string - ParcelDimensions: + name: FacilityPatchActions + StockInformationForCreation: + description: >- + @deprecated This object is deprecated since 30th of November 2023. This + object carries information about the current stock of this listing. + deprecated: true properties: - height: - description: The height of the package (in cm) - example: 50 - type: number - length: - description: The length of the package (in cm) - example: 100 - type: number - weight: - description: The weight of the package (in g) - example: 1700 + reserved: + deprecated: true + description: >- +
+
This endpoint is deprecated and has been replaced.

@deprecated This field is deprecated since 8th of February + 2023. + + Reserved can't be overridden by the API, because its internally now + handled by open PickJobs (or other upcoming ways to reserve Stock) + + Any Value provided will be ignored upon arrival. + example: 24 + minimum: 0 + multipleOf: 1 type: number - width: - description: The width of the package (in cm) - example: 25 + stock: + description: >- + This the amount of the given article that is in stock for the given + facility + example: 42 + minimum: 0 + multipleOf: 1 type: number + required: + - stock type: object - ParcelServices: - additionalProperties: false + StockInformation: + allOf: + - $ref: '#/components/schemas/StockInformationForCreation' + - properties: + reserved: + example: 24 + minimum: 0 + multipleOf: 1 + type: number + available: + description: The actual available amount for this stock + example: 24 + minimum: 0 + multipleOf: 1 + type: number + required: + - available + type: object + StrippedCarrier: + allOf: + - $ref: '#/components/schemas/VersionedResource' + - properties: + deliveryType: + $ref: '#/components/schemas/CarrierDeliveryType' + id: + description: >- + The id of this carrier. It is generated during creation + automatically and suits as the primary identifier of the + described carrier. + example: climk4dcQFiPdA5ULuhS + type: string + key: + type: string + lifecycle: + $ref: '#/components/schemas/CarrierLifecycle' + name: + description: >- + This is the well known name for a supported CEP partner. Can be + adapted to the clients needs. + example: DHL Köln + type: string + status: + $ref: '#/components/schemas/CarrierStatus' + required: + - id + - name + - key + type: object + xml: + name: StrippedCarrier + StrippedCarriers: properties: - bulkyGoods: - type: boolean - signature: - type: boolean - Parcel: - additionalProperties: false + carriers: + items: + $ref: '#/components/schemas/StrippedCarrier' + type: array + total: + description: Total number of found entities for this query + example: 42 + type: integer + type: object + StrippedFacilities: + properties: + facilities: + items: + $ref: '#/components/schemas/StrippedFacility' + type: array + total: + description: Total number of found entities for this query + example: 42 + type: integer + type: object + StrippedFacility: + allOf: + - $ref: '#/components/schemas/VersionedResource' + - $ref: '#/components/schemas/Address' + - properties: + id: + type: string + name: + description: name of the facility + example: Köln store + type: string + status: + $ref: '#/components/schemas/FacilityStatus' + tenantFacilityId: + description: The id of the facility in the tenants own system + example: K12345 + type: string + required: + - id + - status + type: object + StrippedHandoverjob: allOf: - $ref: '#/components/schemas/VersionedResource' - properties: - anonymized: - description: Indicates if gdpr related data was anonymized - example: false - type: boolean carrierRef: - description: Reference to the carrier this parcel should be send by - example: cf00e102-34f2-45c1-a846-6a21f384321e type: string - carrierProduct: - description: Desired product of given carrier to choose when ordering a label + channel: + enum: + - DELIVERY + - COLLECT + type: string + facilityRef: + description: The id of the facility reference. + example: Esb20gpHBL94X5NdMp3C type: string - example: EXPRESS - customAttributes: - description: >- - Attributes that can be added to the parcel. These attributes - cannot be used within fulfillment processes, but it could be - useful to have the information carried here. - type: object - dimensions: - $ref: '#/components/schemas/ParcelDimensions' - services: - $ref: '#/components/schemas/ParcelServices' id: description: >- - The id of this parcel. It is generated during creation + The id of this handoverjob. It is generated during creation automatically and suits as the primary identifier of the described entity. example: 95EWrieX09OmeriXIUbb type: string - documentsRef: - description: Reference to the documents collection from this entity - type: string loadUnitRefs: description: Reference to array of load unit Refs items: type: string type: array - recipient: - $ref: '#/components/schemas/ConsumerAddress' - processRef: + orderDate: + description: The date this order was created at the supplying system. + example: '2020-02-03T08:45:50.525Z' + format: date-time + type: string + parcelRef: + description: The reference to the parcel. + example: 2fOge2ZGW54K4TgvDTQw + type: string + pickJobRef: + description: >- + The reference to the pickjob for which the handoverjob is + assigned to + example: ca525716-7208-4a63-a2a6-11274eb37f67-0 type: string - items: - items: - $ref: '#/components/schemas/ParcelItem' - type: array - postalCharges: - $ref: '#/components/schemas/ParcelPostalCharge' - returnAddress: - $ref: '#/components/schemas/FacilityAddress' - result: - $ref: '#/components/schemas/ParcelResult' - sender: - $ref: '#/components/schemas/FacilityAddress' shipmentRef: - description: The id of this shipment this parcel has been created for. - example: 95EWrieX09OmeriXIUbb + description: The reference to the shipment belonging to the handoverjob + example: Esb20gpHBL94X5NdMp3C type: string status: - $ref: '#/components/schemas/ParcelStatus' - paymentInformation: - $ref: '#/components/schemas/PaymentInformation' - pickUpInformation: - $ref: '#/components/schemas/ParcelPickUpInformation' - productValue: + $ref: '#/components/schemas/HandoverjobStatus' + tenantOrderId: description: >- - Monetary value of all goods in this parcel. Needed for sending - cross border packages (customs) To be interpreted as money in - the currency given under paymentInformation.currency - type: number - example: 12.5 + Field can be used as a reference number in foreign systems, for + example as a reference to the source system's identifier for + this order. + example: R456728546 + type: string + searchPaths: + description: This is the search term that was used to find the handover job + example: R456728546 + type: array + items: + type: string + minItems: 0 required: - id - status - - carrierRef - - shipmentRef - - processRef - - sender - - recipient - - loadUnitRefs + - facilityRef + - channel type: object - ParcelForCreation: - additionalProperties: false + StrippedHandoverjobs: properties: - status: - $ref: '#/components/schemas/ParcelStatus' - carrierProduct: - description: Desired product of given carrier to choose when ordering a label - type: string - example: EXPRESS - customAttributes: - description: >- - Attributes that can be added to the parcel. These attributes cannot - be used within fulfillment processes, but it could be useful to have - the information carried here. - type: object - dimensions: - $ref: '#/components/schemas/ParcelDimensions' - services: - $ref: '#/components/schemas/ParcelServices' - loadUnitRefs: - description: Reference to array of load unit Refs - items: - type: string - type: array - items: + handoverjobs: items: - $ref: '#/components/schemas/ParcelItem' + $ref: '#/components/schemas/StrippedHandoverjob' type: array - recipient: - $ref: '#/components/schemas/ConsumerAddress' - sender: - $ref: '#/components/schemas/FacilityAddress' - returnAddress: - $ref: '#/components/schemas/FacilityAddress' - paymentInformation: - $ref: '#/components/schemas/PaymentInformation' - pickUpInformation: - $ref: '#/components/schemas/ParcelPickUpInformation' - productValue: - description: >- - Monetary value of all goods in this parcel. Needed for sending cross - border packages (customs) To be interpreted as money in the currency - given under paymentInformation.currency - type: number - example: 12.5 - result: - description: >- - Possibility to add data from carrier while creating a parcel. Parcel - must be in a final status to add this field. - $ref: '#/components/schemas/ParcelResult' - type: object - ParcelPickUpInformation: - additionalProperties: false - properties: - startTime: - description: needs to be before end time - format: date-time - type: string - endTime: - description: needs to be after start time - format: date-time - type: string - required: - - startTime - - endTime - ParcelPostalCharge: - properties: - value: - type: number - description: Monetary Value in the given currency - example: 15.5 - currency: - type: string - description: Currency of the given value - example: EUR - required: - - currency - - value - ParcelItem: - properties: - quantity: - type: integer - minimum: 1 - description: amount of the given items - example: 5 - hsCode: - type: string - maxLength: 50 - description: - description: Description of the given item/items - example: Item Description - type: string - weightInGram: + total: + description: Total number of found entities for this query + example: 42 type: integer - description: Weight of a single item in gram - example: 10000 - parcelItemValue: - $ref: '#/components/schemas/ParcelItemValue' - countryOfManufacture: - type: string - article: - $ref: '#/components/schemas/ParcelItemArticle' - required: - - quantity type: object - xml: - name: ParcelItem - ParcelItemArticle: + StrippedListing: allOf: - - $ref: '#/components/schemas/AbstractArticle' + - $ref: '#/components/schemas/VersionedResource' - properties: - attributes: - items: - $ref: '#/components/schemas/ArticleAttributeItem' - type: array + id: + example: fsfdsf87fsd + type: string + status: + enum: + - ACTIVE + - INACTIVE + type: string + tenantArticleId: + description: This is a reference to an article Id + example: '4711' + type: string + required: + - status + - facilityId + - id + - tenantArticleId type: object - xml: - name: ParcelItemArticle - ParcelItemValue: + StrippedListings: properties: - value: - type: number - description: Monetary Value of a single item in the given currency - example: 15.5 - currency: - type: string - description: Currency of the given value - example: EUR - required: - - value - - currency + listings: + items: + $ref: '#/components/schemas/StrippedListing' + type: array + total: + description: Total number of found entities for this query + example: 42 + type: integer type: object - ParcelStatus: - enum: - - OPEN - - PROCESSING - - DONE - - FAILED - - CANCELED - - OBSOLETE - type: string - UserModificationHistory: - additionalProperties: false + ListingBulkOperationResult: type: object + properties: + listing: + $ref: '#/components/schemas/Listing' + status: + $ref: '#/components/schemas/BulkOperationResultStatus' required: - - modificationDate - - username + - listing + - status + BulkOperationResultStatus: + type: string + enum: + - UPDATED + - CREATED + - FAILED + StrippedParcel: properties: - userId: - description: ID of the user who commited this modification + carrierRef: + description: The reference to the carrier for which the parcel is assigned to + example: ca525716-7208-4a63-a2a6-11274eb37f67-0 type: string - username: - description: Username of the user who commited this modification + parcelRef: + example: 15EZrieW09OmeriXIUbc type: string - modificationDate: - format: date-time + status: + $ref: '#/components/schemas/ParcelStatus' + carrierTrackingNumber: + example: '84168117830018' type: string - PickJob: + required: + - parcelRef + - carrierRef + - status + type: object + StrippedParcels: + properties: + parcels: + items: + $ref: '#/components/schemas/StrippedParcel' + type: array + total: + description: Total number of found entities for this query + example: 42 + type: integer + type: object + StrippedPickJob: allOf: - - $ref: '#/components/schemas/PickJobForCreation' - $ref: '#/components/schemas/VersionedResource' - properties: - usersModificationHistory: - type: array + searchPaths: items: - $ref: '#/components/schemas/UserModificationHistory' - anonymized: - description: Indicates if gdpr related data was anonymized - example: false - type: boolean - deliveryinformation: - $ref: '#/components/schemas/PickjobDeliveryInformation' - editor: - $ref: '#/components/schemas/Editor' - id: + type: string + type: array + minItems: 0 + carrierKey: + type: string + example: DPD + facilityRef: description: >- - The id of this pickjob. It is generated during creation - automatically and suits as the primary identifier of the - described entity. + The id of the facility reference. The given ID has to be present + in the system. example: Esb20gpHBL94X5NdMp3C type: string - pickLineItems: - items: - $ref: '#/components/schemas/PickLineItem' - type: array - shortId: + id: + type: string + orderRef: description: >- - A short identifier that helps assigning a pickJob to a customer. - This is automatically created during creation. - example: AS12 + The id of the order that lead to the creation of this pickjob. + Can be empty / not present when the pickjob was created without + having an order. + example: LGMl2DuvPnfPoSHhYFOm + type: string + targetTime: + description: At which time the result is expected. + example: '2020-02-03T09:45:51.525Z' + format: date-time type: string status: $ref: '#/components/schemas/PickJobStatus' - pickRunRef: - type: string - description: Pick run id to which the pick job belongs - tags: - type: array - minItems: 1 - items: - $ref: '#/components/schemas/TagReference' - documentHandling: - $ref: '#/components/schemas/DocumentHandling' - resetBlocked: - type: boolean - default: false - description: Indicates if pickJob can still be resetted or restarted - documentsRef: - description: Reference to the documents collection from this entity - type: string - statusReason: - type: string - description: >- - The reason for the current status. Currently, only reroute - reasons are supported. - pickingZones: - type: array - items: - $ref: '#/components/schemas/PickingZone' required: - id - status - - pickLineItems - - shortId - - deliveryinformation - - documentsRef + - created + - lastModified + - version type: object - PickJobForCreation: + StrippedPickJobs: properties: - operativeProcessRef: - type: string - customAttributes: - description: >- - Attributes that can be added to the pickjob. These attributes cannot - be used within fulfillment processes, but it could be useful to have - the informations carried here. - type: object - deliveryinformation: - $ref: '#/components/schemas/PickjobDeliveryInformationForCreation' + pickjobs: + items: + $ref: '#/components/schemas/StrippedPickJob' + type: array + total: + description: Total number of found entities for this query + example: 42 + type: integer + type: object + PickRunForCreation: + properties: + pickJobRefs: + items: + type: string + type: array + minItems: 1 + status: + $ref: '#/components/schemas/PickRunStatus' facilityRef: - description: >- - The id of the facility reference. The given ID has to be present in - the system. - example: Esb20gpHBL94X5NdMp3C type: string - orderDate: - description: The date this order was created at the supplying system. - example: '2020-02-03T08:45:50.525Z' + pickRunType: + $ref: '#/components/schemas/PickRunType' + required: + - pickJobRefs + - facilityRef + type: object + PickRun: + allOf: + - $ref: '#/components/schemas/VersionedResource' + - properties: + pickLineItems: + items: + $ref: '#/components/schemas/PickLineItem' + type: array + pickJobRefs: + items: + type: string + type: array + facilityRef: + type: string + status: + $ref: '#/components/schemas/PickRunStatus' + id: + type: string + editor: + $ref: '#/components/schemas/Editor' + pickRunType: + $ref: '#/components/schemas/PickRunType' + required: + - pickLineItems + - pickJobRefs + - facilityRef + - status + - id + type: object + StrippedShipments: + properties: + shipments: + items: + $ref: '#/components/schemas/ShipmentWithSearchPath' + type: array + total: + description: Total number of found entities for this query + example: 42 + type: integer + type: object + StrippedUsers: + properties: + total: + description: Total number of found entities for this query + example: 42 + type: integer + users: + items: + $ref: '#/components/schemas/User' + type: array + type: object + Subscription: + allOf: + - $ref: '#/components/schemas/SubscriptionForCreation' + properties: + created: + description: >- + The date this subscription was created at the platform. This value + is generated by the service. + example: '2020-02-03T08:45:51.525Z' format: date-time type: string - orderRef: - description: >- - The id of the order reference. The given ID has to be present in the - system. - example: LGMl2DuvPnfPoSHhYFOm + id: type: string - pickLineItems: + required: + - id + - created + type: object + SubscriptionForCreation: + properties: + callbackUrl: + type: string + event: + type: string + headers: items: - $ref: '#/components/schemas/PickLineItemForCreation' + $ref: '#/components/schemas/CallbackHeader' minItems: 1 type: array - paymentInformation: - $ref: '#/components/schemas/PaymentInformation' - processId: + name: + type: string + required: + - name + - event + - callbackUrl + - headers + type: object + Subscriptions: + properties: + subscriptions: + items: + $ref: '#/components/schemas/Subscription' + type: array + total: + description: Total number of found entities for this query + example: 42 + type: integer + type: object + Substitute: + properties: + attributes: + items: + $ref: '#/components/schemas/SubstituteAttributeItem' + type: array + imageUrl: + type: string + priority: description: >- - Id of the global process related to this entity. For example used - for starting the GDPR process and others. + This field allows you to rank substitutes against each other. The + lowest number is the most preferrable substitute. + minimum: 0 + type: number + scannableCodes: + items: + description: Strings, that identify the substitute article + type: string + type: array + tenantArticleId: type: string - shortId: - description: A short identifier that helps assigning a pick job to a customer. - example: AS12 + title: type: string - status: - $ref: '#/components/schemas/PickJobStatus' - tenantOrderId: + required: + - title + - tenantArticleId + type: object + xml: + name: Substitute + SubstituteAttributeItem: + allOf: + - $ref: '#/components/schemas/ArticleAttributeItem' + SubstituteLineItem: + properties: + article: + $ref: '#/components/schemas/SubstituteLineItemArticle' + priority: description: >- - Field can be used as a reference number in foreign systems, for - example as a reference to the source system's identifier for this - order. - example: R456728546 + This field allows you to rank substitutes against each other. The + lowest number is the most preferrable substitute. + minimum: 0 + type: number + pickedAt: + description: Date when the line has been picked. + example: '2024-02-03T08:45:51.525Z' + format: date-time type: string - tags: + quantity: description: >- - Tags can only be set when there is no process related with this - pickJob. Setting processId and tags will lead to an validationError. - type: array - minItems: 1 + quantity of the specific article that has been picked to substitute + the ordered line item + example: 21 + format: int64 + minimum: 1 + type: integer + scannableCodes: items: - $ref: '#/components/schemas/TagReference' - stickers: + description: Codes, that identify the article + type: string type: array - minItems: 0 + partialStockLocations: items: - $ref: '#/components/schemas/Sticker' - routingPlanRef: - description: Reference to the routingplan which created this pickjob + $ref: '#/components/schemas/SubstituteLineItemPartialStockLocation' + required: + - quantity + - article + type: object + SubstituteLineItemArticle: + allOf: + - $ref: '#/components/schemas/AbstractArticle' + - properties: + attributes: + items: + $ref: '#/components/schemas/ArticleAttributeItem' + type: array + type: object + xml: + name: SubstituteLineItemArticle + SubstituteLineItemForCreation: + properties: + quantity: + description: >- + quantity of the specific article that has been picked to substitute + the ordered line item + example: 21 + format: int64 + minimum: 1 + type: integer + tenantArticleId: + description: TenantArticleId of the substitute article type: string - preferredPickingMethods: - description: Preferred way of picking a given pickJob. + pickedAt: + description: Date when the line has been picked. + example: '2024-02-03T08:45:51.525Z' + format: date-time + type: string + required: + - quantity + - tenantArticleId + type: object + Substitutes: + allOf: + - $ref: '#/components/schemas/Entity' + - $ref: '#/components/schemas/SubstitutesForUpsert' + required: + - tenantArticleId + - substitutes + type: object + xml: + name: Substitutes + SubstitutesForUpsert: + properties: + substitutes: items: - $ref: '#/components/schemas/PickingMethodEnum' + $ref: '#/components/schemas/Substitute' type: array + tenantArticleId: + type: string + version: + description: >- + Version field is used in the optimistic locking process. If the + Substitute is for the tenantArticleId is not set yet, this field is + ignored. + example: 1 + type: number required: - - orderDate - - facilityRef - - pickLineItems - additionalProperties: false + - substitutes + - version + - tenantArticleId type: object xml: - name: Pickjob - PickingZone: - description: Zones from which items can be picked + name: SubstitutesForUpsert + ResolvedSubstitutes: properties: - zoneRef: + substitutes: + items: + $ref: '#/components/schemas/Substitute' + type: array + tenantArticleId: type: string required: - - zoneRef - PaymentInformation: + - substitutes + - tenantArticleId + type: object + xml: + name: ResolvedSubstitutes + PackingConfigurations: + allOf: + - $ref: '#/components/schemas/VersionedResource' properties: - currency: - description: The currency in which the consumer paid with - example: EUR - type: string + packingContainerRequiredConfiguration: + $ref: '#/components/schemas/PackingContainerRequiredConfiguration' + packingItemConfirmationNeededConfiguration: + $ref: '#/components/schemas/PackingItemConfirmationNeededConfiguration' + packingSourceContainerConfiguration: + $ref: '#/components/schemas/PackingSourceContainerConfiguration' + scanningConfiguration: + $ref: '#/components/schemas/PackingScanningConfiguration' type: object - PickJobStatusUnprotected: + PackingSourceContainerConfiguration: + description: Can this tenant use the packing source container + properties: + active: + default: false + type: boolean + required: + - active + type: object + PackingScanningConfiguration: + properties: + scanningType: + $ref: '#/components/schemas/PackingScanningConfigurationEnum' + type: object + ScanningRuleConfiguration: description: >- - The status of a pickjob. These are the status that are still allowed to - be used in the deprecated status field of ModifyPickJob actions + Configuration to show the client how the items should be scanned during + picking + properties: + values: + items: + $ref: '#/components/schemas/ScanningRuleValue' + type: array + ScanningRuleValue: + properties: + priority: + description: >- + This field allows you to rank scanningRuleType against each other. + The lowest number is the most preferable. + minimum: 0 + type: number + scanningRuleType: + $ref: '#/components/schemas/ScanningRuleTypeEnum' + required: + - priority + - scanningRuleType + ScanningRuleTypeEnum: + example: ARTICLE + description: Type of scanning rule enum: - - OPEN - - IN_PROGRESS - - CLOSED - - PICKED - - REROUTED - - REJECTED - - RESTOWED - - EXPIRED + - ARTICLE + - LOCATION type: string - xml: - name: PickJobStatusUnprotected - PickJobStatus: - description: The status of a pickjob. + StockPropertyInputType: + example: DATE + description: Input Type for this property, used for clients. enum: - - ABORTED - - OPEN - - IN_PROGRESS - - CLOSED - - PICKED - - REROUTED - - REJECTED - - RESTOWED - - EXPIRED - - CANCELED - - OBSOLETE + - DATE + - TEXT type: string - xml: - name: PickJobStatus - PickJobLineItemPartialStockLocationForUpdate: + PackingScanningConfigurationEnum: + enum: + - MUST_SCAN_EACH + - SCAN_NOT_REQUIRED + type: string + PickingMethodEnum: + example: SINGLE_ORDER + description: >- + Way in which the picking should be handled Deprecated: BATCH_PICKING, + use BATCH instead + enum: + - SINGLE_ORDER + - MULTI_ORDER + - BATCH_PICKING + - BATCH + type: string + PackingContainerRequiredConfiguration: + additionalProperties: false properties: - tenantPartialStockId: - type: string - picked: - example: 21 - format: int64 - minimum: 0 - type: number - stockEmptied: - example: true + active: type: boolean + default: false required: - - tenantPartialStockId - - picked + - active type: object - PickJobLineItemPartialStockLocation: + PackingItemConfirmationNeededConfiguration: + description: Do the customer need to validate which items are part of a pack job + additionalProperties: false + properties: + active: + type: boolean + default: true + required: + - active + type: object + SubstitutionConfiguration: allOf: - - $ref: '#/components/schemas/PickJobLineItemPartialStockLocationForCreation' + - $ref: '#/components/schemas/VersionedResource' properties: - picked: - example: 21 - format: int64 - minimum: 0 - type: number - stockEmptied: - example: true + active: + default: true + description: Toggle for substitution articles. + example: false type: boolean required: - - tenantPartialStockId + - active type: object - PickJobLineItemPartialStockLocationForCreation: + SupportedEvent: properties: - tenantPartialStockId: + description: type: string - quantity: - description: >- - quantity of the specific article that should be picked from given - stockLocation - example: 21 - format: int64 - minimum: 0 + event: + type: string + type: object + SupportedEvents: + properties: + supportedEvents: + items: + $ref: '#/components/schemas/SupportedEvent' + type: array + type: object + SupportedLocale: + 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

ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.) + enum: + - de_DE + - en_US + - pl_PL + - ru_RU + - nl_NL + - fr_FR + - it_IT + - nb_NO + - es_ES + example: de_DE + type: string + SupportedLocales: + items: + $ref: '#/components/schemas/SupportedLocale' + type: array + TargetAddress: + allOf: + - $ref: '#/components/schemas/ConsumerAddress' + - properties: + facilityRef: + description: >- + The id of the facility reference. The given ID has to be present + in the system. + example: Esb20gpHBL94X5NdMp3C + type: string + type: object + type: object + TimeRange: + properties: + end: + $ref: '#/components/schemas/TimeStamp' + start: + $ref: '#/components/schemas/TimeStamp' + capacity: type: number - available: - example: 21 - format: int64 + minimum: 0 + required: + - start + - end + type: object + TimeStamp: + properties: + hour: + maximum: 23 minimum: 0 type: number - ratingScore: + minute: + maximum: 59 + minimum: 0 type: number - sequenceScore: + required: + - hour + - minute + type: object + TimeZone: + description: Timezone for information retrieved e.g. by the Google Maps API + properties: + offsetInSeconds: + description: offset in seconds to standard time + example: 28800 type: number - location: - $ref: '#/components/schemas/Location' - stockProperties: - anyOf: - - $ref: '#/components/schemas/PickingStockPropertyPreset' - - $ref: '#/components/schemas/PickingStockProperty' + timeZoneId: + description: official id of the timezone + example: America/Los_Angeles + type: string + timeZoneName: + description: descriptive name of the timezone + example: Pacific Standard Time + type: string + required: + - timeZoneId + - timeZoneName + - offsetInSeconds + type: object + TrackingStatus: + description: The state of the KEP + enum: + - registered + - picked_up + - delivered + - not_delivered + - transit + - exception + - out_for_delivery + - destroyed + - unknown + - canceled + - awaits_pickup_by_receiver + - delayed + - notification + type: string + PickRunStatus: + description: The state of the PickRun + enum: + - OPEN + - IN_PROGRESS + - CLOSED + - CANCELED + type: string + UserAssignedZone: + description: A facility zone that was assigned to an user + properties: + zoneRef: + example: LGMl2DuvPnfPoSHhYFOm + type: string + required: + - zoneRef + type: object + UserAssignedFacilityForCreation: + description: A facility that was assigned to an user + properties: + facilityRef: + description: The id of the assigned facility + example: 0T1vKaEar0nuG58CxzA5 + type: string + assignedZones: + items: + $ref: '#/components/schemas/UserAssignedZone' + type: array required: - - tenantPartialStockId + - facilityRef type: object - SubstituteLineItemPartialStockLocation: - properties: - quantity: - example: 21 - format: int64 - minimum: 0 - type: number - location: - $ref: '#/components/schemas/Location' + UserAssignedFacility: + description: A facility that was assigned to an user + allOf: + - $ref: '#/components/schemas/UserAssignedFacilityForCreation' + - properties: + id: + example: LGMl2DuvPnfPoSHhYFOm + type: string required: - - location - - quantity + - id type: object - PickLineItemArticle: + User: allOf: - - $ref: '#/components/schemas/AbstractArticle' + - $ref: '#/components/schemas/VersionedResource' - properties: - attributes: - items: - $ref: '#/components/schemas/OrderArticleAttributeItem' - type: array - prices: + customClaims: + $ref: '#/components/schemas/CustomClaims' + firstname: + example: Alex + type: string + id: + example: LGMl2DuvPnfPoSHhYFOm + type: string + lastname: + example: Schneider + type: string + locale: + $ref: '#/components/schemas/SupportedLocale' + username: + example: aschneider + type: string + authenticationProviderType: + deprecated: true + enum: + - EMAIL_PASSWORD + - OIDC + type: string + description: >- +
+
This endpoint is deprecated and has been + replaced.

@deprecated use authenticationProvider + instead. + authenticationProvider: + $ref: '#/components/schemas/AuthenticationProvider' + assignedFacilities: items: - $ref: '#/components/schemas/ArticlePrice' + $ref: '#/components/schemas/UserAssignedFacility' type: array + customAttributes: + nullable: true + description: >- + Attributes that can be added to the user. These attributes + **cannot** be used within fulfillment processes, but enable you + to attach custom data from your systems to fulfillmenttools + entities. + type: object + required: + - id + - username + - firstname + - lastname + - locale + - authenticationProvider type: object xml: - name: PickLineItemArticle - ArticlePrice: - additionalProperties: false - type: object - properties: - pricePerUnit: - type: number - example: 9.99 - description: Price value for a given currency per unit - minimum: 0 - currency: - description: The currency of the price as an ISO 4217 code. - example: EUR - nullable: true - allOf: - - $ref: '#/components/schemas/CurrencyCode' - PickingPatchActions: + name: User + AuthenticationProviderType: + enum: + - EMAIL_PASSWORD + - OIDC + type: string + AuthenticationProvider: properties: - actions: - items: - anyOf: - - $ref: '#/components/schemas/ModifyPickLineItemAction' - - $ref: '#/components/schemas/ModifyPickJobAction' - - $ref: '#/components/schemas/ModifyPickJobLastEditorAction' - - $ref: '#/components/schemas/RestartPickJobAction' - - $ref: '#/components/schemas/ResetPickJobAction' - - $ref: '#/components/schemas/AbortPickJobAction' - minItems: 1 - type: array - version: - description: >- - The version of the document to be used in optimistic locking - mechanisms. - example: 42 - format: int64 - type: integer + type: + $ref: '#/components/schemas/AuthenticationProviderType' + id: + example: LGMl2DuvPnfPoSHhYFOm + type: string required: - - version - - actions + - type type: object xml: - name: PickingPatchActions - PickRunPatchAction: + name: AuthenticationProvider + UserForCreation: properties: - actions: + firstname: + example: Alex + type: string + lastname: + example: Schneider + type: string + locale: + $ref: '#/components/schemas/SupportedLocale' + password: + example: Ghg9u8X7ms8A8tLT + type: string + roles: + $ref: '#/components/schemas/UserRoles' + username: + example: aschneider + type: string + assignedFacilities: items: - anyOf: - - $ref: '#/components/schemas/ModifyPickRunLineItemAction' - - $ref: '#/components/schemas/StartPickRunAction' - - $ref: '#/components/schemas/CancelPickRunAction' - - $ref: '#/components/schemas/FinishPickRunAction' - minItems: 1 + $ref: '#/components/schemas/UserAssignedFacilityForCreation' type: array - version: + customAttributes: + nullable: true description: >- - The version of the document to be used in optimistic locking - mechanisms. - example: 42 - format: int64 - type: integer + Attributes that can be added to the user. These attributes + **cannot** be used within fulfillment processes, but enable you to + attach custom data from your systems to fulfillmenttools entities. + type: object required: - - version - - actions + - username + - password + - firstname + - lastname + - roles type: object xml: - name: PickRunPatchAction - PickRunPickJobsPatchAction: + name: UserForCreation + UserPatchActions: properties: actions: items: - anyOf: - - $ref: '#/components/schemas/RemovePickJobFromPickRunAction' + $ref: '#/components/schemas/ModifyUserAction' minItems: 1 - maxItems: 1 type: array version: description: >- @@ -28037,941 +29891,844 @@ components: - actions type: object xml: - name: PickRunPickJobsPatchAction - CancelPickRunAction: - deprecated: true - description: >- -
-
This endpoint is deprecated and has been replaced.

@deprecated Use api/pickruns/:id/actions instead - allOf: - - $ref: '#/components/schemas/AbstractModificationAction' - - additionalProperties: false - properties: - action: - description: Use value 'CancelPickRun', because you want to cancel a pickrun - enum: - - CancelPickRun - type: string - required: - - action - type: object - xml: - name: CancelPickRunAction - StartPickRunAction: - deprecated: true - description: >- -
-
This endpoint is deprecated and has been replaced.

@deprecated Use api/pickruns/:id/actions instead - allOf: - - $ref: '#/components/schemas/AbstractModificationAction' - - additionalProperties: false - properties: - action: - description: Use value 'StartPickRun', because you want to start a pickrun - enum: - - StartPickRun - type: string - required: - - action - type: object - xml: - name: StartPickRunAction - FinishPickRunAction: - deprecated: true - description: >- -
-
This endpoint is deprecated and has been replaced.

@deprecated Use api/pickruns/:id/actions instead - allOf: - - $ref: '#/components/schemas/AbstractModificationAction' - - additionalProperties: false - properties: - action: - description: Use value 'FinishPickRun', because you want to finish a pickrun - enum: - - FinishPickRun - type: string - required: - - action - type: object - xml: - name: FinishPickRunAction - PickJobActionsParameter: - anyOf: - - $ref: '#/components/schemas/PickJobAbortActionParameter' - - $ref: '#/components/schemas/PickJobRestartActionParameter' - - $ref: '#/components/schemas/PickJobResetActionParameter' - - $ref: '#/components/schemas/PickJobObsoleteActionParameter' - PickJobAbortActionParameter: - additionalProperties: false - properties: - name: - $ref: '#/components/schemas/PickJobAbortActionEnum' - version: - description: Version of the entity to be changed - minimum: 0 - type: integer - required: - - name - - version - PickJobAbortActionEnum: - enum: - - ABORT - type: string - PickJobRestartActionParameter: - additionalProperties: false - properties: - name: - $ref: '#/components/schemas/PickJobRestartActionEnum' - version: - description: Version of the entity to be changed - minimum: 0 - type: integer - required: - - name - - version - PickJobRestartActionEnum: - enum: - - RESTART - type: string - PickJobObsoleteActionParameter: - additionalProperties: false - properties: - name: - $ref: '#/components/schemas/PickJobObsoleteActionEnum' - version: - description: Version of the entity to be changed - minimum: 0 - type: integer - required: - - name - - version - PickJobObsoleteActionEnum: - enum: - - OBSOLETE - type: string - PickJobResetActionParameter: - additionalProperties: false - properties: - name: - $ref: '#/components/schemas/PickJobResetActionEnum' - version: - description: Version of the entity to be changed - minimum: 0 - type: integer - required: - - name - - version - PickJobResetActionEnum: - enum: - - RESET - type: string - PackingContainerActionsParameter: - anyOf: - - $ref: '#/components/schemas/UpdatePackingContainerLineItemAction' - - $ref: '#/components/schemas/ReplacePackingContainerLineItemCodesAction' - UpdatePackingContainerLineItemAction: - additionalProperties: false + name: UserPatchActions + UserRole: properties: + facilities: + default: [] + description: List of facility Ids that the user is assigned to + example: + - 0T1vKaEar0nuG58CxzA5 + items: + type: string + maxItems: 23 + minItems: 0 + type: array name: - $ref: '#/components/schemas/UpdatePackingContainerLineItemEnum' - version: - description: Version of the entity to be changed - minimum: 0 - type: integer - payload: - additionalProperties: false - properties: - lineItem: - $ref: '#/components/schemas/PackingContainerLineItem' - required: - - lineItem + $ref: '#/components/schemas/UserRoleNames' required: - - version - - payload - name - UpdatePackingContainerLineItemEnum: - enum: - - UpdateLineItem - type: string - ReplacePackingContainerLineItemCodesEnum: + type: object + UserRoleNames: enum: - - ReplaceLineItemCodes + - FULFILLER + - SUPERVISOR + - ADMINISTRATOR type: string - ReplacePackingContainerLineItemCodesAction: - additionalProperties: false - properties: - name: - $ref: '#/components/schemas/ReplacePackingContainerLineItemCodesEnum' - version: - description: Version of the entity to be changed - minimum: 0 - type: integer - payload: - additionalProperties: false - properties: - codes: - items: - description: List of codes - type: string - minItems: 1 - type: array - required: - - codes - required: - - payload - - version - - name - PickRunActionsParameter: - anyOf: - - $ref: '#/components/schemas/PickRunStartActionParameter' - - $ref: '#/components/schemas/PickRunFinishActionParameter' - - $ref: '#/components/schemas/PickRunCancelActionParameter' - - $ref: '#/components/schemas/PickRunRemovePickJobActionParameter' - PickRunFinishActionParameter: - additionalProperties: false + UserRoles: + description: 'roles of a user ' + items: + $ref: '#/components/schemas/UserRole' + maxItems: 1 + minItems: 1 + type: array + VersionedResource: properties: - name: - $ref: '#/components/schemas/PickRunFinishActionEnum' + created: + description: >- + The date this entity was created at the platform. This value is + generated by the service. + example: '2020-02-03T08:45:51.525Z' + format: date-time + type: string + lastModified: + description: >- + The date this entity was modified last. This value is generated by + the service. + example: '2020-02-03T09:45:51.525Z' + format: date-time + type: string version: - description: Version of the entity to be changed - minimum: 0 + description: >- + The version of the document to be used in optimistic locking + mechanisms. + example: 42 + format: int64 type: integer required: - - name - version - PickRunFinishActionEnum: - enum: - - FINISH - type: string - PickRunStartActionParameter: - additionalProperties: false + type: object + CustomAttributesResource: + type: object properties: - name: - $ref: '#/components/schemas/PickRunStartActionEnum' - version: - description: Version of the entity to be changed - minimum: 0 - type: integer - required: - - name - - version - PickRunStartActionEnum: + customAttributes: + nullable: true + description: >- + Attributes that can be added to this entity. These attributes + **cannot** be used within fulfillment processes, but enable you to + attach custom data from your systems to fulfillmenttools entities. + type: object + CustomAttributableVersionedResource: + allOf: + - $ref: '#/components/schemas/VersionedResource' + - $ref: '#/components/schemas/CustomAttributesResource' + type: object + PickJobOrderBy: + description: Attribute to order a pickJobs by enum: - - START + - TARGET_TIME_DESC + - TARGET_TIME_ASC + - LAST_MODIFIED_DESC + - LAST_MODIFIED_ASC + - ORDER_DATE_DESC + - ORDER_DATE_ASC + - LAST_MODIFIED_BY_USER_DESC + - LAST_MODIFIED_BY_USER_ASC type: string - PickRunRemovePickJobActionParameter: - additionalProperties: false - properties: - name: - $ref: '#/components/schemas/PickRunRemovePickJobActionEnum' - version: - description: Version of the entity to be changed - minimum: 0 - type: integer - payload: - additionalProperties: false - properties: - pickJobId: - type: string - example: 4baaa052-7286-4dc2-937f-6e703ece25ac - required: - - pickJobId - required: - - name - - version - - payload - PickRunRemovePickJobActionEnum: + xml: + name: PickJobOrderBy + PackJobOrderBy: + description: Attribute to order a packJobs by enum: - - REMOVE_PICK_JOB + - TARGET_TIME_DESC + - TARGET_TIME_ASC + - LAST_MODIFIED_DESC + - LAST_MODIFIED_ASC + - ORDER_DATE_DESC + - ORDER_DATE_ASC type: string - PickRunCancelActionParameter: - additionalProperties: false - properties: - name: - $ref: '#/components/schemas/PickRunCancelActionEnum' - version: - description: Version of the entity to be changed - minimum: 0 - type: integer - required: - - name - - version - PickRunCancelActionEnum: + xml: + name: PackJobOrderBy + FacilityOrderBy: + description: Attribute to order a facility list enum: - - CANCEL + - NAME + - CREATED + - POSTAL_CODE_ASC type: string - HandoverJobActionsParameter: - anyOf: - - $ref: '#/components/schemas/HandoverJobCancelActionParameter' - HandoverJobCancelActionParameter: - additionalProperties: false - properties: - name: - $ref: '#/components/schemas/HandoverJobCancelActionEnum' - version: - description: Version of the entity to be changed - minimum: 0 - type: integer - payload: - additionalProperties: false - properties: - handoverJobCancelReason: - $ref: '#/components/schemas/HandoverJobCancelReason' - required: - - handoverJobCancelReason - required: - - name - - version - - payload - HandoverJobCancelActionEnum: + xml: + name: FacilityOrderBy + UserOrderBy: + description: Attribute to order a user list enum: - - CANCEL + - LASTNAME type: string - ModifyPickRunLineItemAction: - allOf: - - $ref: '#/components/schemas/AbstractModificationAction' - - properties: - action: - description: >- - Use value 'ModifyPickRunLineItem', because you want to modify a - pick line item - enum: - - ModifyPickRunLineItem - type: string - id: - description: >- - The id of this lineItem. It is generated during creation - automatically and suits as the primary identifier of the - described entity. - example: climk4dcQFiPdA5ULuhS - type: string - picked: - description: The amount of articles that were picked for this pickline. - example: 20 - format: int64 - minimum: 0 - type: integer - status: - $ref: '#/components/schemas/PickLineItemStatus' - partialStockLocations: - items: - $ref: >- - #/components/schemas/PickJobLineItemPartialStockLocationForUpdate - required: - - id - - action - type: object xml: - name: ModifyPickRunLineItemAction - RemovePickJobFromPickRunAction: - deprecated: true - description: >- -
-
This endpoint is deprecated and has been replaced.

@deprecated Use /api/pickruns/{pickRunId}/actions instead + name: UserOrderBy + CarrierConfiguration: allOf: - - $ref: '#/components/schemas/AbstractModificationAction' - - additionalProperties: false - properties: - action: - description: >- - Use value 'RemovePickJobFromPickRunAction', because you want to - remove a pickjob - enum: - - RemovePickJobFromPickRunAction - type: string - pickJobRef: - description: PickJob reference of the PickJob you want to remove. - type: string - required: - - action - - pickJobRef - type: object - xml: - name: RemovePickJobFromPickRunAction - PickingTimes: - description: There must be no overlaps for time ranges on a day + - $ref: '#/components/schemas/VersionedResource' properties: - friday: - items: - $ref: '#/components/schemas/TimeRange' + id: + type: string + carrierRef: + type: string + returnLabel: + default: false + description: >- + When enabled, a return label will be created by creating a shipping + label + example: false + type: boolean + additionalWeightInPercent: + description: >- + It is an amount of percentage for packaging weight which will be + added to the calculated shipping weight + type: number + minimum: 0 + mustBeWeighed: + description: >- + Indicates if the content of a parcel must be weighed before ordering + a label + type: boolean + default: false + example: false + fallBackTrackAndTraceEmail: + description: >- + EmailAddress used to receive track and trace information when no + other emailaddress was provided + type: string + example: max@speedyboxales.com + format: email + minLength: 1 + nonDeliveryDaysPerCountryAndProvince: type: array - monday: items: - $ref: '#/components/schemas/TimeRange' + $ref: '#/components/schemas/NonDeliveryDaysPerCountryAndProvince' + countryServiceMappings: + items: + $ref: '#/components/schemas/CarrierCountryServiceMapping' type: array - saturday: + serviceUrl: + type: string + required: + - returnLabel + - carrierRef + type: object + DeliveryCost: + type: object + additionalProperties: false + properties: + cost: + type: number + example: 10.99 + description: The cost of sending with a carrier + currency: + type: string + example: EUR + description: currency as 3 letter iso code + pattern: ^[A-Z]{3}$ + required: + - cost + - currency + CarrierCountryServiceMapping: + type: object + additionalProperties: false + properties: + id: + description: unique identifier for a countryServiceMapping + example: bc5b581a-8f65-45b0-9f81-6e0d4babbcb2 + type: string + source: + $ref: '#/components/schemas/RegionInformation' + destinations: + description: The destination regions this mapping should be applied to. items: - $ref: '#/components/schemas/TimeRange' + $ref: '#/components/schemas/RegionInformation' + minItems: 1 type: array - sunday: + sourceCountry: + deprecated: true + type: string + minLength: 2 + maxLength: 2 + description: >- +
+
This endpoint is deprecated and has been replaced.

@deprecated Use source instead. + example: DE + destinationCountries: + deprecated: true + description: >- +
+
This endpoint is deprecated and has been replaced.

@deprecated Use destination instead. items: - $ref: '#/components/schemas/TimeRange' + $ref: '#/components/schemas/CountryCode' + minItems: 1 type: array - thursday: + mandatoryShippingAttributes: items: - $ref: '#/components/schemas/TimeRange' + $ref: '#/components/schemas/MandatoryShippingAttribute' type: array - tuesday: + minItems: 0 + mandatoryShippingItemAttributes: items: - $ref: '#/components/schemas/TimeRange' + $ref: '#/components/schemas/MandatoryShippingItemAttribute' type: array - wednesday: + minItems: 0 + product: + type: string + example: EXPRESS + carrierProductCategory: + $ref: '#/components/schemas/CarrierProductCategory' + transitTime: + $ref: '#/components/schemas/CarrierTransitTime' + deliveryCosts: items: - $ref: '#/components/schemas/TimeRange' + $ref: '#/components/schemas/DeliveryCost' type: array + maxItems: 1 + required: + - id + - source + - destinations + CarrierCountryServiceMappingForCreation: type: object - PickjobDeliveryInformation: - allOf: - - $ref: '#/components/schemas/PickjobDeliveryInformationForCreation' - - required: - - targetTime - - channel - PickjobDeliveryInformationForCreation: + additionalProperties: false properties: - channel: - enum: - - COLLECT - - SHIPPING - type: string - details: - properties: - collect: - properties: - identifier: - description: Includes information about Click & Collect recipient - type: string - paid: - default: false - description: Indicates if the order is already paid. - type: boolean - type: object - shipping: - properties: - carrierKey: - type: string - carrierProduct: - description: >- - Desired product of given carrier to choose when ordering a - label - type: string - example: EXPRESS - carrierServices: - type: array - items: - $ref: '#/components/schemas/CarrierServices' - identifier: - description: >- - Includes information on how to identify Ship from Store - recipient (Name, PIN, Reference number, ...) - type: string - recipientaddress: - $ref: '#/components/schemas/ConsumerAddress' - invoiceAddress: - $ref: '#/components/schemas/ConsumerAddress' - postalAddress: - $ref: '#/components/schemas/ConsumerAddress' - serviceLevel: - description: TBD - enum: - - DELIVERY - - SAMEDAY - type: string - type: object - type: object - targetTime: - description: At which time the result is expected. - example: '2020-02-03T09:45:51.525Z' - format: date-time - type: string - targetTimeBaseDate: - description: The start date for the targetTime calculation. - example: '2020-02-03T08:45:50.525Z' - format: date-time + carrierConfigurationVersion: + description: >- + The version of the carrier configuration to be used in optimistic + locking mechanisms. + example: 42 + format: int64 + type: integer + source: + $ref: '#/components/schemas/RegionInformation' + destinations: + description: The destination regions this mapping should be applied to. + items: + $ref: '#/components/schemas/RegionInformation' + minItems: 1 + type: array + sourceCountry: + deprecated: true type: string - type: object - PreselectedFacility: - properties: - facilityRef: - description: Reference to the facility which is supposed to fulfill the order + minLength: 2 + maxLength: 2 + description: >- +
+
This endpoint is deprecated and has been replaced.

@deprecated Use source instead. + example: DE + destinationCountries: + deprecated: true + description: >- +
+
This endpoint is deprecated and has been replaced.

@deprecated Use destination instead. + items: + $ref: '#/components/schemas/CountryCode' + minItems: 1 + type: array + mandatoryShippingAttributes: + items: + $ref: '#/components/schemas/MandatoryShippingAttribute' + type: array + minItems: 0 + mandatoryShippingItemAttributes: + items: + $ref: '#/components/schemas/MandatoryShippingItemAttribute' + type: array + minItems: 0 + product: type: string + example: EXPRESS + carrierProductCategory: + $ref: '#/components/schemas/CarrierProductCategory' + transitTime: + $ref: '#/components/schemas/CarrierTransitTime' + deliveryCosts: + items: + $ref: '#/components/schemas/DeliveryCost' + type: array + minItems: 1 + maxItems: 1 required: - - facilityRef + - carrierConfigurationVersion + - source + - destinations + CarrierCountryServiceMappingForUpdate: type: object - PrioritizationRule: - description: >- - You can select a default Prioritization Rule from the catalog. When you - decide to select 'CUSTOM' you must also provide a vmExpression to match - the type CustomPrioritizationRule. + additionalProperties: false properties: - active: - type: boolean - id: + carrierConfigurationVersion: description: >- - This value identifies this very instance of the prioritization rule. - It is set autmatically by the server when the configuration is - updated. - example: 9156fafb-d0b4-4f99-815e-5f231cb50fae + The version of the document to be used in optimistic locking + mechanisms. + example: 42 + format: int64 + type: integer + source: + $ref: '#/components/schemas/RegionInformation' + destinations: + description: The destination regions this mapping should be applied to. + items: + $ref: '#/components/schemas/RegionInformation' + minItems: 1 + type: array + sourceCountry: + deprecated: true type: string - implementation: - $ref: '#/components/schemas/PrioritizationRuleImplementation' - name: + minLength: 2 + maxLength: 2 + description: >- +
+
This endpoint is deprecated and has been replaced.

@deprecated Use source instead. + example: DE + destinationCountries: + deprecated: true + description: >- +
+
This endpoint is deprecated and has been replaced.

@deprecated Use destination instead. + items: + $ref: '#/components/schemas/CountryCode' + minItems: 1 + type: array + mandatoryShippingAttributes: + items: + $ref: '#/components/schemas/MandatoryShippingAttribute' + type: array + minItems: 0 + mandatoryShippingItemAttributes: + items: + $ref: '#/components/schemas/MandatoryShippingItemAttribute' + type: array + minItems: 0 + product: type: string + example: EXPRESS + carrierProductCategory: + $ref: '#/components/schemas/CarrierProductCategory' + transitTime: + $ref: '#/components/schemas/CarrierTransitTime' + deliveryCosts: + items: + $ref: '#/components/schemas/DeliveryCost' + type: array + minItems: 1 + maxItems: 1 required: - - active - - name - - implementation - type: object - PrioritizationRuleImplementation: - enum: - - CUSTOM + - carrierConfigurationVersion + CarrierProductCategory: type: string - xml: - name: PrioritizationRuleImplementation - Processes: + enum: + - STANDARD + - EXPRESS + - VALUE + - FORWARDING + CarrierTransitTime: + type: object properties: - processes: - items: - $ref: '#/components/schemas/Process' - type: array - total: - description: Total number of found entities for this query - example: 42 + minTransitDays: + description: Minimum days a carrier needs for transit + example: 1 type: integer - type: object - DomainStatusHistoryItem: - description: >- - This item represent a process status change triggered by a specific - domain. + minimum: 0 + maxTransitDays: + description: Maximum days a carrier needs for transit + example: 3 + type: integer + minimum: 0 + required: + - maxTransitDays + - minTransitDays + MandatoryShippingItemAttribute: properties: - timestamp: - description: >- - Timestamp of the moment at which the state was notified by the - domain. - example: '2020-02-03T08:45:50.525Z' - format: date-time + referencedField: type: string - domain: - description: The domain of the entity that caused the status change. - $ref: '#/components/schemas/DomainType' - domainRef: - description: The id of the domain entity that caused the status change. + enum: + - description + - weightInGram + - quantity + - parcelItemValue.value + - parcelItemValue.currency + - countryOfManufacture + - tenantArticleId + description: 'Deprecated: quantity, this field is now mandatory in the item' + dataType: type: string - domainEntityProcessStatus: - description: The assigned status - $ref: '#/components/schemas/DomainStatus' - required: - - timestamp - - domain - - domainEntityProcessStatus - - domainRef + enum: + - Number + - String + - Date + description: + type: string + descriptionLocalized: + $ref: '#/components/schemas/LocaleString' type: object - LastDomainEntityStatusItem: - description: >- - An object holding the last DomainStatus of a given entity and its - corresponding domain. + MandatoryShippingAttribute: properties: - domain: - description: The domain of the entity that caused the status change. - $ref: '#/components/schemas/DomainType' - status: - description: The status of the entity. - $ref: '#/components/schemas/DomainStatus' - entityId: - description: The entity id + referencedField: type: string - required: - - domain - - status - - entityId + enum: + - dimensions.weight + - productValue + - pickUpInformation.startTime + - pickUpInformation.endTime + dataType: + type: string + enum: + - Number + - String + - Date + description: + type: string + descriptionLocalized: + $ref: '#/components/schemas/LocaleString' + type: object + RegionInformation: type: object - Process: - allOf: - - $ref: '#/components/schemas/VersionedResource' properties: - tags: + countryCode: + $ref: '#/components/schemas/CountryCode' + postalCodes: type: array - minItems: 1 - items: - $ref: '#/components/schemas/TagReference' - flatRefs: - description: >- - This field references all IDs of any entity connected to this - process. items: type: string - type: array - gdprCleanupDate: + required: + - countryCode + CountryCode: + type: string + minLength: 2 + maxLength: 2 + description: ISO 3166 ALPHA-2 of country + example: DE + PackJobForCreation: + properties: + customAttributes: description: >- - The date that defines when the entities will be or have been - anonymized. - example: '2020-02-03T08:45:50.525Z' - format: date-time + Attributes that can be added to the pack job. These attributes + cannot be used within fulfillment processes, but it could be useful + to have the informations carried here. + type: object + facilityRef: + description: Reference to the facility you want to get the corresponding packjob + example: Esb50gpH7794X5NdMp3C type: string - deletionDate: - description: >- - The date that defines when the entities will be or have been - deleted. - example: '2020-02-03T08:45:50.525Z' - format: date-time + pickJobRef: + description: Reference to a pick job + example: Pic50gpH7794X5NdMp3C type: string - handoverJobRefs: - description: References to Handoverjobs connected to this process (if present). + status: + $ref: '#/components/schemas/PackJobStatus' + lineItems: items: - type: string + $ref: '#/components/schemas/PackLineItemForCreation' type: array - id: - description: ID of this process + processId: + description: >- + Id of the global process related to this entity. For example used + for starting the GDPR process and others. type: string - isAnonymized: - description: Indicates if the entities have been anonymized. - type: boolean - orderRef: - description: References to the Order connected to this process (if present). + operativeProcessRef: type: string - routingPlanRefs: - description: >- - References the RoutingPlans that were used during this process (if - present). - items: - type: string - type: array - pickJobRefs: - description: References to the Pickjobs connected to this process (if present). - items: - type: string - type: array - returnRefs: - description: References to the Returns connected to this process (if present). - items: - type: string - type: array - itemReturnJobsRef: - description: >- - References to the Item Return Job connected to this process (if - present). - items: - type: string - type: array - shipmentRefs: - description: References to the Shipments connected to this process (if present). - items: - type: string - type: array tenantOrderId: - description: The tenantOrderId referencing this process. type: string - documentRefs: - description: References to documents that are attached to this process. - items: - type: string - type: array - status: - description: Overall status of the process. - $ref: '#/components/schemas/ProcessStatus' - default: CREATED - domsStatus: - description: Overall status of the process. - $ref: '#/components/schemas/ProcessStatus' - default: CREATED - operativeStatus: - description: Overall status of the process - $ref: '#/components/schemas/ProcessStatus' - default: CREATED - domainStatuses: - type: object - description: Overview of the different domain adherent status of the process. - additionalProperties: - $ref: '#/components/schemas/DomainStatus' - lastDomainEntityStatuses: - type: array - description: The last domain statuses of each domain - items: - $ref: '#/components/schemas/LastDomainEntityStatusItem' - packJobRefs: - description: References of the Packjobs connected to this process (if present). - items: - type: string - type: array - facilityRefs: - description: References of the Facilities connected to this process (if any). - items: - type: string - type: array - domainStatusHistory: + targetTime: + description: Until when the pack job must be finished. + example: '2020-02-03T09:45:51.525Z' + format: date-time + type: string + orderDate: + description: Date when the order was placed. + example: '2020-02-03T09:45:51.525Z' + format: date-time + type: string + tags: description: >- - History of process status changes caused by changes on the related - domains. + Tags can only be set when there is no process related with this + packJob. Setting processId and tags will lead to an validationError. type: array + minItems: 1 items: - $ref: '#/components/schemas/DomainStatusHistoryItem' - serviceJobRefs: - description: >- - References to the Service Jobs connected to this process (if - present). - items: - type: string + $ref: '#/components/schemas/TagReference' + recipient: + $ref: '#/components/schemas/ConsumerAddress' + invoice: + $ref: '#/components/schemas/ConsumerAddress' + deliveryChannel: + enum: + - COLLECT + - SHIPPING + type: string + shortId: + description: The short identifier of the shipment. + type: string + transfers: type: array + minItems: 0 + items: + $ref: '#/components/schemas/OperativeTransfer' required: - - gdprCleanupDate - - id + - facilityRef + - lineItems type: object - ProcessProgressLog: + xml: + name: PackJobForCreation + DocumentHandling: + type: object + properties: + sendLabel: + type: object + properties: + enabled: + type: boolean + default: false + required: + - enabled + required: + - sendLabel + PackJob: allOf: - $ref: '#/components/schemas/VersionedResource' - properties: - id: - type: string - processRef: - type: string - domainEntityProcessStatus: - $ref: '#/components/schemas/DomainStatus' - domain: - $ref: '#/components/schemas/DomainType' - domainRef: - type: string - domainStatus: - type: string - domainLastModified: - description: The last modified date of the related domain entity - example: '2020-02-03T09:45:51.525Z' - format: date-time - type: string - domainVersion: - description: The version of the related domain entity - example: 1 - format: int64 - type: integer - attributes: + - properties: + id: + description: >- + The id of this pack job. It is generated during creation + automatically and suits as the primary identifier of the + described entity. + example: Esb20gpHBL94X5NdMp3C + type: string + editor: + $ref: '#/components/schemas/Editor' + facilityRef: + description: >- + Reference to the facility you want to get the corresponding + packjob + example: Esb50gpH7794X5NdMp3C + type: string + pickJobRef: + description: Reference to a pick job + example: Pic50gpH7794X5NdMp3C + type: string + status: + $ref: '#/components/schemas/PackJobStatus' + lineItems: + items: + $ref: '#/components/schemas/PackLineItem' + type: array + packingSourceContainers: + items: + $ref: '#/components/schemas/StrippedPackingSourceContainer' + processId: + description: >- + Id of the global process related to this entity. For example + used for starting the GDPR process and others. + type: string + operativeProcessRef: + type: string + targetTime: + description: Until when the pack job must be finished. + example: '2020-02-03T09:45:51.525Z' + format: date-time + type: string + orderDate: + description: Date when the order was placed. + example: '2020-02-03T09:45:51.525Z' + format: date-time + type: string + tags: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/TagReference' + stickers: + items: + $ref: '#/components/schemas/Sticker' + type: array + recipient: + $ref: '#/components/schemas/ConsumerAddress' + invoice: + $ref: '#/components/schemas/ConsumerAddress' + tenantOrderId: + type: string + documentsRef: + description: Reference to the documents collection from this entity + type: string + documentHandling: + $ref: '#/components/schemas/DocumentHandling' + anonymized: + description: Indicates if gdpr related data was anonymized + example: false + type: boolean + deliveryChannel: + enum: + - COLLECT + - SHIPPING + type: string + customAttributes: + description: >- + Attributes that can be added to the pack job. These attributes + cannot be used within fulfillment processes, but it could be + useful to have the informations carried here. + type: object + shortId: + description: The short identifier of the shipment. + type: string + transfers: + type: array + minItems: 0 + items: + $ref: '#/components/schemas/OperativeTransfer' + required: + - id + - facilityRef + - documentsRef + - status + - lineItems + - processId type: object + xml: + name: PackJob + TagReference: required: + - value - id - - domainVersion - - processRef - - domainEntityProcessStatus - - domain - - domainRef - - domainStatus - DomainStatus: + properties: + value: + type: string + id: + type: string + PackJobStatus: + description: >- + A pack job initially has the status OPEN and packing can start. When + packing has started, the pack job changes its status to IN_PROGRESS. + After a pack job has been completely packed its status becomes CLOSED. enum: - - PENDING - - CREATED + - OPEN - IN_PROGRESS - - STUCK - - FINISHED - - CANCELED + - CLOSED - OBSOLETE - type: string - ProcessStatus: - enum: - - CREATED - - IN_PROGRESS - - FINISHED - CANCELED - - ERROR - - NOT_AVAILABLE - type: string - DomainType: - enum: - - ORDER - - ROUTING_PLAN - - PICKJOB - - PACKJOB - - SHIPMENT - - HANDOVER - - RETURN - - SERVICE_JOB - type: string - Section: - enum: - - ORDER - - PACKJOB - - PICKJOB - - HANDOVERJOB - - PARCEL - type: string - DocumentType: - enum: - - PDF - - PNG - - JPG - - GIF - - JPEG + - PAUSED type: string - ExternalDocument: - allOf: - - $ref: '#/components/schemas/VersionedResource' - properties: - type: - $ref: '#/components/schemas/DocumentType' - section: - $ref: '#/components/schemas/Section' - name: - type: string - path: - type: string - id: - type: string - priority: - type: number - minimum: 0 - required: - - type - - section - - id - type: object - ExternalDocumentInSectionForCreation: - additionalProperties: false + xml: + name: PackJobStatus + TagPatchActions: properties: - type: - $ref: '#/components/schemas/DocumentType' - file: - $ref: '#/components/schemas/NamedFile' - priority: - type: number - minimum: 0 + actions: + items: + anyOf: + - $ref: '#/components/schemas/AddAllowedValueToTagAction' + minItems: 1 + type: array + version: + description: >- + The version of the document to be used in optimistic locking + mechanisms. + example: 42 + format: int64 + type: integer required: - - type + - version + - actions type: object - ExternalDocumentForCreation: - additionalProperties: false + xml: + name: TagPatchActions + AddAllowedValueToTagAction: + allOf: + - $ref: '#/components/schemas/AbstractModificationAction' + - additionalProperties: false + properties: + action: + description: >- + Use value 'AddAllowedValueToTag', because you want to add an + allowed value to a tag + enum: + - AddAllowedValueToTag + type: string + allowedValue: + type: string + required: + - action + - allowedValue + type: object + xml: + name: AddAllowedValueToTagAction + PackLineItemForCreation: properties: - type: - $ref: '#/components/schemas/DocumentType' - section: - $ref: '#/components/schemas/Section' - file: - $ref: '#/components/schemas/NamedFile' - priority: - type: number - minimum: 0 + article: + $ref: '#/components/schemas/PackLineItemArticle' + customAttributes: + description: >- + Attributes that can be added to the pack line. These attributes + cannot be used within fulfillment processes, but it could be useful + to have the information carried here. + type: object + quantity: + description: quantity of the specific article that has been ordered + example: 21 + format: int64 + minimum: 1 + type: integer + measurementUnitKey: + description: Identifier for items unit of measurement. + example: liter + type: string + tags: + items: + $ref: '#/components/schemas/TagReference' + type: array + stickers: + items: + $ref: '#/components/schemas/Sticker' + type: array + scannableCodes: + items: + description: Codes, that identify the article + type: string + type: array required: - - type - - section + - quantity + - article type: object - ExternalDocumentForUpdate: + xml: + name: PackLineItemForCreation + PackLineItem: allOf: - - $ref: '#/components/schemas/VersionedResource' - properties: - file: - $ref: '#/components/schemas/NamedFile' - required: - - file + - $ref: '#/components/schemas/PackLineItemForCreation' + - properties: + id: + description: >- + The id of this lineItem. It is generated during creation + automatically and suits as the primary identifier of the + described entity. + example: climk4dcQFiPdA5ULuhS + type: string + packed: + description: The amount of articles that were packed for this packline. + example: 20 + format: int32 + minimum: 0 + type: integer + required: + - id type: object - Rating: - additionalProperties: false - description: >- - A rating is used to rate a set of possible facilities against each other - during routing of orders. + xml: + name: PackLineItem + PackLineItemForUpdate: properties: - active: - type: boolean - configuration: - $ref: '#/components/schemas/AbstractRatingConfiguration' - description: - type: string id: - description: >- - This value identifies this very instance of the rating. It is set - automatically by the server when the configuration is updated. - example: 579ff115-8941-4221-8530-04f8b4adf59f - type: string - implementation: - $ref: '#/components/schemas/RatingImplementation' - maxPenalty: - example: 100 - type: number - name: type: string + description: references the id of the packLineItem of a packJob + packed: + description: >- + The amount of articles that were packed for this packline. Can't be + more than picked before. + example: 20 + format: int64 + minimum: 0 + type: integer required: - - name - - active - - implementation - - maxPenalty - id + - packed type: object - RatingImplementation: - 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

- enum: - - STOCK-BALANCING - - GEO-DISTANCE - - TURNOVER - - STOCK-AVAILABILITY - - WORKLOAD-BALANCING - - MATCHING-BUSINESSTYPE - - PREFER-STORE - - PREFER-WAREHOUSE - - ZONE - - EXPIRY-DATE - - CAPACITY - - DELIVERY-COSTS - - DELIVERY-TIME - type: string xml: - name: RatingImplementation - RerouteReason: - enum: - - PROCESSREROUTE - - MANUAL - - SHORTPICK - - TIMETRIGGERED - - STOCKZEROED - - ABORTED - - RECALCULATION - type: string - RerouteRoutingPlan: + name: PackLineItemForUpdate + PackLineItemArticle: + allOf: + - $ref: '#/components/schemas/AbstractArticle' + - properties: + attributes: + items: + $ref: '#/components/schemas/ArticleAttributeItem' + type: array + type: object + xml: + name: PackLineItemArticle + PackJobWithSearchPath: + allOf: + - $ref: '#/components/schemas/PackJob' + - additionalProperties: false properties: - allReroutable: - description: >- - if set to true every reroutable routing plan is rerouted. overrules - every other identifier - type: boolean - orderRefs: - items: - type: string - maxItems: 10 - type: array - routingPlanIds: + searchPaths: items: type: string - maxItems: 10 type: array - tenantOrderIds: + minItems: 0 + xml: + name: PackJobWithPath + PackJobs: + properties: + packJobs: items: - type: string - maxItems: 10 + $ref: '#/components/schemas/PackJobWithSearchPath' type: array + total: + description: Total number of found entities for this query + example: 42 + type: integer type: object - OidcProviders: + PackJobPatchActions: properties: - providers: + actions: items: - $ref: '#/components/schemas/StrippedOidcProvider' + anyOf: + - $ref: '#/components/schemas/ModifyPackJobAction' + - $ref: '#/components/schemas/ModifyPackLineItemAction' + - $ref: '#/components/schemas/PausePackJobAction' + minItems: 1 type: array - total: - type: number - required: - - providers - - total - OidcProviderForUpdate: - allOf: - - $ref: '#/components/schemas/OidcProviderForCreation' - properties: version: description: >- The version of the document to be used in optimistic locking @@ -28981,634 +30738,779 @@ components: type: integer required: - version - OidcProviderForCreation: + - actions + type: object + xml: + name: PackJobPatchActions + ModifyPackJobAction: + allOf: + - $ref: '#/components/schemas/AbstractModificationAction' + - additionalProperties: false + properties: + action: + description: Use value 'ModifyPackJob', because you want to modify a packjob + enum: + - ModifyPackJob + type: string + status: + $ref: '#/components/schemas/PackJobStatus' + required: + - action + type: object + xml: + name: ModifyPackJobAction + PausePackJobAction: + allOf: + - $ref: '#/components/schemas/AbstractModificationAction' + - additionalProperties: false + properties: + action: + description: Use value 'PausePackJob', because you want to pause a packjob + enum: + - PausePackJob + type: string + packLineItemsUpdate: + items: + $ref: '#/components/schemas/PackLineItemForUpdate' + type: array + required: + - action + type: object + xml: + name: PausePackJobAction + ModifyPackLineItemAction: + allOf: + - $ref: '#/components/schemas/AbstractModificationAction' + - additionalProperties: false + properties: + action: + description: >- + Use value 'ModifyPackLineItem', because you want to modify a + packjobs lineItem + enum: + - ModifyPackLineItem + type: string + id: + type: string + description: references the id of the packLineItem of a packJob + packed: + description: >- + The amount of articles that were packed for this packline. Can't + be more than picked before. + example: 20 + format: int64 + minimum: 0 + type: integer + required: + - action + - id + type: object + xml: + name: ModifyPackLieItemAction + PartialStockForCreation: + additionalProperties: false properties: - name: - type: string - minLength: 3 - maxLength: 15 - status: - $ref: '#/components/schemas/OidcProviderStatus' - issuer: - type: string - clientId: - type: string - customParameters: - type: array - items: - $ref: '#/components/schemas/OidcProviderCustomParameter' - minItems: 0 - maxItems: 3 - clientSecret: + tenantPartialStockId: + description: The id associated with the partial stock type: string - assignedGroups: + stockinformation: + $ref: '#/components/schemas/StockInformationForCreation' + scores: type: array items: - $ref: '#/components/schemas/AssignedGroup' + $ref: '#/components/schemas/Score' + location: + $ref: '#/components/schemas/Location' required: - - clientSecret - - name - - status - - issuer - - clientId - - customParameters - - assignedGroups - OidcProviderCustomParameter: + - tenantPartialStockId + - stockinformation type: object - properties: - key: - type: string - value: - type: string - required: - - key - - value - StrippedOidcProvider: + xml: + name: PartialStock + PartialStock: allOf: - - $ref: '#/components/schemas/VersionedResource' + - $ref: '#/components/schemas/PartialStockForCreation' properties: - id: - type: string - name: - type: string - minLength: 3 - maxLength: 15 - status: - $ref: '#/components/schemas/OidcProviderStatus' - issuer: - type: string - clientId: + eventLastModified: + description: >- + The date when the inventory domain comunicated a change in this + partial stock + example: '2020-02-03T08:45:50.525Z' + format: date-time type: string - customParameters: - items: - $ref: '#/components/schemas/OidcProviderCustomParameter' - minItems: 0 - maxItems: 3 - type: array - assignedGroups: - type: array - items: - $ref: '#/components/schemas/AssignedGroup' + stockinformation: + $ref: '#/components/schemas/StockInformation' required: - - id - - name - - status - - issuer - - clientId - - customParameters - - assignedGroups - OidcProviderStatus: - description: Status of Provider - enum: - - ACTIVE - - INACTIVE - type: string - AssignedGroup: + - tenantPartialStockId + - stockinformation type: object + xml: + name: PartialStock + Location: properties: - group: + locationRef: + description: The id of the location type: string - minLength: 1 - facilityRefs: + scannableCodes: + description: Represents barcodes that may be scanned at this location type: array - minItems: 1 items: type: string + xml: + name: Location + ScoreType: + description: Describes what kind of score is represented + enum: + - RATING + - SEQUENCE + type: string + xml: + name: ScoreType + ScoreName: + description: Describes the name of the score for humans to identify + enum: + - ZONE + - EXPIRY_DATE + - RECEIPT_DATE + - RUNNING_SEQUENCE + - RESTOW_SEQUENCE + type: string + xml: + name: ScoreName + Score: + properties: + scoreType: + $ref: '#/components/schemas/ScoreType' + scoreName: + $ref: '#/components/schemas/ScoreName' + scoreValue: + description: Describes the performance of the score + type: number required: - - group - - facilityRefs - RerouteShortPickConfiguration: + - scoreType + - scoreName + - scoreValue + type: object + xml: + name: Score + ModifyPartialStockAction: allOf: - - $ref: '#/components/schemas/VersionedResource' + - $ref: '#/components/schemas/AbstractModificationAction' + - additionalProperties: false + properties: + action: + description: >- + Use value 'ModifyPartialStock', because you want to modify a + partial stock + enum: + - ModifyPartialStock + type: string + partialStocks: + items: + $ref: '#/components/schemas/PartialStockForCreation' + minItems: 0 + type: array + required: + - action + type: object + xml: + name: ModifyPartialStockAction + PartialStockPatchActions: properties: - blacklistAssignedFacilities: - default: false + actions: + items: + $ref: '#/components/schemas/ModifyPartialStockAction' + minItems: 1 + maxItems: 1 + type: array + version: description: >- - Does not consider facilities which previously owned the pickjob - during routing. - type: boolean - clickAndCollectReroute: - $ref: '#/components/schemas/ClickAndCollectRerouteConfiguration' - restowAfterMinutes: - description: The amount of minutes after which an automated restow is executed - example: '60' - type: number - shipFromStoreReroute: - $ref: '#/components/schemas/ShipFromStoreRerouteConfiguration' - id: - type: string - rerouteZeroPicksOnly: - default: false - description: Whether or not only pickjobs with zero items picked may be rerouted - type: boolean + The version of the listing where we want to patch the partialStocks, + to be used in optimistic locking mechanisms. + example: 42 + format: int64 + type: integer required: - - clickAndCollectReroute - - shipFromStoreReroute + - version + - actions type: object - GlobalManualRerouteConfiguration: - description: Allows reroutes to be triggered manually via api. + xml: + name: PartialStockPatchActions + PartialStocksForReplacement: + additionalProperties: false properties: - active: - type: boolean + partialStocks: + items: + $ref: '#/components/schemas/PartialStockForCreation' + minItems: 1 + type: array + version: + description: >- + The version of the listing where we want to put the partialStocks, + to be used in optimistic locking mechanisms. + example: 42 + format: int64 + type: integer required: - - active + - partialStocks + - version type: object - ManualRerouteConfiguration: - deprecated: true - description: >- - @deprecated This config property is deprecated since 26/02/24. Use - GlobalManualRerouteConfiguration instead. + xml: + name: PartialStocksForReplacement + Tag: allOf: - $ref: '#/components/schemas/VersionedResource' + - $ref: '#/components/schemas/TagForCreation' + properties: + id: + type: string + xml: + name: Tag + required: + - id + TagForCreation: + additionalProperties: false + required: + - id + - allowedValues properties: - active: - type: boolean id: type: string + allowedValues: + type: array + minItems: 1 + items: + type: string + StrippedTags: + properties: + tags: + items: + $ref: '#/components/schemas/Tag' + type: array + total: + description: Total number of found entities for this query + example: 42 + type: integer + type: object + ProcessPatchActions: + properties: + actions: + items: + anyOf: + - $ref: '#/components/schemas/AddTagsToProcessAction' + - $ref: '#/components/schemas/AssignFacilityToProcessAction' + minItems: 1 + type: array + version: + description: >- + The version of the document to be used in optimistic locking + mechanisms. + example: 42 + format: int64 + type: integer required: - - active + - version + - actions type: object - RerouteTimeTriggeredConfiguration: + xml: + name: ProcessPatchActions + AddTagsToProcessAction: allOf: - - $ref: '#/components/schemas/VersionedResource' - required: - - clickAndCollectReroute - - shipFromStoreDeliveryReroute - - shipFromStoreSamedayReroute + - $ref: '#/components/schemas/AbstractModificationAction' + - additionalProperties: false + properties: + action: + description: >- + Use value 'AddTagsToProcess', because you want to modify a + process + enum: + - AddTagsToProcess + type: string + tags: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/TagReference' + required: + - action + type: object + xml: + name: AddTagsToProcessAction + PrintableDocument: + type: object properties: - clickAndCollectReroute: - $ref: '#/components/schemas/RerouteConfiguration' - shipFromStoreDeliveryReroute: - $ref: '#/components/schemas/RerouteConfiguration' - shipFromStoreSamedayReroute: - $ref: '#/components/schemas/RerouteConfiguration' id: type: string - PromisesConfiguration: - allOf: - - $ref: '#/components/schemas/VersionedResource' - required: - - invalidAfterTime - properties: - invalidAfterTime: - default: PT8H - description: >- - Default amount of time in ISO 8601 duration format after which an - promised order becomes invalid and is cancelled. The duration need - to be a multiple of 60 seconds. + documentType: + $ref: '#/components/schemas/DocumentType' + documentCategory: + $ref: '#/components/schemas/DocumentCategory' + status: + $ref: '#/components/schemas/DocumentStatus' + operations: + type: array + description: Offered operations for this document + items: + $ref: '#/components/schemas/DocumentOperations' + name: type: string - pattern: ^P(?:(\d+W)|(\d+Y)?(\d+M)?(\d+D)?(?:T(\d+H)?(\d+M)?(\d+S)?)?)$ - id: + path: type: string - RerouteConfiguration: - required: - - active - - rerouteTargetTimeHours - - rerouteAfterMinutes - properties: - active: - type: boolean - rerouteTargetTimeHours: - type: number - example: '48' - default: 48 - minimum: 1 - description: >- - Only pickjobs within the target time window are considered for - reroute. - rerouteAfterMinutes: + priority: type: number - example: '60' - default: 1440 - minimum: 5 - description: The amount of minutes after which an automated reroute is executed - ReturnArticleAttributeItem: - allOf: - - $ref: '#/components/schemas/ArticleAttributeItem' - ReturnConfiguration: - allOf: - - $ref: '#/components/schemas/VersionedResource' - properties: - active: - deprecated: true - default: true - description: >- -
-
This endpoint is deprecated and has been replaced.

Enable or disable legacy returns. Use - returnTypeConfiguration instead - type: boolean - returnTypeConfiguration: - $ref: '#/components/schemas/ReturnTypeConfiguration' - availableItemConditions: - items: - $ref: '#/components/schemas/AvailableItemCondition' - availableReturnReasons: - items: - $ref: '#/components/schemas/AvailableReturnReason' + minimum: 0 required: - - active + - documentType + - id + - status + - documentCategory + PrintableDocumentForUpdate: type: object - ExpiryConfiguration: - allOf: - - $ref: '#/components/schemas/VersionedResource' + additionalProperties: false properties: - provisioningTimeOffsetInMinutes: + version: + description: Version of the documentSet you want to update a document of + example: 42 + format: int64 type: integer - minimum: 0 + priority: + description: Sorting display order of document + example: 42 + format: int64 + type: integer + operations: + type: array + description: Offered operations for this document + minItems: 1 + items: + $ref: '#/components/schemas/DocumentOperations' required: - - provisioningTimeOffsetInMinutes + - version + ExternalPrintableDocumentForCreation: type: object - AvailableItemCondition: - additionalProperties: false - properties: - conditionLocalized: - description: Will be translated into 'condition' when requested - $ref: '#/components/schemas/LocaleString' - example: - de_DE: Beschädigt - en_US: Damaged - AvailableReturnReason: additionalProperties: false properties: - reasonLocalized: - description: Will be translated into 'reason' when requested - example: - de_DE: Beschädigt - en_US: Damaged - $ref: '#/components/schemas/LocaleString' - required: - - reasonLocalized - LocalizedReturnConfiguration: - allOf: - - $ref: '#/components/schemas/VersionedResource' - properties: - active: - deprecated: true - default: true - description: >- -
-
This endpoint is deprecated and has been replaced.

Enable or disable legacy returns. Use - returnTypeConfiguration instead - type: boolean - returnTypeConfiguration: - $ref: '#/components/schemas/ReturnTypeConfiguration' - availableItemConditions: - items: - $ref: '#/components/schemas/LocalizedAvailableItemCondition' - availableReturnReasons: + type: + $ref: '#/components/schemas/DocumentType' + file: + $ref: '#/components/schemas/NamedFile' + priority: + type: number + minimum: 0 + operations: + type: array + description: Offered operations for this document + minItems: 1 items: - $ref: '#/components/schemas/LocalizedAvailableReturnReason' + $ref: '#/components/schemas/DocumentOperations' required: - - active + - type + ExternalDocumentContentForUpdate: type: object - LocalizedAvailableItemCondition: additionalProperties: false properties: - condition: - type: string - example: Damaged - description: translated conditionsLocalized - conditionLocalized: - $ref: '#/components/schemas/LocaleString' - example: - de_DE: Beschädigt - en_US: Damaged + file: + $ref: '#/components/schemas/NamedFile' + documentSetVersion: + type: number + example: 2 + description: Version of documentSet to which this document belongs. required: - - conditionLocalized - - condition - LocalizedAvailableReturnReason: + - file + - documentSetVersion + DocumentSet: allOf: - - $ref: '#/components/schemas/AvailableReturnReason' - additionalProperties: false + - $ref: '#/components/schemas/VersionedResource' properties: - reason: + id: type: string - example: Damaged - description: translated reasonLocalized - required: - - reasonLocalized - - reason - ReturnTypeConfiguration: - properties: - type: - $ref: '#/components/schemas/ReturnConfigurationType' + facilityRef: + type: string + documents: + type: array + items: + $ref: '#/components/schemas/PrintableDocument' required: - - type - ReturnConfigurationType: + - id + DocumentStatus: type: string enum: - - RETURN - - ITEM_RETURN - ReturnItemArticle: - allOf: - - $ref: '#/components/schemas/AbstractArticle' - - properties: - attributes: - items: - $ref: '#/components/schemas/ReturnArticleAttributeItem' - type: array - type: object - xml: - name: ReturnItemArticle - ReturnJob: + - AVAILABLE + - LOADING + - REQUESTABLE + - CANCELED + - WAITING_FOR_INPUT + DocumentOperations: + type: string + enum: + - PRINT + - VIEW + DocumentCategory: + enum: + - EXTERNAL + - DELIVERYNOTE + - RETURNNOTE + - SENDLABEL + - RETURNLABEL + type: string + AssignFacilityToProcessAction: allOf: - - $ref: '#/components/schemas/ReturnJobForCreation' - - $ref: '#/components/schemas/VersionedResource' - - properties: + - $ref: '#/components/schemas/AbstractModificationAction' + - additionalProperties: false + properties: + action: + description: Use value to manually assign a facility to a process + enum: + - AssignFacilityToProcess + type: string facilityRef: - description: >- - Reference to the facility which could have been given via - tenantFacilityID while creating type: string - anonymized: - description: Indicates if gdpr related data was anonymized - example: false - type: boolean - id: - description: >- - The id of this returnJob. It is generated during creation - automatically and suits as the primary identifier of the - described entity. - example: Esb20gpHBL94X5NdMp3C - minItems: 1 + rerouteDescriptionId: type: string required: - - id + - action + - facilityRef type: object xml: - name: ReturnJob - ReturnJobForCreation: - additionalProperties: false + name: AssignFacilityToProcessAction + PackingTargetContainer: + allOf: + - $ref: '#/components/schemas/VersionedResource' + - $ref: '#/components/schemas/PackingTargetContainerForCreation' properties: - carrierTrackingNumber: - example: '84168117830018' + description: type: string - consumerAddress: - $ref: '#/components/schemas/ConsumerAddress' - facilityAddress: - $ref: '#/components/schemas/FacilityAddress' - tenantFacilityId: + descriptionLocalized: + $ref: '#/components/schemas/LocaleString' + facilityRef: description: >- The id of the facility reference. The given ID has to be present in - the system. + the system. But it is not updatable via PUT request example: Esb20gpHBL94X5NdMp3C type: string - orderRef: - description: The id of the order - example: LGMl2DuvPnfPoSHhYFOm + packJobRef: type: string - processId: - description: >- - Id of the global process related to this entity. For example used - for starting the GDPR process and others. + iconUrl: type: string - returnLines: + id: + type: string + dimensions: + $ref: '#/components/schemas/ContainerDimensions' + weightLimitInG: + description: 'Maximal weight in gramm(gr) the container can be loaded with. ' + example: 2500 + type: number + minimum: 1 + name: + type: string + nameLocalized: + $ref: '#/components/schemas/LocaleString' + lineItems: items: - $ref: '#/components/schemas/ReturnLine' - minItems: 1 + $ref: '#/components/schemas/PackingTargetContainerLineItem' + required: + - id + - nameLocalized + - version + - facilityRef + - packJobRef + - lineItems + type: object + PackingTargetContainerForCreation: + properties: + codes: + items: + description: List of codes + type: string + minItems: 1 type: array - status: - $ref: '#/components/schemas/ReturnStatus' - tenantOrderId: + lineItems: + items: + $ref: '#/components/schemas/PackingTargetContainerLineItemForCreation' + packingContainerTypeRef: type: string - customAttributes: - description: >- - Attributes that can be added to the return job. These attributes - cannot be used within fulfillment processes, but it could be useful - to have the information carried here. required: - - returnLines + - packingContainerTypeRef + - codes type: object - ReturnJobs: + ContainerDimensions: + additionalProperties: false properties: - returnJobs: + heightInCm: + description: The height of the container (in cm) + example: 50 + type: number + lengthInCm: + description: The length of the container (in cm) + example: 100 + type: number + weightInG: + description: The weight of the container (in g) + example: 1700 + type: number + widthInCm: + description: The width of the container (in cm) + example: 25.5 + type: number + type: object + AddressType: + description: >- + Type of this address, used e.g. for communication with the carrier. Use + POSTAL_ADDRESS for the address where the order should be shipped to, + INVOICE_ADDRESS for the address where the invoice is sent to and + PARCEL_LOCKER if a parcel locker is used for this order. + type: string + enum: + - POSTAL_ADDRESS + - PARCEL_LOCKER + - INVOICE_ADDRESS + PackingTargetContainerPatchActions: + properties: + actions: items: - $ref: '#/components/schemas/ReturnJob' + anyOf: + - $ref: >- + #/components/schemas/ReplaceCodesInPackingTargetContainerAction + - $ref: '#/components/schemas/AddLineItemToPackingTargetContainerAction' + - $ref: >- + #/components/schemas/RemoveLineItemFromPackingTargetContainerAction + - $ref: >- + #/components/schemas/UpdateLineItemOnPackingTargetContainerAction + minItems: 1 type: array - total: - description: Total number of found entities for this query + version: + description: >- + The version of the document to be used in optimistic locking + mechanisms. example: 42 + format: int64 type: integer required: - - returnJobs - - total - ReturnLine: + - version + - actions + type: object + xml: + name: PackingTargetContainerPatchActions + ReplaceCodesInPackingTargetContainerAction: + allOf: + - $ref: '#/components/schemas/AbstractModificationAction' + - additionalProperties: false + properties: + action: + description: >- + Use ReplaceCodesInPackingTargetContainer to add a code to an + existing packing container + enum: + - ReplaceCodesInPackingTargetContainer + type: string + codes: + items: + description: List of codes + type: string + minItems: 1 + type: array + required: + - action + type: object + xml: + name: ReplaceCodesInPackingTargetContainer + AddLineItemToPackingTargetContainerAction: + allOf: + - $ref: '#/components/schemas/AbstractModificationAction' + - additionalProperties: false + properties: + action: + description: >- + Use AddLineItemToPackingTargetContainer to add a line item to an + existing packing container + enum: + - AddLineItemToPackingTargetContainer + type: string + lineItem: + $ref: '#/components/schemas/PackingTargetContainerLineItemForCreation' + required: + - action + - lineItem + type: object + xml: + name: AddLineItemToPackingTargetContainer + RemoveLineItemFromPackingTargetContainerAction: + allOf: + - $ref: '#/components/schemas/AbstractModificationAction' + - additionalProperties: false + properties: + action: + description: >- + Use RemoveLineItemFromPackingTargetContainer to remove a line + item from an existing packing container + enum: + - RemoveLineItemFromPackingTargetContainer + type: string + lineItemRef: + description: Id of the PackLineItem you want to remove. + type: string + required: + - action + - lineItemRef + type: object + xml: + name: RemoveLineItemFromPackingTargetContainer + UpdateLineItemOnPackingTargetContainerAction: + allOf: + - $ref: '#/components/schemas/AbstractModificationAction' + - additionalProperties: false + properties: + action: + description: >- + Use UpdateLineItemOnPackingTargetContainer to change a line item + on an existing packing container + enum: + - UpdateLineItemOnPackingTargetContainer + type: string + lineItem: + $ref: '#/components/schemas/PackingTargetContainerLineItem' + required: + - action + - lineItem + type: object + xml: + name: UpdateLineItemOnPackingTargetContainer + PackingTargetContainerLineItem: + allOf: + - $ref: '#/components/schemas/PackingTargetContainerLineItemForCreation' properties: - article: - $ref: '#/components/schemas/ReturnItemArticle' - delivered: - description: The amount of articles that were delivered - example: 20 - format: int64 - minimum: 0 - type: integer id: description: >- - The id of this return Item. It is generated during creation + The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity. example: climk4dcQFiPdA5ULuhS type: string - pickJobRefs: - items: - description: List of corresponding pickjob Ids - type: string - minItems: 1 - type: array - returned: - $ref: '#/components/schemas/Returned' + required: + - id + - article + - quantity + PackingTargetContainerLineItemForCreation: + properties: + article: + $ref: '#/components/schemas/PackingTargetContainerLineItemArticle' + customAttributes: + description: >- + Attributes that can be added to the line item. These attributes + cannot be used within fulfillment processes, but it could be useful + to have the informations carried here. + type: object + measurementUnitKey: + description: Identifier for items unit of measurement. + example: liter + type: string + quantity: + description: quantity of the specific article that has been ordered + example: 21 + format: int64 + minimum: 1 + type: integer scannableCodes: items: description: Codes, that identify the article type: string type: array - status: - $ref: '#/components/schemas/ReturnLineStatus' - customAttributes: - description: >- - Attributes that can be added to the return job. These attributes - cannot be used within fulfillment processes, but it could be useful - to have the information carried here. required: - - pickJobRefs - - id - - status - - delivered - - returned - - scannableCodes - article - type: object - ReturnLineStatus: - description: A return item line initially has the status INITIAL. - enum: - - INITIAL - - ADVISED - - ACCEPTED - - DECLINED - - CANCELED - type: string + - quantity + PackingTargetContainerLineItemArticle: + allOf: + - $ref: '#/components/schemas/AbstractArticle' + - properties: + attributes: + items: + $ref: '#/components/schemas/PackingTargetContainerAttributeItem' + type: array + type: object xml: - name: ReturnItemStatus - ReturnNoteConfiguration: + name: PackingTargetContainerLineItemArticle + PackingTargetContainerAttributeItem: + allOf: + - $ref: '#/components/schemas/ArticleAttributeItem' + PackingContainerType: allOf: - $ref: '#/components/schemas/VersionedResource' + additionalProperties: false properties: + description: + type: string + descriptionLocalized: + $ref: '#/components/schemas/LocaleString' + iconUrl: + description: '' + type: string id: - example: delivery-note + description: '' type: string - logoUrl: + name: type: string - pdfBackgroundConfiguration: - $ref: '#/components/schemas/PdfBackgroundConfiguration' - companyAddress: - $ref: '#/components/schemas/CompanyAddress' - orderDateLabel: - $ref: '#/components/schemas/LocaleString' - orderNumberLabel: - $ref: '#/components/schemas/LocaleString' - headline: - $ref: '#/components/schemas/LocaleString' - quantityLabel: - $ref: '#/components/schemas/LocaleString' - articleIdLabel: - $ref: '#/components/schemas/LocaleString' - articleTitleLabel: - $ref: '#/components/schemas/LocaleString' - returnReasonLabel: - $ref: '#/components/schemas/LocaleString' - returnReasonExplanationHeadline: - $ref: '#/components/schemas/LocaleString' - returnReasonExplanation: - $ref: '#/components/schemas/LocaleString' - reasons: - deprecated: true - description: Deprecated - use ReturnConfiguration.availableReturnReasons instead - items: - $ref: '#/components/schemas/LocaleString' - type: array - disclaimerHeadline: - $ref: '#/components/schemas/LocaleString' - disclaimer: - $ref: '#/components/schemas/LocaleString' - displayPageLabel: - type: boolean - default: false - description: Determines if the page label should be shown - pageLabel: - $ref: '#/components/schemas/LocaleString' - substituteText: + nameLocalized: $ref: '#/components/schemas/LocaleString' + priority: + description: >- + This value gives the priority of the respective + packingContainerType. The lower the value the higher is the + priority, e.g. priority 1 is higher than priority 10. The priority + can be used to order packingContainerTypes in the UI. + example: 100 + format: int32 + maximum: 10000 + minimum: 1 + type: integer + dimensions: + $ref: '#/components/schemas/ContainerDimensions' + weightLimitInG: + description: 'Maximal weight in gramm(gr) the container can be loaded with. ' + example: 2500 + type: number + minimum: 1 required: - id - - orderDateLabel - - orderNumberLabel - - headline - - quantityLabel - - articleIdLabel - - articleTitleLabel - - returnReasonLabel - - disclaimerHeadline - - disclaimer - - pageLabel - type: object - PdfBackgroundConfiguration: - properties: - firstPageBackgroundFileUrl: - description: >- - File url of the background image that will be used for the first - page - type: string - followingPageBackgroundFileUrl: - description: File url of background image that will be used for 2-n pages - type: string - type: object - PdfBackgroundConfigurationForUpsert: - properties: - firstPageBackgroundFile: - $ref: '#/components/schemas/NamedFile' - followingPageBackgroundFile: - $ref: '#/components/schemas/NamedFile' + - version + - nameLocalized type: object - ReturnNoteConfigurationForUpsert: + PackingContainerTypeForCreation: additionalProperties: false properties: - logo: - $ref: '#/components/schemas/NamedFile' - pdfBackgroundConfiguration: - $ref: '#/components/schemas/PdfBackgroundConfigurationForUpsert' - companyAddress: - $ref: '#/components/schemas/CompanyAddress' - orderDateLabel: - $ref: '#/components/schemas/LocaleString' - orderNumberLabel: - $ref: '#/components/schemas/LocaleString' - headline: - $ref: '#/components/schemas/LocaleString' - quantityLabel: - $ref: '#/components/schemas/LocaleString' - articleIdLabel: - $ref: '#/components/schemas/LocaleString' - articleTitleLabel: - $ref: '#/components/schemas/LocaleString' - returnReasonLabel: - $ref: '#/components/schemas/LocaleString' - returnReasonExplanationHeadline: - $ref: '#/components/schemas/LocaleString' - returnReasonExplanation: - $ref: '#/components/schemas/LocaleString' - reasons: - deprecated: true - description: Deprecated - use ReturnConfiguration.availableReturnReasons instead - items: - $ref: '#/components/schemas/LocaleString' - type: array - disclaimerHeadline: - $ref: '#/components/schemas/LocaleString' - disclaimer: - $ref: '#/components/schemas/LocaleString' - displayPageLabel: - type: boolean - default: false - description: Determines if the page label should be shown - pageLabel: + descriptionLocalized: $ref: '#/components/schemas/LocaleString' - substituteText: + icon: + $ref: '#/components/schemas/NamedFile' + nameLocalized: $ref: '#/components/schemas/LocaleString' - version: + priority: description: >- - The version of the document to be used in optimistic locking - mechanisms. - example: 42 - format: int64 + This value gives the priority in the respective + packingContainerType. The lower the value the higher is the + priority, e.g. priority 1 is higher than priority 10. The priority + can be used to order packingContainerTypes. + example: 100 + format: int32 + maximum: 10000 + minimum: 1 type: integer + dimensions: + $ref: '#/components/schemas/ContainerDimensions' + weightLimitInG: + description: 'Maximal weight in gramm(gr) the container can be loaded with. ' + example: 2500 + type: number + minimum: 1 required: - - orderDateLabel - - orderNumberLabel - - headline - - quantityLabel - - articleIdLabel - - articleTitleLabel - - returnReasonLabel - - disclaimerHeadline - - disclaimer - - pageLabel - - version + - nameLocalized type: object - ReturnPatchActions: - description: >- - You can choose from patch actions for the ReturnLineItems - (ModifyReturnLineItemAction, action value: 'ModifyReturnLineItem') or - the return itself (ModifyReturnAction, action value 'ModifyReturn'). + PackingContainerTypePatchActions: properties: actions: items: anyOf: - - $ref: '#/components/schemas/ModifyReturnAction' - - $ref: '#/components/schemas/ModifyReturnLineItemAction' + - $ref: '#/components/schemas/ModifyPackingContainerTypeAction' + - $ref: '#/components/schemas/ModifyPackingContainerTypeIconAction' minItems: 1 type: array version: @@ -29623,127 +31525,279 @@ components: - actions type: object xml: - name: ReturnPatchActions - ReturnStatus: + name: PackingContainerTypePatchActions + ModifyPackingContainerTypeAction: + allOf: + - $ref: '#/components/schemas/AbstractModificationAction' + - additionalProperties: false + properties: + action: + description: >- + Use value 'ModifyPackingContainerType', because you want to + modify a PackingContainerType + enum: + - ModifyPackingContainerType + type: string + descriptionLocalized: + $ref: '#/components/schemas/LocaleString' + nameLocalized: + $ref: '#/components/schemas/LocaleString' + priority: + description: >- + This value gives the priority in the respective + packingContainerType. The lower the value the higher is the + priority, e.g. priority 1 is higher than priority 10. The + priority can be used to order PackingContainerTypes. + example: 100 + format: int32 + maximum: 10000 + minimum: 1 + type: integer + dimensions: + $ref: '#/components/schemas/ContainerDimensions' + weightLimitInG: + description: 'Maximal weight in gramm(gr) the container can be loaded with. ' + example: 2500 + type: number + minimum: 1 + required: + - action + type: object + xml: + name: ModifyPackingContainerType + ModifyPackingContainerTypeIconAction: + allOf: + - $ref: '#/components/schemas/AbstractModificationAction' + - additionalProperties: false + properties: + action: + description: >- + Use value 'ModifyPackingContainerTypeIcon', because you want to + modify a PackingContainerTypes icon + enum: + - ModifyPackingContainerTypeIcon + type: string + content: + type: string + description: Content of the icon as base64 string + name: + type: string + description: icons filename + required: + - action + - name + - content + type: object + xml: + name: ModifyPackingContainerTypeIcon + PickRunType: description: >- - A return initially has the status INITIAL. As soon as one of the - returnlines is returned partly or in full the state changes to CLAIMED. - When the return option voids the state could change to CLOSED. Please - note that this last step might depend on configuration values. + Deprecated: batchPick, use batch instead Deprecated: multiOrderPick, use + multiOrder instead enum: - - INITIAL - - IN_PROGRESS - - CLAIMED - - CLOSED - - CANCELED + - multiOrderPick + - multiOrder + - batchPick + - batch type: string - xml: - name: ReturnItemStatus - Returned: + default: batchPick + ParcelResult: + description: >- + Within this object you can find the result of the request after it has + been processed (status = DONE or FAILED) properties: - reason: - description: Reason of return. - example: Zu klein + carrierTrackingNumber: + example: '84168117830018' + type: string + labelUrl: + description: >- + The URL where you can download the label relative to the path of + this resource + example: '%%HOST%%/api/parcels/{parcelId}/labels/84168117830018.pdf' + type: string + proxyId: + description: The ID of the corresponding job at the CEP proxy (if used) + example: 3a186c51d4281acbecf5ed38805b1db92a9d668b + type: string + returnLabelId: + description: The original return label id + example: 3a186c51d4281acbecf5ed38805b1db92a9d668b + type: string + returnLabelUrl: + description: The original return label URL + example: someCepProvider.com/pathToReturnLabel.pdf + type: string + customsDocumentId: + description: The customs document id + example: 3a186c51d4281acbecf5ed38805b1db92a9d668b + type: string + customsDocumentUrl: + description: The original customs document URL + example: someCepProvider.com/pathToReturnLabel.pdf + type: string + sendLabelUrl: + description: The original send label URL + example: someCepProvider.com/pathToSendLabel.pdf + type: string + summary: + description: Summary of the result of the request in a human readable form. + example: Package label was successfully requested at DHL. + type: string + trackingStatus: + $ref: '#/components/schemas/TrackingStatus' + trackingUrl: + description: The URL to track this parcel + example: http://track.io/3a186c51d4 type: string - returnedAmount: - description: Amount of item which is returned - example: 5 - minimum: 0 - type: number required: - - returnedAmount + - summary type: object - RoutingConfiguration: + WeekDay: + description: A weekday + enum: + - MONDAY + - TUESDAY + - WEDNESDAY + - THURSDAY + - FRIDAY + - SATURDAY + - SUNDAY + type: string + xml: + name: WeekDay + RestowedItems: + properties: + restowedItems: + items: + $ref: '#/components/schemas/RestowItem' + type: array + total: + description: Total number of found entities for this query + example: 42 + type: integer + type: object + ModifyRestowItemAction: additionalProperties: 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

This is the configuration for the distributing order management system. By changing the configuration you are able to change the behavior of the routing of orders henceforth. properties: - created: + action: description: >- - The date this order was created at the platform. This value is - generated by the service. - example: '2020-02-03T08:45:51.525Z' - format: date-time + Use value 'ModifyRestowItem', because you want to modify a restow + item + enum: + - ModifyRestowItem type: string - globalRoutingConfiguration: - $ref: '#/components/schemas/GlobalRoutingConfiguration' - lastModified: - description: >- - The date this order was modified last. This value is generated by - the service. - example: '2020-02-03T09:45:51.525Z' - format: date-time + restowed: + type: boolean + example: true + default: false + description: Indicates if the restowItem has been restowed + location: + $ref: '#/components/schemas/Location' + required: + - action + - restowed + type: object + RestowItem: + allOf: + - $ref: '#/components/schemas/VersionedResource' + properties: + id: + example: LGMl2DuvPnfPoSHhYFOm type: string - prioritizationRules: + quantity: + example: 1 + format: int64 + minimum: 1 + type: integer + default: 1 + measurementUnitKey: + description: Identifier for items unit of measurement. + example: liter + type: string + article: + $ref: '#/components/schemas/RestowItemArticle' + restowed: + type: boolean + example: true + default: false + description: Indicates if the restowItem has been restowed + scannableCodes: + items: + description: Codes, that identify the article + type: string + type: array + facilityRef: description: >- - Contains the routing configuration for prioritization & routing for - the whole tenant + The id of the facility reference. The given ID has to be present in + the system. + example: Esb20gpHBL94X5NdMp3C + type: string + location: + $ref: '#/components/schemas/Location' + required: + - id + - article + - restowed + - facilityRef + - quantity + type: object + RestowItemForCreation: + properties: + measurementUnitKey: + description: Identifier for items unit of measurement. + example: liter + type: string + quantity: + example: 1 + format: int64 + minimum: 1 + type: integer + default: 1 + article: + $ref: '#/components/schemas/RestowItemArticle' + restowed: + type: boolean + example: true + default: false + description: Indicates if the restowItem has been restowed + scannableCodes: items: - $ref: '#/components/schemas/PrioritizationRule' + description: Codes, that identify the article + type: string type: array - routingRule: - $ref: '#/components/schemas/RoutingRule' - timingMode: - $ref: '#/components/schemas/RoutingConfigurationTiming' - version: + facilityRef: description: >- - The version of the document to be used in optimistic locking - mechanisms. - example: 42 - format: int64 - type: integer - id: + The id of the facility reference. The given ID has to be present in + the system. + example: Esb20gpHBL94X5NdMp3C type: string + location: + $ref: '#/components/schemas/Location' required: - - version - - prioritizationRules - - routingRule - - globalRoutingConfiguration + - facilityRef + - article + - quantity type: object - RoutingConfigurationTiming: - description: Configuration for the timing of routing decisions - properties: - options: + RestowItemArticle: + allOf: + - $ref: '#/components/schemas/AbstractArticle' + - properties: + attributes: + items: + $ref: '#/components/schemas/RestowAttributeItem' + type: array type: object - type: - $ref: '#/components/schemas/RoutingConfigurationTimingType' - required: - - type - type: object - RoutingConfigurationTimingType: - 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

The available types for routing timing. - enum: - - DIRECT - - MANUAL - type: string xml: - name: RoutingConfigurationTimingType - RoutingConfigurationsPatchActions: + name: RestowItemArticle + RestowAttributeItem: + allOf: + - $ref: '#/components/schemas/ArticleAttributeItem' + RestowItemPatchActions: properties: actions: items: anyOf: - - $ref: '#/components/schemas/ModifyFenceAction' - - $ref: '#/components/schemas/ModifyRatingAction' - - $ref: '#/components/schemas/ModifyTimingModeAction' - - $ref: '#/components/schemas/ModifyOrderSplitAction' - - $ref: '#/components/schemas/ModifyPrioritizationAction' - - $ref: '#/components/schemas/ModifyGlobalRoutingConfigurationAction' + - $ref: '#/components/schemas/ModifyRestowItemAction' minItems: 1 type: array version: @@ -29758,690 +31812,1207 @@ components: - actions type: object xml: - name: RoutingConfigurationsPatchActions - RerouteDescriptionForCreation: + name: RestowItemPatchActions + PickingConfigurations: + allOf: + - $ref: '#/components/schemas/VersionedResource' properties: - reason: - description: Text explaining the reason for rerouting an order. - example: Rerouted because of an issue in the Facility. - type: string - reasonLocalized: - $ref: '#/components/schemas/LocaleString' + pickingShortPickConfiguration: + $ref: '#/components/schemas/PickingShortPickConfiguration' + scanningConfiguration: + $ref: '#/components/schemas/PickingScanningConfiguration' + scanCodeValidationConfiguration: + $ref: '#/components/schemas/PickingScanCodeValidationConfiguration' + takeOverPickJobConfiguration: + $ref: '#/components/schemas/TakeOverPickJobConfiguration' + loadUnitAssignmentConfiguration: + $ref: '#/components/schemas/LoadUnitAssignmentConfiguration' + pickingMethodsConfiguration: + $ref: '#/components/schemas/PickingMethodsConfiguration' + restartPickJobConfiguration: + $ref: '#/components/schemas/RestartPickJobConfiguration' + stockUpdateConfiguration: + $ref: '#/components/schemas/PickingStockUpdateConfiguration' + backofficePickingConfiguration: + $ref: '#/components/schemas/BackofficePickingConfiguration' + type: object + PickingStockUpdateConfiguration: + properties: + active: + default: false + description: Enable or disable stock update check for pick jobs + type: boolean required: - - reason - - reasonLocalized + - active type: object - xml: - name: RerouteDescriptionForCreation - RerouteDescriptionForModification: - allOf: - - $ref: '#/components/schemas/RerouteDescriptionForCreation' + PickingScanCodeValidationConfiguration: properties: - version: + pickingScanCodeValidationType: + $ref: '#/components/schemas/PickingScanCodeValidationEnum' + required: + - pickingScanCodeValidationType + type: object + PickingScanCodeValidationEnum: + description: State that defines if unknown scan codes can be accepted + enum: + - NO_VALIDATION + - CODE_MUST_BE_KNOWN + type: string + TakeOverPickJobConfiguration: + properties: + active: + default: false + description: Enable or disable returns + type: boolean + required: + - active + type: object + PickingMethodsConfiguration: + properties: + defaultPickingMethod: + $ref: '#/components/schemas/PickingMethodEnum' + required: + - defaultPickingMethod + type: object + RestartPickJobConfiguration: + properties: + active: + default: true + type: boolean + required: + - active + type: object + BackofficePickingConfiguration: + description: Can this tenant use the backoffice for picking? + properties: + active: + default: false + type: boolean + required: + - active + type: object + PickingShortPickConfiguration: + properties: + confirmationOnShortPick: description: >- - The version of the document to be used in optimistic locking - mechanisms. - example: 42 - format: int64 - type: integer + Does the picker needs to confirm a stock correction before adding a + short pick + default: false + type: boolean + shortPickReasons: + type: array + items: + $ref: '#/components/schemas/ShortPickReason' required: - - version + - confirmationOnShortPick type: object - xml: - name: RerouteDescriptionForModification - RerouteDescription: - allOf: - - $ref: '#/components/schemas/RerouteDescriptionForModification' - - $ref: '#/components/schemas/VersionedResource' + PickingScanningConfiguration: properties: - id: - description: The id of the RerouteReasonDescription - example: LGMl2DuvPnfPoSHhYFOm - type: string + scanningType: + $ref: '#/components/schemas/PickingScanningConfigurationEnum' + scanningRule: + $ref: '#/components/schemas/ScanningRuleConfiguration' + rolesWithOverwritingScanningPermission: + type: array + items: + $ref: '#/components/schemas/UserRoleNames' + minItems: 1 + type: object + LoadUnitAssignmentConfiguration: + description: >- + Who do the load units need to be assigned in pickJob (SingleOrderPick) + and pickRun (MultiOrderPick) + properties: + pickJob: + $ref: '#/components/schemas/LoadUnitAssignmentType' + pickRun: + $ref: '#/components/schemas/LoadUnitAssignmentType' required: - - id + - pickJob + - pickRun type: object - xml: - name: RerouteDescription - RerouteDescriptions: + LoadUnitAssignmentType: + example: AT_END + description: Where do the load unit needs to be assigned? + enum: + - INACTIVE + - AT_START + - AT_END + - DURING_PICKING + type: string + TagScanningConfiguration: + additionalProperties: false properties: - rerouteDescriptions: + offeredScanningRuleByTag: + type: array items: - $ref: '#/components/schemas/RerouteDescription' + $ref: '#/components/schemas/OfferedScanningRuleByTag' + OfferedScanningRuleByTag: + additionalProperties: false + properties: + tagRef: + type: string + minLength: 1 + matchingValues: type: array - hasNextPage: - description: True if there are more results after the current page - type: boolean - total: - description: Total number of found entities for this query - example: 42 - type: integer + minItems: 1 + items: + type: string + scanningType: + $ref: '#/components/schemas/PickingScanningConfigurationEnum' + required: + - tagRef + - matchingValues + - scanningType type: object + PreferredPickingMethodsPerTag: + additionalProperties: false required: - - rerouteDescriptions - - total - - hasNextPage - RoutingPlan: + - tagRef + - pickingMethods + - matchingValues + properties: + tagRef: + type: string + matchingValues: + type: array + minItems: 1 + items: + type: string + pickingMethods: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/PickingMethodEnum' + PreferredPickingMethodsConfiguration: + properties: + PreferredPickingMethodsPerTag: + type: array + items: + $ref: '#/components/schemas/PreferredPickingMethodsPerTag' + PickJobTagConfiguration: allOf: - $ref: '#/components/schemas/VersionedResource' properties: - deliveryPreferences: - $ref: '#/components/schemas/DeliveryPreferences' + stickerConfiguration: + $ref: '#/components/schemas/StickerConfiguration' + lineItemStickerConfiguration: + $ref: '#/components/schemas/StickerConfiguration' + lineItemScanningConfiguration: + $ref: '#/components/schemas/TagScanningConfiguration' + preferredPickingMethodsConfiguration: + $ref: '#/components/schemas/PreferredPickingMethodsConfiguration' + offeredDocumentsPerTag: + type: array + description: >- + All entries with a match in their matchingValues will be combined + when determining what documents belong to an entity + items: + $ref: '#/components/schemas/OfferedDocumentPerTag' + offeredDocumentsByDefault: + type: array + description: >- + This configuration is a fallback and applies only if none of the + entries in offeredDocumentsPerTag can be applied + items: + $ref: '#/components/schemas/OfferedDocument' + required: + - offeredDocumentsPerTag + - offeredDocumentsByDefault + ItemReturnJob: + allOf: + - $ref: '#/components/schemas/VersionedResource' + additionalProperties: false + properties: + id: + type: string + processRef: + type: string + originFacilityRefs: + items: + type: string + type: array + status: + $ref: '#/components/schemas/ItemReturnJobStatus' + tenantOrderId: + type: string + consumerAddresses: + items: + $ref: '#/components/schemas/ConsumerAddress' + type: array + scannableCodes: + items: + type: string + type: array + shortId: + description: >- + A short identifier that helps assigning a item return job to a + customer. This is automatically created during creation. + example: AS12 + type: string + returnableLineItems: + items: + $ref: '#/components/schemas/ItemReturnJobLineItem' + type: array + minItems: 1 + itemReturns: + items: + $ref: '#/components/schemas/ItemReturn' + type: array + minItems: 0 anonymized: description: Indicates if gdpr related data was anonymized example: false type: boolean - decisionLogs: + type: object + required: + - id + - processRef + - originFacilityRefs + - status + - consumerAddresses + - returnableLineItems + - itemReturns + ItemReturnJobWithSearchPaths: + allOf: + - $ref: '#/components/schemas/ItemReturnJob' + additionalProperties: false + properties: + searchPaths: items: - $ref: '#/components/schemas/DecisionLogRef' + type: string type: array - facilityBlackList: + minItems: 0 + type: object + ItemReturnJobForCreation: + additionalProperties: false + properties: + processRef: + type: string + originFacilityRefs: items: - description: Contains a list of facilities to ignore when rerouting happens. type: string type: array - facilityRef: - description: >- - The id of the facility reference. The given ID has to be present in - the system. - example: Esb20gpHBL94X5NdMp3C - type: string - finalizeRun: - description: The iteration through the finalizer process - example: 5 - minimum: 0 - type: number - firstRoutingAttempt: - description: The date of the first routing attempt. - example: '2020-02-03T08:45:50.525Z' - format: date-time - type: string - id: - type: string - orderDate: - description: The date this order was created at the supplying system. - example: '2020-02-03T08:45:50.525Z' - format: date-time + status: + $ref: '#/components/schemas/ItemReturnJobStatus' + tenantOrderId: type: string - orderLineItems: + consumerAddresses: items: - $ref: '#/components/schemas/RoutingPlanLineItem' + $ref: '#/components/schemas/ConsumerAddress' type: array - orderRef: + scannableCodes: + items: + type: string + type: array + shortId: description: >- - The id of the order that lead to the creation of this pickjob. Can - be empty / not present when the pickjob was created without having - an order. - example: LGMl2DuvPnfPoSHhYFOm - type: string - parentRoutingPlanRef: - type: string - childRoutingPlanRef: + A short identifier that helps assigning a item return job to a + customer. This is automatically created during creation. + example: AS12 type: string - pickJobRef: - description: The id of the pickjob that has been created from the routing plan. - example: Esb20gpHBL94X5NdMp3C + returnableLineItems: + items: + $ref: '#/components/schemas/ItemReturnJobLineItemForCreation' + type: array + minItems: 1 + type: object + required: + - originFacilityRefs + - status + - consumerAddresses + - returnableLineItems + ItemReturnJobs: + properties: + itemReturnJobsWithSearchPaths: + items: + $ref: '#/components/schemas/ItemReturnJobWithSearchPaths' + type: array + total: + description: Total number of found entities for this query + example: 42 + type: integer + type: object + ItemReturnJobStatus: + type: string + enum: + - OPEN + - IN_PROGRESS + - FINISHED + ItemReturnJobLineItem: + additionalProperties: false + allOf: + - $ref: '#/components/schemas/ItemReturnJobLineItemForCreation' + properties: + id: type: string - priority: - description: priority of return plan + returned: + type: number minimum: 0 + returnable: type: number - reRouteReason: - $ref: '#/components/schemas/RerouteReason' - rerouteDescription: - $ref: '#/components/schemas/RerouteDescription' - reRoutedFacilityRef: - description: The id of the facility the order was rerouted from. - example: 1DEYZgmfAcXRVYv6KEka36 + minimum: 0 + required: + - id + - article + - delivered + - returned + - returnable + ReturnedLineItemRefund: + additionalProperties: false + description: Either price or percent must be set, not both. + properties: + status: + $ref: '#/components/schemas/ReturnedLineItemRefundStatus' + price: + $ref: '#/components/schemas/ReturnedLineItemRefundPrice' + percent: + example: 80.6 + description: 0.0 - 100.0 amount of the line item price that should be refunded + type: number + required: + - status + ReturnedLineItemRefundStatus: + enum: + - OPEN + - IN_PROGRESS + - CLOSED + type: string + ItemReturnJobLineItemForCreation: + additionalProperties: false + properties: + article: + $ref: '#/components/schemas/ItemReturnJobLineItemArticle' + delivered: + type: number + minimum: 1 + scannableCodes: + items: + type: string + type: array + required: + - article + - delivered + ItemReturnJobLineItemArticle: + allOf: + - $ref: '#/components/schemas/AbstractArticle' + - properties: + attributes: + items: + $ref: '#/components/schemas/ArticleAttributeItem' + type: array + prices: + items: + $ref: '#/components/schemas/ArticlePrice' + type: array + type: object + xml: + name: PickLineItemArticle + ItemReturn: + additionalProperties: false + properties: + id: type: string - reRoutedPickJobRef: - description: The id of the original pickjob that was rerouted. - example: Eghhj20878dhbd989NdMp3C + created: + description: >- + The date this entity was created at the platform. This value is + generated by the service. + example: '2020-02-03T08:45:51.525Z' + format: date-time type: string - reRoutedRoutingPlanRef: - description: The id of the original routingplan that was rerouted. - example: Eghhj20878dhbd989NdMp3C + lastModified: + description: >- + The date this entity was modified last. This value is generated by + the service. + example: '2020-02-03T09:45:51.525Z' + format: date-time type: string - routingRun: - description: The iteration through the routing process - type: number - runType: - description: The rule type of a decision log entry - enum: - - DEFAULT - - REROUTE - - ORDERSPLIT_ON_SHORTPICK - - MANUAL_ASSIGNMENT - - PROCESS_MANUALASSIGNMENT - - REACTIVATION + returnFacilityRef: type: string - splitCount: - default: 0 - description: >- - The number of order splits that happened before this routingplan was - created - example: 5 - minimum: 0 - type: number status: - $ref: '#/components/schemas/RoutingPlanStatus' - statusHistory: - type: array + $ref: '#/components/schemas/ItemReturnStatus' + tenantOrderId: + type: string + scannableCodes: items: - $ref: '#/components/schemas/RoutingPlanStatus' - statusReasons: + type: string type: array - items: - $ref: '#/components/schemas/RoutingPlanStatusReason' - consolidatedStatus: - $ref: '#/components/schemas/ConsolidatedRoutingPlanStatus' - targetAddress: - $ref: '#/components/schemas/TargetAddress' - targetAddressesByDeliveryEvent: + returnedLineItems: type: array + minItems: 1 items: - $ref: '#/components/schemas/DeliveryEventTargetAddress' - processId: - description: >- - Id of the global process related to this entity. For example used - for starting the GDPR process and others. + $ref: '#/components/schemas/ItemReturnLineItem' + required: + - id + - status + - returnedLineItems + - returnFacilityRef + ItemReturnStatus: + enum: + - ANNOUNCED + - OPEN + - IN_PROGRESS + - PAUSED + - FINISHED + - WAITING_FOR_INPUT + type: string + ItemReturnLineItem: + additionalProperties: false + allOf: + - $ref: '#/components/schemas/ItemReturnLineItemForCreation' + properties: + id: type: string - targetTimeBaseDate: - description: This date is used as base/start to calculate the target time date. - example: '2020-02-03T08:45:50.525Z' - format: date-time + example: a69006ba-7100-4b4d-a610-1ca28016a4eb + itemCondition: type: string - customServices: + example: Damaged + itemReturnJobLineItemRefs: + items: + example: a69006ba-7100-4b4d-a610-1ca28016a4eb + type: string type: array - minItems: 1 + reasons: items: - $ref: '#/components/schemas/CustomServiceReference' - provisioningTime: - description: The point in time by which the order is supposed to be provisioned. - example: '2020-02-03T08:45:50.525Z' - format: date-time - type: string + $ref: '#/components/schemas/ItemReturnLineItemReason' + type: array + refund: + $ref: '#/components/schemas/ReturnedLineItemRefund' required: - id - - orderDate - - created - - lastModified - - version - - orderRef - - priority - status - - consolidatedStatus - - decisionLogs - - routingRun - - finalizeRun - - processId - type: object - RoutingPlanStatusReason: - anyOf: - - $ref: '#/components/schemas/RoutingPlanObsoleteStatusReason' - RoutingPlanObsoleteStatusReason: + - itemReturnJobLineItemRefs + - tenantArticleId + ItemReturnLineItemReason: + additionalProperties: false properties: reason: + description: Translated reasonLocalized type: string - enum: - - REROUTE_AFTER_SHORTPICK - - MANUALLY_REROUTED - - MANUALLY_ASSIGNED - status: + reasonLocalized: + $ref: '#/components/schemas/LocaleString' + comment: type: string - enum: - - OBSOLETE + minLength: 1 + example: Upper corner damaged required: - - reason - - status - DeliveryEventTargetAddress: - type: object + - reasonLocalized + ItemReturnForCreation: + additionalProperties: false properties: - facilityRef: + status: + $ref: '#/components/schemas/ItemReturnStatus' + returnFacilityRef: type: string - targetAddress: - $ref: '#/components/schemas/TargetAddress' - deliveryEvent: - $ref: '#/components/schemas/DeliveryEvent' + tenantOrderId: + type: string + scannableCodes: + items: + type: string + type: array + returnedLineItems: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/ItemReturnLineItemForCreation' required: - - facilityRef - - targetAddress - - deliveryEvent - RoutingPlanLineItem: + - returnedLineItems + - status + - returnFacilityRef + ItemReturnsWithSearchPaths: allOf: - - $ref: '#/components/schemas/OrderLineItem' + - $ref: '#/components/schemas/ItemReturn' + additionalProperties: false properties: - picked: - type: number - available: - type: number - pieces: + searchPaths: type: array items: - $ref: '#/components/schemas/RoutingPlanLineItemPiece' - outOfStockBehaviour: - enum: - - BACKORDER - type: string - availabilityTimeframe: - $ref: '#/components/schemas/AvailabilityTimeframe' - RoutingPlanLineItemPiece: + type: string + required: + - searchPaths + AddItemReturnToItemReturnJob: + additionalProperties: false properties: - partialStockRef: + itemReturnForCreation: + $ref: '#/components/schemas/ItemReturnForCreation' + itemReturnJobVersion: + description: Version of the itemReturnJob the itemReturn gets added to + minimum: 0 + type: integer + required: + - itemReturnForCreation + - itemReturnJobVersion + ItemReturnLineItemForCreation: + additionalProperties: false + properties: + itemConditionLocalized: + $ref: '#/components/schemas/LocaleString' + itemConditionComment: type: string - quantity: - type: number - available: - type: number - mandatoryScore: - type: number - sequenceScore: - type: number - location: - $ref: '#/components/schemas/Location' - picked: + minLength: 1 + example: Upper corner damaged + tenantArticleId: + type: string + example: a69006ba-7100-4b4d-a610-1ca28016a4eb + scannedCodes: + type: array + items: + type: string + status: + $ref: '#/components/schemas/ItemReturnLineItemStatus' + reasons: + items: + $ref: '#/components/schemas/ItemReturnLineItemReason' + type: array + required: + - tenantArticleId + - status + ItemReturnLineItemForUpdate: + additionalProperties: false + properties: + status: + $ref: '#/components/schemas/ItemReturnLineItemStatus' + refund: + $ref: '#/components/schemas/ReturnedLineItemRefund' + itemReturnJobVersion: type: number - type: object - RoutingPlanPatchActions: + example: 42 + description: version of the overlaying itemReturnJob + required: + - itemReturnJobVersion + ReplaceReturnedLineItems: + additionalProperties: false properties: - actions: - items: - $ref: '#/components/schemas/ModifyRoutingPlanAction' + itemReturnJobVersion: + description: Version of the entity to be changed + minimum: 0 + type: integer + returnedLineItems: + type: array minItems: 1 + items: + $ref: '#/components/schemas/ItemReturnLineItemForCreation' + required: + - itemReturnJobVersion + - returnedLineItems + ItemReturnLineItemStatus: + enum: + - OPEN + - IN_PROGRESS + - WAITING_FOR_INPUT + - REJECTED + - ACCEPTED + type: string + ItemReturns: + properties: + itemReturns: + items: + $ref: '#/components/schemas/ItemReturnsWithSearchPaths' type: array - version: - description: >- - The version of the document to be used in optimistic locking - mechanisms. + totalCount: + description: Total number of found entities for this query example: 42 - format: int64 + type: integer + type: object + required: + - itemReturns + - totalCount + ItemReturnJobActionsParameter: + anyOf: + - $ref: '#/components/schemas/StartItemReturnJobActionParameter' + - $ref: '#/components/schemas/FinishItemReturnJobActionParameter' + - $ref: '#/components/schemas/RestartItemReturnJobActionParameter' + StartItemReturnJobActionParameter: + additionalProperties: false + properties: + name: + $ref: '#/components/schemas/StartItemReturnJobActionEnum' + version: + description: Version of the entity to be changed + minimum: 0 type: integer required: + - name - version - - actions - type: object - xml: - name: RoutingPlanPatchActions - RoutingPlanStatus: - description: >- - A routing plan line initially has the status INITIAL. Final state is - ROUTED + StartItemReturnJobActionEnum: enum: - - INITIAL - - PRIORITIZED - - ROUTING - - PROPOSED - - PLANNED - - ROUTED - - NOT_ROUTABLE - - MANUAL_PLANNED - - FAILED - - REDUNDANT_REROUTE - - FAILED_REROUTE - - RETRYABLE - - FALLBACK_ROUTING - - WAITING - - OBSOLETE - - CANCELED - - LOCKED - - PROMISED + - StartItemReturnJob type: string - xml: - name: RoutingPlanStatus - ConsolidatedRoutingPlanStatus: - description: |- - This status consolidates many of the RoutingPlanStatus and offers - a more detailes explanation of what happened to the routing plan. + FinishItemReturnJobActionParameter: + additionalProperties: false + properties: + name: + $ref: '#/components/schemas/FinishItemReturnJobActionEnum' + version: + description: Version of the entity to be changed + minimum: 0 + type: integer + required: + - name + - version + FinishItemReturnJobActionEnum: enum: - - ROUTED - - PROCESS_MANUAL_REROUTED_THEN_ROUTED - - PROCESS_MANUAL_REROUTED_THEN_NOT_ROUTABLE - - PROCESS_MANUAL_REROUTED_THEN_REROUTED_AND_SPLIT - - ROUTING_PLAN_REROUTED_THEN_ROUTED_TO_SAME_FACILITY - - ROUTING_PLAN_SHORTPICKED_THEN_ROUTED_TO_SAME_FACILITY - - ROUTING_PLAN_CREATED_THEN_ROUTING - - ROUTING_PLAN_CREATED_THEN_PLANNED - - ROUTING_PLAN_REROUTED_THEN_FAILED - - FACILITY_MANUALLY_ASSIGNED_TO_PICKJOB_THEN_ROUTED - - FACILITY_MANUALLY_ASSIGNED_TO_PROCESS_THEN_ROUTED - - STOCK_UPDATE_RECEIVED_THEN_REACTIVATED - - ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED - - ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_AND_SPLIT - - ROUTING_PLAN_SHORTPICKED_THEN_REROUTED - - ROUTINGPLAN_SHORTPICKED_THEN_SPLIT - - ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_AND_SPLIT - - ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED - - ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED_AND_SPLIT - - ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED_TO_SAME_FACILITY - - PICKJOB_REJECTED_THEN_REROUTED - - PICKJOB_REJECTED_THEN_NOT_ROUTABLE - - PICKJOB_REJECTED_THEN_ROUTED_AND_SPLIT - - ROUTED_AND_SPLIT - - OBSOLETE - - OBSOLETE_WAS_ROUTED - - OBSOLETE_WAS_SHORTPICKED - - UNKNOWN - - RETRYABLE - - FAILED_REROUTE - - CANCELED - - NOT_ROUTABLE - - WAITING - - WAITING_AND_SPLIT - - WAITING_THEN_ROUTED - - WAITING_THEN_ROUTED_AND_SPLIT - - WAITING_THEN_NOT_ROUTABLE - - WAITING_THEN_WAITING_AND_SPLIT + - FinishItemReturnJob type: string - xml: - name: RealRoutingPlanStatus - RoutingPlans: + RestartItemReturnJobActionParameter: + additionalProperties: false properties: - routingPlans: - items: - $ref: '#/components/schemas/RoutingPlan' - type: array - total: - description: Total number of found entities for this query - example: 42 + name: + $ref: '#/components/schemas/RestartItemReturnJobActionEnum' + version: + description: Version of the entity to be changed + minimum: 0 + type: integer + required: + - name + - version + RestartItemReturnJobActionEnum: + enum: + - RestartItemReturnJob + type: string + ItemReturnActionsParameter: + anyOf: + - $ref: '#/components/schemas/AnnounceItemReturnActionParameter' + - $ref: '#/components/schemas/OpenItemReturnActionParameter' + - $ref: '#/components/schemas/StartItemReturnActionParameter' + - $ref: '#/components/schemas/PauseItemReturnActionParameter' + - $ref: '#/components/schemas/FinishItemReturnActionParameter' + AnnounceItemReturnActionParameter: + additionalProperties: false + properties: + name: + $ref: '#/components/schemas/AnnounceItemReturnActionEnum' + itemReturnJobVersion: + description: Version of the entity to be changed + minimum: 0 + type: integer + required: + - name + - itemReturnJobVersion + AnnounceItemReturnActionEnum: + enum: + - AnnounceItemReturn + type: string + OpenItemReturnActionParameter: + additionalProperties: false + properties: + name: + $ref: '#/components/schemas/OpenItemReturnActionEnum' + itemReturnJobVersion: + description: Version of the entity to be changed + minimum: 0 + type: integer + required: + - name + - itemReturnJobVersion + OpenItemReturnActionEnum: + enum: + - OpenItemReturn + type: string + StartItemReturnActionParameter: + additionalProperties: false + properties: + name: + $ref: '#/components/schemas/StartItemReturnActionEnum' + itemReturnJobVersion: + description: Version of the entity to be changed + minimum: 0 + type: integer + required: + - name + - itemReturnJobVersion + StartItemReturnActionEnum: + enum: + - StartItemReturn + type: string + PauseItemReturnActionParameter: + additionalProperties: false + properties: + name: + $ref: '#/components/schemas/PauseItemReturnActionEnum' + itemReturnJobVersion: + description: Version of the entity to be changed + minimum: 0 + type: integer + required: + - name + - itemReturnJobVersion + PauseItemReturnActionEnum: + enum: + - PauseItemReturn + type: string + FinishItemReturnActionParameter: + additionalProperties: false + properties: + name: + $ref: '#/components/schemas/FinishItemReturnActionEnum' + itemReturnJobVersion: + description: Version of the entity to be changed + minimum: 0 + type: integer + required: + - name + - itemReturnJobVersion + FinishItemReturnActionEnum: + enum: + - FinishItemReturn + type: string + WaitForInputItemReturnActionParameter: + additionalProperties: false + properties: + name: + $ref: '#/components/schemas/WaitForInputItemReturnActionEnum' + itemReturnJobVersion: + description: Version of the entity to be changed + minimum: 0 type: integer - type: object - RoutingRule: + required: + - name + - itemReturnJobVersion + WaitForInputItemReturnActionEnum: + enum: + - WaitForInputItemReturn + type: string + OperativeProcess: + allOf: + - $ref: '#/components/schemas/VersionedResource' additionalProperties: false properties: - fences: + id: + type: string + processRef: + type: string + description: Reference to the overall process + facilityRef: + type: string + description: Reference to the facility this operative process is handled in + flatEntityRefs: items: - $ref: '#/components/schemas/Fence' - type: array - orderSplit: - $ref: '#/components/schemas/OrderSplit' - ratings: + type: string + description: >- + References to all operational entities belonging to this operative + process + minLength: 0 + entityChildren: items: - $ref: '#/components/schemas/Rating' - type: array - required: - - ratings - - fences + $ref: '#/components/schemas/OperativeEntity' + description: Tree structure of entities belonging to this operative process + minLength: 0 type: object - ScopedCapabilities: + required: + - id + - processRef + - facilityRef + - flatEntityRefs + - entityChildren + OperativeProcessForCreation: + additionalProperties: false properties: - capabilities: + processRef: + type: string + description: Reference to the overall process + facilityRef: + type: string + description: Reference to the facility this operative process is handled in + entityChildren: items: - $ref: '#/components/schemas/ScopedCapability' - type: array - total: - description: Total number of found entities for this query - example: 42 - type: integer + $ref: '#/components/schemas/OperativeEntity' + description: Tree structure of entities belonging to this operative process type: object - ScopedCapability: - allOf: - - $ref: '#/components/schemas/VersionedResource' + required: + - processRef + - facilityRef + OperativeEntity: + additionalProperties: false properties: - currentUserPermissions: + entityRef: + type: string + description: Reference to the full entity + entityType: + $ref: '#/components/schemas/OperativeEntityType' + entityChildren: items: - type: string - type: array - name: + $ref: '#/components/schemas/OperativeEntity' + description: Tree structure of entities belonging to this entity + required: + - entityRef + - entityType + OperativeEntityType: + type: string + enum: + - PICK_JOB + - PACK_JOB + - SHIPMENT + - HANDOVER_JOB + - PARCEL + - SERVICE_JOB + - RESTOW_ITEM + - ITEM_RETURN_JOB + - LINKED_SERVICE_JOBS + ExpiryEntity: + additionalProperties: false + properties: + id: + type: string + description: Generated identifier of this entity + example: 611c860f-3f00-4b01-9f4c-64cdee38a30e + version: + type: integer + format: int64 + example: 42 + description: >- + The version of the document to be used in optimistic locking + mechanisms. + created: + type: string + format: date-time + example: '2020-02-03T08:45:51.525Z' + description: >- + The date this entity was created at the platform. This value is + generated by the service. + lastModified: + type: string + format: date-time + example: '2020-02-03T09:45:51.525Z' + description: >- + The date this entity was modified last. This value is generated by + the service. + processRef: + type: string + example: c4e5fb70-a893-4ffa-b7b0-e042cda6fb9f + description: Reference to the Process of this Entity + provisioningTime: + type: string + format: date-time + example: '2020-02-03T08:45:51.525Z' + description: >- + Planned time where this entity should be provided or handed over to + the customer + expiryTime: type: string + format: date-time + example: '2020-02-03T08:45:51.525Z' + description: Time where the connected process expires, if not fulfilled status: - $ref: '#/components/schemas/CapabilityStatus' - configurations: - items: - anyOf: - - $ref: '#/components/schemas/SubstitutionConfiguration' - - $ref: '#/components/schemas/CarrierConfiguration' - - $ref: '#/components/schemas/RerouteShortPickConfiguration' - - $ref: '#/components/schemas/ReturnNoteConfiguration' - type: array + $ref: '#/components/schemas/ExpiryEntityStatus' required: - - name + - id + - version + - created + - lastModified + - processRef + - provisioningTime + - expiryTime - status - type: object - RerouteType: - description: |- - The type of reroute to apply to the order - * `REROUTE`- the complete routing plan is rerouted. - * `ORDERSPLIT`- the order is splitted. The short picked line items will be moved to a new routing plan and rerouted - enum: - - REROUTE - - ORDERSPLIT - type: string - ShipFromStoreRerouteConfiguration: + ExpiryEntityForCreation: + additionalProperties: false properties: - active: - type: boolean - allowManualReroute: - default: false + processRef: + type: string + example: c4e5fb70-a893-4ffa-b7b0-e042cda6fb9f description: >- - @deprecated This config property is deprecated since 26/02/24. Use - GlobalManualRerouteConfiguration instead. - type: boolean - deprecated: true - facilityWideRerouteOnShortPick: - default: false - type: boolean - rerouteTargetTime: + Reference to the Process for which this expiry entity will be + created + provisioningTime: + type: string + format: date-time + example: '2020-02-03T08:45:51.525Z' description: >- - Only pickJobs where the targetTime in not larger than now plus this - number are rerouted - example: '48' - type: number - rerouteType: - $ref: '#/components/schemas/RerouteType' + Planned time where this entity should be provided or handed over to + the customer + status: + $ref: '#/components/schemas/ExpiryEntityStatus' required: - - active - - rerouteType - type: object - ShipmentOrderBy: - description: STATUS_TARGET_TIME_LAST_MODIFIED_DATE is depricated - enum: - - STATUS_TARGET_TIME_ORDER_DATE - ShipmentWithSearchPath: - allOf: - - $ref: '#/components/schemas/Shipment' - - properties: - searchPaths: - items: - type: string - type: array - minItems: 0 - additionalProperties: false - type: object - Shipment: - allOf: - - $ref: '#/components/schemas/ShipmentForCreation' - - $ref: '#/components/schemas/VersionedResource' - - properties: - anonymized: - default: false - description: Indicates if gdpr related data was anonymized - example: false - type: boolean - hasActiveCarrier: - default: true - description: >- - Indicates if there is an active carrier configuration to fulfill - this shipment - example: false - type: boolean - carrierKey: - type: string - example: DPD - id: - description: >- - The id of this Shipment. It is generated during creation - automatically and suits as the primary identifier of the - described entity. - example: 95EWrieX09OmeriXIUbb - type: string - lineItems: - items: - $ref: '#/components/schemas/ShipmentLineItem' - type: array - parcels: - items: - $ref: '#/components/schemas/StrippedParcel' - type: array - status: - $ref: '#/components/schemas/ShipmentStatus' - required: - - id - - status - - hasActiveCarrier - type: object - ShipmentForCreation: + - processRef + - provisioningTime + - status + ExpiryEntityForUpdate: additionalProperties: false properties: - operativeProcessRef: + version: + type: integer + description: version of the entity you want to alter + provisioningTime: type: string - carrierLogoUrl: - description: The URL to the carrier logo + format: date-time + example: '2020-02-03T08:45:51.525Z' + description: >- + Planned time where this entity should be provided or handed over to + the customer + status: + $ref: '#/components/schemas/ExpiryEntityStatus' + required: + - version + ExpiryEntityFilter: + additionalProperties: false + properties: + processRef: type: string - carrierRef: - description: The reference to the carrier for which the shipment is assigned to - example: ca525716-7208-4a63-a2a6-11274eb37f67-0 + description: process of the entity you want to load + status: + $ref: '#/components/schemas/ExpiryEntityStatus' + startDate: + format: date-time + example: '2020-02-03T08:45:51.525Z' + description: start date range for expiryTime + endDate: + format: date-time + example: '2020-02-03T08:45:51.525Z' + description: end date range for expiryTime + ExpiryEntityStatus: + enum: + - ACTIVE + - INACTIVE + type: string + StorageLocationForCreation: + properties: + name: + description: The name of this storage location type: string - carrierProduct: - description: Desired product of given carrier to choose when ordering a label + maxLength: 15 + tenantLocationId: + description: The internal tenant id for this location type: string - example: EXPRESS - carrierServices: + type: + $ref: '#/components/schemas/StorageLocationType' + traits: + description: >- + The traits of this storage location, includes both local config and + and defaults. Do not use to write to traits, use traitConfig + instead. type: array items: - $ref: '#/components/schemas/CarrierServices' - customAttributes: - description: >- - Attributes that can be added to the shipment. These attributes - cannot be used within fulfillment processes, but it could be useful - to have the informations carried here. - type: object - facilityRef: - description: The reference to the facility which the shipment is assigned to. - type: string - lineItems: + $ref: '#/components/schemas/StorageLocationTrait' + traitConfig: + $ref: '#/components/schemas/StorageLocationTraitConfig' + scannableCodes: + description: Barcodes representing this storage location + type: array + maxItems: 5 items: - $ref: '#/components/schemas/ShipmentLineItemForCreation' + type: string + runningSequences: + description: The Sequence item/s of this location type: array - orderDate: - description: The date this order was created at the supplying system. - format: date-time - type: string - pickJobRef: - description: The id of the facility reference. + maxItems: 10 + items: + $ref: '#/components/schemas/StorageLocationSequenceItem' + zoneRef: + description: The id of the Zone to which this storage location belongs example: Esb20gpHBL94X5NdMp3C type: string - processId: - description: >- - Id of the global process related to this entity. For example used - for starting the GDPR process and others. + zoneName: + description: The name of the Zone to which this storage location belongs type: string - shortId: - description: The short identifier of the shipment. + information: + description: A free text information about this storage location, max length 1024 type: string - sourceAddress: - $ref: '#/components/schemas/FacilityAddress' - targetAddress: - $ref: '#/components/schemas/ConsumerAddress' - invoiceAddress: - $ref: '#/components/schemas/ConsumerAddress' - postalAddress: - $ref: '#/components/schemas/ConsumerAddress' - targetTime: - description: At which time the result is expected. - example: '2020-02-03T09:45:51.525Z' - format: date-time + maxLength: 1024 + customAttributes: + description: >- + Attributes that can be added to the storage location. These + attributes cannot be used within fulfillment processes, but it could + be useful to have the informations carried here. + type: object + required: + - name + - runningSequences + - scannableCodes + - type + type: object + xml: + name: StorageLocationForCreation + StorageLocationForReplacement: + allOf: + - $ref: '#/components/schemas/StorageLocationForCreation' + properties: + version: + example: 42 + format: int64 + type: integer + required: + - version + type: object + xml: + name: StorageLocationForReplacement + StorageLocation: + allOf: + - $ref: '#/components/schemas/StorageLocationForReplacement' + - $ref: '#/components/schemas/VersionedResource' + properties: + id: + description: The id of this storage location type: string - tenantOrderId: - description: Reference to the order in the tenant system. + facilityRef: + description: The id of the facility reference. + example: Esb20gpHBL94X5NdMp3C type: string - targetTimeBaseDate: - description: The start date for the targetTime calculation. - example: '2020-02-03T08:45:50.525Z' - format: date-time + zoneName: + description: >- + Deprecated! This field will not be filled in newly created storage + locations. Resolve the zone name separately via the + facilities/{id}/zones endpoint. The name of the Zone to which this + storage location belongs type: string - paymentInformation: - $ref: '#/components/schemas/PaymentInformation' - tags: - items: - $ref: '#/components/schemas/TagReference' + deprecated: true + traits: + description: The traits of this storage location type: array + items: + $ref: '#/components/schemas/StorageLocationTrait' + traitConfig: + $ref: '#/components/schemas/StorageLocationTraitConfig' + schemaVersion: + type: number + required: + - id + - facilityRef + - traits + type: object + xml: + name: StorageLocation + StorageLocationTraitConfig: + description: The configuration of the traits of this storage location + type: array + items: + type: object + properties: + trait: + $ref: '#/components/schemas/StorageLocationTrait' + enabled: + type: boolean + required: + - trait + - enabled + StorageLocationType: + description: |- + Describes the kind of a storage location: + * `SINGLE_STORAGE`- it is only allowed to store stock with the same tenantArticleId here + * `BULK_STORAGE`- stocks belonging to different tenantArticleIds can be stored here + enum: + - SINGLE_STORAGE + - BULK_STORAGE + type: string + xml: + name: StorageLocationType + StorageLocationTrait: + type: string + description: |- + Describes what kind of actions this stock is available for + * `PICKABLE`- The stock is available for picking + * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc) + * `KEEP_ON_ZERO`- The stock will not be deleted when emptied + enum: + - PICKABLE + - ACCESSIBLE + - KEEP_ON_ZERO + xml: + name: StorageLocationTrait + StorageLocationSequenceType: + description: |- + Describes the type of a storage location sequence type + * `PICKING_SEQUENCE`- The sequence in wich the storage locations are picked. + * `RESTOW_SEQUENCE`- The sequence in wich the storage locations are restowed. + enum: + - PICKING_SEQUENCE + - RESTOW_SEQUENCE + type: string + xml: + name: StorageLocationType + StorageLocationSequenceItem: + properties: + type: + $ref: '#/components/schemas/StorageLocationSequenceType' + previousStorageLocationRef: + description: The previous storage from which to pick up after this one + type: string + nextStorageLocationRef: + description: The next storage from which to pick up after this one + type: string + score: + deprecated: true + description: Running sequence score - read-only + type: number required: - - facilityRef - - targetTime - - targetAddress - - orderDate + - type type: object xml: - name: Shipment - ShipmentLineItem: + name: StorageLocationSequenceItem + ModifyStorageLocationAction: allOf: - - $ref: '#/components/schemas/ShipmentLineItemForCreation' - - properties: - id: + - $ref: '#/components/schemas/AbstractModificationAction' + - additionalProperties: false + properties: + action: description: >- - The id of this lineItem. It is generated during creation - automatically and suits as the primary identifier of the - described entity. - example: climk4dcQFiPdA5ULuhS + Use value 'ModifyStorageLocation', because you want to modify a + storage location + enum: + - ModifyStorageLocation type: string - required: - - id - type: object - ShipmentLineItemArticle: - allOf: - - $ref: '#/components/schemas/AbstractArticle' - - properties: - attributes: + name: + description: The name of this storage location + type: string + maxLength: 15 + tenantLocationId: + description: The internal tenant id for this location + type: string + type: + $ref: '#/components/schemas/StorageLocationType' + traits: + deprecated: true + description: >- + The traits of this storage location. Do not use this to write + traits, use traitConfig instead. + type: array items: - $ref: '#/components/schemas/OrderArticleAttributeItem' + $ref: '#/components/schemas/StorageLocationTrait' + traitConfig: + $ref: '#/components/schemas/StorageLocationTraitConfig' + scannableCodes: + description: Barcodes representing this storage location + type: array + maxItems: 5 + items: + type: string + runningSequences: + description: The Sequence item/s of this location type: array + maxItems: 10 + items: + $ref: '#/components/schemas/StorageLocationSequenceItem' + zoneRef: + description: The id of the Zone to which this storage location belongs. + example: Esb20gpHBL94X5NdMp3C + type: string + information: + description: >- + A free text information about this storage location, max length + 1024 + type: string + maxLength: 1024 + customAttributes: + description: >- + Attributes that can be added to the storage location. These + attributes cannot be used within fulfillment processes, but it + could be useful to have the informations carried here. + type: object + required: + - action type: object xml: - name: PickLineItemArticle - ShipmentLineItemForCreation: - properties: - article: - $ref: '#/components/schemas/ShipmentLineItemArticle' - customAttributes: - description: >- - Attributes that can be added to the orderline. These attributes - cannot be used within fulfillment processes, but it could be useful - to have the informations carried here. - type: object - measurementUnitKey: - description: Identifier for items unit of measurement. - example: liter - type: string - quantity: - description: quantity of the specific article that has been ordered - example: 21 - format: int64 - minimum: 1 - type: integer - tags: - items: - $ref: '#/components/schemas/TagReference' - type: array - scannableCodes: - items: - description: Codes, that identify the article - type: string - type: array - required: - - quantity - - article - type: object - ShipmentPatchActions: + name: ModifyStorageLocationAction + StorageLocationPatchActions: properties: actions: items: - $ref: '#/components/schemas/ModifyShipmentAction' + $ref: '#/components/schemas/ModifyStorageLocationAction' minItems: 1 type: array version: description: >- - The version of the document to be used in optimistic locking - mechanisms. + The version of the facility where we want to patch the storage + locations to be used in optimistic locking mechanisms. example: 42 format: int64 type: integer @@ -30450,4307 +33021,4461 @@ components: - actions type: object xml: - name: ShipmentPatchActions - ShipmentStatus: - description: >- - Every newly created shipment is in state INITIAL. When the parcel labels - should be requested the state changes to REQUEST and as soon as all - parcel labels are successfully requested the state changes to CONFIRMED. - The state COMPLETED is set in the end or the process - enum: - - INITIAL - - REQUEST - - RETRYABLE - - CONFIRMED - - COMPLETED - - CANCELED - - OBSOLETE - type: string - Status: + name: StorageLocationPatchActions + RemoteConfigurationForCreation: additionalProperties: false properties: - status: - description: The current state of the API - enum: - - UP - - DEGRADED - - DOWN + key: type: string + example: PICKING_SHOW_NEW_SCAN_VIEW + description: unique business key of this entity + scopes: + type: array + items: + $ref: '#/components/schemas/RemoteConfigurationScopeForCreation' + valueType: + $ref: '#/components/schemas/RemoteConfigurationValueType' + value: + oneOf: + - type: string + - type: integer + - type: number + - type: boolean + - type: object + groups: + type: array + items: + example: INVENTORY + type: string + minItems: 1 required: - - status + - key + - value + - valueType + - groups type: object - xml: - name: Status - StockConfiguration: + RemoteConfiguration: allOf: - $ref: '#/components/schemas/VersionedResource' + additionalProperties: false properties: - stockModificationEnabled: - default: true - description: Indicates if manual stock modification is allowed - example: true - type: boolean id: type: string - required: - - stockModificationEnabled - type: object - xml: - name: StockConfiguration - StockConfigurationPatchActions: - properties: - actions: + example: LGMl2DuvPnfPoSHhYFOm + description: auto generated unique identifier + key: + type: string + example: PICKING_SHOW_NEW_SCAN_VIEW + description: unique business key of this entity + scopes: + type: array items: - anyOf: - - $ref: '#/components/schemas/ModifyRetainedOfflineStockAction' - - $ref: '#/components/schemas/ModifyListingReactivationAfterAction' - - $ref: '#/components/schemas/ModifyShortpickAction' - minItems: 1 + $ref: '#/components/schemas/RemoteConfigurationScope' + valueType: + $ref: '#/components/schemas/RemoteConfigurationValueType' + value: + oneOf: + - type: string + - type: number + - type: boolean + - type: object + - type: integer + groups: type: array - version: + items: + example: INVENTORY + type: string + minItems: 1 + flattenScopeIds: description: >- - The version of the document to be used in optimistic locking - mechanisms. - example: 42 - format: int64 - type: integer + generated flatten unique ids of all scope sub elements (userRef, + facilityRef) + type: array + items: + example: + - INVENTORY + - 67151fc3-3ce1-400e-8b23-23c29e0cde90 + type: string required: + - id + - key - version - - actions - type: object - xml: - name: FacilityPatchActions - StockInformationForCreation: - description: >- - @deprecated This object is deprecated since 30th of November 2023. This - object carries information about the current stock of this listing. - deprecated: true - properties: - reserved: - deprecated: true - description: >- -
-
This endpoint is deprecated and has been replaced.

@deprecated This field is deprecated since 8th of February - 2023. - - Reserved can't be overridden by the API, because its internally now - handled by open PickJobs (or other upcoming ways to reserve Stock) - - Any Value provided will be ignored upon arrival. - example: 24 - minimum: 0 - multipleOf: 1 - type: number - stock: - description: >- - This the amount of the given article that is in stock for the given - facility - example: 42 - minimum: 0 - multipleOf: 1 - type: number - required: - - stock - type: object - StockInformation: - allOf: - - $ref: '#/components/schemas/StockInformationForCreation' - - properties: - reserved: - example: 24 - minimum: 0 - multipleOf: 1 - type: number - available: - description: The actual available amount for this stock - example: 24 - minimum: 0 - multipleOf: 1 - type: number - required: - - available + - value + - valueType + - groups + - flattenScopeIds type: object - StrippedCarrier: - allOf: - - $ref: '#/components/schemas/VersionedResource' - - properties: - deliveryType: - $ref: '#/components/schemas/CarrierDeliveryType' - id: - description: >- - The id of this carrier. It is generated during creation - automatically and suits as the primary identifier of the - described carrier. - example: climk4dcQFiPdA5ULuhS - type: string - key: - type: string - lifecycle: - $ref: '#/components/schemas/CarrierLifecycle' - name: - description: >- - This is the well known name for a supported CEP partner. Can be - adapted to the clients needs. - example: DHL Köln - type: string - status: - $ref: '#/components/schemas/CarrierStatus' - required: - - id - - name - - key - type: object - xml: - name: StrippedCarrier - StrippedCarriers: + RemoteConfigurationForUpdate: + additionalProperties: false properties: - carriers: - items: - $ref: '#/components/schemas/StrippedCarrier' - type: array - total: - description: Total number of found entities for this query - example: 42 + version: type: integer - type: object - StrippedFacilities: - properties: - facilities: + scopes: + type: array items: - $ref: '#/components/schemas/StrippedFacility' + $ref: '#/components/schemas/RemoteConfigurationScopeForCreation' + valueType: + $ref: '#/components/schemas/RemoteConfigurationValueType' + value: + oneOf: + - type: string + - type: integer + - type: number + - type: boolean + - type: object + groups: type: array - total: - description: Total number of found entities for this query - example: 42 - type: integer + items: + example: INVENTORY + type: string + minItems: 1 + required: + - version type: object - StrippedFacility: - allOf: - - $ref: '#/components/schemas/VersionedResource' - - $ref: '#/components/schemas/Address' - - properties: - id: - type: string - name: - description: name of the facility - example: Köln store - type: string - status: - $ref: '#/components/schemas/FacilityStatus' - tenantFacilityId: - description: The id of the facility in the tenants own system - example: K12345 - type: string - required: - - id - - status - type: object - StrippedHandoverjob: - allOf: - - $ref: '#/components/schemas/VersionedResource' - - properties: - carrierRef: - type: string - channel: - enum: - - DELIVERY - - COLLECT - type: string - facilityRef: - description: The id of the facility reference. - example: Esb20gpHBL94X5NdMp3C - type: string - id: - description: >- - The id of this handoverjob. It is generated during creation - automatically and suits as the primary identifier of the - described entity. - example: 95EWrieX09OmeriXIUbb - type: string - loadUnitRefs: - description: Reference to array of load unit Refs - items: - type: string - type: array - orderDate: - description: The date this order was created at the supplying system. - example: '2020-02-03T08:45:50.525Z' - format: date-time - type: string - parcelRef: - description: The reference to the parcel. - example: 2fOge2ZGW54K4TgvDTQw - type: string - pickJobRef: - description: >- - The reference to the pickjob for which the handoverjob is - assigned to - example: ca525716-7208-4a63-a2a6-11274eb37f67-0 - type: string - shipmentRef: - description: The reference to the shipment belonging to the handoverjob - example: Esb20gpHBL94X5NdMp3C - type: string - status: - $ref: '#/components/schemas/HandoverjobStatus' - tenantOrderId: - description: >- - Field can be used as a reference number in foreign systems, for - example as a reference to the source system's identifier for - this order. - example: R456728546 - type: string - searchPaths: - description: This is the search term that was used to find the handover job - example: R456728546 - type: array - items: - type: string - minItems: 0 - required: - - id - - status - - facilityRef - - channel - type: object - StrippedHandoverjobs: + RemoteConfigurationForPut: + additionalProperties: false properties: - handoverjobs: - items: - $ref: '#/components/schemas/StrippedHandoverjob' - type: array - total: - description: Total number of found entities for this query - example: 42 + version: type: integer - type: object - StrippedListing: - allOf: - - $ref: '#/components/schemas/VersionedResource' - - properties: - id: - example: fsfdsf87fsd - type: string - status: - enum: - - ACTIVE - - INACTIVE - type: string - tenantArticleId: - description: This is a reference to an article Id - example: '4711' - type: string - required: - - status - - facilityId - - id - - tenantArticleId - type: object - StrippedListings: + scopes: + type: array + items: + $ref: '#/components/schemas/RemoteConfigurationScopeForCreation' + valueType: + $ref: '#/components/schemas/RemoteConfigurationValueType' + value: + oneOf: + - type: string + - type: integer + - type: number + - type: boolean + - type: object + groups: + type: array + items: + example: INVENTORY + type: string + minItems: 1 + required: + - version + - value + - valueType + - groups + type: object + RemoteConfigurations: properties: - listings: + remoteConfigurations: items: - $ref: '#/components/schemas/StrippedListing' + $ref: '#/components/schemas/RemoteConfiguration' type: array total: description: Total number of found entities for this query example: 42 type: integer type: object - ListingBulkOperationResult: + RemoteConfigurationScopeForCreation: + additionalProperties: false + properties: + facilityRefs: + type: array + items: + description: Reference of a Facility + example: 928f3730-bc48-4d85-b83f-3fd86b776178 + type: string + userRefs: + type: array + items: + description: Reference of a user + example: 928f3730-bc48-4d85-b83f-3fd86b776178 + type: string type: object + AddRemoteConfigurationScopeParameter: + additionalProperties: false properties: - listing: - $ref: '#/components/schemas/Listing' - status: - $ref: '#/components/schemas/BulkOperationResultStatus' + scope: + $ref: '#/components/schemas/RemoteConfigurationScopeForCreation' + remoteConfigVersion: + type: number + minimum: 0 required: - - listing - - status - BulkOperationResultStatus: + - scope + - remoteConfigVersion + type: object + RemoteConfigurationScope: + allOf: + - $ref: '#/components/schemas/RemoteConfigurationScopeForCreation' + additionalProperties: false + properties: + id: + type: string + example: LGMl2DuvPnfPoSHhYFOm + description: auto generated unique identifier + required: + - id + type: object + RemoteConfigurationValueType: + enum: + - BOOLEAN + - STRING + - JSON + - NUMBER + - INT type: string + ExternalActionType: + type: string + description: The type of an external action enum: - - UPDATED - - CREATED - - FAILED - StrippedOrder: - allOf: - - $ref: '#/components/schemas/VersionedResource' - - properties: - id: - description: >- - The id of this order. It is generated during creation - automatically and suits as the primary identifier of the - described entity. - example: LGMl2DuvPnfPoSHhYFOm - type: string - orderDate: - description: The date this order was created at the supplying system. - example: '2020-02-03T08:45:50.525Z' - format: date-time - type: string - orderLineItems: - items: - properties: - quantity: - description: quantity of the specific article that has been ordered - example: 21 - format: int64 - minimum: 1 - type: integer - title: - example: Cologne Water - type: string - required: - - quantity - - title - type: object - type: array - status: - $ref: '#/components/schemas/OrderStatus' - stickers: - items: - $ref: '#/components/schemas/Sticker' - type: array - required: - - id - - status - - orderDate - type: object - StrippedOrders: + - BLANK_LINK + - FORM + ExternalFormActionDefinition: + additionalProperties: false properties: - orders: - items: - $ref: '#/components/schemas/StrippedOrder' + type: + $ref: '#/components/schemas/ExternalActionType' + elements: type: array - total: - description: Total number of found entities for this query - example: 42 - type: integer + minItems: 1 + items: + anyOf: + - $ref: '#/components/schemas/ExternalFormActionElement' + - $ref: '#/components/schemas/ExternalFormActionInputElement' + discriminator: + propertyName: elementType + mapping: + TEXT_INPUT: '#/components/schemas/ExternalFormActionInputElement' + HEADLINE: '#/components/schemas/ExternalFormActionElement' + SUBHEADLINE: '#/components/schemas/ExternalFormActionElement' + TEXT: '#/components/schemas/ExternalFormActionElement' + success: + $ref: '#/components/schemas/ExternalFormActionButton' + cancel: + $ref: '#/components/schemas/ExternalFormActionButton' + required: + - elements + - success + - type type: object - StrippedParcel: + xml: + name: ExternalFormActionDefinition + ExternalFormActionElementType: + type: string + enum: + - TEXT_INPUT + - HEADLINE + - SUBHEADLINE + - TEXT + ExternalFormActionInputElement: + additionalProperties: false properties: - carrierRef: - description: The reference to the carrier for which the parcel is assigned to - example: ca525716-7208-4a63-a2a6-11274eb37f67-0 + elementId: type: string - parcelRef: - example: 15EZrieW09OmeriXIUbc + isMandatory: + type: boolean + validation: + anyOf: + - $ref: '#/components/schemas/StringValidation' + - $ref: '#/components/schemas/IntegerValidation' + - $ref: '#/components/schemas/FloatValidation' + discriminator: + propertyName: validationType + mapping: + STRING: '#/components/schemas/StringValidation' + FLOAT: '#/components/schemas/FloatValidation' + INTEGER: '#/components/schemas/IntegerValidation' + style: type: string - status: - $ref: '#/components/schemas/ParcelStatus' - carrierTrackingNumber: - example: '84168117830018' + enum: + - BODY + - INFO + - WARN + - ERROR + titleLocalized: + description: The name of this external action localized + example: '{ en_US: ''SomeName'' }' + $ref: '#/components/schemas/LocaleString' + title: type: string + elementType: + $ref: '#/components/schemas/ExternalFormActionElementType' required: - - parcelRef - - carrierRef - - status + - elementId + - titleLocalized + - elementType + type: object + xml: + name: ExternalFormActionInputElement + BaseValidation: type: object - StrippedParcels: properties: - parcels: - items: - $ref: '#/components/schemas/StrippedParcel' - type: array - total: - description: Total number of found entities for this query - example: 42 - type: integer + validationType: + type: string + enum: + - STRING + - FLOAT + - INTEGER + required: + - validationType + StringValidation: type: object - StrippedPickJob: allOf: - - $ref: '#/components/schemas/VersionedResource' - - properties: - searchPaths: - items: - type: string - type: array - minItems: 0 - carrierKey: - type: string - example: DPD - facilityRef: - description: >- - The id of the facility reference. The given ID has to be present - in the system. - example: Esb20gpHBL94X5NdMp3C - type: string - id: - type: string - orderRef: - description: >- - The id of the order that lead to the creation of this pickjob. - Can be empty / not present when the pickjob was created without - having an order. - example: LGMl2DuvPnfPoSHhYFOm - type: string - targetTime: - description: At which time the result is expected. - example: '2020-02-03T09:45:51.525Z' - format: date-time - type: string - status: - $ref: '#/components/schemas/PickJobStatus' - required: - - id - - status - - created - - lastModified - - version - type: object - StrippedPickJobs: + - $ref: '#/components/schemas/BaseValidation' + additionalProperties: false properties: - pickjobs: - items: - $ref: '#/components/schemas/StrippedPickJob' - type: array - total: - description: Total number of found entities for this query - example: 42 - type: integer + minLength: + type: number + maxLength: + type: number + IntegerValidation: type: object - PickRunForCreation: + allOf: + - $ref: '#/components/schemas/BaseValidation' + additionalProperties: false properties: - pickJobRefs: - items: - type: string - type: array - minItems: 1 - status: - $ref: '#/components/schemas/PickRunStatus' - facilityRef: - type: string - pickRunType: - $ref: '#/components/schemas/PickRunType' - required: - - pickJobRefs - - facilityRef + minValue: + type: number + maxValue: + type: number + FloatValidation: type: object - PickRun: allOf: - - $ref: '#/components/schemas/VersionedResource' - - properties: - pickLineItems: - items: - $ref: '#/components/schemas/PickLineItem' - type: array - pickJobRefs: - items: - type: string - type: array - facilityRef: - type: string - status: - $ref: '#/components/schemas/PickRunStatus' - id: - type: string - editor: - $ref: '#/components/schemas/Editor' - pickRunType: - $ref: '#/components/schemas/PickRunType' + - $ref: '#/components/schemas/BaseValidation' + additionalProperties: false + properties: + minValue: + type: number + maxValue: + type: number + ExternalFormActionElement: + properties: + style: + type: string + description: it is only allowed to set a style for elementType TEXT + enum: + - BODY + - INFO + - WARN + - ERROR + titleLocalized: + description: The name of this external action localized + example: '{ en_US: ''SomeName'' }' + $ref: '#/components/schemas/LocaleString' + title: + type: string + elementType: + $ref: '#/components/schemas/ExternalFormActionElementType' required: - - pickLineItems - - pickJobRefs - - facilityRef - - status - - id + - elementType + - titleLocalized type: object - StrippedShipments: + xml: + name: ExternalFormActionElement + ExternalFormActionButton: + additionalProperties: false properties: - shipments: - items: - $ref: '#/components/schemas/ShipmentWithSearchPath' - type: array - total: - description: Total number of found entities for this query - example: 42 - type: integer + labelLocalized: + description: The name of this external action localized + example: '{ en_US: ''SomeName'' }' + $ref: '#/components/schemas/LocaleString' + label: + type: string + required: + - labelLocalized type: object - StrippedShippingTargetAddress: + xml: + name: ExternalFormActionElement + ExternalLinkActionDefinition: + additionalProperties: false properties: - country: - description: A two-digit country code as per ISO 3166-1 alpha-2 - example: DE - pattern: ^[A-Z]{2}$ + type: + $ref: '#/components/schemas/ExternalActionType' + linkUrl: type: string - postalCode: - example: '40764' - pattern: ^.+ + required: + - linkUrl + - type + type: object + xml: + name: ExternalLinkActionDefinition + ExternalActionForCreation: + properties: + processRef: + description: Id of the global process related to this entity. type: string + nameLocalized: + description: The name of this external action localized + example: '{ en_US: ''SomeName'' }' + $ref: '#/components/schemas/LocaleString' + groups: + items: + description: User-defined text strings for grouping external actions + type: string + type: array + action: + oneOf: + - $ref: '#/components/schemas/ExternalFormActionDefinition' + - $ref: '#/components/schemas/ExternalLinkActionDefinition' + discriminator: + propertyName: type + mapping: + BLANK_LINK: '#/components/schemas/ExternalLinkActionDefinition' + FORM: '#/components/schemas/ExternalFormActionDefinition' + required: + - processRef + - nameLocalized + - groups + - action type: object - StrippedUsers: + xml: + name: ExternalActionForCreation + ExternalActionForReplacement: properties: - total: - description: Total number of found entities for this query + version: example: 42 + format: int64 type: integer - users: + nameLocalized: + description: The name of this external action localized + example: '{ en_US: ''SomeName'' }' + $ref: '#/components/schemas/LocaleString' + groups: items: - $ref: '#/components/schemas/User' + description: User-defined text strings for grouping external actions + type: string type: array + action: + oneOf: + - $ref: '#/components/schemas/ExternalFormActionDefinition' + - $ref: '#/components/schemas/ExternalLinkActionDefinition' + discriminator: + propertyName: type + mapping: + BLANK_LINK: '#/components/schemas/ExternalLinkActionDefinition' + FORM: '#/components/schemas/ExternalFormActionDefinition' + required: + - version + - nameLocalized + - groups + - action type: object - Subscription: + xml: + name: ExternalActionForReplacement + ExternalAction: allOf: - - $ref: '#/components/schemas/SubscriptionForCreation' + - $ref: '#/components/schemas/ExternalActionForReplacement' + - $ref: '#/components/schemas/VersionedResource' properties: - created: - description: >- - The date this subscription was created at the platform. This value - is generated by the service. - example: '2020-02-03T08:45:51.525Z' - format: date-time - type: string id: + description: >- + The id of this external action. It is generated during creation + automatically and suits as the primary identifier of the described + entity. + example: LGMl2DuvPnfPoSHhYFOm type: string - required: - - id - - created - type: object - SubscriptionForCreation: - properties: - callbackUrl: - type: string - event: + processRef: + description: Id of the global process related to this entity. type: string - headers: - items: - $ref: '#/components/schemas/CallbackHeader' - minItems: 1 - type: array name: + description: The name of this external action. type: string required: + - id - name - - event - - callbackUrl - - headers + - processRef type: object - Subscriptions: + xml: + name: ExternalAction + ExternalActions: + additionalProperties: false properties: - subscriptions: + externalActions: items: - $ref: '#/components/schemas/Subscription' + $ref: '#/components/schemas/ExternalAction' type: array total: description: Total number of found entities for this query example: 42 type: integer type: object - Substitute: + required: + - externalActions + - total + ExternalActionLogs: + additionalProperties: false properties: - attributes: + externalActionLogs: items: - $ref: '#/components/schemas/SubstituteAttributeItem' + $ref: '#/components/schemas/ExternalActionLog' type: array - imageUrl: + total: + description: Total number of found entities for this query + example: 42 + type: integer + type: object + required: + - externalActionLogs + - total + ExternalFormActionLogPayloadElement: + properties: + elementId: type: string - priority: - description: >- - This field allows you to rank substitutes against each other. The - lowest number is the most preferrable substitute. - minimum: 0 - type: number - scannableCodes: - items: - description: Strings, that identify the substitute article - type: string - type: array - tenantArticleId: + value: type: string - title: + required: + - elementId + - value + type: object + xml: + name: ExternalFormActionLogPayloadElement + ExternalLinkActionLogPayload: + properties: + linkOpenedAt: + description: The date when this link was opened. + example: '2020-02-03T08:45:50.525Z' + format: date-time type: string required: - - title - - tenantArticleId + - linkOpenedAt type: object xml: - name: Substitute - SubstituteAttributeItem: - allOf: - - $ref: '#/components/schemas/ArticleAttributeItem' - SubstituteLineItem: + name: ExternalLinkActionLogPayload + ExternalFormActionLogPayload: properties: - article: - $ref: '#/components/schemas/SubstituteLineItemArticle' - priority: - description: >- - This field allows you to rank substitutes against each other. The - lowest number is the most preferrable substitute. - minimum: 0 - type: number - quantity: - description: >- - quantity of the specific article that has been picked to substitute - the ordered line item - example: 21 - format: int64 - minimum: 1 - type: integer - scannableCodes: - items: - description: Codes, that identify the article - type: string + elements: type: array - partialStockLocations: + minItems: 1 items: - $ref: '#/components/schemas/SubstituteLineItemPartialStockLocation' + $ref: '#/components/schemas/ExternalFormActionLogPayloadElement' required: - - quantity - - article + - elements type: object - SubstituteLineItemArticle: - allOf: - - $ref: '#/components/schemas/AbstractArticle' - - properties: - attributes: - items: - $ref: '#/components/schemas/OrderArticleAttributeItem' - type: array - type: object xml: - name: SubstituteLineItemArticle - SubstituteLineItemForCreation: + name: ExternalFormActionLogPayload + ExternalActionLogForCreation: properties: - quantity: - description: >- - quantity of the specific article that has been picked to substitute - the ordered line item - example: 21 - format: int64 - minimum: 1 - type: integer - tenantArticleId: - description: TenantArticleId of the substitute article - type: string + requiresAnonymization: + type: boolean + actionPayload: + oneOf: + - $ref: '#/components/schemas/ExternalLinkActionLogPayload' + - $ref: '#/components/schemas/ExternalFormActionLogPayload' required: - - quantity - - tenantArticleId + - requiresAnonymization + - actionPayload type: object - Substitutes: + xml: + name: ExternalActionLogForCreation + ExternalActionLog: allOf: - - $ref: '#/components/schemas/Entity' - - $ref: '#/components/schemas/SubstitutesForUpsert' + - $ref: '#/components/schemas/ExternalActionLogForCreation' + additionalProperties: false + properties: + id: + type: string + externalActionRef: + description: Id of the refered external action. + type: string + editor: + $ref: '#/components/schemas/Editor' + created: + description: The date this action has been executed + example: '2020-02-03T08:45:50.525Z' + format: date-time + type: string required: - - tenantArticleId - - substitutes + - id + - externalActionRef + - editor + - created type: object xml: - name: Substitutes - SubstitutesForUpsert: + name: ExternalActionLog + AbstractReasonForCreation: + additionalProperties: false properties: - substitutes: - items: - $ref: '#/components/schemas/Substitute' - type: array - tenantArticleId: - type: string - version: - description: >- - Version field is used in the optimistic locking process. If the - Substitute is for the tenantArticleId is not set yet, this field is - ignored. - example: 1 - type: number + reason: + description: Text explaining the reason for a supported action. + example: Rerouted because of an issue in the Facility. + type: string + reasonLocalized: + $ref: '#/components/schemas/LocaleString' required: - - substitutes - - version - - tenantArticleId + - reason + - reasonLocalized type: object xml: - name: SubstitutesForUpsert - ResolvedSubstitutes: + name: AbstractReasonForCreation + AbstractReasonForModification: + additionalProperties: false properties: - substitutes: - items: - $ref: '#/components/schemas/Substitute' - type: array - tenantArticleId: + reason: + description: Text explaining the reason for a supported action. + example: Rerouted because of an issue in the Facility. type: string + reasonLocalized: + $ref: '#/components/schemas/LocaleString' + version: + description: >- + The version of the document to be used in optimistic locking + mechanisms. + example: 42 + format: int64 + type: integer required: - - substitutes - - tenantArticleId + - version + - reason + - reasonLocalized type: object xml: - name: ResolvedSubstitutes - PackingConfigurations: + name: AbstractReasonForModification + AbstractReason: allOf: + - $ref: '#/components/schemas/AbstractReasonForCreation' - $ref: '#/components/schemas/VersionedResource' properties: - packingContainerRequiredConfiguration: - $ref: '#/components/schemas/PackingContainerRequiredConfiguration' - packingItemConfirmationNeededConfiguration: - $ref: '#/components/schemas/PackingItemConfirmationNeededConfiguration' - packingSourceContainerConfiguration: - $ref: '#/components/schemas/PackingSourceContainerConfiguration' - scanningConfiguration: - $ref: '#/components/schemas/PackingScanningConfiguration' + id: + description: The id of the Reason + type: string + action: + description: The action this reason can be attached to. + type: string + required: + - id + - action type: object - PackingSourceContainerConfiguration: - description: Can this tenant use the packing source container + xml: + name: AbstractReason + AbstractReasons: properties: - active: - default: false + reasons: + items: + $ref: '#/components/schemas/AbstractReason' + type: array + hasNextPage: + description: True if there are more results after the current page type: boolean + total: + description: Total number of found entities for this query + type: integer required: - - active + - reasons + - hasNextPage + - total type: object - PackingScanningConfiguration: + xml: + name: AbstractReasons + CarrierCutoffConfiguration: properties: - scanningType: - $ref: '#/components/schemas/PackingScanningConfigurationEnum' + time: + type: string + pattern: ^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$ + example: '12:00' + capacity: + type: number type: object - ScanningRuleConfiguration: - description: >- - Configuration to show the client how the items should be scanned during - picking + required: + - time + xml: + name: CarrierCutoffTimes + CarrierCutoffTimesWeekDay: properties: - values: + day: + $ref: '#/components/schemas/WeekDay' + cutoffConfigurations: items: - $ref: '#/components/schemas/ScanningRuleValue' + $ref: '#/components/schemas/CarrierCutoffConfiguration' type: array - ScanningRuleValue: - properties: - priority: - description: >- - This field allows you to rank scanningRuleType against each other. - The lowest number is the most preferable. - minimum: 0 - type: number - scanningRuleType: - $ref: '#/components/schemas/ScanningRuleTypeEnum' + type: object required: - - priority - - scanningRuleType - ScanningRuleTypeEnum: - example: ARTICLE - description: Type of scanning rule - enum: - - ARTICLE - - LOCATION - type: string - StockPropertyInputType: - example: DATE - description: Input Type for this property, used for clients. - enum: - - DATE - - TEXT - type: string - PackingScanningConfigurationEnum: - enum: - - MUST_SCAN_EACH - - SCAN_NOT_REQUIRED - type: string - PickingMethodEnum: - example: SINGLE_ORDER - description: >- - Way in which the picking should be handled Deprecated: BATCH_PICKING, - use BATCH instead - enum: - - SINGLE_ORDER - - MULTI_ORDER - - BATCH_PICKING - - BATCH - type: string - PackingContainerRequiredConfiguration: - additionalProperties: false + - day + - cutoffConfigurations + xml: + name: CarrierCutoffTimesWeekDay + CarrierCutoffTimesOverwrite: properties: - active: - type: boolean - default: false - required: - - active + date: + type: string + pattern: ^\d{4}-\d{2}-\d{2}$ + example: '2020-02-03' + cutoffConfigurations: + items: + $ref: '#/components/schemas/CarrierCutoffConfiguration' + type: array type: object - PackingItemConfirmationNeededConfiguration: - description: Do the customer need to validate which items are part of a pack job - additionalProperties: false - properties: - active: - type: boolean - default: true required: - - active + - date + - cutoffConfigurations + xml: + name: CarrierCutoffTimes + CarrierCutoffTimes: + properties: + weekdays: + items: + $ref: '#/components/schemas/CarrierCutoffTimesWeekDay' + type: array + overwrites: + items: + $ref: '#/components/schemas/CarrierCutoffTimesOverwrite' + type: array type: object - SubstitutionConfiguration: + required: + - weekdays + - overwrites + xml: + name: CarrierCutoffTimes + FacilityCarrierConnection: allOf: - $ref: '#/components/schemas/VersionedResource' properties: - active: - default: true - description: Toggle for substitution articles. - example: false - type: boolean - required: - - active - type: object - SupportedEvent: - properties: - description: + id: + example: fsfdsf87fsd type: string - event: + facilityRef: + description: The id of the facility reference. + example: Esb20gpHBL94X5NdMp3C type: string - type: object - SupportedEvents: - properties: - supportedEvents: + carrierRef: + description: ID that references the configured carrier. + type: string + deliveryType: + $ref: '#/components/schemas/CarrierDeliveryType' + key: + type: string + configuration: + description: Facility specific configuration for this carrier + anyOf: + - $ref: '#/components/schemas/GlsFacilityCarrierConfiguration' + - $ref: '#/components/schemas/AngelFacilityCarrierConfiguration' + - $ref: '#/components/schemas/PostNLFacilityCarrierConfiguration' + - $ref: '#/components/schemas/DpdChFacilityCarrierConfiguration' + - $ref: '#/components/schemas/DhlV2FacilityCarrierConfiguration' + - $ref: '#/components/schemas/VceFacilityCarrierConfiguration' + - $ref: '#/components/schemas/BringFacilityCarrierConfiguration' + - $ref: '#/components/schemas/FedExFacilityCarrierConfiguration' + credentials: + description: Facility specific credentials for this carrier + anyOf: + - $ref: '#/components/schemas/DHLV2BusinessCredentials' + - $ref: '#/components/schemas/DpdChCarrierCredentials' + - $ref: '#/components/schemas/PostNLCarrierCredentials' + - $ref: '#/components/schemas/VceCarrierCredentials' + cutoffTime: + description: '@deprecated' + $ref: '#/components/schemas/CutoffTime' + cutoffTimes: + $ref: '#/components/schemas/CarrierCutoffTimes' + deliveryAreas: items: - $ref: '#/components/schemas/SupportedEvent' + $ref: '#/components/schemas/DeliveryArea' type: array + name: + description: >- + This is the well known name for a supported CEP partner. Can be + adapted to the clients needs. + example: DHL Köln + type: string + status: + $ref: '#/components/schemas/CarrierStatus' + parcelLabelClassifications: + items: + $ref: '#/components/schemas/ParcelLabelClassification' + type: array + tags: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/TagReference' + validDeliveryTargets: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/DeliveryTarget' + required: + - id + - facilityRef + - carrierRef + - key + - status + - cutoffTimes type: object - SupportedLocale: - 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

ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.) - enum: - - de_DE - - en_US - - pl_PL - - ru_RU - - nl_NL - - fr_FR - - it_IT - - nb_NO - example: de_DE - type: string - SupportedLocales: - items: - $ref: '#/components/schemas/SupportedLocale' - type: array - TargetAddress: - allOf: - - $ref: '#/components/schemas/ConsumerAddress' - - properties: - facilityRef: - description: >- - The id of the facility reference. The given ID has to be present - in the system. - example: Esb20gpHBL94X5NdMp3C - type: string - type: object - type: object - TimeRange: + FacilityCarrierConnectionForCreation: + additionalProperties: false properties: - end: - $ref: '#/components/schemas/TimeStamp' - start: - $ref: '#/components/schemas/TimeStamp' - capacity: - type: number - minimum: 0 - required: - - start - - end + credentials: + description: Facility specific credentials for this carrier + anyOf: + - $ref: '#/components/schemas/DHLV2BusinessCredentials' + - $ref: '#/components/schemas/DpdChCarrierCredentials' + - $ref: '#/components/schemas/PostNLCarrierCredentials' + - $ref: '#/components/schemas/VceCarrierCredentials' + configuration: + description: Facility specific configuration for this carrier + anyOf: + - $ref: '#/components/schemas/GlsFacilityCarrierConfiguration' + - $ref: '#/components/schemas/AngelFacilityCarrierConfiguration' + - $ref: '#/components/schemas/PostNLFacilityCarrierConfiguration' + - $ref: '#/components/schemas/DpdChFacilityCarrierConfiguration' + - $ref: '#/components/schemas/DhlV2FacilityCarrierConfiguration' + - $ref: '#/components/schemas/VceFacilityCarrierConfiguration' + - $ref: '#/components/schemas/BringFacilityCarrierConfiguration' + - $ref: '#/components/schemas/FedExFacilityCarrierConfiguration' + cutoffTime: + deprecated: true + description: Deprecated in favor of cutoffTimes + $ref: '#/components/schemas/CutoffTime' + cutoffTimes: + $ref: '#/components/schemas/CarrierCutoffTimes' + deliveryAreas: + items: + $ref: '#/components/schemas/DeliveryArea' + type: array + name: + description: >- + This is the well known name for a supported CEP partner. Can be + adapted to the clients needs. + example: DHL Köln + type: string + status: + $ref: '#/components/schemas/CarrierStatus' + parcelLabelClassifications: + items: + $ref: '#/components/schemas/ParcelLabelClassificationForCreation' + type: array + tags: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/TagReference' + validDeliveryTargets: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/DeliveryTarget' type: object - TimeStamp: + FacilityCarrierConnectionForModification: + additionalProperties: false properties: - hour: - maximum: 23 - minimum: 0 - type: number - minute: - maximum: 59 - minimum: 0 + credentials: + description: Facility specific credentials for this carrier + anyOf: + - $ref: '#/components/schemas/DHLV2BusinessCredentials' + - $ref: '#/components/schemas/DpdChCarrierCredentials' + - $ref: '#/components/schemas/PostNLCarrierCredentials' + - $ref: '#/components/schemas/VceCarrierCredentials' + configuration: + description: Facility specific configuration for this carrier + anyOf: + - $ref: '#/components/schemas/GlsFacilityCarrierConfiguration' + - $ref: '#/components/schemas/AngelFacilityCarrierConfiguration' + - $ref: '#/components/schemas/PostNLFacilityCarrierConfiguration' + - $ref: '#/components/schemas/DpdChFacilityCarrierConfiguration' + - $ref: '#/components/schemas/DhlV2FacilityCarrierConfiguration' + - $ref: '#/components/schemas/VceFacilityCarrierConfiguration' + - $ref: '#/components/schemas/BringFacilityCarrierConfiguration' + - $ref: '#/components/schemas/FedExFacilityCarrierConfiguration' + cutoffTime: + deprecated: true + description: Deprecated in favor of cutoffTimes + $ref: '#/components/schemas/CutoffTime' + cutoffTimes: + $ref: '#/components/schemas/CarrierCutoffTimes' + deliveryAreas: + items: + $ref: '#/components/schemas/DeliveryArea' + type: array + name: + description: >- + This is the well known name for a supported CEP partner. Can be + adapted to the clients needs. + example: DHL Köln + type: string + status: + $ref: '#/components/schemas/CarrierStatus' + parcelLabelClassifications: + items: + $ref: '#/components/schemas/ParcelLabelClassificationForCreation' + type: array + tags: + type: array + items: + $ref: '#/components/schemas/TagReference' + version: type: number + validDeliveryTargets: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/DeliveryTarget' required: - - hour - - minute + - version type: object - TimeZone: - description: Timezone for information retrieved e.g. by the Google Maps API + AbstractFacilityCarrierConfiguration: + discriminator: + propertyName: key properties: - offsetInSeconds: - description: offset in seconds to standard time - example: 28800 - type: number - timeZoneId: - description: official id of the timezone - example: America/Los_Angeles + key: type: string - timeZoneName: - description: descriptive name of the timezone - example: Pacific Standard Time + serviceUrl: type: string required: - - timeZoneId - - timeZoneName - - offsetInSeconds + - key type: object - TrackingStatus: - description: The state of the KEP - enum: - - registered - - picked_up - - delivered - - not_delivered - - transit - - exception - - out_for_delivery - - destroyed - - unknown - - canceled - - awaits_pickup_by_receiver - - delayed - - notification - type: string - PickRunStatus: - description: The state of the PickRun - enum: - - OPEN - - IN_PROGRESS - - CLOSED - - CANCELED - type: string - UserAssignedZone: - description: A facility zone that was assigned to an user + xml: + name: AbstractFacilityCarrierConfiguration + DhlV2FacilityCarrierConfiguration: + allOf: + - $ref: '#/components/schemas/AbstractFacilityCarrierConfiguration' properties: - zoneRef: - example: LGMl2DuvPnfPoSHhYFOm + alternativeReturnAddress: + $ref: '#/components/schemas/FacilityAddress' + trackAndTraceUrl: type: string - required: - - zoneRef - type: object - UserAssignedFacilityForCreation: - description: A facility that was assigned to an user + xml: + name: DhlV2FacilityCarrierConfiguration + VceFacilityCarrierConfiguration: + allOf: + - $ref: '#/components/schemas/AbstractFacilityCarrierConfiguration' properties: - facilityRef: - description: The id of the assigned facility - example: 0T1vKaEar0nuG58CxzA5 + alternativeReturnAddress: + $ref: '#/components/schemas/FacilityAddress' + trackAndTraceUrl: type: string - assignedZones: - items: - $ref: '#/components/schemas/UserAssignedZone' - type: array - required: - - facilityRef - type: object - UserAssignedFacility: - description: A facility that was assigned to an user + xml: + name: VceFacilityCarrierConfiguration + AngelFacilityCarrierConfiguration: allOf: - - $ref: '#/components/schemas/UserAssignedFacilityForCreation' + - $ref: '#/components/schemas/AbstractFacilityCarrierConfiguration' - properties: - id: - example: LGMl2DuvPnfPoSHhYFOm + pickupLocationId: + description: The id of the Pickup Location type: string - required: - - id - type: object - User: + pattern: ^[A-z0-9-]{15}$ + type: object + xml: + name: AngelFacilityCarrierConfiguration + PostNLFacilityCarrierConfiguration: + allOf: + - $ref: '#/components/schemas/AbstractFacilityCarrierConfiguration' + - properties: + customerId: + type: string + customerCode: + type: string + trackAndTraceUrl: + type: string + type: object + required: + - customerId + - customerCode + xml: + name: PostNLFacilityCarrierConfiguration + GlsFacilityCarrierConfiguration: + allOf: + - $ref: '#/components/schemas/AbstractFacilityCarrierConfiguration' + - properties: + contactId: + type: string + pattern: ^[A-z0-9-]{15}$ + returnContactId: + type: string + pattern: ^[A-z0-9-]{15}$ + trackAndTraceUrl: + type: string + trackAndTraceWsdlUrl: + type: string + type: object + xml: + name: GlsFacilityCarrierConfiguration + DpdChFacilityCarrierConfiguration: allOf: - - $ref: '#/components/schemas/VersionedResource' + - $ref: '#/components/schemas/AbstractFacilityCarrierConfiguration' - properties: - customClaims: - $ref: '#/components/schemas/CustomClaims' - firstname: - example: Alex - type: string - id: - example: LGMl2DuvPnfPoSHhYFOm + depot: type: string - lastname: - example: Schneider + trackAndTraceUrl: type: string - locale: - $ref: '#/components/schemas/SupportedLocale' - username: - example: aschneider + type: object + xml: + name: DpdChFacilityCarrierConfiguration + BringFacilityCarrierConfiguration: + allOf: + - $ref: '#/components/schemas/AbstractFacilityCarrierConfiguration' + - properties: + trackAndTraceUrl: type: string - authenticationProviderType: - deprecated: true - enum: - - EMAIL_PASSWORD - - OIDC + webhookFftHost: type: string - description: >- -
-
This endpoint is deprecated and has been - replaced.

@deprecated use authenticationProvider - instead. - authenticationProvider: - $ref: '#/components/schemas/AuthenticationProvider' - assignedFacilities: - items: - $ref: '#/components/schemas/UserAssignedFacility' - type: array - customAttributes: - nullable: true - description: >- - Attributes that can be added to the user. These attributes - **cannot** be used within fulfillment processes, but enable you - to attach custom data from your systems to fulfillmenttools - entities. - type: object - required: - - id - - username - - firstname - - lastname - - locale - - authenticationProvider type: object xml: - name: User - AuthenticationProviderType: - enum: - - EMAIL_PASSWORD - - OIDC - type: string - AuthenticationProvider: - properties: - type: - $ref: '#/components/schemas/AuthenticationProviderType' - id: - example: LGMl2DuvPnfPoSHhYFOm - type: string - required: - - type - type: object + name: BringFacilityCarrierConfiguration + FedExFacilityCarrierConfiguration: + allOf: + - $ref: '#/components/schemas/AbstractFacilityCarrierConfiguration' + - properties: + trackAndTraceUrl: + type: string + type: object xml: - name: AuthenticationProvider - UserForCreation: + name: FedExFacilityCarrierConfiguration + ZoneForCreation: properties: - firstname: - example: Alex - type: string - lastname: - example: Schneider - type: string - locale: - $ref: '#/components/schemas/SupportedLocale' - password: - example: Ghg9u8X7ms8A8tLT - type: string - roles: - $ref: '#/components/schemas/UserRoles' - username: - example: aschneider + name: + description: The name of this zone type: string - assignedFacilities: - items: - $ref: '#/components/schemas/UserAssignedFacilityForCreation' - type: array - customAttributes: - nullable: true - description: >- - Attributes that can be added to the user. These attributes - **cannot** be used within fulfillment processes, but enable you to - attach custom data from your systems to fulfillmenttools entities. - type: object + score: + description: The score of this zone + type: number required: - - username - - password - - firstname - - lastname - - roles + - name + - score type: object xml: - name: UserForCreation - UserPatchActions: + name: ZoneForCreation + ZoneForReplacement: + allOf: + - $ref: '#/components/schemas/ZoneForCreation' properties: - actions: - items: - $ref: '#/components/schemas/ModifyUserAction' - minItems: 1 - type: array version: - description: >- - The version of the document to be used in optimistic locking - mechanisms. example: 42 format: int64 type: integer required: - version - - actions type: object xml: - name: UserPatchActions - UserRole: - properties: - facilities: - default: [] - description: List of facility Ids that the user is assigned to - example: - - 0T1vKaEar0nuG58CxzA5 - items: - type: string - maxItems: 23 - minItems: 0 - type: array - name: - $ref: '#/components/schemas/UserRoleNames' - required: - - name - type: object - UserRoleNames: - enum: - - FULFILLER - - SUPERVISOR - - ADMINISTRATOR - type: string - UserRoles: - description: 'roles of a user ' - items: - $ref: '#/components/schemas/UserRole' - maxItems: 1 - minItems: 1 - type: array - VersionedResource: + name: ZoneForReplacement + Zone: + allOf: + - $ref: '#/components/schemas/ZoneForReplacement' + - $ref: '#/components/schemas/VersionedResource' properties: - created: - description: >- - The date this entity was created at the platform. This value is - generated by the service. - example: '2020-02-03T08:45:51.525Z' - format: date-time + id: + description: The id of this zone type: string - lastModified: + facilityRef: description: >- - The date this entity was modified last. This value is generated by - the service. - example: '2020-02-03T09:45:51.525Z' - format: date-time + The id of the facility reference. The given ID has to be present in + the system. + example: Esb20gpHBL94X5NdMp3C type: string - version: - description: >- - The version of the document to be used in optimistic locking - mechanisms. - example: 42 - format: int64 - type: integer required: - - version - type: object - CustomAttributesResource: + - id + - facilityRef type: object + xml: + name: Zone + CustomServiceForCreation: + additionalProperties: false properties: - customAttributes: - nullable: true - description: >- - Attributes that can be added to this entity. These attributes - **cannot** be used within fulfillment processes, but enable you to - attach custom data from your systems to fulfillmenttools entities. - type: object - CustomAttributableVersionedResource: - allOf: - - $ref: '#/components/schemas/VersionedResource' - - $ref: '#/components/schemas/CustomAttributesResource' + status: + $ref: '#/components/schemas/CustomServiceStatus' + nameLocalized: + $ref: '#/components/schemas/LocaleString' + descriptionLocalized: + $ref: '#/components/schemas/LocaleString' + executionTimeInMin: + type: integer + example: 120 + itemsReturnable: + type: boolean + itemsRequired: + $ref: '#/components/schemas/ItemsRequiredEnum' + additionalInformation: + type: array + items: + $ref: '#/components/schemas/AdditionalInformationForCreation' type: object - PickJobOrderBy: - description: Attribute to order a pickJobs by - enum: - - TARGET_TIME_DESC - - TARGET_TIME_ASC - - LAST_MODIFIED_DESC - - LAST_MODIFIED_ASC - - ORDER_DATE_DESC - - ORDER_DATE_ASC - - LAST_MODIFIED_BY_USER_DESC - - LAST_MODIFIED_BY_USER_ASC - type: string - xml: - name: PickJobOrderBy - PackJobOrderBy: - description: Attribute to order a packJobs by - enum: - - TARGET_TIME_DESC - - TARGET_TIME_ASC - - LAST_MODIFIED_DESC - - LAST_MODIFIED_ASC - - ORDER_DATE_DESC - - ORDER_DATE_ASC - type: string - xml: - name: PackJobOrderBy - FacilityOrderBy: - description: Attribute to order a facility list - enum: - - NAME - - CREATED - - POSTAL_CODE_ASC - type: string - xml: - name: FacilityOrderBy - UserOrderBy: - description: Attribute to order a user list - enum: - - LASTNAME - type: string - xml: - name: UserOrderBy - CarrierConfiguration: + required: + - nameLocalized + - itemsRequired + - status + CustomService: allOf: - $ref: '#/components/schemas/VersionedResource' + - $ref: '#/components/schemas/CustomServiceForCreation' properties: id: type: string - carrierRef: + status: + $ref: '#/components/schemas/CustomServiceStatus' + name: type: string - returnLabel: - default: false - description: >- - When enabled, a return label will be created by creating a shipping - label - example: false - type: boolean - additionalWeightInPercent: - description: >- - It is an amount of percentage for packaging weight which will be - added to the calculated shipping weight - type: number - minimum: 0 - mustBeWeighed: - description: >- - Indicates if the content of a parcel must be weighed before ordering - a label - type: boolean - default: false - example: false - fallBackTrackAndTraceEmail: - description: >- - EmailAddress used to receive track and trace information when no - other emailaddress was provided + description: type: string - example: max@speedyboxales.com - format: email - minLength: 1 - countryServiceMappings: - items: - $ref: '#/components/schemas/CarrierCountryServiceMapping' + additionalInformation: type: array - required: - - returnLabel - - carrierRef + items: + $ref: '#/components/schemas/AdditionalInformation' type: object - DeliveryCost: + required: + - id + StrippedCustomServices: + properties: + customServices: + items: + $ref: '#/components/schemas/CustomService' + type: array + total: + description: Total number of found entities for this query + example: 42 + type: integer type: object + ItemsRequiredEnum: + type: string + enum: + - MANDATORY + - NONE + CustomServiceStatus: + type: string + enum: + - ENABLED + - DISABLED + ServiceJobStatus: + type: string + enum: + - OPEN + - IN_PROGRESS + - FINISHED + - CANCELLED + - WAITING_FOR_INPUT + - OBSOLETE + - NOT_READY + AdditionalInformationValueType: + type: string + enum: + - STRING + - BOOLEAN + - NUMBER + - NOVALUE + - INPUT_MULTILINE_STRING + AdditionalInformationForCreation: additionalProperties: false + type: object properties: - cost: - type: number - example: 10.99 - description: The cost of sending with a carrier - currency: - type: string - example: EUR - description: currency as 3 letter iso code - pattern: ^[A-Z]{3}$ + nameLocalized: + $ref: '#/components/schemas/LocaleString' + descriptionLocalized: + $ref: '#/components/schemas/LocaleString' + valueType: + $ref: '#/components/schemas/AdditionalInformationValueType' + isMandatory: + type: boolean required: - - cost - - currency - CarrierCountryServiceMapping: + - nameLocalized + - valueType + AdditionalInformation: + allOf: + - $ref: '#/components/schemas/AdditionalInformationForCreation' type: object - additionalProperties: false properties: id: - description: unique identifier for a countryServiceMapping - example: bc5b581a-8f65-45b0-9f81-6e0d4babbcb2 - type: string - source: - $ref: '#/components/schemas/RegionInformation' - destinations: - description: The destination regions this mapping should be applied to. - items: - $ref: '#/components/schemas/RegionInformation' - minItems: 1 - type: array - sourceCountry: - deprecated: true - type: string - minLength: 2 - maxLength: 2 - description: >- -
-
This endpoint is deprecated and has been replaced.

@deprecated Use source instead. - example: DE - destinationCountries: - deprecated: true - description: >- -
-
This endpoint is deprecated and has been replaced.

@deprecated Use destination instead. - items: - $ref: '#/components/schemas/CountryCode' - minItems: 1 - type: array - mandatoryShippingAttributes: - items: - $ref: '#/components/schemas/MandatoryShippingAttribute' - type: array - minItems: 0 - mandatoryShippingItemAttributes: - items: - $ref: '#/components/schemas/MandatoryShippingItemAttribute' - type: array - minItems: 0 - product: type: string - example: EXPRESS - carrierProductCategory: - $ref: '#/components/schemas/CarrierProductCategory' - transitTime: - $ref: '#/components/schemas/CarrierTransitTime' - deliveryCosts: - items: - $ref: '#/components/schemas/DeliveryCost' - type: array - maxItems: 1 - required: - - id - - source - - destinations - CarrierCountryServiceMappingForCreation: - type: object - additionalProperties: false - properties: - carrierConfigurationVersion: - description: >- - The version of the carrier configuration to be used in optimistic - locking mechanisms. - example: 42 - format: int64 - type: integer - source: - $ref: '#/components/schemas/RegionInformation' - destinations: - description: The destination regions this mapping should be applied to. - items: - $ref: '#/components/schemas/RegionInformation' - minItems: 1 - type: array - sourceCountry: - deprecated: true + name: type: string - minLength: 2 - maxLength: 2 - description: >- -
-
This endpoint is deprecated and has been replaced.

@deprecated Use source instead. - example: DE - destinationCountries: - deprecated: true - description: >- -
-
This endpoint is deprecated and has been replaced.

@deprecated Use destination instead. - items: - $ref: '#/components/schemas/CountryCode' - minItems: 1 - type: array - mandatoryShippingAttributes: - items: - $ref: '#/components/schemas/MandatoryShippingAttribute' - type: array - minItems: 0 - mandatoryShippingItemAttributes: - items: - $ref: '#/components/schemas/MandatoryShippingItemAttribute' - type: array - minItems: 0 - product: + description: type: string - example: EXPRESS - carrierProductCategory: - $ref: '#/components/schemas/CarrierProductCategory' - transitTime: - $ref: '#/components/schemas/CarrierTransitTime' - deliveryCosts: - items: - $ref: '#/components/schemas/DeliveryCost' - type: array - minItems: 1 - maxItems: 1 required: - - carrierConfigurationVersion - - source - - destinations - CarrierCountryServiceMappingForUpdate: + - id + ServiceJobAdditionalInformation: + allOf: + - $ref: '#/components/schemas/AdditionalInformation' type: object - additionalProperties: false properties: - carrierConfigurationVersion: + value: + anyOf: + - type: string + - type: number + - type: boolean + description: Value of the additional information + example: some value + CustomServicePatchActions: + properties: + actions: + items: + anyOf: + - $ref: '#/components/schemas/ModifyCustomServiceAction' + minItems: 1 + type: array + version: description: >- The version of the document to be used in optimistic locking mechanisms. example: 42 format: int64 type: integer - source: - $ref: '#/components/schemas/RegionInformation' - destinations: - description: The destination regions this mapping should be applied to. - items: - $ref: '#/components/schemas/RegionInformation' - minItems: 1 - type: array - sourceCountry: - deprecated: true - type: string - minLength: 2 - maxLength: 2 - description: >- -
-
This endpoint is deprecated and has been replaced.

@deprecated Use source instead. - example: DE - destinationCountries: - deprecated: true - description: >- -
-
This endpoint is deprecated and has been replaced.

@deprecated Use destination instead. - items: - $ref: '#/components/schemas/CountryCode' - minItems: 1 - type: array - mandatoryShippingAttributes: - items: - $ref: '#/components/schemas/MandatoryShippingAttribute' - type: array - minItems: 0 - mandatoryShippingItemAttributes: - items: - $ref: '#/components/schemas/MandatoryShippingItemAttribute' - type: array - minItems: 0 - product: - type: string - example: EXPRESS - carrierProductCategory: - $ref: '#/components/schemas/CarrierProductCategory' - transitTime: - $ref: '#/components/schemas/CarrierTransitTime' - deliveryCosts: + required: + - version + - actions + type: object + xml: + name: CustomServicePatchActions + ModifyCustomServiceAction: + allOf: + - $ref: '#/components/schemas/AbstractModificationAction' + - additionalProperties: false + properties: + action: + description: >- + Use value 'ModifyCustomService', because you want to modify a + custom service + enum: + - ModifyCustomService + type: string + status: + $ref: '#/components/schemas/CustomServiceStatus' + nameLocalized: + $ref: '#/components/schemas/LocaleString' + descriptionLocalized: + $ref: '#/components/schemas/LocaleString' + executionTimeInMin: + type: integer + description: Time in minutes the custom service takes to be executed + example: 100 + itemsReturnable: + type: boolean + description: >- + Indicates if the items of the custom service are returnable + after the custom service has been executed + itemsRequired: + $ref: '#/components/schemas/ItemsRequiredEnum' + required: + - action + type: object + xml: + name: ModifyCustomServiceAction + ServiceJobLineItemForCreation: + type: object + properties: + quantity: + type: integer + description: Quantity of the items + example: 12 + minimum: 1 + scannableCodes: items: - $ref: '#/components/schemas/DeliveryCost' + type: string + description: Codes, that identify the article + example: '4012345678901' type: array - minItems: 1 - maxItems: 1 + article: + $ref: '#/components/schemas/ServiceJobLineItemArticle' required: - - carrierConfigurationVersion - CarrierProductCategory: - type: string - enum: - - STANDARD - - EXPRESS - - VALUE - - FORWARDING - CarrierTransitTime: + - quantity + - article + ServiceJobAdditionalInformationForCreation: type: object properties: - minTransitDays: - description: Minimum days a carrier needs for transit - example: 1 - type: integer - minimum: 0 - maxTransitDays: - description: Maximum days a carrier needs for transit - example: 3 - type: integer - minimum: 0 + additionalInformationRef: + type: string + description: ID of the additional information + example: 41d43211-g5a1-gg22-a716-ba095e30ds1d + value: + anyOf: + - type: string + - type: number + - type: boolean + description: Value of the additional information + example: some value required: - - maxTransitDays - - minTransitDays - EstimatedDeliveryTime: + - additionalInformationRef + ServiceJobAdditionalInformationForUpdate: type: object properties: - minDeliveryDays: - description: Minimum total delivery time in days - example: 1 - type: integer - minimum: 0 - maxDeliveryDays: - description: Maximum total delivery time in days - example: 3 - type: integer - minimum: 0 + additionalInformationRef: + type: string + description: ID of the additional information + example: 41d43211-g5a1-gg22-a716-ba095e30ds1d + value: + anyOf: + - type: string + - type: number + - type: boolean + description: Value of the additional information + example: some value required: - - maxDeliveryDays - - minDeliveryDays - MandatoryShippingItemAttribute: + - additionalInformationRef + ServiceJobLineItem: + allOf: + - $ref: '#/components/schemas/ServiceJobLineItemForCreation' + additionalProperties: false + type: object properties: - referencedField: + id: type: string - enum: - - description - - weightInGram - - quantity - - parcelItemValue.value - - parcelItemValue.currency - - countryOfManufacture + required: + - id + ServiceJobLineItemArticle: + allOf: + - $ref: '#/components/schemas/AbstractArticle' + - properties: + attributes: + items: + $ref: '#/components/schemas/ArticleAttributeItem' + type: array + type: object + required: + - title - tenantArticleId - description: 'Deprecated: quantity, this field is now mandatory in the item' - dataType: - type: string - enum: - - Number - - String - - Date - description: - type: string - descriptionLocalized: - $ref: '#/components/schemas/LocaleString' - type: object - MandatoryShippingAttribute: + xml: + name: ServiceLineItemArticle + ServiceJob: + allOf: + - $ref: '#/components/schemas/VersionedResource' + additionalProperties: false properties: - referencedField: + operativeProcessRef: type: string - enum: - - dimensions.weight - - productValue - - pickUpInformation.startTime - - pickUpInformation.endTime - dataType: + id: + type: string + name: type: string - enum: - - Number - - String - - Date description: type: string + lineItems: + type: array + minLength: 1 + items: + $ref: '#/components/schemas/ServiceJobLineItem' + processRef: + type: string + facilityRef: + type: string + status: + $ref: '#/components/schemas/ServiceJobStatus' + nameLocalized: + $ref: '#/components/schemas/LocaleString' descriptionLocalized: $ref: '#/components/schemas/LocaleString' - type: object - RegionInformation: - type: object - properties: - countryCode: - $ref: '#/components/schemas/CountryCode' - postalCodes: + executionTimeInMin: + type: integer + itemsReturnable: + type: boolean + itemsRequired: + $ref: '#/components/schemas/ItemsRequiredEnum' + shortId: + type: string + example: KD-12-1 + additionalInformation: type: array items: - type: string - required: - - countryCode - CountryCode: - type: string - minLength: 2 - maxLength: 2 - description: ISO 3166 ALPHA-2 of country - example: DE - PackJobForCreation: - properties: + $ref: '#/components/schemas/ServiceJobAdditionalInformation' customAttributes: description: >- - Attributes that can be added to the pack job. These attributes + Attributes that can be added to the service job. These attributes cannot be used within fulfillment processes, but it could be useful - to have the informations carried here. + to have the information carried here. type: object - facilityRef: - description: Reference to the facility you want to get the corresponding packjob - example: Esb50gpH7794X5NdMp3C - type: string - pickJobRef: - description: Reference to a pick job - example: Pic50gpH7794X5NdMp3C - type: string - status: - $ref: '#/components/schemas/PackJobStatus' - lineItems: - items: - $ref: '#/components/schemas/PackLineItemForCreation' - type: array - processId: - description: >- - Id of the global process related to this entity. For example used - for starting the GDPR process and others. - type: string - tenantOrderId: - type: string targetTime: - description: Until when the pack job must be finished. + description: At which time the service job is expected to be finished. example: '2020-02-03T09:45:51.525Z' format: date-time type: string - orderDate: - description: Date when the order was placed. - example: '2020-02-03T09:45:51.525Z' - format: date-time + customServiceRef: type: string - tags: - description: >- - Tags can only be set when there is no process related with this - packJob. Setting processId and tags will lead to an validationError. - type: array - minItems: 1 - items: - $ref: '#/components/schemas/TagReference' - recipient: - $ref: '#/components/schemas/ConsumerAddress' - deliveryChannel: - enum: - - COLLECT - - SHIPPING + description: Id of the customService this ServiceJob was created from. + example: 41d43211-g5a1-gg22-a716-ba095e30ds1d + linkedServiceJobsRef: type: string - shortId: - description: The short identifier of the shipment. + description: ID of the Linked Service Job, the Service Job should reference. + example: 41d43211-g5a1-gg22-a716-ba095e30ds1d + tenantOrderId: + description: ID of the tenant order, the linked service jobs are part of type: string + example: ocff-order-100 + inheritedLineItems: + type: array + items: + $ref: '#/components/schemas/InheritedServiceJobLineItem' + description: >- + Line items that are inherited from a preceding service job in a + linked service job required: - - facilityRef - - lineItems - type: object - xml: - name: PackJobForCreation - DocumentHandling: - type: object - properties: - sendLabel: - type: object - properties: - enabled: - type: boolean - default: false - required: - - enabled - required: - - sendLabel - PackJob: - allOf: - - $ref: '#/components/schemas/VersionedResource' - - properties: - id: - description: >- - The id of this pack job. It is generated during creation - automatically and suits as the primary identifier of the - described entity. - example: Esb20gpHBL94X5NdMp3C - type: string - editor: - $ref: '#/components/schemas/Editor' - facilityRef: - description: >- - Reference to the facility you want to get the corresponding - packjob - example: Esb50gpH7794X5NdMp3C - type: string - pickJobRef: - description: Reference to a pick job - example: Pic50gpH7794X5NdMp3C - type: string - status: - $ref: '#/components/schemas/PackJobStatus' - lineItems: - items: - $ref: '#/components/schemas/PackLineItem' - type: array - packingSourceContainers: - items: - $ref: '#/components/schemas/StrippedPackingSourceContainer' - processId: - description: >- - Id of the global process related to this entity. For example - used for starting the GDPR process and others. - type: string - targetTime: - description: Until when the pack job must be finished. - example: '2020-02-03T09:45:51.525Z' - format: date-time - type: string - orderDate: - description: Date when the order was placed. - example: '2020-02-03T09:45:51.525Z' - format: date-time - type: string - tags: - type: array - minItems: 1 - items: - $ref: '#/components/schemas/TagReference' - stickers: - items: - $ref: '#/components/schemas/Sticker' - type: array - recipient: - $ref: '#/components/schemas/ConsumerAddress' - tenantOrderId: - type: string - documentsRef: - description: Reference to the documents collection from this entity - type: string - documentHandling: - $ref: '#/components/schemas/DocumentHandling' - anonymized: - description: Indicates if gdpr related data was anonymized - example: false - type: boolean - deliveryChannel: - enum: - - COLLECT - - SHIPPING - type: string - customAttributes: - description: >- - Attributes that can be added to the pack job. These attributes - cannot be used within fulfillment processes, but it could be - useful to have the informations carried here. - type: object - shortId: - description: The short identifier of the shipment. - type: string - required: - - id - - facilityRef - - documentsRef - - status - - lineItems - - processId - type: object - xml: - name: PackJob - TagReference: - required: - - value - id + - lineItems + - processRef + - status + - nameLocalized + - itemsRequired + - facilityRef + - targetTime + - customServiceRef + ServiceJobForCreation: properties: - value: + operativeProcessRef: type: string - id: + customServiceRef: type: string - PackJobStatus: - description: >- - A pack job initially has the status OPEN and packing can start. When - packing has started, the pack job changes its status to IN_PROGRESS. - After a pack job has been completely packed its status becomes CLOSED. - enum: - - OPEN - - IN_PROGRESS - - CLOSED - - OBSOLETE - - CANCELED - type: string - xml: - name: PackJobStatus - TagPatchActions: - properties: - actions: + description: ID of the Custom Service, the Service Job should reference. + example: 41d43211-g5a1-gg22-a716-ba095e30ds1d + processRef: + type: string + description: ID of the Process, the Service Job belongs to. + example: 550e8400-e29b-41d4-a716-446655440000 + facilityRef: + type: string + description: ID of the Facility, the Service Job is executed in. + example: ba095e30-879f-11ee-b9d1-0242ac120002 + shortId: + type: string + example: KD-12-1 + lineItems: + type: array items: - anyOf: - - $ref: '#/components/schemas/AddAllowedValueToTagAction' - minItems: 1 + $ref: '#/components/schemas/ServiceJobLineItemForCreation' + additionalInformation: type: array - version: - description: >- - The version of the document to be used in optimistic locking - mechanisms. - example: 42 - format: int64 - type: integer - required: - - version - - actions - type: object - xml: - name: TagPatchActions - AddAllowedValueToTagAction: - allOf: - - $ref: '#/components/schemas/AbstractModificationAction' - - additionalProperties: false - properties: - action: - description: >- - Use value 'AddAllowedValueToTag', because you want to add an - allowed value to a tag - enum: - - AddAllowedValueToTag - type: string - allowedValue: - type: string - required: - - action - - allowedValue - type: object - xml: - name: AddAllowedValueToTagAction - PackLineItemForCreation: - properties: - article: - $ref: '#/components/schemas/PackLineItemArticle' + items: + $ref: '#/components/schemas/ServiceJobAdditionalInformationForCreation' customAttributes: description: >- - Attributes that can be added to the pack line. These attributes + Attributes that can be added to the service job. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here. type: object - quantity: - description: quantity of the specific article that has been ordered - example: 21 - format: int64 - minimum: 1 - type: integer - measurementUnitKey: - description: Identifier for items unit of measurement. - example: liter + targetTime: + description: At which time the service job is expected to be finished. + example: '2020-02-03T09:45:51.525Z' + format: date-time type: string - tags: - items: - $ref: '#/components/schemas/TagReference' - type: array - stickers: - items: - $ref: '#/components/schemas/Sticker' - type: array - scannableCodes: - items: - description: Codes, that identify the article - type: string - type: array + tenantOrderId: + description: ID of the tenant order, the linked service jobs are part of + type: string + example: ocff-order-100 + serviceJobLinkRef: + type: string + description: ID of the Service Job Link, the Service Job should reference. + example: 41d43211-g5a1-gg22-a716-ba095e30ds1d required: - - quantity - - article - type: object - xml: - name: PackLineItemForCreation - PackLineItem: - allOf: - - $ref: '#/components/schemas/PackLineItemForCreation' - - properties: - id: - description: >- - The id of this lineItem. It is generated during creation - automatically and suits as the primary identifier of the - described entity. - example: climk4dcQFiPdA5ULuhS - type: string - packed: - description: The amount of articles that were packed for this packline. - example: 20 - format: int32 - minimum: 0 - type: integer - required: - - id - type: object - xml: - name: PackLineItem - PackLineItemArticle: - allOf: - - $ref: '#/components/schemas/AbstractArticle' - - properties: - attributes: - items: - $ref: '#/components/schemas/ArticleAttributeItem' - type: array - type: object - xml: - name: PackLineItemArticle - PackJobWithSearchPath: + - customServiceRef + - facilityRef + - targetTime + ServiceJobWithSearchPaths: allOf: - - $ref: '#/components/schemas/PackJob' - - additionalProperties: false + - $ref: '#/components/schemas/ServiceJob' + additionalProperties: false properties: searchPaths: + type: array items: type: string - type: array - minItems: 0 - xml: - name: PackJobWithPath - PackJobs: + required: + - searchPaths + ServiceJobs: properties: - packJobs: + serviceJobs: items: - $ref: '#/components/schemas/PackJobWithSearchPath' + $ref: '#/components/schemas/ServiceJobWithSearchPaths' type: array total: description: Total number of found entities for this query example: 42 type: integer type: object - PackJobPatchActions: + ServiceJobOrderBy: + description: Attribute to order service job by + enum: + - TARGET_TIME_ASC + - TARGET_TIME_DESC + - LAST_MODIFIED_ASC + - LAST_MODIFIED_DESC + type: string + xml: + name: ServiceJobOrderBy + ServiceJobFilterChannel: + enum: + - COLLECT + - SHIPPING + type: string + xml: + name: ServiceJobFilterChannel + ServiceJobInProgressActionParameter: + additionalProperties: false properties: - actions: - items: - anyOf: - - $ref: '#/components/schemas/ModifyPackJobAction' - - $ref: '#/components/schemas/ModifyPackLineItemAction' - minItems: 1 + name: + $ref: '#/components/schemas/ServiceJobInProgressActionEnum' + version: + description: Version of the entity to be changed + minimum: 0 + type: integer + additionalInformation: type: array + items: + $ref: '#/components/schemas/ServiceJobAdditionalInformationForUpdate' + required: + - name + - version + ServiceJobObsoleteActionParameter: + additionalProperties: false + properties: + name: + $ref: '#/components/schemas/ServiceJobObsoleteActionEnum' version: - description: >- - The version of the document to be used in optimistic locking - mechanisms. - example: 42 - format: int64 + description: Version of the entity to be changed + minimum: 0 type: integer required: + - name - version - - actions - type: object - xml: - name: PackJobPatchActions - ModifyPackJobAction: - allOf: - - $ref: '#/components/schemas/AbstractModificationAction' - - additionalProperties: false - properties: - action: - description: Use value 'ModifyPackJob', because you want to modify a packjob - enum: - - ModifyPackJob - type: string - status: - $ref: '#/components/schemas/PackJobStatus' - required: - - action - type: object - xml: - name: ModifyPackJobAction - ModifyPackLineItemAction: - allOf: - - $ref: '#/components/schemas/AbstractModificationAction' - - additionalProperties: false - properties: - action: - description: >- - Use value 'ModifyPackLineItem', because you want to modify a - packjobs lineItem - enum: - - ModifyPackLineItem - type: string - id: - type: string - description: references the id of the packLineItem of a packJob - packed: - description: >- - The amount of articles that were packed for this packline. Can't - be more than picked before. - example: 20 - format: int64 - minimum: 0 - type: integer - required: - - action - - id - type: object - xml: - name: ModifyPackLieItemAction - PartialStockForCreation: + ServiceJobOpenActionParameter: additionalProperties: false properties: - tenantPartialStockId: - description: The id associated with the partial stock - type: string - stockinformation: - $ref: '#/components/schemas/StockInformationForCreation' - scores: + name: + $ref: '#/components/schemas/ServiceJobOpenActionEnum' + version: + description: Version of the entity to be changed + minimum: 0 + type: integer + additionalInformation: type: array items: - $ref: '#/components/schemas/Score' - location: - $ref: '#/components/schemas/Location' + $ref: '#/components/schemas/ServiceJobAdditionalInformationForUpdate' required: - - tenantPartialStockId - - stockinformation - type: object - xml: - name: PartialStock - PartialStock: - allOf: - - $ref: '#/components/schemas/PartialStockForCreation' + - name + - version + ServiceJobFinishedActionParameter: + additionalProperties: false properties: - eventLastModified: - description: >- - The date when the inventory domain comunicated a change in this - partial stock - example: '2020-02-03T08:45:50.525Z' - format: date-time - type: string - stockinformation: - $ref: '#/components/schemas/StockInformation' + name: + $ref: '#/components/schemas/ServiceJobFinishedActionEnum' + version: + description: Version of the entity to be changed + minimum: 0 + type: integer + additionalInformation: + type: array + items: + $ref: '#/components/schemas/ServiceJobAdditionalInformationForUpdate' required: - - tenantPartialStockId - - stockinformation - type: object - xml: - name: PartialStock - Location: + - name + - version + ServiceJobCancelledActionParameter: + additionalProperties: false properties: - locationRef: - description: The id of the location - type: string - scannableCodes: - description: Represents barcodes that may be scanned at this location + name: + $ref: '#/components/schemas/ServiceJobCancelledActionEnum' + version: + description: Version of the entity to be changed + minimum: 0 + type: integer + additionalInformation: type: array items: - type: string - xml: - name: Location - ScoreType: - description: Describes what kind of score is represented + $ref: '#/components/schemas/ServiceJobAdditionalInformationForUpdate' + required: + - name + - version + ServiceJobWaitingForInputActionParameter: + additionalProperties: false + properties: + name: + $ref: '#/components/schemas/ServiceJobWaitingForInputActionEnum' + version: + description: Version of the entity to be changed + minimum: 0 + type: integer + additionalInformation: + type: array + items: + $ref: '#/components/schemas/ServiceJobAdditionalInformationForUpdate' + required: + - name + - version + ServiceJobFinishedActionEnum: enum: - - RATING - - SEQUENCE + - FinishServiceJob type: string - xml: - name: ScoreType - ScoreName: - description: Describes the name of the score for humans to identify + ServiceJobOpenActionEnum: enum: - - ZONE - - EXPIRY_DATE - - RECEIPT_DATE - - RUNNING_SEQUENCE - - RESTOW_SEQUENCE + - OpenServiceJob type: string - xml: - name: ScoreName - Score: + ServiceJobObsoleteActionEnum: + enum: + - ObsoleteServiceJob + type: string + ServiceJobInProgressActionEnum: + enum: + - StartServiceJob + type: string + ServiceJobCancelledActionEnum: + enum: + - CancelServiceJob + type: string + ServiceJobWaitingForInputActionEnum: + enum: + - HoldServiceJob + type: string + ServiceJobActionsParameter: + anyOf: + - $ref: '#/components/schemas/ServiceJobInProgressActionParameter' + - $ref: '#/components/schemas/ServiceJobFinishedActionParameter' + - $ref: '#/components/schemas/ServiceJobCancelledActionParameter' + - $ref: '#/components/schemas/ServiceJobWaitingForInputActionParameter' + - $ref: '#/components/schemas/ServiceJobObsoleteActionParameter' + - $ref: '#/components/schemas/ServiceJobOpenActionParameter' + FacilityCustomServiceConnectionStatus: + type: string + enum: + - ACTIVE + - INACTIVE + FacilityCustomServiceConnection: + allOf: + - $ref: '#/components/schemas/VersionedResource' + additionalProperties: false properties: - scoreType: - $ref: '#/components/schemas/ScoreType' - scoreName: - $ref: '#/components/schemas/ScoreName' - scoreValue: - description: Describes the performance of the score - type: number + id: + type: string + status: + $ref: '#/components/schemas/FacilityCustomServiceConnectionStatus' + facilityRef: + type: string + customServiceRef: + type: string + executionTimeInMin: + type: integer required: - - scoreType - - scoreName - - scoreValue + - id + - status + - facilityRef + - customServiceRef + FacilityCustomServiceConnectionForUpdate: + additionalProperties: false + properties: + status: + $ref: '#/components/schemas/FacilityCustomServiceConnectionStatus' + executionTimeInMin: + type: integer + description: Time in minutes the custom service takes to be executed + example: 100 + version: + description: Version of the documentSet you want to update a document of + example: 42 + format: int64 + type: integer + required: + - version + FacilityCustomServiceConnectionForCreation: + additionalProperties: false + properties: + executionTimeInMin: + type: integer + description: Time in minutes the custom service takes to be executed + example: 100 + status: + $ref: '#/components/schemas/FacilityCustomServiceConnectionStatus' + required: + - status + StrippedFacilityCustomServiceConnections: + additionalProperties: false + properties: + facilityCustomServiceConnections: + items: + $ref: '#/components/schemas/FacilityCustomServiceConnection' + type: array + total: + description: Total number of found entities for this query + example: 42 + type: integer type: object - xml: - name: Score - ModifyPartialStockAction: + LinkedServiceJobs: + additionalProperties: false allOf: - - $ref: '#/components/schemas/AbstractModificationAction' - - additionalProperties: false - properties: - action: - description: >- - Use value 'ModifyPartialStock', because you want to modify a - partial stock - enum: - - ModifyPartialStock - type: string - partialStocks: - items: - $ref: '#/components/schemas/PartialStockForCreation' - minItems: 0 - type: array - required: - - action - type: object - xml: - name: ModifyPartialStockAction - PartialStockPatchActions: + - $ref: '#/components/schemas/VersionedResource' properties: - actions: + id: + example: 9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1 + type: string + processRef: + description: >- + ProcessRef of the added ServiceJobs. All Service Jobs need to be + part of the same process + example: 9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1 + type: string + facilityRef: + description: Id linked Facility from the includes service jobs + type: string + example: cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05 + targetTime: + type: string + format: date-time + includedServiceJobLinkIds: + description: searchable field of all included service job link ids + items: + type: string + example: cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05 + type: array + minItems: 1 + includedServiceJobRefs: + description: searchable field of all included service job ids + items: + type: string + example: cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05 + type: array + minItems: 1 + status: + $ref: '#/components/schemas/LinkedServiceJobsStatus' + serviceJobLinks: items: - $ref: '#/components/schemas/ModifyPartialStockAction' - minItems: 1 - maxItems: 1 + $ref: '#/components/schemas/ServiceJobLink' type: array - version: + minItems: 1 + operativeProcessRef: + type: string + fullIdentifier: + type: string description: >- - The version of the listing where we want to patch the partialStocks, - to be used in optimistic locking mechanisms. - example: 42 - format: int64 - type: integer + Full identifier of the service job. Using the full name of the + customer when created from an order. + example: 240429_lorem-42 required: - - version - - actions - type: object - xml: - name: PartialStockPatchActions - PartialStocksForReplacement: + - id + - serviceJobLinks + - processRef + - facilityRef + - includedServiceJobLinkIds + - includedServiceJobRefs + - status + - targetTime + LinkedServiceJobsStatus: + type: string + enum: + - OPEN + - IN_PROGRESS + - FINISHED + - CANCELLED + - OBSOLETE + - NOT_READY + LinkedServiceJobsForCreation: additionalProperties: false properties: - partialStocks: + serviceJobLinks: items: - $ref: '#/components/schemas/PartialStockForCreation' - minItems: 1 + $ref: '#/components/schemas/ServiceJobLinkForCreation' type: array - version: + minItems: 1 + operativeProcessRef: + type: string + fullIdentifier: + type: string description: >- - The version of the listing where we want to put the partialStocks, - to be used in optimistic locking mechanisms. - example: 42 - format: int64 - type: integer + Full identifier of the service job. Using the full name of the + customer when created from an order. + example: 240429_lorem-42 + status: + $ref: '#/components/schemas/LinkedServiceJobsStatus' required: - - partialStocks - - version - type: object - xml: - name: PartialStocksForReplacement - Tag: - allOf: - - $ref: '#/components/schemas/VersionedResource' - - $ref: '#/components/schemas/TagForCreation' + - serviceJobLinks + ServiceJobLinkForCreation: + additionalProperties: false properties: - id: + serviceJobRef: type: string - xml: - name: Tag + example: 0ed803c2-fa20-48d9-9c1b-0d243937a9ad + previousServiceJobRefs: + items: + type: string + example: 9f197dbf-c724-469b-90f1-dc94f20b2825 + type: array + maxItems: 1 + minItems: 0 + nextServiceJobLinks: + items: + $ref: '#/components/schemas/ServiceJobLinkForCreation' + type: array + minItems: 0 required: - - id - TagForCreation: + - serviceJobRef + - previousServiceJobRefs + - nextServiceJobLinks + ServiceJobLinkForAdding: additionalProperties: false + properties: + serviceJobRef: + type: string + example: 0ed803c2-fa20-48d9-9c1b-0d243937a9ad required: - - id - - allowedValues + - serviceJobRef + ServiceJobLink: + additionalProperties: false properties: id: type: string - allowedValues: + example: 0ed803c2-fa20-48d9-9c1b-0d243937a9ad + serviceJobRef: + type: string + example: 0ed803c2-fa20-48d9-9c1b-0d243937a9ad + previousServiceJobRefs: + items: + type: string + example: 9f197dbf-c724-469b-90f1-dc94f20b2825 type: array - minItems: 1 + maxItems: 1 + minItems: 0 + previousServiceJobLinkRefs: + description: id of the created previous service job links items: type: string - StrippedTags: - properties: - tags: + example: 9f197dbf-c724-469b-90f1-dc94f20b2825 + type: array + maxItems: 1 + minItems: 0 + nextServiceJobLinks: items: - $ref: '#/components/schemas/Tag' + $ref: '#/components/schemas/ServiceJobLink' type: array - total: - description: Total number of found entities for this query - example: 42 - type: integer - type: object - ProcessPatchActions: + minItems: 0 + required: + - id + - serviceJobRef + - previousServiceJobRefs + - previousServiceJobLinkRefs + - nextServiceJobLinks + InheritedServiceJobLineItem: + additionalProperties: false properties: - actions: + id: + type: string + quantity: + type: integer + description: Quantity of the items + example: 12 + minimum: 1 + scannableCodes: items: - anyOf: - - $ref: '#/components/schemas/AddTagsToProcessAction' - - $ref: '#/components/schemas/AssignFacilityToProcessAction' - minItems: 1 + type: string + description: Codes, that identify the article + example: '4012345678901' type: array - version: - description: >- - The version of the document to be used in optimistic locking - mechanisms. - example: 42 - format: int64 - type: integer + article: + $ref: '#/components/schemas/ServiceJobLineItemArticle' + serviceJobRef: + type: string required: - - version - - actions - type: object - xml: - name: ProcessPatchActions - AddTagsToProcessAction: + - id + - quantity + - article + - serviceJobRef + LinkedServiceJobsWithSearchPaths: allOf: - - $ref: '#/components/schemas/AbstractModificationAction' - - additionalProperties: false - properties: - action: - description: >- - Use value 'AddTagsToProcess', because you want to modify a - process - enum: - - AddTagsToProcess - type: string - tags: - type: array - minItems: 1 - items: - $ref: '#/components/schemas/TagReference' - required: - - action + - $ref: '#/components/schemas/LinkedServiceJobs' + additionalProperties: false + properties: + searchPaths: + type: array + items: + type: string + required: + - searchPaths + LinkedServiceJobsPaginatedResult: + additionalProperties: false + type: object + properties: + total: type: object + minimum: 0 + linkedServiceJobs: + type: array + items: + $ref: '#/components/schemas/LinkedServiceJobsWithSearchPaths' + required: + - total + - linkedServiceJobs + LinkedServiceJobsOrderBy: + description: Attribute to order linked service jobs by + enum: + - LAST_MODIFIED_ASC + - LAST_MODIFIED_DESC + - TARGET_TIME_ASC + - TARGET_TIME_DESC + type: string xml: - name: AddTagsToProcessAction - PrintableDocument: + name: LinkedServiceJobsOrderBy + LinkedServiceJobsFilterChannel: + enum: + - COLLECT + - SHIPPING + type: string + xml: + name: LinkedServiceJobsFilterChannel + HealthResult: + properties: + status: + $ref: '#/components/schemas/HealthStatus' + dependencies: + items: + $ref: '#/components/schemas/HealthDependencyStatus' + type: array + minItems: 1 + type: object + required: + - status + - dependencies + HealthDependencyStatus: + properties: + name: + example: database + description: Name of the component that is checked to be healthy + type: string + status: + $ref: '#/components/schemas/HealthStatus' + type: object + required: + - name + - status + HealthStatus: + enum: + - UP + - DOWN + type: string + CurrencyCode: + type: string + description: >- + The currency code is a three-letter code that represents a currency in + the ISO 4217 standard. + enum: + - AED + - AFN + - ALL + - AMD + - ANG + - AOA + - ARS + - AUD + - AWG + - AZN + - BAM + - BBD + - BDT + - BGN + - BHD + - BIF + - BMD + - BND + - BOB + - BOV + - BRL + - BSD + - BTN + - BWP + - BYN + - BZD + - CAD + - CDF + - CHE + - CHF + - CHW + - CLF + - CLP + - CNY + - COP + - COU + - CRC + - CUC + - CUP + - CVE + - CZK + - DJF + - DKK + - DOP + - DZD + - EGP + - ERN + - ETB + - EUR + - FJD + - FKP + - GBP + - GEL + - GHS + - GIP + - GMD + - GNF + - GTQ + - GYD + - HKD + - HNL + - HTG + - HUF + - IDR + - ILS + - INR + - IQD + - IRR + - ISK + - JMD + - JOD + - JPY + - KES + - KGS + - KHR + - KMF + - KPW + - KRW + - KWD + - KYD + - KZT + - LAK + - LBP + - LKR + - LRD + - LSL + - LYD + - MAD + - MDL + - MGA + - MKD + - MMK + - MNT + - MOP + - MRU + - MUR + - MVR + - MWK + - MXN + - MXV + - MYR + - MZN + - NAD + - NGN + - NIO + - NOK + - NPR + - NZD + - OMR + - PAB + - PEN + - PGK + - PHP + - PKR + - PLN + - PYG + - QAR + - RON + - RSD + - RUB + - RWF + - SAR + - SBD + - SCR + - SDG + - SEK + - SGD + - SHP + - SLE + - SOS + - SRD + - SSP + - STN + - SVC + - SYP + - SZL + - THB + - TJS + - TMT + - TND + - TOP + - TRY + - TTD + - TWD + - TZS + - UAH + - UGX + - USD + - USN + - UYI + - UYU + - UYW + - UZS + - VED + - VES + - VND + - VUV + - WST + - XAF + - XAG + - XAU + - XBA + - XBB + - XBC + - XBD + - XCD + - XDR + - XOF + - XPD + - XPF + - XPT + - XSU + - XTS + - XUA + - XXX + - YER + - ZAR + - ZMW + - ZWL + LocaleString: + type: object + additionalProperties: + type: string + description: >- + Provides Localized values. The key is the locale, the value is the + translation. See + https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/localization#fallback-language-mechanism + example: + de_DE: Wert + en_US: Value + ru_RU: значение + ArticleAttributeItem: + type: object + properties: + category: + type: string + enum: + - descriptive + - miscellaneous + - pickingSequence + description: |- + This category is used by OCFF to customize implemented processes. + Categorized attributes are used by various processes and tools + throughout our platform. For a complete list of possible categories + and the correct use of those please refer to the documentation. + Default value: miscellaneous + key: + type: string + description: |- + Providing the key %%subtitle%% (see example) here will cause the + value to appear for example in the App directly under the title. + With all other attributes also the key will be displayed in the + clients. + example: '%%subtitle%%' + minLength: 1 + keyLocalized: + description: >- + The translations for the key of the attribute. This can be only + filled with a descriptive category. Excluding for %%subtitle%% + allOf: + - $ref: '#/components/schemas/LocaleString' + priority: + type: integer + description: |- + This value gives the priority in the respective attribute category. + The lower the value the higher is the priority, e.g. priority 1 is + higher than priority 10. Attributes that have the highest priority + might be selected for display in different articles of OCFF. Default + Value is 1001. For details please contact the product owners. + example: 100 + format: int64 + minimum: 1 + maximum: 1000 + value: + type: string + example: 585er Gold + minLength: 1 + valueLocalized: + description: >- + The translations for the key of the attribute. This can be only + filled with a descriptive category + allOf: + - $ref: '#/components/schemas/LocaleString' + required: + - key + - value + AbstractArticle: type: object properties: - id: + customAttributes: + type: object + nullable: true + description: >- + Attributes that can be added to this entity. These attributes + **cannot** be used within fulfillment processes, but enable you to + attach custom data from your systems to fulfillmenttools entities. + imageUrl: type: string - documentType: - $ref: '#/components/schemas/DocumentType' - documentCategory: - $ref: '#/components/schemas/DocumentCategory' - status: - $ref: '#/components/schemas/DocumentStatus' - operations: - type: array - description: Offered operations for this document - items: - $ref: '#/components/schemas/DocumentOperations' - name: + description: >- + A web link to a picture of this article. Please make sure that no + authentication is required to fetch the image! + tenantArticleId: type: string - path: + description: This is a reference to an article number + example: '4711' + title: type: string - priority: + description: The title of the product + example: Cologne Water + titleLocalized: + description: The translations for the title of the product + allOf: + - $ref: '#/components/schemas/LocaleString' + weight: type: number + description: weight value is in gram minimum: 0 required: - - documentType - - id - - status - - documentCategory - PrintableDocumentForUpdate: - type: object - additionalProperties: false - properties: - version: - description: Version of the documentSet you want to update a document of - example: 42 - format: int64 - type: integer - priority: - description: Sorting display order of document - example: 42 - format: int64 - type: integer - operations: - type: array - description: Offered operations for this document - minItems: 1 - items: - $ref: '#/components/schemas/DocumentOperations' - required: - - version - ExternalPrintableDocumentForCreation: + - tenantArticleId + - title + OperativeTransfer: type: object - additionalProperties: false properties: + id: + description: The id of the transfer + type: string + example: 018fe899-80ec-70f8-9bda-f7cc904bc0bf type: - $ref: '#/components/schemas/DocumentType' - file: - $ref: '#/components/schemas/NamedFile' - priority: - type: number - minimum: 0 - operations: - type: array - description: Offered operations for this document - minItems: 1 - items: - $ref: '#/components/schemas/DocumentOperations' + description: The type of the transfer + enum: + - SUPPLIER + - RECEIVER + example: RECEIVER required: + - id - type - ExternalDocumentContentForUpdate: - type: object additionalProperties: false + BaseDecisionDetail: properties: - file: - $ref: '#/components/schemas/NamedFile' - documentSetVersion: - type: number - example: 2 - description: Version of documentSet to which this document belongs. + decisionType: + $ref: '#/components/schemas/DecisionType' required: - - file - - documentSetVersion - DocumentSet: + - decisionType + DecisionType: + enum: + - FENCE + - TOOLKIT + - TOOLKITCOMPARISON + - RATING + CustomServiceReference: allOf: - - $ref: '#/components/schemas/VersionedResource' + - $ref: '#/components/schemas/CustomServiceReferenceForCreation' properties: id: type: string - facilityRef: - type: string - documents: - type: array + customServiceItems: items: - $ref: '#/components/schemas/PrintableDocument' + $ref: '#/components/schemas/CustomServiceItem' + type: array + type: object required: + - customServiceDefinition + - articleItems + - customServiceItems - id - DocumentStatus: - type: string - enum: - - AVAILABLE - - LOADING - - REQUESTABLE - - CANCELED - - WAITING_FOR_INPUT - DocumentOperations: - type: string - enum: - - PRINT - - VIEW - DocumentCategory: - enum: - - EXTERNAL - - DELIVERYNOTE - - RETURNNOTE - - SENDLABEL - - RETURNLABEL - type: string - AssignFacilityToProcessAction: - allOf: - - $ref: '#/components/schemas/AbstractModificationAction' - - additionalProperties: false - properties: - action: - description: Use value to manually assign a facility to a process - enum: - - AssignFacilityToProcess - type: string - facilityRef: - type: string - rerouteDescriptionId: - type: string - required: - - action - - facilityRef - type: object - xml: - name: AssignFacilityToProcessAction - PackingContainer: + CustomServiceReferenceForCreation: + additionalProperties: false + properties: + customServiceDefinition: + $ref: '#/components/schemas/CustomServiceDefinition' + articleItems: + items: + $ref: '#/components/schemas/ArticleItem' + type: array + customServiceItems: + items: + $ref: '#/components/schemas/CustomServiceItemForCreation' + type: array + type: object + required: + - customServiceDefinition + - articleItems + - customServiceItems + CustomServiceItem: allOf: - - $ref: '#/components/schemas/VersionedResource' - - $ref: '#/components/schemas/PackingContainerForCreation' + - $ref: '#/components/schemas/CustomServiceItemForCreation' properties: - description: - type: string - descriptionLocalized: - $ref: '#/components/schemas/LocaleString' - facilityRef: - description: >- - The id of the facility reference. The given ID has to be present in - the system. But it is not updatable via PUT request - example: Esb20gpHBL94X5NdMp3C - type: string - packJobRef: - type: string - iconUrl: - type: string id: type: string - dimensions: - $ref: '#/components/schemas/ContainerDimensions' - weightLimitInG: - description: 'Maximal weight in gramm(gr) the container can be loaded with. ' - example: 2500 - type: number - minimum: 1 - name: - type: string - nameLocalized: - $ref: '#/components/schemas/LocaleString' - lineItems: + customServiceItems: items: - $ref: '#/components/schemas/PackingContainerLineItem' + $ref: '#/components/schemas/CustomServiceItem' + type: array + type: object required: - id - - nameLocalized - - version - - facilityRef - - packJobRef - - lineItems - type: object - PackingContainerForCreation: + - customServiceItems + - articleItems + - customServiceDefinition + CustomServiceItemForCreation: + additionalProperties: false properties: - codes: + customServiceDefinition: + $ref: '#/components/schemas/CustomServiceDefinition' + articleItems: items: - description: List of codes - type: string - minItems: 1 + $ref: '#/components/schemas/ArticleItem' type: array - lineItems: + customServiceItems: items: - $ref: '#/components/schemas/PackingContainerLineItemForCreation' - packingContainerTypeRef: - type: string - required: - - packingContainerTypeRef - - codes - type: object - ContainerDimensions: - additionalProperties: false - properties: - heightInCm: - description: The height of the container (in cm) - example: 50 - type: number - lengthInCm: - description: The length of the container (in cm) - example: 100 - type: number - weightInG: - description: The weight of the container (in g) - example: 1700 - type: number - widthInCm: - description: The width of the container (in cm) - example: 25.5 - type: number + $ref: '#/components/schemas/CustomServiceItemForCreation' + type: array type: object - AddressType: - description: >- - Type of this address, used e.g. for communication with the carrier. Use - POSTAL_ADDRESS for the address where the order should be shipped to, - INVOICE_ADDRESS for the address where the invoice is sent to and - PARCEL_LOCKER if a parcel locker is used for this order. - type: string - enum: - - POSTAL_ADDRESS - - PARCEL_LOCKER - - INVOICE_ADDRESS - PackingContainerPatchActions: + required: + - customServiceItems + - articleItems + - customServiceDefinition + CustomServiceDefinition: properties: - actions: + customServiceRef: + description: >- + A reference to the custom service to be applied to the orderline + items + type: string + isBundled: + description: if true all articles below this service are intrpreted as a bundle + type: boolean + additionalInformation: items: - anyOf: - - $ref: '#/components/schemas/ReplaceCodesInPackingContainerAction' - - $ref: '#/components/schemas/AddLineItemToPackingContainerAction' - - $ref: '#/components/schemas/RemoveLineItemFromPackingContainerAction' - - $ref: '#/components/schemas/UpdateLineItemOnPackingContainerAction' - minItems: 1 + properties: + additionalInformationRef: + description: >- + A reference to the specific additional information of the + custom service + type: string + value: + description: The value of the additional information + anyOf: + - type: string + - type: integer + - type: number + - type: boolean + type: object + required: + - additionalInformationRef + description: Additional information necessary to fulfil the custom service type: array - version: - description: >- - The version of the document to be used in optimistic locking - mechanisms. - example: 42 - format: int64 - type: integer - required: - - version - - actions type: object - xml: - name: PackingContainerPatchActions - ReplaceCodesInPackingContainerAction: + Order: allOf: - - $ref: '#/components/schemas/AbstractModificationAction' - - additionalProperties: false - properties: - action: + - $ref: '#/components/schemas/OrderForCreation' + - $ref: '#/components/schemas/VersionedResource' + - properties: + cancelationReason: + $ref: '#/components/schemas/CancelationReason' + anonymized: + description: Indicates if gdpr related data was anonymized + example: false + type: boolean + id: description: >- - Use ReplaceCodesInPackingContainer to add a code to an existing - packing container - enum: - - ReplaceCodesInPackingContainer + The id of this order. It is generated during creation + automatically and suits as the primary identifier of the + described entity. + example: LGMl2DuvPnfPoSHhYFOm type: string - codes: + orderLineItems: items: - description: List of codes - type: string - minItems: 1 + $ref: '#/components/schemas/OrderLineItem' type: array - required: - - action - type: object - xml: - name: ReplaceCodesInPackingContainer - AddLineItemToPackingContainerAction: - allOf: - - $ref: '#/components/schemas/AbstractModificationAction' - - additionalProperties: false - properties: - action: + processId: description: >- - Use AddLineItemToPackingContainer to add a line item to an - existing packing container - enum: - - AddLineItemToPackingContainer + Id of the global process related to this entity. For example + used for starting the GDPR process and others. type: string - lineItem: - $ref: '#/components/schemas/PackingContainerLineItemForCreation' + customServices: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/CustomServiceReference' + schemaVersion: + type: number + status: + $ref: '#/components/schemas/OrderStatus' required: - - action - - lineItem + - id + - status + - orderLineItems + - processId type: object xml: - name: AddLineItemToPackingContainer - RemoveLineItemFromPackingContainerAction: + name: Order + OrderArticleAttributeItem: allOf: - - $ref: '#/components/schemas/AbstractModificationAction' - - additionalProperties: false + - $ref: '#/components/schemas/ArticleAttributeItem' + OrderPaymentInfo: + properties: + currency: + description: The currency in which the consumer paid with + example: EUR + type: string + type: object + OrderForCreation: + additionalProperties: false + properties: + consumer: properties: - action: + addresses: + items: + $ref: '#/components/schemas/ConsumerAddress' + type: array + customAttributes: description: >- - Use RemoveLineItemFromPackingContainer to remove a line item - from an existing packing container - enum: - - RemoveLineItemFromPackingContainer - type: string - lineItemRef: - description: Id of the PackLineItem you want to remove. + Attributes that can be added to the consumer. These attributes + cannot be used within fulfillment processes, but it could be + useful to have the informations carried here. + type: object + email: + description: The email address of the consumer. + example: max@speedyboxales.com + format: email type: string required: - - action - - lineItemRef + - addresses type: object - xml: - name: RemoveLineItemFromPackingContainer - UpdateLineItemOnPackingContainerAction: - allOf: - - $ref: '#/components/schemas/AbstractModificationAction' - - additionalProperties: false - properties: - action: - description: >- - Use UpdateLineItemOnPackingContainer to change a line item on an - existing packing container - enum: - - UpdateLineItemOnPackingContainer - type: string - lineItem: - $ref: '#/components/schemas/PackingContainerLineItem' - required: - - action - - lineItem + customAttributes: + description: >- + Attributes that can be added to the order. These attributes cannot + be used within fulfillment processes, but it could be useful to have + the informations carried here. type: object + deliveryPreferences: + $ref: '#/components/schemas/DeliveryPreferences' + orderDate: + description: The date this order was created at the supplying system. + example: '2020-02-03T08:45:50.525Z' + format: date-time + type: string + orderLineItems: + items: + $ref: '#/components/schemas/OrderLineItemForCreation' + type: array + status: + $ref: '#/components/schemas/OrderStatus' + stickers: + type: array + minItems: 1 + maxItems: 100 + items: + $ref: '#/components/schemas/Sticker' + tenantOrderId: + description: >- + Field can be used as a reference number in foreign systems, for + example as a reference to the source system's identifier for this + order. + example: R456728546 + type: string + tags: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/TagReference' + customServices: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/CustomServiceReferenceForCreation' + paymentInfo: + $ref: '#/components/schemas/OrderPaymentInfo' + statusReasons: + type: array + items: + $ref: '#/components/schemas/OrderStatusReason' + promisesOptions: + $ref: '#/components/schemas/OrderPromisesOptions' + required: + - orderDate + - orderLineItems + - consumer + type: object xml: - name: UpdateLineItemOnPackingContainer - PackingContainerLineItem: - allOf: - - $ref: '#/components/schemas/PackingContainerLineItemForCreation' + name: Order + OrderPromisesOptions: + additionalProperties: false + required: + - validUntil properties: - id: + validUntil: description: >- - The id of this lineItem. It is generated during creation - automatically and suits as the primary identifier of the described - entity. - example: climk4dcQFiPdA5ULuhS + The date the promised order will become invalid and is cancelled + automatically, when not transformed into an actual order. + example: '2020-02-03T08:45:50.525Z' + format: date-time + type: string + type: object + xml: + name: OrderPromisesOptions + CheckoutOptionsConsumerAddress: + properties: + city: + example: Langenfeld + pattern: ^.+$ + type: string + country: + description: A two-digit country code as per ISO 3166-1 alpha-2 + example: DE + pattern: ^[A-Z]{2}$ + type: string + province: + example: NRW + pattern: ^.+$ + type: string + houseNumber: + example: 42a + pattern: ^.+$ + type: string + postalCode: + example: '40764' + pattern: ^.+$ + type: string + street: + example: Hauptstr. + pattern: ^.+$ type: string + type: object required: - - id - PackingContainerLineItemForCreation: + - country + CheckoutOptionsInput: + additionalProperties: false properties: - article: - $ref: '#/components/schemas/PackingContainerLineItemArticle' - customAttributes: - description: >- - Attributes that can be added to the line item. These attributes - cannot be used within fulfillment processes, but it could be useful - to have the informations carried here. - type: object - measurementUnitKey: - description: Identifier for items unit of measurement. - example: liter - type: string - quantity: - description: quantity of the specific article that has been ordered - example: 21 - format: int64 - minimum: 1 - type: integer - scannableCodes: + consumerAddress: + $ref: '#/components/schemas/CheckoutOptionsConsumerAddress' + deliveryPreferences: + $ref: '#/components/schemas/DeliveryPreferences' + orderLineItems: items: - description: Codes, that identify the article - type: string + $ref: '#/components/schemas/OrderLineItemForCreation' type: array - PackingContainerLineItemArticle: - allOf: - - $ref: '#/components/schemas/AbstractArticle' - - properties: - attributes: - items: - $ref: '#/components/schemas/PackingContainerAttributeItem' - type: array - type: object + tags: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/TagReference' + customServices: + type: array + minItems: 1 + items: + $ref: '#/components/schemas/CustomServiceReference' + geoFence: + $ref: '#/components/schemas/GeoFence' + filterDuplicates: + type: boolean + default: true + required: + - orderLineItems + - deliveryPreferences + type: object xml: - name: PackingContainerLineItemArticle - PackingContainerAttributeItem: - allOf: - - $ref: '#/components/schemas/ArticleAttributeItem' - PackingContainerType: - allOf: - - $ref: '#/components/schemas/VersionedResource' + name: CheckoutOptionsInput + CheckoutOptionsAvailability: additionalProperties: false properties: - description: + tenantArticleId: type: string - descriptionLocalized: - $ref: '#/components/schemas/LocaleString' - iconUrl: - description: '' + available: + type: number + preOrderReleaseDate: + format: date-time type: string - id: - description: '' + isBackOrderable: + type: boolean + required: + - tenantArticleId + - available + - isBackOrderable + type: object + xml: + name: CheckoutOptionsAvailability + PromiseCarrier: + additionalProperties: false + properties: + carrierKey: type: string - name: + carrierName: type: string - nameLocalized: - $ref: '#/components/schemas/LocaleString' - priority: - description: >- - This value gives the priority of the respective - packingContainerType. The lower the value the higher is the - priority, e.g. priority 1 is higher than priority 10. The priority - can be used to order packingContainerTypes in the UI. - example: 100 - format: int32 - maximum: 10000 - minimum: 1 - type: integer - dimensions: - $ref: '#/components/schemas/ContainerDimensions' - weightLimitInG: - description: 'Maximal weight in gramm(gr) the container can be loaded with. ' - example: 2500 - type: number - minimum: 1 + products: + items: + $ref: '#/components/schemas/PromiseDeliveryOptions' + type: array + deliveryPromiseValidUntil: + type: string + format: date-time required: - - id - - version - - nameLocalized + - carrierKey + - carrierName + - products + type: object + xml: + name: PromiseCarrier + EstimatedDeliveryTime: type: object - PackingContainerTypeForCreation: - additionalProperties: false properties: - descriptionLocalized: - $ref: '#/components/schemas/LocaleString' - icon: - $ref: '#/components/schemas/NamedFile' - nameLocalized: - $ref: '#/components/schemas/LocaleString' - priority: - description: >- - This value gives the priority in the respective - packingContainerType. The lower the value the higher is the - priority, e.g. priority 1 is higher than priority 10. The priority - can be used to order packingContainerTypes. - example: 100 - format: int32 - maximum: 10000 - minimum: 1 + minDeliveryDays: + description: Minimum total delivery time in days + example: 1 type: integer - dimensions: - $ref: '#/components/schemas/ContainerDimensions' - weightLimitInG: - description: 'Maximal weight in gramm(gr) the container can be loaded with. ' - example: 2500 - type: number - minimum: 1 + minimum: 0 + maxDeliveryDays: + description: Maximum total delivery time in days + example: 3 + type: integer + minimum: 0 required: - - nameLocalized - type: object - PackingContainerTypePatchActions: + - maxDeliveryDays + - minDeliveryDays + PromiseDeliveryOptions: + additionalProperties: false properties: - actions: + carrierProductCategory: + $ref: '#/components/schemas/CarrierProductCategory' + transitTime: + $ref: '#/components/schemas/CarrierTransitTime' + estimatedDeliveryTime: + $ref: '#/components/schemas/EstimatedDeliveryTime' + deliveryCosts: items: - anyOf: - - $ref: '#/components/schemas/ModifyPackingContainerTypeAction' - - $ref: '#/components/schemas/ModifyPackingContainerTypeIconAction' - minItems: 1 + $ref: '#/components/schemas/DeliveryCost' type: array - version: - description: >- - The version of the document to be used in optimistic locking - mechanisms. - example: 42 - format: int64 - type: integer required: - - version - - actions + - carrierProductCategory + - deliveryCosts type: object xml: - name: PackingContainerTypePatchActions - ModifyPackingContainerTypeAction: - allOf: - - $ref: '#/components/schemas/AbstractModificationAction' - - additionalProperties: false - properties: - action: - description: >- - Use value 'ModifyPackingContainerType', because you want to - modify a PackingContainerType - enum: - - ModifyPackingContainerType - type: string - descriptionLocalized: - $ref: '#/components/schemas/LocaleString' - nameLocalized: - $ref: '#/components/schemas/LocaleString' - priority: - description: >- - This value gives the priority in the respective - packingContainerType. The lower the value the higher is the - priority, e.g. priority 1 is higher than priority 10. The - priority can be used to order PackingContainerTypes. - example: 100 - format: int32 - maximum: 10000 - minimum: 1 - type: integer - dimensions: - $ref: '#/components/schemas/ContainerDimensions' - weightLimitInG: - description: 'Maximal weight in gramm(gr) the container can be loaded with. ' - example: 2500 - type: number - minimum: 1 - required: - - action - type: object - xml: - name: ModifyPackingContainerType - ModifyPackingContainerTypeIconAction: - allOf: - - $ref: '#/components/schemas/AbstractModificationAction' - - additionalProperties: false - properties: - action: - description: >- - Use value 'ModifyPackingContainerTypeIcon', because you want to - modify a PackingContainerTypes icon - enum: - - ModifyPackingContainerTypeIcon - type: string - content: - type: string - description: Content of the icon as base64 string - name: - type: string - description: icons filename - required: - - action - - name - - content - type: object - xml: - name: ModifyPackingContainerTypeIcon - PickRunType: - description: >- - Deprecated: batchPick, use batch instead Deprecated: multiOrderPick, use - multiOrder instead - enum: - - multiOrderPick - - multiOrder - - batchPick - - batch - type: string - default: batchPick - ToolkitOperatorType: - description: |- - Type of operator used for a toolkit fence or rating: - * `TAG_EQUALS`- the entity2 should have a tag with the same id as the entity1 and the value is dynamically matched - * `VALUE_EQUALS`- compares the tag of entity1 with the tag of entity2 attending to the configured rule and returns true if it does match - * `VALUE_NOT_EQUALS`- compares the tag of entity1 with the tag of entity2 attending to the configured rule and returns true if it does not match - enum: - - TAG_EQUALS - - VALUE_EQUALS - - VALUE_NOT_EQUALS - type: string + name: PromiseDeliveryOptions + CheckoutOptionsCustomServices: + additionalProperties: false + properties: + customServiceRef: + type: string + name: + type: string + required: + - customServiceRef + - name + type: object xml: - name: ToolkitOperatorType - ToolkitAllowedEntities: - description: |- - The entities that can be compared by the toolkit fence or rating - * `ORDER` - * `FACILITY` - * `CARRIERCONNECTION` - enum: - - ORDER - - FACILITY - - CARRIERCONNECTION - type: string + name: CheckoutOptionsCustomServices + CheckoutOptionsFacilityForSFS: + additionalProperties: false + properties: + facilityRef: + type: string + name: + type: string + availabilities: + items: + $ref: '#/components/schemas/CheckoutOptionsAvailability' + type: array + deliveryOptions: + items: + $ref: '#/components/schemas/PromiseCarrier' + type: array + customServices: + items: + $ref: '#/components/schemas/CheckoutOptionsCustomServices' + type: array + required: + - facilityRef + - name + - availabilities + - deliveryOptions + - customServices + type: object xml: - name: ToolkitAllowedEntities - ToolkitFenceForCreation: + name: CheckoutOptionsFacilityForSFS + CheckoutOptionsFacilityForCNC: + additionalProperties: false properties: + facilityRef: + type: string name: - description: The name of the fence. - example: CustomFence type: string - nameLocalized: - $ref: '#/components/schemas/LocaleString' - description: - description: The description of this fence. - example: Some text that describes what the fence does. + address: + $ref: '#/components/schemas/FacilityAddress' + closingDays: + items: + $ref: '#/components/schemas/ClosingDay' + type: array + pickingTimes: + $ref: '#/components/schemas/PickingTimes' + availabilities: + items: + $ref: '#/components/schemas/CheckoutOptionsAvailability' + type: array + customServices: + items: + $ref: '#/components/schemas/CheckoutOptionsCustomServices' + type: array + targetTime: + format: date-time type: string - descriptionLocalized: - $ref: '#/components/schemas/LocaleString' - active: - default: false - description: Indicates whether this fence is active or not. - type: boolean - order: - description: Order in which this fence is executed - example: 1 - type: integer - entity1: - $ref: '#/components/schemas/ToolkitAllowedEntities' - entity2: - $ref: '#/components/schemas/ToolkitAllowedEntities' - rule: - $ref: '#/components/schemas/ToolkitRule' - comparisonRule: - $ref: '#/components/schemas/ToolkitComparisonRule' required: + - facilityRef - name - - nameLocalized - - active - - order - - entity1 - - entity2 + - address + - closingDays + - pickingTimes + - availabilities + - customServices + - targetTime type: object xml: - name: ToolkitFenceForCreation - ToolkitFenceForModification: - allOf: - - $ref: '#/components/schemas/ToolkitFenceForCreation' + name: CheckoutOptionsFacilityForCNC + ResponseForSFSCheckoutOptions: + additionalProperties: false properties: - version: - description: >- - The version of the document to be used in optimistic locking - mechanisms. - example: 42 - format: int64 - type: integer + facilities: + items: + $ref: '#/components/schemas/CheckoutOptionsFacilityForSFS' + type: array required: - - version + - facilities type: object xml: - name: ToolkitFenceForModification - ToolkitFence: - allOf: - - $ref: '#/components/schemas/ToolkitFenceForModification' - - $ref: '#/components/schemas/VersionedResource' + name: ResponseForSFSCheckoutOptions + ResponseForCNCCheckoutOptions: + additionalProperties: false properties: - id: - description: The id of the toolkit fence - example: LGMl2DuvPnfPoSHhYFOm - type: string + facilities: + items: + $ref: '#/components/schemas/CheckoutOptionsFacilityForCNC' + type: array required: - - id + - facilities type: object xml: - name: ToolkitFence - ToolkitFencesTransporter: + name: ResponseForCNCCheckoutOptions + DeliveryPromiseLineItem: + type: object properties: - fences: + tenantArticleId: + type: string + title: + type: string + quantity: + type: number + available: + type: number + outOfStockBehaviour: + enum: + - BACKORDER + type: string + availabilityTimeframe: + $ref: '#/components/schemas/AvailabilityTimeframe' + DeliveryPromiseShipment: + additionalProperties: false + allOf: + - $ref: '#/components/schemas/BasicDeliveryPromiseShipment' + properties: + carriers: items: - $ref: '#/components/schemas/ToolkitFence' + $ref: '#/components/schemas/PromiseCarrier' type: array - total: - description: Total number of found entities for this query - example: 42 - type: integer required: - - fences - - total + - carriers type: object xml: - name: ToolkitFenceTransporter - ToolkitRatingForCreation: + name: DeliveryPromiseShipment + BasicDeliveryPromiseShipmentFacility: + additionalProperties: false properties: - name: - description: The name of the rating - example: CustomRating + facilityRef: type: string - nameLocalized: - $ref: '#/components/schemas/LocaleString' - description: - description: The description of this rating - example: Some text that describes what the rating does. + facilityName: type: string - descriptionLocalized: - $ref: '#/components/schemas/LocaleString' - active: - default: false - description: Indicates whether this fence is active or not - type: boolean - entity1: - $ref: '#/components/schemas/ToolkitAllowedEntities' - entity2: - $ref: '#/components/schemas/ToolkitAllowedEntities' - rule: - $ref: '#/components/schemas/ToolkitRule' - comparisonRule: - $ref: '#/components/schemas/ToolkitComparisonRule' - maxPenalty: - type: integer - example: 100 - description: The maximum penalty this rating can have required: - - name - - nameLocalized - - active - - entity1 - - entity2 - - maxPenalty + - facilityName + - facilityRef + BasicDeliveryPromiseShipment: + additionalProperties: false + properties: + lineItems: + items: + $ref: '#/components/schemas/DeliveryPromiseLineItem' + type: array + facility: + $ref: '#/components/schemas/BasicDeliveryPromiseShipmentFacility' + required: + - lineItems + - facility type: object xml: - name: ToolkitRatingForCreation - ToolkitRatingForModification: + name: DeliveryPromiseShipment + DeliveryPromiseCollect: + additionalProperties: false allOf: - - $ref: '#/components/schemas/ToolkitRatingForCreation' + - $ref: '#/components/schemas/BasicDeliveryPromiseShipment' properties: - version: - description: >- - The version of the document to be used in optimistic locking - mechanisms. - example: 42 - format: int64 - type: integer + targetTime: + format: date-time + type: string required: - - version + - targetTime type: object xml: - name: ToolkitRatingForModification - ToolkitRating: - allOf: - - $ref: '#/components/schemas/ToolkitRatingForModification' - - $ref: '#/components/schemas/VersionedResource' + name: DeliveryPromiseCollect + ResponseForDeliveryPromise: + additionalProperties: false properties: - id: - description: The id of the toolkit rating - example: LGMl2DuvPnfPoSHhYFOm + orderRef: type: string + orderVersion: + type: number + promisesOptions: + $ref: '#/components/schemas/OrderPromisesOptions' + collect: + $ref: '#/components/schemas/DeliveryPromiseCollect' + shipToCustomer: + type: array + items: + $ref: '#/components/schemas/DeliveryPromiseShipment' + shipToStore: + type: array + items: + $ref: '#/components/schemas/DeliveryPromiseShipment' + backOrdered: + $ref: '#/components/schemas/Backordered' required: - - id + - orderRef + - orderVersion type: object xml: - name: ToolkitRating - ToolkitRatingTransporter: + name: ResponseForDeliveryPromise + Backordered: + type: object properties: - ratings: + lineItems: items: - $ref: '#/components/schemas/ToolkitRating' + $ref: '#/components/schemas/DeliveryPromiseLineItem' type: array - total: - description: Total number of entities found for this query - example: 42 - type: integer required: - - ratings - - total - type: object - xml: - name: ToolkitRatingTransporter - ToolkitEntityOperatorType: - description: The possible operator types that can be used on given entities - enum: - - VALUE_EQUALS - - VALUE_NOT_EQUALS - - ANY_VALUE_EQUALS - - ANY_VALUE_GREATER_EQUALS - - ANY_VALUE_GREATER_THAN - - ANY_VALUE_LESS_EQUALS - - ANY_VALUE_LESS_THAN - - ANY_VALUE_CONTAINS - - ANY_VALUE_NOT_CONTAINS - - EVERY_VALUE_EQUALS - - EVERY_VALUE_GREATER_EQUALS - - EVERY_VALUE_GREATER_THAN - - EVERY_VALUE_LESS_EQUALS - - EVERY_VALUE_LESS_THAN - - EVERY_VALUE_CONTAINS - - EVERY_VALUE_NOT_CONTAINS - - NO_VALUE_EQUALS - - NO_VALUE_GREATER_EQUALS - - NO_VALUE_GREATER_THAN - - NO_VALUE_LESS_EQUALS - - NO_VALUE_LESS_THAN - - NO_VALUE_CONTAINS - - NO_VALUE_NOT_CONTAINS - - VALUE_CONTAINS - - VALUE_NOT_CONTAINS - - GREATER_THAN - - GREATER_EQUALS - - LESS_THAN - - LESS_EQUALS - type: string - xml: - name: ToolkitEntityOperatorType - ToolkitTransformationType: - description: >- - The transformations available to apply on the entity property value - before a predicate is evaluated - enum: - - SUBSTRING - - COUNT - - SUM - - LAST - type: string - xml: - name: ToolkitTransformationType - ToolkitRuleOperatorType: - description: >- - The type of the rule operator applied to the results of evaluating the - left predicates and the right predicates - enum: - - EQUALS - type: string - xml: - name: ToolkitTransformationType - ToolkitRuleComparisonOperatorType: - description: >- - The type of the rule operator applied to the results of evaluating the - left predicates and the right predicates - enum: - - ALL_MATCHES - - LEFT_CONTAINS_RIGHT - - RIGHT_CONTAINS_LEFT - type: string - xml: - name: ToolkitTransformationType - ToolkitPredicate: - description: >- - The predicate for a Toolkit V2 Fence that defines how conditions are - constructed + - lineItems + OrderStatusReason: properties: - propertyPath: + reason: + description: The reason for setting this order status type: string - minLength: 1 - entityOperator: - $ref: '#/components/schemas/ToolkitEntityOperatorType' - transformation: - $ref: '#/components/schemas/ToolkitTransformationType' - transformationArgs: - type: array - items: - oneOf: - - type: string - - type: number - - type: boolean - expectedValue: - oneOf: - - type: string - - type: number - - type: boolean + status: + $ref: '#/components/schemas/OrderStatus' required: - - propertyPath - - entityOperator - type: object + - reason + - status + OrderLineItem: + allOf: + - $ref: '#/components/schemas/OrderLineItemForCreation' + - properties: + id: + description: >- + The id of this orderline. It is generated during creation + automatically by the API and suits as the primary identifier of + the described line. + example: LGMl2DuvPnfPoSHhYFOm + type: string + required: + - id + type: object + OrderLineItemArticle: + allOf: + - $ref: '#/components/schemas/AbstractArticle' + - properties: + attributes: + items: + $ref: '#/components/schemas/OrderArticleAttributeItem' + type: array + type: object xml: - name: ToolkitPredicate - ToolkitComparisonPredicate: - description: >- - The predicate for a Toolkit V2 Fence that defines how conditions are - constructed + name: OrderLineItemArticle + OrderLineItemForCreation: + additionalProperties: false properties: - rightPropertyPath: + article: + $ref: '#/components/schemas/OrderLineItemArticle' + customAttributes: + description: >- + Attributes that can be added to the orderline. These attributes + cannot be used within fulfillment processes, but it could be useful + to have the informations carried here. + type: object + measurementUnitKey: + description: Identifier for items unit of measurement. + example: liter type: string - minLength: 1 - leftPropertyPath: + quantity: + description: quantity of the specific article that has been ordered + example: 21 + format: int64 + minimum: 1 + type: integer + secondaryMeasurementUnitKey: + description: Secondary identifier for items unit of measurement. + example: liter type: string - minLength: 1 - entityOperator: - $ref: '#/components/schemas/ToolkitRuleComparisonOperatorType' - rightTransformation: - $ref: '#/components/schemas/ToolkitTransformationType' - rightTransformationArgs: + secondaryQuantity: + description: Secondary quantity of the specific article that has been ordered + example: 21 + format: int64 + minimum: 0 + type: integer + scannableCodes: + items: + description: Codes, that identify the article + type: string type: array + measurementValidation: + $ref: '#/components/schemas/MeasurementValidation' + shopPrice: + description: price per piece of this line item + example: 1200 + type: number + tags: items: - oneOf: - - type: string - - type: number - - type: boolean - leftTransformation: - $ref: '#/components/schemas/ToolkitTransformationType' - leftTransformationArgs: + $ref: '#/components/schemas/TagReference' type: array + allowedSubstitutes: items: - oneOf: - - type: string - - type: number - - type: boolean + $ref: '#/components/schemas/Substitute' + type: array + description: >- + Array of allowed substitutes for given orderLineItem. If an empty + array is provided, no substitute is allowed for this orderLineItem. + If allowedSubstitutes is not provided, this configured substitutes + on listing level will be available required: - - rightPropertyPath - - leftPropertyPath - - entityOperator + - article + - quantity type: object - xml: - name: ToolkitComparisonPredicate - ToolkitRule: + OrderRoutingConfiguration: + allOf: + - $ref: '#/components/schemas/VersionedResource' + properties: + infiniteStockEnabled: + description: Config to enable/disable infinite stock + type: boolean + id: + type: string + type: object + FixedCountConfiguration: description: >- - The rule, containing the left predicates and the right predicates, that - will be evaluated applying a RuleOperator +

This part of the API is currently under development. + That means that this endpoint, model, etc. can contain breaking changes + and / or might not be available at all times in your API instance. 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

Configuration of fixed count split. properties: - operator: - $ref: '#/components/schemas/ToolkitRuleOperatorType' - leftPart: - $ref: '#/components/schemas/ToolkitRulePart' - rightPart: - $ref: '#/components/schemas/ToolkitRulePart' + maxSplitCount: + description: >- + This setting defines how often an order split might be performed to + fulfill the order. + minimum: 1 + type: number required: - - operator - - leftPart - - rightPart + - maxSplitCount type: object - xml: - name: ToolkitRule - ToolkitComparisonRule: + OrderSplit: description: >- - The rule, comparing the left and right path values, that will be - evaluated applying a RuleOperator +

This part of the API is currently under development. + That means that this endpoint, model, etc. can contain breaking changes + and / or might not be available at all times in your API instance. 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

+ additionalProperties: false properties: - predicateConnector: - description: The default value for the predicateConnector property is AND. - $ref: '#/components/schemas/ToolkitPredicateConnector' - predicates: - type: array - items: - $ref: '#/components/schemas/ToolkitComparisonPredicate' - minItems: 1 + active: + default: false + type: boolean + activeForSameDay: + default: false + type: boolean + shouldUseWaitingRoomForPreBackOrderItems: + default: false + type: boolean + fixedCountConfiguration: + $ref: '#/components/schemas/FixedCountConfiguration' + orderSplitType: + $ref: '#/components/schemas/OrderSplitType' required: - - predicates + - active + - orderSplitType type: object + OrderSplitType: + description: The type of order split + enum: + - FIXED_COUNT + type: string xml: - name: ToolkitRule - ToolkitRulePart: - description: >- - One half of the rule, containing either the left or right predicates and - booleanOperator. + name: OrderSplitType + RoutingPlanLineItem: + allOf: + - $ref: '#/components/schemas/OrderLineItem' properties: - predicateConnector: - description: The default value for the predicateConnector property is AND. - $ref: '#/components/schemas/ToolkitPredicateConnector' - predicates: + picked: + type: number + available: + type: number + pieces: type: array items: - $ref: '#/components/schemas/ToolkitPredicate' + $ref: '#/components/schemas/RoutingPlanLineItemPiece' + outOfStockBehaviour: + enum: + - BACKORDER + type: string + availabilityTimeframe: + $ref: '#/components/schemas/AvailabilityTimeframe' + RoutingPlanLineItemPiece: + properties: + partialStockRef: + type: string + quantity: + type: number + available: + type: number + mandatoryScore: + type: number + sequenceScore: + type: number + location: + $ref: '#/components/schemas/Location' + picked: + type: number + type: object + RoutingPlanPatchActions: + properties: + actions: + items: + $ref: '#/components/schemas/ModifyRoutingPlanAction' minItems: 1 + type: array + version: + description: >- + The version of the document to be used in optimistic locking + mechanisms. + example: 42 + format: int64 + type: integer required: - - predicates + - version + - actions type: object xml: - name: ToolkitRulePart - ToolkitPredicateConnector: - description: The allowed operators for connecting multiple predicates + name: RoutingPlanPatchActions + RoutingPlanStatus: + description: >- + A routing plan line initially has the status INITIAL. Final state is + ROUTED enum: - - OR - - AND + - INITIAL + - PRIORITIZED + - ROUTING + - PROPOSED + - PLANNED + - ROUTED + - NOT_ROUTABLE + - MANUAL_PLANNED + - FAILED + - REDUNDANT_REROUTE + - FAILED_REROUTE + - RETRYABLE + - FALLBACK_ROUTING + - WAITING + - OBSOLETE + - CANCELED + - LOCKED + - PROMISED + - REROUTED type: string xml: - name: ToolkitPredicateConnector - ParcelResult: - description: >- - Within this object you can find the result of the request after it has - been processed (status = DONE or FAILED) - properties: - carrierTrackingNumber: - example: '84168117830018' - type: string - labelUrl: - description: >- - The URL where you can download the label relative to the path of - this resource - example: '%%HOST%%/api/parcels/{parcelId}/labels/84168117830018.pdf' - type: string - proxyId: - description: The ID of the corresponding job at the CEP proxy (if used) - example: 3a186c51d4281acbecf5ed38805b1db92a9d668b - type: string - returnLabelId: - description: The original return label id - example: 3a186c51d4281acbecf5ed38805b1db92a9d668b - type: string - returnLabelUrl: - description: The original return label URL - example: someCepProvider.com/pathToReturnLabel.pdf - type: string - customsDocumentId: - description: The customs document id - example: 3a186c51d4281acbecf5ed38805b1db92a9d668b - type: string - customsDocumentUrl: - description: The original customs document URL - example: someCepProvider.com/pathToReturnLabel.pdf - type: string - sendLabelUrl: - description: The original send label URL - example: someCepProvider.com/pathToSendLabel.pdf - type: string - summary: - description: Summary of the result of the request in a human readable form. - example: Package label was successfully requested at DHL. - type: string - trackingStatus: - $ref: '#/components/schemas/TrackingStatus' - trackingUrl: - description: The URL to track this parcel - example: http://track.io/3a186c51d4 - type: string - required: - - summary - type: object - RestowedItems: + name: RoutingPlanStatus + ConsolidatedRoutingPlanStatus: + description: |- + This status consolidates many of the RoutingPlanStatus and offers + a more detailes explanation of what happened to the routing plan. + enum: + - ROUTED + - ROUTED_THEN_REROUTED + - PROCESS_MANUAL_REROUTED_THEN_ROUTED + - PROCESS_MANUAL_REROUTED_THEN_NOT_ROUTABLE + - PROCESS_MANUAL_REROUTED_THEN_REROUTED_AND_SPLIT + - ROUTING_PLAN_REROUTED_THEN_ROUTED_TO_SAME_FACILITY + - ROUTING_PLAN_SHORTPICKED_THEN_ROUTED_TO_SAME_FACILITY + - ROUTING_PLAN_CREATED_THEN_ROUTING + - ROUTING_PLAN_CREATED_THEN_PLANNED + - ROUTING_PLAN_REROUTED_THEN_FAILED + - FACILITY_MANUALLY_ASSIGNED_TO_PICKJOB_THEN_ROUTED + - FACILITY_MANUALLY_ASSIGNED_TO_PROCESS_THEN_ROUTED + - STOCK_UPDATE_RECEIVED_THEN_REACTIVATED + - ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED + - ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_AND_SPLIT + - ROUTING_PLAN_SHORTPICKED_THEN_REROUTED + - ROUTING_PLAN_SHORTPICKED_THEN_SPLIT + - ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_AND_SPLIT + - ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED + - ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED_AND_SPLIT + - ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED_TO_SAME_FACILITY + - PICKJOB_REJECTED_THEN_REROUTED + - PICKJOB_REJECTED_THEN_NOT_ROUTABLE + - PICKJOB_REJECTED_THEN_ROUTED_AND_SPLIT + - ROUTED_AND_SPLIT + - OBSOLETE + - OBSOLETE_WAS_ROUTED + - OBSOLETE_WAS_SHORTPICKED + - UNKNOWN + - RETRYABLE + - FAILED_REROUTE + - ROUTED_THEN_CANCELED + - ROUTED_AND_SPLIT_THEN_CANCELED + - ROUTING_PLAN_SHORTPICKED_THEN_SPLIT_THEN_CANCELED + - ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_THEN_CANCELED + - ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED + - ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_THEN_CANCELED + - >- + ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED + - FACILITY_MANUALLY_ASSIGNED_TO_PICKJOB_THEN_ROUTED_THEN_CANCELED + - FACILITY_MANUALLY_ASSIGNED_TO_PROCESS_THEN_ROUTED_THEN_CANCELED + - PROCESS_MANUAL_REROUTED_THEN_ROUTED_THEN_CANCELED + - PROCESS_MANUAL_REROUTED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED + - CANCELED + - NOT_ROUTABLE + - WAITING + - WAITING_AND_SPLIT + - WAITING_THEN_ROUTED + - WAITING_THEN_ROUTED_AND_SPLIT + - WAITING_THEN_NOT_ROUTABLE + - WAITING_THEN_WAITING_AND_SPLIT + - LOCKED + - INITIAL + type: string + xml: + name: RealRoutingPlanStatus + RoutingPlans: properties: - restowedItems: + routingPlans: items: - $ref: '#/components/schemas/RestowItem' + $ref: '#/components/schemas/RoutingPlan' type: array total: description: Total number of found entities for this query example: 42 type: integer type: object - ModifyRestowItemAction: + RoutingRule: additionalProperties: false properties: - action: - description: >- - Use value 'ModifyRestowItem', because you want to modify a restow - item - enum: - - ModifyRestowItem - type: string - restowed: - type: boolean - example: true - default: false - description: Indicates if the restowItem has been restowed - location: - $ref: '#/components/schemas/Location' + fences: + items: + $ref: '#/components/schemas/Fence' + type: array + orderSplit: + $ref: '#/components/schemas/OrderSplit' + ratings: + items: + $ref: '#/components/schemas/Rating' + type: array required: - - action - - restowed + - ratings + - fences type: object - RestowItem: - allOf: - - $ref: '#/components/schemas/VersionedResource' + AbstractRatingConfiguration: + description: Base Configuration for Ratings. See documentation for Details. + type: object + xml: + name: AbstractRatingConfiguration + Rating: + additionalProperties: false + description: >- + A rating is used to rate a set of possible facilities against each other + during routing of orders. properties: - id: - example: LGMl2DuvPnfPoSHhYFOm - type: string - quantity: - example: 1 - format: int64 - minimum: 1 - type: integer - default: 1 - measurementUnitKey: - description: Identifier for items unit of measurement. - example: liter - type: string - article: - $ref: '#/components/schemas/RestowItemArticle' - restowed: + active: type: boolean - example: true - default: false - description: Indicates if the restowItem has been restowed - scannableCodes: - items: - description: Codes, that identify the article - type: string - type: array - facilityRef: + configuration: + $ref: '#/components/schemas/AbstractRatingConfiguration' + description: + type: string + id: description: >- - The id of the facility reference. The given ID has to be present in - the system. - example: Esb20gpHBL94X5NdMp3C + This value identifies this very instance of the rating. It is set + automatically by the server when the configuration is updated. + example: 579ff115-8941-4221-8530-04f8b4adf59f + type: string + implementation: + $ref: '#/components/schemas/RatingImplementation' + maxPenalty: + example: 100 + type: number + minimum: 0 + name: type: string - location: - $ref: '#/components/schemas/Location' required: + - name + - active + - implementation + - maxPenalty - id - - article - - restowed - - facilityRef - - quantity type: object - RestowItemForCreation: + RatingImplementation: + 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

+ enum: + - STOCK-BALANCING + - GEO-DISTANCE + - TURNOVER + - STOCK-AVAILABILITY + - WORKLOAD-BALANCING + - MATCHING-BUSINESSTYPE + - PREFER-STORE + - PREFER-WAREHOUSE + - ZONE + - EXPIRY-DATE + - CAPACITY + - DELIVERY-COSTS + - DELIVERY-TIME + type: string + xml: + name: RatingImplementation + RerouteReason: + enum: + - PROCESSREROUTE + - MANUAL + - SHORTPICK + - TIMETRIGGERED + - STOCKZEROED + - ABORTED + - RECALCULATION + type: string + RerouteRoutingPlan: properties: - measurementUnitKey: - description: Identifier for items unit of measurement. - example: liter - type: string - quantity: - example: 1 - format: int64 - minimum: 1 - type: integer - default: 1 - article: - $ref: '#/components/schemas/RestowItemArticle' - restowed: + allReroutable: + description: >- + if set to true every reroutable routing plan is rerouted. overrules + every other identifier type: boolean - example: true - default: false - description: Indicates if the restowItem has been restowed - scannableCodes: + orderRefs: items: - description: Codes, that identify the article type: string + maxItems: 10 + type: array + routingPlanIds: + items: + type: string + maxItems: 10 + type: array + tenantOrderIds: + items: + type: string + maxItems: 10 type: array - facilityRef: - description: >- - The id of the facility reference. The given ID has to be present in - the system. - example: Esb20gpHBL94X5NdMp3C - type: string - location: - $ref: '#/components/schemas/Location' - required: - - facilityRef - - article - - quantity type: object - RestowItemArticle: + StrippedOrder: allOf: - - $ref: '#/components/schemas/AbstractArticle' + - $ref: '#/components/schemas/VersionedResource' - properties: - attributes: + id: + description: >- + The id of this order. It is generated during creation + automatically and suits as the primary identifier of the + described entity. + example: LGMl2DuvPnfPoSHhYFOm + type: string + orderDate: + description: The date this order was created at the supplying system. + example: '2020-02-03T08:45:50.525Z' + format: date-time + type: string + orderLineItems: items: - $ref: '#/components/schemas/RestowAttributeItem' + properties: + quantity: + description: quantity of the specific article that has been ordered + example: 21 + format: int64 + minimum: 1 + type: integer + title: + example: Cologne Water + type: string + required: + - quantity + - title + type: object + type: array + status: + $ref: '#/components/schemas/OrderStatus' + stickers: + items: + $ref: '#/components/schemas/Sticker' type: array + required: + - id + - status + - orderDate type: object - xml: - name: RestowItemArticle - RestowAttributeItem: - allOf: - - $ref: '#/components/schemas/ArticleAttributeItem' - RestowItemPatchActions: + StrippedOrders: properties: - actions: + orders: items: - anyOf: - - $ref: '#/components/schemas/ModifyRestowItemAction' - minItems: 1 + $ref: '#/components/schemas/StrippedOrder' type: array - version: - description: >- - The version of the document to be used in optimistic locking - mechanisms. + total: + description: Total number of found entities for this query example: 42 - format: int64 type: integer - required: - - version - - actions - type: object - xml: - name: RestowItemPatchActions - PickingConfigurations: - allOf: - - $ref: '#/components/schemas/VersionedResource' - properties: - pickingShortPickConfiguration: - $ref: '#/components/schemas/PickingShortPickConfiguration' - scanningConfiguration: - $ref: '#/components/schemas/PickingScanningConfiguration' - scanCodeValidationConfiguration: - $ref: '#/components/schemas/PickingScanCodeValidationConfiguration' - takeOverPickJobConfiguration: - $ref: '#/components/schemas/TakeOverPickJobConfiguration' - loadUnitAssignmentConfiguration: - $ref: '#/components/schemas/LoadUnitAssignmentConfiguration' - pickingMethodsConfiguration: - $ref: '#/components/schemas/PickingMethodsConfiguration' - restartPickJobConfiguration: - $ref: '#/components/schemas/RestartPickJobConfiguration' - stockUpdateConfiguration: - $ref: '#/components/schemas/PickingStockUpdateConfiguration' - backofficePickingConfiguration: - $ref: '#/components/schemas/BackofficePickingConfiguration' type: object - PickingStockUpdateConfiguration: + RoutingPlanHistory: properties: - active: - default: false - description: Enable or disable stock update check for pick jobs - type: boolean + status: + $ref: '#/components/schemas/RoutingPlanStatus' + created: + description: Information about the time, when a routing plan status is set + example: '2024-05-12T08:45:50.525Z' + format: date-time + type: string required: - - active - type: object - PickingScanCodeValidationConfiguration: + - status + - created + DecisionLog: + allOf: + - $ref: '#/components/schemas/VersionedResource' properties: - pickingScanCodeValidationType: - $ref: '#/components/schemas/PickingScanCodeValidationEnum' + id: + type: string + routingRun: + type: number + facilityDecisions: + items: + $ref: '#/components/schemas/FacilityDecision' + type: array + orderSplitDecision: + $ref: '#/components/schemas/OrderSplitDecision' + statistics: + $ref: '#/components/schemas/RoutingStatistics' + results: + $ref: '#/components/schemas/RoutingResults' + routingPlanRef: + type: string required: - - pickingScanCodeValidationType + - id + - routingPlanRef + - facilityDecisions + - routingRun + - statistics + - results + - created + - lastModified + - version type: object - PickingScanCodeValidationEnum: - description: State that defines if unknown scan codes can be accepted - enum: - - NO_VALIDATION - - CODE_MUST_BE_KNOWN - type: string - TakeOverPickJobConfiguration: + xml: + name: DecisionLog + DecisionLogFacilityInfo: properties: - active: - default: false - description: Enable or disable returns - type: boolean + name: + type: string + facilityRef: + type: string required: - - active - type: object - PickingMethodsConfiguration: + - name + - facilityRef + RoutingResults: properties: - defaultPickingMethod: - $ref: '#/components/schemas/PickingMethodEnum' + assignedItems: + type: array + items: + $ref: '#/components/schemas/AssignmentItem' + bestRatedFacility: + $ref: '#/components/schemas/DecisionLogFacilityInfo' + bestAvailableFacility: + $ref: '#/components/schemas/DecisionLogFacilityInfo' + bestReassignmentFacility: + $ref: '#/components/schemas/DecisionLogFacilityInfo' + routingPlanStatus: + $ref: '#/components/schemas/RoutingPlanStatus' required: - - defaultPickingMethod - type: object - RestartPickJobConfiguration: + - assignedItems + RoutingStatistics: properties: - active: - default: true - type: boolean + fenceStatistics: + type: array + items: + $ref: '#/components/schemas/FenceStatistic' + ratingStatistics: + type: array + items: + $ref: '#/components/schemas/RatingStatistic' + durationMs: + type: number required: - - active - type: object - BackofficePickingConfiguration: - description: Can this tenant use the backoffice for picking? + - fenceStatistics + - ratingStatistics + - lineItemFenceStatistics + FenceStatistic: properties: - active: - default: false - type: boolean + name: + type: string + rejectedAmount: + type: number + passedAmount: + type: number + passedPercentage: + type: number + durationMs: + description: Duration in Milliseconds + type: number required: - - active - type: object - PickingShortPickConfiguration: + - name + - rejectedAmount + - passedAmount + - passedPercentage + - durationMs + RatingStatistic: properties: - confirmationOnShortPick: - description: >- - Does the picker needs to confirm a stock correction before adding a - short pick - default: false - type: boolean + name: + type: string + maxScore: + type: number + minScore: + type: number + maxPenalty: + type: number + durationMs: + description: Duration in Milliseconds + type: number required: - - confirmationOnShortPick - type: object - PickingScanningConfiguration: - properties: - scanningType: - $ref: '#/components/schemas/PickingScanningConfigurationEnum' - scanningRule: - $ref: '#/components/schemas/ScanningRuleConfiguration' - rolesWithOverwritingScanningPermission: - type: array - items: - $ref: '#/components/schemas/UserRoleNames' - minItems: 1 - type: object - LoadUnitAssignmentConfiguration: - description: >- - Who do the load units need to be assigned in pickJob (SingleOrderPick) - and pickRun (MultiOrderPick) - properties: - pickJob: - $ref: '#/components/schemas/LoadUnitAssignmentType' - pickRun: - $ref: '#/components/schemas/LoadUnitAssignmentType' + - name + - maxPenalty + - durationMs + SplitResultType: + enum: + - SPLIT + - DO_NOT_SPLIT + - DO_NOT_SPLIT_USE_BEST_RATED + - DO_NOT_SPLIT_BECAUSE_AVAILABILITY_USE_BEST_RATED + - DO_NOT_SPLIT_USE_BEST_AVAILABLE + - REASSIGN_TO_PARENT + - REASSIGN_TO_PARENT_COMPLETELY + - FAIL + - INVALID_SPLIT + - PARK_IN_WAITING_ROOM + OrderSplitDecision: + properties: + split: + $ref: '#/components/schemas/SplitInformation' + reassignment: + $ref: '#/components/schemas/ReassignmentInformation' + splitType: + $ref: '#/components/schemas/SplitResultType' required: - - pickJob - - pickRun - type: object - LoadUnitAssignmentType: - example: AT_END - description: Where do the load unit needs to be assigned? - enum: - - INACTIVE - - AT_START - - AT_END - - DURING_PICKING - type: string - TagScanningConfiguration: - additionalProperties: false + - splitType + ReassignmentInformation: properties: - offeredScanningRuleByTag: + sourceFacility: + $ref: '#/components/schemas/DecisionLogFacilityInfo' + reassignedItems: type: array items: - $ref: '#/components/schemas/OfferedScanningRuleByTag' - OfferedScanningRuleByTag: - additionalProperties: false + $ref: '#/components/schemas/AssignmentItem' + required: + - sourceFacility + - reassignedItems + AssignmentItem: properties: - tagRef: + tenantArticleId: type: string - minLength: 1 - matchingValues: - type: array - minItems: 1 - items: - type: string - scanningType: - $ref: '#/components/schemas/PickingScanningConfigurationEnum' - required: - - tagRef - - matchingValues - - scanningType - type: object - PreferredPickingMethodsPerTag: - additionalProperties: false + articleTitle: + type: string + quantity: + type: number required: - - tagRef - - pickingMethods - - matchingValues + - tenantArticleId + - quantity + SplitInformation: properties: - tagRef: + targetFacility: + $ref: '#/components/schemas/DecisionLogFacilityInfo' + targetRoutingPlanRef: type: string - matchingValues: + splitCount: + type: number + splittedItems: type: array - minItems: 1 items: - type: string - pickingMethods: + $ref: '#/components/schemas/AssignmentItem' + required: + - splitCount + - targetRoutingPlanRef + - splittedItems + FacilityDecision: + properties: + facility: + $ref: '#/components/schemas/DecisionLogFacilityInfo' + orderFences: type: array - minItems: 1 items: - $ref: '#/components/schemas/PickingMethodEnum' - PreferredPickingMethodsConfiguration: - properties: - PreferredPickingMethodsPerTag: + $ref: '#/components/schemas/OrderFenceDecision' + orderLineItemFences: type: array items: - $ref: '#/components/schemas/PreferredPickingMethodsPerTag' - PickJobTagConfiguration: - allOf: - - $ref: '#/components/schemas/VersionedResource' - properties: - stickerConfiguration: - $ref: '#/components/schemas/StickerConfiguration' - lineItemStickerConfiguration: - $ref: '#/components/schemas/StickerConfiguration' - lineItemScanningConfiguration: - $ref: '#/components/schemas/TagScanningConfiguration' - preferredPickingMethodsConfiguration: - $ref: '#/components/schemas/PreferredPickingMethodsConfiguration' - offeredDocumentsPerTag: + $ref: '#/components/schemas/OrderLineItemFenceDecisions' + orderRatings: type: array - description: >- - All entries with a match in their matchingValues will be combined - when determining what documents belong to an entity items: - $ref: '#/components/schemas/OfferedDocumentPerTag' - offeredDocumentsByDefault: + $ref: '#/components/schemas/OrderRatingDecision' + availabilities: type: array - description: >- - This configuration is a fallback and applies only if none of the - entries in offeredDocumentsPerTag can be applied items: - $ref: '#/components/schemas/OfferedDocument' + $ref: '#/components/schemas/AvailabilityDuringRouting' + totalPenalty: + type: number + rank: + type: number + isBestRated: + type: boolean + isBestAvailable: + type: boolean + isBestReassignmentCandidate: + type: boolean required: - - offeredDocumentsPerTag - - offeredDocumentsByDefault - ItemReturnJob: - allOf: - - $ref: '#/components/schemas/VersionedResource' - additionalProperties: false + - facility + - orderFences + - orderLineItemFences + - orderRatings + - orderLineItemRatings + - availabilities + OrderRatingDecision: + type: object properties: - id: - type: string - processRef: - type: string - originFacilityRefs: - items: - type: string - type: array - status: - $ref: '#/components/schemas/ItemReturnJobStatus' - tenantOrderId: + name: type: string - consumerAddresses: - items: - $ref: '#/components/schemas/ConsumerAddress' + score: + type: number + normalizedScore: + type: number + maxPenalty: + type: number + details: type: array - scannableCodes: items: - type: string - type: array - shortId: - description: >- - A short identifier that helps assigning a item return job to a - customer. This is automatically created during creation. - example: AS12 + anyOf: + - $ref: '#/components/schemas/ToolkitDecisionDetail' + - $ref: '#/components/schemas/ToolkitComparisonDecisionDetail' + required: + - name + - normalizedScore + - maxPenalty + AvailabilityDuringRouting: + properties: + tenantArticleId: type: string - returnableLineItems: - items: - $ref: '#/components/schemas/ItemReturnJobLineItem' + articleTitle: + type: string + requestedQuantity: + type: number + stockInformation: + $ref: '#/components/schemas/AvailabilityDuringRoutingStock' + rerouteInformation: + $ref: '#/components/schemas/AvailabilityDuringRerouteStock' + stockInformationPostRerouteAdjustment: + $ref: '#/components/schemas/AvailabilityDuringRoutingStock' + bundleInformation: type: array - minItems: 1 - itemReturns: items: - $ref: '#/components/schemas/ItemReturn' - type: array - minItems: 0 - anonymized: - description: Indicates if gdpr related data was anonymized - example: false - type: boolean - type: object + $ref: '#/components/schemas/BundleInformation' required: - - id - - processRef - - originFacilityRefs - - status - - consumerAddresses - - returnableLineItems - - itemReturns - ItemReturnJobWithSearchPaths: - allOf: - - $ref: '#/components/schemas/ItemReturnJob' - additionalProperties: false + - tenantArticleId + - requestedQuantity + - stockInformation + BundleInformation: properties: - searchPaths: - items: - type: string - type: array + customServiceNodeId: + type: string + requestedQuantity: + type: number + required: + - customServiceNodeId + - requestedQuantity + AvailabilityDuringRerouteStock: + properties: + rerouteReason: + $ref: '#/components/schemas/RerouteReason' + pickedQuantity: + type: number + AvailabilityDuringRoutingStock: + properties: + stock: + type: number + stockConsideringOfflineStock: + type: number + reserved: + type: number + available: + type: number + required: + - available + - reserved + - stock + - stockConsideringOfflineStock + OrderFenceDecision: type: object - ItemReturnJobForCreation: - additionalProperties: false properties: - processRef: + name: type: string - originFacilityRefs: - items: - type: string + decision: + $ref: '#/components/schemas/FenceResultStatus' + details: type: array - status: - $ref: '#/components/schemas/ItemReturnJobStatus' - tenantOrderId: - type: string - consumerAddresses: items: - $ref: '#/components/schemas/ConsumerAddress' + anyOf: + - $ref: '#/components/schemas/OrderFenceDecisionDetail' + - $ref: '#/components/schemas/ToolkitDecisionDetail' + - $ref: '#/components/schemas/ToolkitComparisonDecisionDetail' + required: + - name + - decision + - details + ToolkitPredicateDecisionDetail: + properties: + originalValue: type: array - scannableCodes: items: type: string + transformedValue: type: array - shortId: - description: >- - A short identifier that helps assigning a item return job to a - customer. This is automatically created during creation. - example: AS12 - type: string - returnableLineItems: items: - $ref: '#/components/schemas/ItemReturnJobLineItemForCreation' - type: array - minItems: 1 - type: object + type: string + evaluationResult: + type: boolean + predicate: + $ref: '#/components/schemas/ToolkitPredicate' required: - - originFacilityRefs - - status - - consumerAddresses - - returnableLineItems - ItemReturnJobs: + - originalValue + - transformedValue + - evaluationResult + - predicate + ToolkitPredicatesDecisionDetail: properties: - itemReturnJobsWithSearchPaths: - items: - $ref: '#/components/schemas/ItemReturnJobWithSearchPaths' + connector: + $ref: '#/components/schemas/ToolkitPredicateConnector' + predicates: type: array - total: - description: Total number of found entities for this query - example: 42 - type: integer - type: object - ItemReturnJobStatus: - type: string - enum: - - OPEN - - IN_PROGRESS - - FINISHED - ItemReturnJobLineItem: - additionalProperties: false + items: + $ref: '#/components/schemas/ToolkitPredicateDecisionDetail' + required: + - connector + - predicates + ToolkitComparisonDecisionDetail: allOf: - - $ref: '#/components/schemas/ItemReturnJobLineItemForCreation' + - $ref: '#/components/schemas/BaseDecisionDetail' properties: - id: + predicates: + type: array + items: + $ref: '#/components/schemas/ToolKitComparisonDetails' + predicateConnector: + $ref: '#/components/schemas/ToolkitPredicateConnector' + description: type: string - returned: - type: number - minimum: 0 - returnable: - type: number - minimum: 0 + explanation: + $ref: >- + #/components/schemas/ToolkitRuleComparePropertiesOperatorResultExplanation required: - - id - - article - - delivered - - returned - - returnable - ItemReturnJobLineItemForCreation: - additionalProperties: false + - predicates + - result + - predicateConnector + - description + ToolKitComparisonDetails: properties: - article: - $ref: '#/components/schemas/ItemReturnJobLineItemArticle' - delivered: - type: number - minimum: 1 - scannableCodes: - items: - type: string - type: array + leftPart: + $ref: '#/components/schemas/ToolKitComparisonPart' + rightPart: + $ref: '#/components/schemas/ToolKitComparisonPart' + evaluationResult: + type: boolean + predicate: + $ref: '#/components/schemas/ToolkitComparisonPredicate' required: - - article - - delivered - ItemReturnJobLineItemArticle: - allOf: - - $ref: '#/components/schemas/AbstractArticle' - - properties: - attributes: - items: - $ref: '#/components/schemas/ArticleAttributeItem' - type: array - type: object - xml: - name: PickLineItemArticle - ItemReturn: - additionalProperties: false + - leftPart + - rightPart + - evaluationResult + - predicate + ToolKitComparisonPart: properties: - id: - type: string - created: - description: >- - The date this entity was created at the platform. This value is - generated by the service. - example: '2020-02-03T08:45:51.525Z' - format: date-time - type: string - lastModified: - description: >- - The date this entity was modified last. This value is generated by - the service. - example: '2020-02-03T09:45:51.525Z' - format: date-time - type: string - returnFacilityRef: - type: string - status: - $ref: '#/components/schemas/ItemReturnStatus' - tenantOrderId: - type: string - scannableCodes: + originalValue: + type: array items: type: string + transformedValue: type: array - returnedLineItems: - type: array - minItems: 1 items: - $ref: '#/components/schemas/ItemReturnLineItem' + type: string required: - - id - - status - - returnedLineItems - - returnFacilityRef - ItemReturnStatus: - enum: - - ANNOUNCED - - OPEN - - IN_PROGRESS - - PAUSED - - FINISHED - type: string - ItemReturnLineItem: - additionalProperties: false + - originalValue + - transformedValue + ToolkitDecisionDetail: allOf: - - $ref: '#/components/schemas/ItemReturnLineItemForCreation' + - $ref: '#/components/schemas/BaseDecisionDetail' properties: - id: - type: string - example: a69006ba-7100-4b4d-a610-1ca28016a4eb - itemCondition: + leftSideEvaluation: + type: boolean + leftPredicatesDetail: + $ref: '#/components/schemas/ToolkitPredicatesDecisionDetail' + rightSideEvaluation: + type: boolean + rightPredicatesDetail: + $ref: '#/components/schemas/ToolkitPredicatesDecisionDetail' + comparisonOperator: + $ref: '#/components/schemas/ToolkitRuleComparisonOperatorType' + description: type: string - example: Damaged - itemReturnJobLineItemRefs: - items: - example: a69006ba-7100-4b4d-a610-1ca28016a4eb - type: string - type: array - reasons: - items: - $ref: '#/components/schemas/ItemReturnLineItemReason' - minItems: 1 - type: array + explanation: + $ref: '#/components/schemas/ToolkitRuleOperatorResultExplanation' required: - - id - - status - - itemReturnJobLineItemRefs - - tenantArticleId - - reasons - ItemReturnLineItemReason: - additionalProperties: false - properties: - reason: - description: Translated reasonLocalized + - decisionType + - result + - leftSideEvaluation + - description + ToolkitRuleOperatorResultExplanation: + enum: + - SKIPPED + - BOTH_CONDITIONS_MET + - ONLY_FIRST_CONDITION_MET + - ONLY_SECOND_CONDITION_MET + - SKIPPED_BECAUSE_OF_ERROR + ToolkitRuleComparePropertiesOperatorResultExplanation: + enum: + - ALL_PREDICATES_MET + - NOT_ALL_PREDICATES_MET + - SKIPPED_BECAUSE_OF_ERROR + OrderFenceDecisionDetail: + allOf: + - $ref: '#/components/schemas/BaseDecisionDetail' + properties: + contextReference: + $ref: '#/components/schemas/ContextReference' + expectedValue: type: string - reasonLocalized: - $ref: '#/components/schemas/LocaleString' - comment: + actualValue: type: string - minLength: 1 - example: Upper corner damaged + reactiveErrorReason: + $ref: '#/components/schemas/ReactiveErrorReason' required: - - reasonLocalized - ItemReturnForCreation: - additionalProperties: false + - expectedValue + - facilityValue + - decisionType + ContextReference: properties: - status: - $ref: '#/components/schemas/ItemReturnStatus' - returnFacilityRef: + reference: type: string - tenantOrderId: + routingDecisionContext: + $ref: '#/components/schemas/RoutingDecisionContext' + required: + - reference + - routingDecisionContext + RoutingDecisionContext: + enum: + - LISTING + - CARRIER + FenceResultStatus: + enum: + - FAILED + - PASSED + - REACTIVE_PASSING_POSSIBLE + ReactiveErrorReason: + enum: + - BACKORDER_LISTING + - PREORDER_LISTING + OrderLineItemFenceDecisions: + properties: + name: type: string - scannableCodes: - items: - type: string - type: array - returnedLineItems: + orderLineItems: type: array - minItems: 1 items: - $ref: '#/components/schemas/ItemReturnLineItemForCreation' - required: - - returnedLineItems - - status - - returnFacilityRef - AddItemReturnToItemReturnJob: - additionalProperties: false - properties: - itemReturnForCreation: - $ref: '#/components/schemas/ItemReturnForCreation' - itemReturnJobVersion: - description: Version of the itemReturnJob the itemReturn gets added to - minimum: 0 - type: integer + $ref: '#/components/schemas/OrderLineItemFenceDecision' required: - - itemReturnForCreation - - itemReturnJobVersion - ItemReturnLineItemForCreation: - additionalProperties: false + - name + - orderLineItems + OrderLineItemFenceDecision: + type: object properties: - itemConditionLocalized: - $ref: '#/components/schemas/LocaleString' - itemConditionComment: - type: string - minLength: 1 - example: Upper corner damaged tenantArticleId: type: string - example: a69006ba-7100-4b4d-a610-1ca28016a4eb - scannedCodes: + articleTitle: + type: string + decision: + $ref: '#/components/schemas/FenceResultStatus' + details: type: array items: - type: string - status: - $ref: '#/components/schemas/ItemReturnLineItemStatus' - reasons: - items: - $ref: '#/components/schemas/ItemReturnLineItemReason' - minItems: 1 - type: array + anyOf: + - $ref: '#/components/schemas/OrderFenceDecisionDetail' + - $ref: '#/components/schemas/ToolkitDecisionDetail' + - $ref: '#/components/schemas/ToolkitComparisonDecisionDetail' + reactiveErrorReason: + $ref: '#/components/schemas/ReactiveErrorReason' required: - tenantArticleId - - reasons - - status - ReplaceReturnedLineItems: + - articleTitle + - decision + - details + Fence: additionalProperties: false properties: - itemReturnJobVersion: - description: Version of the entity to be changed - minimum: 0 - type: integer - returnedLineItems: + active: + type: boolean + description: + type: string + id: + description: >- + This value identifies this very instance of the fence. It is set + autmatically by the server when the configuration is updated. + example: f937bc6b-d78b-46a3-913f-ecbba5f9f65d + type: string + implementation: + $ref: '#/components/schemas/FenceImplementation' + name: + type: string + supportedModes: type: array - minItems: 1 items: - $ref: '#/components/schemas/ItemReturnLineItemForCreation' - required: - - itemReturnJobVersion - - returnedLineItems - ItemReturnLineItemStatus: - enum: - - OPEN - - IN_PROGRESS - - WAITING_FOR_INPUT - - REJECTED - - ACCEPTED - type: string - ItemReturnJobActionsParameter: - anyOf: - - $ref: '#/components/schemas/StartItemReturnJobActionParameter' - - $ref: '#/components/schemas/FinishItemReturnJobActionParameter' - - $ref: '#/components/schemas/RestartItemReturnJobActionParameter' - StartItemReturnJobActionParameter: - additionalProperties: false - properties: - name: - $ref: '#/components/schemas/StartItemReturnJobActionEnum' - version: - description: Version of the entity to be changed - minimum: 0 - type: integer - required: - - name - - version - StartItemReturnJobActionEnum: - enum: - - StartItemReturnJob - type: string - FinishItemReturnJobActionParameter: - additionalProperties: false - properties: - name: - $ref: '#/components/schemas/FinishItemReturnJobActionEnum' - version: - description: Version of the entity to be changed - minimum: 0 - type: integer - required: - - name - - version - FinishItemReturnJobActionEnum: - enum: - - FinishItemReturnJob - type: string - RestartItemReturnJobActionParameter: - additionalProperties: false - properties: - name: - $ref: '#/components/schemas/RestartItemReturnJobActionEnum' - version: - description: Version of the entity to be changed - minimum: 0 - type: integer + $ref: '#/components/schemas/FenceMode' + activeMode: + $ref: '#/components/schemas/FenceMode' required: - - name - - version - RestartItemReturnJobActionEnum: + - active + - implementation + - id + type: object + FenceMode: enum: - - RestartItemReturnJob + - static + - reactive type: string - ItemReturnActionsParameter: - anyOf: - - $ref: '#/components/schemas/AnnounceItemReturnActionParameter' - - $ref: '#/components/schemas/OpenItemReturnActionParameter' - - $ref: '#/components/schemas/StartItemReturnActionParameter' - - $ref: '#/components/schemas/PauseItemReturnActionParameter' - - $ref: '#/components/schemas/FinishItemReturnActionParameter' - AnnounceItemReturnActionParameter: - additionalProperties: false - properties: - name: - $ref: '#/components/schemas/AnnounceItemReturnActionEnum' - itemReturnJobVersion: - description: Version of the entity to be changed - minimum: 0 - type: integer - required: - - name - - itemReturnJobVersion - AnnounceItemReturnActionEnum: + FenceImplementation: + 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 enum: - - AnnounceItemReturn + - FACILITY-BUSINESSTYPE + - STOCK-AVAILABILITY + - FACILITY-CARRIERAVAILABILITY + - FACILITY-COUNTRY + - FACILITY-PICKING-TIME-CAPACITY + - PRESELECTED-FACILITY + - SAMEDAY-POSSIBLE + - AVOID-ZERO-STOCK type: string - OpenItemReturnActionParameter: - additionalProperties: false + xml: + name: FenceImplementation + GeoFence: + description: >- + Center (described with lon and lat attributes) and a circular geofence + (described as radius around the center) properties: - name: - $ref: '#/components/schemas/OpenItemReturnActionEnum' - itemReturnJobVersion: - description: Version of the entity to be changed - minimum: 0 - type: integer + lat: + description: The latitude of the center, provided as decimal coordinate + example: 50.968713 + type: number + lon: + description: The longitude of the center, provided as decimal coordinate + example: 7.011375 + type: number + radius: + description: Radius around the center in kilometers (km, max. 100) + minimum: 1 + type: number required: - - name - - itemReturnJobVersion - OpenItemReturnActionEnum: - enum: - - OpenItemReturn - type: string - StartItemReturnActionParameter: - additionalProperties: false + - lat + - lon + - radius + type: object + ArticleAvailability: properties: - name: - $ref: '#/components/schemas/StartItemReturnActionEnum' - itemReturnJobVersion: - description: Version of the entity to be changed - minimum: 0 - type: integer + tenantArticleId: + type: string + availableStock: + type: number + outOfStockBehaviour: + enum: + - BACKORDER + type: string + availabilityTimeframe: + $ref: '#/components/schemas/AvailabilityTimeframe' required: - - name - - itemReturnJobVersion - StartItemReturnActionEnum: - enum: - - StartItemReturn - type: string - PauseItemReturnActionParameter: - additionalProperties: false + - tenantArticleId + - availableStock + Fulfillability: + description: The response to a fulfillability request. properties: - name: - $ref: '#/components/schemas/PauseItemReturnActionEnum' - itemReturnJobVersion: - description: Version of the entity to be changed - minimum: 0 - type: integer - required: - - name - - itemReturnJobVersion - PauseItemReturnActionEnum: - enum: - - PauseItemReturn - type: string - FinishItemReturnActionParameter: - additionalProperties: false + collect: + properties: + facilities: + items: + $ref: '#/components/schemas/FulfillabilityFacility' + type: array + type: object + shipping: + description: >- + Results for the fulfillment of a shipping order for the parameters + provided in the query + properties: + DELIVERY: + description: Depicts wether the servicelevel DELIVERY is available. + properties: + available: + description: Depicts wether the servicelevel DELIVERY is available + example: false + type: boolean + required: + - available + type: object + SAMEDAY: + description: >- + This service level means, that the consumer expects a package + the same day. + properties: + available: + description: Depicts wether the servicelevel SAMEDAY is available + example: true + type: boolean + validUntil: + description: >- + This information is most likely valid until this date (there + are circumstances when this information becomes stale + earlier). + example: '2020-02-03T08:45:50.525Z' + format: date-time + type: string + required: + - available + type: object + type: object + type: object + FulfillabilityResult: properties: - name: - $ref: '#/components/schemas/FinishItemReturnActionEnum' - itemReturnJobVersion: - description: Version of the entity to be changed - minimum: 0 - type: integer + fulfillability: + type: array + items: + $ref: '#/components/schemas/FulfillabilityDetail' required: - - name - - itemReturnJobVersion - FinishItemReturnActionEnum: - enum: - - FinishItemReturn - type: string - OperativeProcess: - allOf: - - $ref: '#/components/schemas/VersionedResource' - additionalProperties: false + - details + FulfillabilityDetail: properties: - id: + facilityRef: type: string - processRef: + tenantFacilityId: type: string - description: Reference to the overall process - facilityRef: + facilityName: type: string - description: Reference to the facility this operative process is handled in - flatEntityRefs: + closingDays: + type: array items: - type: string + $ref: '#/components/schemas/ClosingDay' + pickingTimes: + $ref: '#/components/schemas/PickingTimes' + address: + $ref: '#/components/schemas/FacilityAddress' + targetTime: + type: string + format: date-time + articleAvailabilities: + type: array + items: + $ref: '#/components/schemas/ArticleAvailability' + required: + - facilityRef + - facilityName + - address + - articleAvailabilities + FulfillabilityFacility: + allOf: + - $ref: '#/components/schemas/StrippedFacility' + FulfillabilityItemsConstraintValue: + properties: + items: description: >- - References to all operational entities belonging to this operative - process - minLength: 0 - entityChildren: + The shortened description of an article, that would be part of the + order. items: - $ref: '#/components/schemas/OperativeEntity' - description: Tree structure of entities belonging to this operative process - minLength: 0 + properties: + amount: + description: The required amount + example: 5 + type: integer + tenantArticleId: + description: The article ID, that is used in corresponding listings. + example: RO-57665956-6-XL + type: string + type: object + type: array + mode: + description: >- + The mode this constraint is evaluated in. ITEMS_COMPLETE means, that + all the items in the desired quantities have to be listed in a + resulting facility. + enum: + - ITEMS_COMPLETE + example: ITEMS_COMPLETE + type: string + required: + - mode + - items type: object + FulfillabilityShipFromStoreQuery: + description: >- + Provides the paramters you are interested in. You must supply at least + the articles you are interested in + properties: + geoFence: + $ref: '#/components/schemas/GeoFence' + facilityRefs: + type: array + items: + type: string + articles: + type: array + minItems: 1 + items: + type: object + properties: + tenantArticleId: + type: string + quantity: + type: number + required: + - tenantArticleId + deliveryPreferences: + $ref: '#/components/schemas/DeliveryPreferences' + deliveryCountry: + description: A two-digit country code as per ISO 3166-1 alpha-2 + example: DE + pattern: ^[A-Z]{2}$ + type: string + deliveryPostalCode: + type: string required: - - id - - processRef - - facilityRef - - flatEntityRefs - - entityChildren - OperativeProcessForCreation: - additionalProperties: false + - articles + FulfillabilityClickAndCollectQuery: + description: >- + Provides the paramters you are interested in. You must supply at least + the articles you are interested in properties: - processRef: + geoFence: + $ref: '#/components/schemas/GeoFence' + facilityRefs: + type: array + items: + type: string + deliveryPreferences: + $ref: '#/components/schemas/DeliveryPreferences' + deliveryCountry: + description: A two-digit country code as per ISO 3166-1 alpha-2 + example: DE + pattern: ^[A-Z]{2}$ type: string - description: Reference to the overall process - facilityRef: + deliveryPostalCode: type: string - description: Reference to the facility this operative process is handled in - entityChildren: + articles: + type: array + minItems: 1 items: - $ref: '#/components/schemas/OperativeEntity' - description: Tree structure of entities belonging to this operative process - type: object + type: object + properties: + tenantArticleId: + type: string + quantity: + type: number + required: + - tenantArticleId required: - - processRef - - facilityRef - OperativeEntity: - additionalProperties: false + - articles + AbstractFulfillabilityConstraintType: properties: - entityRef: + type: + description: >- + Type of the constraint (must be supported by the fulfillmenttools + platform). + enum: + - ITEMS + example: ITEMS type: string - description: Reference to the full entity - entityType: - $ref: '#/components/schemas/OperativeEntityType' - entityChildren: - items: - $ref: '#/components/schemas/OperativeEntity' - description: Tree structure of entities belonging to this entity - required: - - entityRef - - entityType - OperativeEntityType: - type: string - enum: - - PICK_JOB - - PACK_JOB - - SHIPMENT - - HANDOVER_JOB - - PARCEL - - SERVICE_JOB - - RESTOW_ITEM - - ITEM_RETURN_JOB - ExpiryEntity: - additionalProperties: false + value: + description: Additional parameters needed for the referenced type of constraint. + type: object + type: object + ItemsFulfillabilityConstraintType: + allOf: + - $ref: '#/components/schemas/AbstractFulfillabilityConstraintType' properties: - id: + type: + enum: + - ITEMS type: string - description: Generated identifier of this entity - example: 611c860f-3f00-4b01-9f4c-64cdee38a30e - version: - type: integer - format: int64 - example: 42 - description: >- - The version of the document to be used in optimistic locking - mechanisms. - created: + value: + $ref: '#/components/schemas/FulfillabilityItemsConstraintValue' + type: object + StrippedShippingTargetAddress: + properties: + country: + description: A two-digit country code as per ISO 3166-1 alpha-2 + example: DE + pattern: ^[A-Z]{2}$ type: string - format: date-time - example: '2020-02-03T08:45:51.525Z' - description: >- - The date this entity was created at the platform. This value is - generated by the service. - lastModified: + postalCode: + example: '40764' + pattern: ^.+ type: string - format: date-time - example: '2020-02-03T09:45:51.525Z' + type: object + FulfillabilityQuery: + description: >- + Provides the paramters you are interested in. You must supply at least + either the shipping or the collect attribute as the description of the + last mile expectation. + properties: + collect: description: >- - The date this entity was modified last. This value is generated by - the service. - processRef: - type: string - example: c4e5fb70-a893-4ffa-b7b0-e042cda6fb9f - description: Reference to the Process of this Entity - provisioningTime: - type: string - format: date-time - example: '2020-02-03T08:45:51.525Z' + The geofence (a gps coordinate and a radius around that coordinate) + for considered facilities to collect the goods. + properties: + geoFence: + $ref: '#/components/schemas/GeoFence' + required: + - geoFence + type: object + constraints: description: >- - Planned time where this entity should be provided or handed over to - the customer - expiryTime: - type: string + Constraints can be used to further cut down the list of resulting + facilities. Important: ALL of the given constraints will be matched + against the resulting list of facilities! + items: + $ref: '#/components/schemas/AbstractFulfillabilityConstraintType' + type: array + estimatedOrderDate: + description: >- + The point in time when the order estimated to be supplied to + fulfillmenttools platform, e.g. calling this endpoint during + checkout, you would most likely put the timestamp for 'now' in here. + example: '2020-02-03T08:45:50.525Z' format: date-time - example: '2020-02-03T08:45:51.525Z' - description: Time where the connected process expires, if not fulfilled - status: - $ref: '#/components/schemas/ExpiryEntityStatus' + type: string + shipping: + description: >- + You want information about the shipping possibility - more detailed + parameters can be described here. + properties: + serviceLevels: + description: >- + The kind of servicelevel you want to query as being part of the + consumer expectation of delivery + items: + $ref: '#/components/schemas/CarrierDeliveryType' + minItems: 1 + type: array + targetAddress: + $ref: '#/components/schemas/StrippedShippingTargetAddress' + required: + - serviceLevels + - targetAddress + type: object required: - - id - - version - - created - - lastModified - - processRef - - provisioningTime - - expiryTime - - status - ExpiryEntityForCreation: - additionalProperties: false + - estimatedOrderDate + type: object + FallbackFacilityConfigurationForPatch: properties: - processRef: - type: string - example: c4e5fb70-a893-4ffa-b7b0-e042cda6fb9f + facilityRefs: + type: array + items: + type: string + maxItems: 1 + minItems: 1 + active: + type: boolean + fallbackAfterTime: description: >- - Reference to the Process for which this expiry entity will be - created - provisioningTime: + Default amount of time in ISO 8601 duration format after which a not + routable routingplan is routed to a configured fallback facility. type: string - format: date-time - example: '2020-02-03T08:45:51.525Z' + pattern: ^P(?:(\d+W)|(\d+Y)?(\d+M)?(\d+D)?(?:T(\d+H)?(\d+M)?(\d+S)?)?)$ + FallbackFacilityConfiguration: + properties: + facilityRefs: + type: array + items: + type: string + maxItems: 1 + minItems: 1 + active: + type: boolean + default: false + fallbackAfterTime: + default: PT0H description: >- - Planned time where this entity should be provided or handed over to - the customer - status: - $ref: '#/components/schemas/ExpiryEntityStatus' + Default amount of time in ISO 8601 duration format after which a not + routable routingplan is routed to a configured fallback facility. + type: string + pattern: ^P(?:(\d+W)|(\d+Y)?(\d+M)?(\d+D)?(?:T(\d+H)?(\d+M)?(\d+S)?)?)$ required: - - processRef - - provisioningTime - - status - ExpiryEntityForUpdate: - additionalProperties: false + - facilityRefs + - active + - fallbackAfterTime + GlobalManualRerouteConfiguration: + description: Allows reroutes to be triggered manually via api. properties: - version: - type: integer - description: version of the entity you want to alter - provisioningTime: - type: string - format: date-time - example: '2020-02-03T08:45:51.525Z' - description: >- - Planned time where this entity should be provided or handed over to - the customer - status: - $ref: '#/components/schemas/ExpiryEntityStatus' + active: + type: boolean required: - - version - ExpiryEntityFilter: - additionalProperties: false + - active + type: object + GlobalRoutingConfiguration: + description: Global configuration for routing properties: - processRef: + manualReroute: + $ref: '#/components/schemas/GlobalManualRerouteConfiguration' + defaultPrice: + default: 10 + description: Default price which is used if no price exists in order or listings + type: number + routingTimeout: + deprecated: true + default: 8 + description: >- +
+
This endpoint is deprecated and has been replaced.

@deprecated Default amount of hours after which a routing + plan is marked not routable. This field is deprecated in favour of + stopRoutingAttemptsAfterTime + type: number + stopRoutingAttemptsAfterTime: + default: PT8H + description: >- + Default amount of time in ISO 8601 duration format after which a + routing plan is marked not routable. The duration need to be a + multiple of 60 seconds. type: string - description: process of the entity you want to load - status: - $ref: '#/components/schemas/ExpiryEntityStatus' - startDate: - format: date-time - example: '2020-02-03T08:45:51.525Z' - description: start date range for expiryTime - endDate: - format: date-time - example: '2020-02-03T08:45:51.525Z' - description: end date range for expiryTime - ExpiryEntityStatus: + pattern: ^P(?:(\d+W)|(\d+Y)?(\d+M)?(\d+D)?(?:T(\d+H)?(\d+M)?(\d+S)?)?)$ + fallbackFacilityConfiguration: + $ref: '#/components/schemas/FallbackFacilityConfiguration' + required: + - defaultPrice + type: object + ModifyFenceAction: + allOf: + - $ref: '#/components/schemas/AbstractModificationAction' + - properties: + action: + description: Use value 'ModifyFence', because you want to modify a fence. + enum: + - ModifyFence + type: string + active: + type: boolean + id: + type: string + activeMode: + $ref: '#/components/schemas/FenceMode' + required: + - action + - id + type: object + xml: + name: ModifyFenceAction + ModifyGlobalRoutingConfigurationAction: + allOf: + - $ref: '#/components/schemas/AbstractModificationAction' + - properties: + action: + description: >- + Use value 'ModifyGlobalRoutingConfiguration', because you want + to modify global routing configuration. + enum: + - ModifyGlobalRoutingConfiguration + type: string + defaultPrice: + default: 10 + description: >- + Default price which is used if no price exists in order or + listings + type: number + manualRerouteConfiguration: + $ref: '#/components/schemas/GlobalManualRerouteConfiguration' + routingTimeout: + deprecated: true + default: 8 + description: >- +
+
This endpoint is deprecated and has been + replaced.

@deprecated Default amount of hours + after which a routing plan is marked not routable. This field is + deprecated in favour of stopRoutingAttemptsAfterTime + type: number + stopRoutingAttemptsAfterTime: + default: PT8H + description: >- + Default amount of time in ISO 8601 duration format after which a + routing plan is marked not routable. The duration need to be a + multiple of 60 seconds. + type: string + pattern: ^P(?:(\d+W)|(\d+Y)?(\d+M)?(\d+D)?(?:T(\d+H)?(\d+M)?(\d+S)?)?)$ + fallbackFacilityConfiguration: + $ref: '#/components/schemas/FallbackFacilityConfigurationForPatch' + required: + - action + type: object + ModifyOrderSplitAction: + allOf: + - $ref: '#/components/schemas/AbstractModificationAction' + - properties: + action: + description: >- + Use value 'ModifyOrderSplit', because you want to modify the + configuration for the an order split. + enum: + - ModifyOrderSplit + type: string + active: + default: false + type: boolean + shouldUseWaitingRoomForPreBackOrderItems: + default: false + type: boolean + activeForSameDay: + default: false + type: boolean + fixedCountConfiguration: + $ref: '#/components/schemas/FixedCountConfiguration' + orderSplitType: + $ref: '#/components/schemas/OrderSplitType' + required: + - action + type: object + xml: + name: ModifyOrderSplitAction + ModifyRatingAction: + allOf: + - $ref: '#/components/schemas/AbstractModificationAction' + - properties: + action: + description: Use value 'ModifyRating', because you want to modify a rating. + enum: + - ModifyRating + type: string + active: + type: boolean + description: + type: string + id: + type: string + maxPenalty: + example: 100 + type: number + minimum: 0 + name: + type: string + required: + - action + - id + type: object + xml: + name: ModifyRatingAction + ModifyRoutingPlanAction: + allOf: + - $ref: '#/components/schemas/AbstractModificationAction' + - additionalProperties: false + properties: + action: + description: >- + Use value 'ModifyRoutingPlan', because you want to modify a + routing plan + enum: + - ModifyRoutingPlan + type: string + facilityRef: + description: >- + The id of the facility reference. The given ID has to be present + in the system. + example: Esb20gpHBL94X5NdMp3C + type: string + status: + $ref: '#/components/schemas/RoutingPlanStatus' + required: + - action + type: object + xml: + name: ModifyRoutingPlanAction + ToolkitOperatorType: + description: |- + Type of operator used for a toolkit fence or rating: + * `TAG_EQUALS`- the entity2 should have a tag with the same id as the entity1 and the value is dynamically matched + * `VALUE_EQUALS`- compares the tag of entity1 with the tag of entity2 attending to the configured rule and returns true if it does match + * `VALUE_NOT_EQUALS`- compares the tag of entity1 with the tag of entity2 attending to the configured rule and returns true if it does not match enum: - - ACTIVE - - INACTIVE + - TAG_EQUALS + - VALUE_EQUALS + - VALUE_NOT_EQUALS type: string - StorageLocationForCreation: + xml: + name: ToolkitOperatorType + ToolkitAllowedEntities: + description: |- + The entities that can be compared by the toolkit fence or rating + * `ORDER` + * `FACILITY` + * `CARRIERCONNECTION` + enum: + - ORDER + - FACILITY + - CARRIERCONNECTION + type: string + xml: + name: ToolkitAllowedEntities + ToolkitFenceForCreation: properties: name: - description: The name of this storage location - type: string - maxLength: 15 - tenantLocationId: - description: The internal tenant id for this location - type: string - type: - $ref: '#/components/schemas/StorageLocationType' - traits: - description: >- - The traits of this storage location, includes both local config and - and defaults. Do not use to write to traits, use traitConfig - instead. - type: array - items: - $ref: '#/components/schemas/StorageLocationTrait' - traitConfig: - $ref: '#/components/schemas/StorageLocationTraitConfig' - scannableCodes: - description: Barcodes representing this storage location - type: array - maxItems: 5 - items: - type: string - runningSequences: - description: The Sequence item/s of this location - type: array - maxItems: 10 - items: - $ref: '#/components/schemas/StorageLocationSequenceItem' - zoneRef: - description: The id of the Zone to which this storage location belongs - example: Esb20gpHBL94X5NdMp3C - type: string - zoneName: - description: The name of the Zone to which this storage location belongs - type: string - information: - description: A free text information about this storage location, max length 1024 + description: The name of the fence. + example: CustomFence type: string - maxLength: 1024 - customAttributes: - description: >- - Attributes that can be added to the storage location. These - attributes cannot be used within fulfillment processes, but it could - be useful to have the informations carried here. - type: object + nameLocalized: + $ref: '#/components/schemas/LocaleString' + description: + description: The description of this fence. + example: Some text that describes what the fence does. + type: string + descriptionLocalized: + $ref: '#/components/schemas/LocaleString' + active: + default: false + description: Indicates whether this fence is active or not. + type: boolean + order: + description: Order in which this fence is executed + example: 1 + type: integer + entity1: + $ref: '#/components/schemas/ToolkitAllowedEntities' + entity2: + $ref: '#/components/schemas/ToolkitAllowedEntities' + rule: + $ref: '#/components/schemas/ToolkitRule' + comparisonRule: + $ref: '#/components/schemas/ToolkitComparisonRule' required: - name - - runningSequences - - scannableCodes - - type + - nameLocalized + - active + - order + - entity1 + - entity2 type: object xml: - name: StorageLocationForCreation - StorageLocationForReplacement: + name: ToolkitFenceForCreation + ToolkitFenceForModification: allOf: - - $ref: '#/components/schemas/StorageLocationForCreation' + - $ref: '#/components/schemas/ToolkitFenceForCreation' properties: version: + description: >- + The version of the document to be used in optimistic locking + mechanisms. example: 42 format: int64 type: integer @@ -34758,571 +37483,371 @@ components: - version type: object xml: - name: StorageLocationForReplacement - StorageLocation: + name: ToolkitFenceForModification + ToolkitFence: allOf: - - $ref: '#/components/schemas/StorageLocationForReplacement' + - $ref: '#/components/schemas/ToolkitFenceForModification' - $ref: '#/components/schemas/VersionedResource' properties: id: - description: The id of this storage location - type: string - facilityRef: - description: The id of the facility reference. - example: Esb20gpHBL94X5NdMp3C - type: string - zoneName: - description: >- - Deprecated! This field will not be filled in newly created storage - locations. Resolve the zone name separately via the - facilities/{id}/zones endpoint. The name of the Zone to which this - storage location belongs + description: The id of the toolkit fence + example: LGMl2DuvPnfPoSHhYFOm type: string - deprecated: true - traits: - description: The traits of this storage location - type: array - items: - $ref: '#/components/schemas/StorageLocationTrait' - traitConfig: - $ref: '#/components/schemas/StorageLocationTraitConfig' - schemaVersion: - type: number required: - id - - facilityRef - - traits type: object xml: - name: StorageLocation - StorageLocationTraitConfig: - description: The configuration of the traits of this storage location - type: array - items: - type: object - properties: - trait: - $ref: '#/components/schemas/StorageLocationTrait' - enabled: - type: boolean - required: - - trait - - enabled - StorageLocationType: - description: |- - Describes the kind of a storage location: - * `SINGLE_STORAGE`- it is only allowed to store stock with the same tenantArticleId here - * `BULK_STORAGE`- stocks belonging to different tenantArticleIds can be stored here - enum: - - SINGLE_STORAGE - - BULK_STORAGE - type: string - xml: - name: StorageLocationType - StorageLocationTrait: - type: string - description: |- - Describes what kind of actions this stock is available for - * `PICKABLE`- The stock is available for picking - * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc) - * `KEEP_ON_ZERO`- The stock will not be deleted when emptied - enum: - - PICKABLE - - ACCESSIBLE - - KEEP_ON_ZERO - xml: - name: StorageLocationTrait - StorageLocationSequenceType: - description: |- - Describes the type of a storage location sequence type - * `PICKING_SEQUENCE`- The sequence in wich the storage locations are picked. - * `RESTOW_SEQUENCE`- The sequence in wich the storage locations are restowed. - enum: - - PICKING_SEQUENCE - - RESTOW_SEQUENCE - type: string + name: ToolkitFence + ToolkitFencesTransporter: + properties: + fences: + items: + $ref: '#/components/schemas/ToolkitFence' + type: array + total: + description: Total number of found entities for this query + example: 42 + type: integer + required: + - fences + - total + type: object xml: - name: StorageLocationType - StorageLocationSequenceItem: + name: ToolkitFenceTransporter + ToolkitRatingForCreation: properties: - type: - $ref: '#/components/schemas/StorageLocationSequenceType' - previousStorageLocationRef: - description: The previous storage from which to pick up after this one + name: + description: The name of the rating + example: CustomRating type: string - nextStorageLocationRef: - description: The next storage from which to pick up after this one + nameLocalized: + $ref: '#/components/schemas/LocaleString' + description: + description: The description of this rating + example: Some text that describes what the rating does. type: string - score: - deprecated: true - description: Running sequence score - read-only - type: number + descriptionLocalized: + $ref: '#/components/schemas/LocaleString' + active: + default: false + description: Indicates whether this fence is active or not + type: boolean + entity1: + $ref: '#/components/schemas/ToolkitAllowedEntities' + entity2: + $ref: '#/components/schemas/ToolkitAllowedEntities' + rule: + $ref: '#/components/schemas/ToolkitRule' + comparisonRule: + $ref: '#/components/schemas/ToolkitComparisonRule' + maxPenalty: + type: integer + example: 100 + description: The maximum penalty this rating can have required: - - type + - name + - nameLocalized + - active + - entity1 + - entity2 + - maxPenalty type: object xml: - name: StorageLocationSequenceItem - ModifyStorageLocationAction: + name: ToolkitRatingForCreation + ToolkitRatingForModification: allOf: - - $ref: '#/components/schemas/AbstractModificationAction' - - additionalProperties: false - properties: - action: - description: >- - Use value 'ModifyStorageLocation', because you want to modify a - storage location - enum: - - ModifyStorageLocation - type: string - name: - description: The name of this storage location - type: string - maxLength: 15 - tenantLocationId: - description: The internal tenant id for this location - type: string - type: - $ref: '#/components/schemas/StorageLocationType' - traits: - deprecated: true - description: >- - The traits of this storage location. Do not use this to write - traits, use traitConfig instead. - type: array - items: - $ref: '#/components/schemas/StorageLocationTrait' - traitConfig: - $ref: '#/components/schemas/StorageLocationTraitConfig' - scannableCodes: - description: Barcodes representing this storage location - type: array - maxItems: 5 - items: - type: string - runningSequences: - description: The Sequence item/s of this location - type: array - maxItems: 10 - items: - $ref: '#/components/schemas/StorageLocationSequenceItem' - zoneRef: - description: The id of the Zone to which this storage location belongs. - example: Esb20gpHBL94X5NdMp3C - type: string - information: - description: >- - A free text information about this storage location, max length - 1024 - type: string - maxLength: 1024 - customAttributes: - description: >- - Attributes that can be added to the storage location. These - attributes cannot be used within fulfillment processes, but it - could be useful to have the informations carried here. - type: object - required: - - action - type: object - xml: - name: ModifyStorageLocationAction - StorageLocationPatchActions: + - $ref: '#/components/schemas/ToolkitRatingForCreation' properties: - actions: - items: - $ref: '#/components/schemas/ModifyStorageLocationAction' - minItems: 1 - type: array version: description: >- - The version of the facility where we want to patch the storage - locations to be used in optimistic locking mechanisms. + The version of the document to be used in optimistic locking + mechanisms. example: 42 format: int64 type: integer required: - version - - actions type: object xml: - name: StorageLocationPatchActions - RemoteConfigurationForCreation: - additionalProperties: false - properties: - key: - type: string - example: PICKING_SHOW_NEW_SCAN_VIEW - description: unique business key of this entity - scopes: - type: array - items: - $ref: '#/components/schemas/RemoteConfigurationScopeForCreation' - valueType: - $ref: '#/components/schemas/RemoteConfigurationValueType' - value: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: object - groups: - type: array - items: - example: INVENTORY - type: string - minItems: 1 - required: - - key - - value - - valueType - - groups - type: object - RemoteConfiguration: + name: ToolkitRatingForModification + ToolkitRating: allOf: + - $ref: '#/components/schemas/ToolkitRatingForModification' - $ref: '#/components/schemas/VersionedResource' - additionalProperties: false properties: id: - type: string + description: The id of the toolkit rating example: LGMl2DuvPnfPoSHhYFOm - description: auto generated unique identifier - key: type: string - example: PICKING_SHOW_NEW_SCAN_VIEW - description: unique business key of this entity - scopes: - type: array - items: - $ref: '#/components/schemas/RemoteConfigurationScope' - valueType: - $ref: '#/components/schemas/RemoteConfigurationValueType' - value: - oneOf: - - type: string - - type: number - - type: boolean - - type: object - - type: integer - groups: - type: array - items: - example: INVENTORY - type: string - minItems: 1 - flattenScopeIds: - description: >- - generated flatten unique ids of all scope sub elements (userRef, - facilityRef) - type: array - items: - example: - - INVENTORY - - 67151fc3-3ce1-400e-8b23-23c29e0cde90 - type: string required: - id - - key - - version - - value - - valueType - - groups - - flattenScopeIds - type: object - RemoteConfigurationForUpdate: - additionalProperties: false - properties: - version: - type: integer - scopes: - type: array - items: - $ref: '#/components/schemas/RemoteConfigurationScopeForCreation' - valueType: - $ref: '#/components/schemas/RemoteConfigurationValueType' - value: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: object - groups: - type: array - items: - example: INVENTORY - type: string - minItems: 1 - required: - - version - type: object - RemoteConfigurationForPut: - additionalProperties: false - properties: - version: - type: integer - scopes: - type: array - items: - $ref: '#/components/schemas/RemoteConfigurationScopeForCreation' - valueType: - $ref: '#/components/schemas/RemoteConfigurationValueType' - value: - oneOf: - - type: string - - type: integer - - type: number - - type: boolean - - type: object - groups: - type: array - items: - example: INVENTORY - type: string - minItems: 1 - required: - - version - - value - - valueType - - groups type: object - RemoteConfigurations: + xml: + name: ToolkitRating + ToolkitRatingTransporter: properties: - remoteConfigurations: + ratings: items: - $ref: '#/components/schemas/RemoteConfiguration' + $ref: '#/components/schemas/ToolkitRating' type: array total: - description: Total number of found entities for this query + description: Total number of entities found for this query example: 42 type: integer - type: object - RemoteConfigurationScopeForCreation: - additionalProperties: false - properties: - facilityRefs: - type: array - items: - description: Reference of a Facility - example: 928f3730-bc48-4d85-b83f-3fd86b776178 - type: string - userRefs: - type: array - items: - description: Reference of a user - example: 928f3730-bc48-4d85-b83f-3fd86b776178 - type: string - type: object - AddRemoteConfigurationScopeParameter: - additionalProperties: false - properties: - scope: - $ref: '#/components/schemas/RemoteConfigurationScopeForCreation' - remoteConfigVersion: - type: number - minimum: 0 - required: - - scope - - remoteConfigVersion - type: object - RemoteConfigurationScope: - allOf: - - $ref: '#/components/schemas/RemoteConfigurationScopeForCreation' - additionalProperties: false - properties: - id: - type: string - example: LGMl2DuvPnfPoSHhYFOm - description: auto generated unique identifier required: - - id + - ratings + - total type: object - RemoteConfigurationValueType: + xml: + name: ToolkitRatingTransporter + ToolkitEntityOperatorType: + description: The possible operator types that can be used on given entities enum: - - BOOLEAN - - STRING - - JSON - - NUMBER - - INT + - VALUE_EQUALS + - VALUE_NOT_EQUALS + - ANY_VALUE_EQUALS + - ANY_VALUE_GREATER_EQUALS + - ANY_VALUE_GREATER_THAN + - ANY_VALUE_LESS_EQUALS + - ANY_VALUE_LESS_THAN + - ANY_VALUE_CONTAINS + - ANY_VALUE_NOT_CONTAINS + - EVERY_VALUE_EQUALS + - EVERY_VALUE_GREATER_EQUALS + - EVERY_VALUE_GREATER_THAN + - EVERY_VALUE_LESS_EQUALS + - EVERY_VALUE_LESS_THAN + - EVERY_VALUE_CONTAINS + - EVERY_VALUE_NOT_CONTAINS + - NO_VALUE_EQUALS + - NO_VALUE_GREATER_EQUALS + - NO_VALUE_GREATER_THAN + - NO_VALUE_LESS_EQUALS + - NO_VALUE_LESS_THAN + - NO_VALUE_CONTAINS + - NO_VALUE_NOT_CONTAINS + - VALUE_CONTAINS + - VALUE_NOT_CONTAINS + - GREATER_THAN + - GREATER_EQUALS + - LESS_THAN + - LESS_EQUALS + type: string + xml: + name: ToolkitEntityOperatorType + ToolkitTransformationType: + description: >- + The transformations available to apply on the entity property value + before a predicate is evaluated + enum: + - SUBSTRING + - COUNT + - SUM + - LAST + type: string + xml: + name: ToolkitTransformationType + ToolkitRuleOperatorType: + description: >- + The type of the rule operator applied to the results of evaluating the + left predicates and the right predicates + enum: + - EQUALS + type: string + xml: + name: ToolkitTransformationType + ToolkitRuleComparisonOperatorType: + description: >- + The type of the rule operator applied to the results of evaluating the + left predicates and the right predicates + enum: + - ALL_MATCHES + - LEFT_CONTAINS_RIGHT + - RIGHT_CONTAINS_LEFT type: string - ZoneForCreation: + xml: + name: ToolkitTransformationType + ToolkitPredicate: + description: >- + The predicate for a Toolkit V2 Fence that defines how conditions are + constructed properties: - name: - description: The name of this zone + propertyPath: type: string - score: - description: The score of this zone - type: number + minLength: 1 + entityOperator: + $ref: '#/components/schemas/ToolkitEntityOperatorType' + transformation: + $ref: '#/components/schemas/ToolkitTransformationType' + transformationArgs: + type: array + items: + oneOf: + - type: string + - type: number + - type: boolean + expectedValue: + oneOf: + - type: string + - type: number + - type: boolean required: - - name - - score + - propertyPath + - entityOperator type: object xml: - name: ZoneForCreation - ZoneForReplacement: - allOf: - - $ref: '#/components/schemas/ZoneForCreation' + name: ToolkitPredicate + ToolkitComparisonPredicate: + description: >- + The predicate for a Toolkit V2 Fence that defines how conditions are + constructed properties: - version: - example: 42 - format: int64 - type: integer + rightPropertyPath: + type: string + minLength: 1 + leftPropertyPath: + type: string + minLength: 1 + entityOperator: + $ref: '#/components/schemas/ToolkitRuleComparisonOperatorType' + rightTransformation: + $ref: '#/components/schemas/ToolkitTransformationType' + rightTransformationArgs: + type: array + items: + oneOf: + - type: string + - type: number + - type: boolean + leftTransformation: + $ref: '#/components/schemas/ToolkitTransformationType' + leftTransformationArgs: + type: array + items: + oneOf: + - type: string + - type: number + - type: boolean required: - - version + - rightPropertyPath + - leftPropertyPath + - entityOperator type: object xml: - name: ZoneForReplacement - Zone: - allOf: - - $ref: '#/components/schemas/ZoneForReplacement' - - $ref: '#/components/schemas/VersionedResource' + name: ToolkitComparisonPredicate + ToolkitRule: + description: >- + The rule, containing the left predicates and the right predicates, that + will be evaluated applying a RuleOperator properties: - id: - description: The id of this zone - type: string - facilityRef: - description: >- - The id of the facility reference. The given ID has to be present in - the system. - example: Esb20gpHBL94X5NdMp3C - type: string + operator: + $ref: '#/components/schemas/ToolkitRuleOperatorType' + leftPart: + $ref: '#/components/schemas/ToolkitRulePart' + rightPart: + $ref: '#/components/schemas/ToolkitRulePart' required: - - id - - facilityRef + - operator + - leftPart + - rightPart type: object xml: - name: Zone - CustomServiceForCreation: - additionalProperties: false + name: ToolkitRule + ToolkitComparisonRule: + description: >- + The rule, comparing the left and right path values, that will be + evaluated applying a RuleOperator properties: - status: - $ref: '#/components/schemas/CustomServiceStatus' - nameLocalized: - $ref: '#/components/schemas/LocaleString' - descriptionLocalized: - $ref: '#/components/schemas/LocaleString' - executionTimeInMin: - type: integer - example: 120 - itemsReturnable: - type: boolean - itemsRequired: - $ref: '#/components/schemas/ItemsRequiredEnum' - additionalInformation: + predicateConnector: + $ref: '#/components/schemas/ToolkitPredicateConnector' + predicates: type: array items: - $ref: '#/components/schemas/AdditionalInformationForCreation' - type: object + $ref: '#/components/schemas/ToolkitComparisonPredicate' + minItems: 1 required: - - nameLocalized - - itemsRequired - - status - CustomService: - allOf: - - $ref: '#/components/schemas/VersionedResource' - - $ref: '#/components/schemas/CustomServiceForCreation' + - predicates + type: object + xml: + name: ToolkitRule + ToolkitRulePart: + description: >- + One half of the rule, containing either the left or right predicates and + booleanOperator. properties: - id: - type: string - status: - $ref: '#/components/schemas/CustomServiceStatus' - name: - type: string - description: - type: string - additionalInformation: + predicateConnector: + $ref: '#/components/schemas/ToolkitPredicateConnector' + predicates: type: array items: - $ref: '#/components/schemas/AdditionalInformation' - type: object + $ref: '#/components/schemas/ToolkitPredicate' + minItems: 1 required: - - id - StrippedCustomServices: - properties: - customServices: - items: - $ref: '#/components/schemas/CustomService' - type: array - total: - description: Total number of found entities for this query - example: 42 - type: integer + - predicates type: object - ItemsRequiredEnum: - type: string - enum: - - MANDATORY - - NONE - CustomServiceStatus: - type: string - enum: - - ENABLED - - DISABLED - ServiceJobStatus: - type: string + xml: + name: ToolkitRulePart + ToolkitPredicateConnector: + description: The allowed operators for connecting multiple predicates enum: - - OPEN - - IN_PROGRESS - - FINISHED - - CANCELLED - - WAITING_FOR_INPUT - - OBSOLETE - - NOT_READY - AdditionalInformationValueType: + - OR + - AND type: string - enum: - - STRING - - BOOLEAN - - NUMBER - - NOVALUE - AdditionalInformationForCreation: - additionalProperties: false - type: object + xml: + name: ToolkitPredicateConnector + DecisionLogRef: properties: - nameLocalized: - $ref: '#/components/schemas/LocaleString' - descriptionLocalized: - $ref: '#/components/schemas/LocaleString' - valueType: - $ref: '#/components/schemas/AdditionalInformationValueType' - isMandatory: - type: boolean + routingRun: + type: number + url: + description: A reference to the finalizer decision log + example: /api/routingplans/{routingPlanId}/decisionlogs/{routingRun} + type: string required: - - nameLocalized - - valueType - AdditionalInformation: - allOf: - - $ref: '#/components/schemas/AdditionalInformationForCreation' + - url + - finalizeRun type: object + xml: + name: DecisionLogRef + RoutingConfiguration: + additionalProperties: 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

This is the configuration for the distributing order management system. By changing the configuration you are able to change the behavior of the routing of orders henceforth. properties: - id: - type: string - name: + created: + description: >- + The date this order was created at the platform. This value is + generated by the service. + example: '2020-02-03T08:45:51.525Z' + format: date-time type: string - description: + globalRoutingConfiguration: + $ref: '#/components/schemas/GlobalRoutingConfiguration' + lastModified: + description: >- + The date this order was modified last. This value is generated by + the service. + example: '2020-02-03T09:45:51.525Z' + format: date-time type: string - required: - - id - ServiceJobAdditionalInformation: - allOf: - - $ref: '#/components/schemas/AdditionalInformation' - type: object - properties: - value: - anyOf: - - type: string - - type: number - - type: boolean - description: Value of the additional information - example: some value - CustomServicePatchActions: - properties: - actions: + prioritizationRules: + description: >- + Contains the routing configuration for prioritization & routing for + the whole tenant items: - anyOf: - - $ref: '#/components/schemas/ModifyCustomServiceAction' - minItems: 1 + $ref: '#/components/schemas/PrioritizationRule' type: array + routingRule: + $ref: '#/components/schemas/RoutingRule' + timingMode: + $ref: '#/components/schemas/RoutingConfigurationTiming' version: description: >- The version of the document to be used in optimistic locking @@ -35330,884 +37855,830 @@ components: example: 42 format: int64 type: integer + id: + type: string required: - version - - actions + - prioritizationRules + - routingRule + - globalRoutingConfiguration + type: object + RoutingConfigurationTiming: + description: Configuration for the timing of routing decisions + properties: + options: + type: object + type: + $ref: '#/components/schemas/RoutingConfigurationTimingType' + required: + - type type: object + RoutingConfigurationTimingType: + 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

The available types for routing timing. + enum: + - DIRECT + - MANUAL + type: string xml: - name: CustomServicePatchActions - ModifyCustomServiceAction: + name: RoutingConfigurationTimingType + ModifyPrioritizationAction: allOf: - $ref: '#/components/schemas/AbstractModificationAction' - - additionalProperties: false - properties: + - properties: action: description: >- - Use value 'ModifyCustomService', because you want to modify a - custom service + Use value 'ModifyPrioritization', because you want to modify + prioritization. enum: - - ModifyCustomService + - ModifyPrioritization type: string - status: - $ref: '#/components/schemas/CustomServiceStatus' - nameLocalized: - $ref: '#/components/schemas/LocaleString' - descriptionLocalized: - $ref: '#/components/schemas/LocaleString' - executionTimeInMin: - type: integer - description: Time in minutes the custom service takes to be executed - example: 100 - itemsReturnable: + active: type: boolean + id: + type: string + name: + type: string + required: + - action + - id + type: object + xml: + name: ModifyPrioritizationAction + ModifyTimingModeAction: + allOf: + - $ref: '#/components/schemas/AbstractModificationAction' + - properties: + action: description: >- - Indicates if the items of the custom service are returnable - after the custom service has been executed - itemsRequired: - $ref: '#/components/schemas/ItemsRequiredEnum' + Use value 'ModifyTimingMode', because you want to modify a + timing mode. + enum: + - ModifyTimingMode + type: string + timingMode: + $ref: '#/components/schemas/RoutingConfigurationTiming' required: - action type: object xml: - name: ModifyCustomServiceAction - ServiceJobLineItemForCreation: - type: object + name: ModifyTimingModeAction + RoutingConfigurationsPatchActions: properties: - quantity: - type: integer - description: Quantity of the items - example: 12 - minimum: 1 - scannableCodes: + actions: items: - type: string - description: Codes, that identify the article - example: '4012345678901' + anyOf: + - $ref: '#/components/schemas/ModifyFenceAction' + - $ref: '#/components/schemas/ModifyRatingAction' + - $ref: '#/components/schemas/ModifyTimingModeAction' + - $ref: '#/components/schemas/ModifyOrderSplitAction' + - $ref: '#/components/schemas/ModifyPrioritizationAction' + - $ref: '#/components/schemas/ModifyGlobalRoutingConfigurationAction' + minItems: 1 type: array - article: - $ref: '#/components/schemas/ServiceJobLineItemArticle' + version: + description: >- + The version of the document to be used in optimistic locking + mechanisms. + example: 42 + format: int64 + type: integer required: - - quantity - - article - ServiceJobAdditionalInformationForCreation: + - version + - actions type: object + xml: + name: RoutingConfigurationsPatchActions + SupplyingFacilityConfiguration: properties: - additionalInformationRef: + facilityRef: type: string - description: ID of the additional information - example: 41d43211-g5a1-gg22-a716-ba095e30ds1d - value: - anyOf: - - type: string - - type: number - - type: boolean - description: Value of the additional information - example: some value + deliveryEvents: + items: + $ref: '#/components/schemas/DeliveryEvent' + type: array required: - - additionalInformationRef - ServiceJobLineItem: - allOf: - - $ref: '#/components/schemas/ServiceJobLineItemForCreation' - additionalProperties: false - type: object + - facilityRef + - deliveryEvents + DeliveryEvent: properties: - id: + deliveryTarget: + $ref: '#/components/schemas/DeliveryTarget' + deliveryTrigger: + enum: + - DEFAULT type: string required: - - id - ServiceJobLineItemArticle: - allOf: - - $ref: '#/components/schemas/AbstractArticle' - - properties: - attributes: - items: - $ref: '#/components/schemas/ArticleAttributeItem' - type: array - type: object - required: - - title - - tenantArticleId - xml: - name: ServiceLineItemArticle - ServiceJob: - allOf: - - $ref: '#/components/schemas/VersionedResource' - additionalProperties: false + - deliveryTarget + - deliveryTrigger + DeliveryEventTargetAddress: + type: object properties: - operativeProcessRef: - type: string - id: - type: string - name: - type: string - description: - type: string - lineItems: - type: array - minLength: 1 - items: - $ref: '#/components/schemas/ServiceJobLineItem' - processRef: - type: string facilityRef: type: string - status: - $ref: '#/components/schemas/ServiceJobStatus' - nameLocalized: - $ref: '#/components/schemas/LocaleString' - descriptionLocalized: - $ref: '#/components/schemas/LocaleString' - executionTimeInMin: - type: integer - itemsReturnable: + targetAddress: + $ref: '#/components/schemas/TargetAddress' + deliveryEvent: + $ref: '#/components/schemas/DeliveryEvent' + required: + - facilityRef + - targetAddress + - deliveryEvent + RoutingPlan: + allOf: + - $ref: '#/components/schemas/VersionedResource' + properties: + transfers: + items: + $ref: '#/components/schemas/Transfer' + type: array + expectedLineItems: + items: + $ref: '#/components/schemas/ExpectedLineItem' + type: array + deliveryPreferences: + $ref: '#/components/schemas/DeliveryPreferences' + anonymized: + description: Indicates if gdpr related data was anonymized + example: false type: boolean - itemsRequired: - $ref: '#/components/schemas/ItemsRequiredEnum' - shortId: - type: string - example: KD-12-1 - additionalInformation: + decisionLogs: + items: + $ref: '#/components/schemas/DecisionLogRef' type: array + facilityBlackList: items: - $ref: '#/components/schemas/ServiceJobAdditionalInformation' - customAttributes: + description: Contains a list of facilities to ignore when rerouting happens. + type: string + type: array + facilityRef: description: >- - Attributes that can be added to the service job. These attributes - cannot be used within fulfillment processes, but it could be useful - to have the information carried here. - type: object - targetTime: - description: At which time the service job is expected to be finished. - example: '2020-02-03T09:45:51.525Z' - format: date-time + The id of the facility reference. The given ID has to be present in + the system. + example: Esb20gpHBL94X5NdMp3C type: string - customServiceRef: + finalizeRun: + description: The iteration through the finalizer process + example: 5 + minimum: 0 + type: number + firstRoutingAttempt: + description: The date of the first routing attempt. + example: '2020-02-03T08:45:50.525Z' + format: date-time type: string - description: Id of the customService this ServiceJob was created from. - example: 41d43211-g5a1-gg22-a716-ba095e30ds1d - linkedServiceJobsRef: + id: type: string - description: ID of the Linked Service Job, the Service Job should reference. - example: 41d43211-g5a1-gg22-a716-ba095e30ds1d - tenantOrderId: - description: ID of the tenant order, the linked service jobs are part of + orderDate: + description: The date this order was created at the supplying system. + example: '2020-02-03T08:45:50.525Z' + format: date-time type: string - example: ocff-order-100 - inheritedLineItems: - type: array + orderLineItems: items: - $ref: '#/components/schemas/InheritedServiceJobLineItem' + $ref: '#/components/schemas/RoutingPlanLineItem' + type: array + orderRef: description: >- - Line items that are inherited from a preceding service job in a - linked service job - required: - - id - - lineItems - - processRef - - status - - nameLocalized - - itemsRequired - - facilityRef - - targetTime - - customServiceRef - ServiceJobForCreation: - properties: - operativeProcessRef: + The id of the order that lead to the creation of this pickjob. Can + be empty / not present when the pickjob was created without having + an order. + example: LGMl2DuvPnfPoSHhYFOm type: string - customServiceRef: + parentRoutingPlanRef: type: string - description: ID of the Custom Service, the Service Job should reference. - example: 41d43211-g5a1-gg22-a716-ba095e30ds1d - processRef: + childRoutingPlanRef: type: string - description: ID of the Process, the Service Job belongs to. - example: 550e8400-e29b-41d4-a716-446655440000 - facilityRef: + pickJobRef: + description: The id of the pickjob that has been created from the routing plan. + example: Esb20gpHBL94X5NdMp3C type: string - description: ID of the Facility, the Service Job is executed in. - example: ba095e30-879f-11ee-b9d1-0242ac120002 - shortId: + priority: + description: priority of return plan + minimum: 0 + type: number + reRouteReason: + $ref: '#/components/schemas/RerouteReason' + rerouteDescription: + $ref: '#/components/schemas/RerouteDescription' + reRoutedFacilityRef: + description: The id of the facility the order was rerouted from. + example: 1DEYZgmfAcXRVYv6KEka36 type: string - example: KD-12-1 - lineItems: + reRoutedPickJobRef: + description: The id of the original pickjob that was rerouted. + example: Eghhj20878dhbd989NdMp3C + type: string + reRoutedRoutingPlanRef: + description: The id of the original routingplan that was rerouted. + example: Eghhj20878dhbd989NdMp3C + type: string + routingRun: + description: The iteration through the routing process + type: number + runType: + description: The rule type of a decision log entry + enum: + - DEFAULT + - REROUTE + - ORDERSPLIT_ON_SHORTPICK + - MANUAL_ASSIGNMENT + - PROCESS_MANUALASSIGNMENT + - REACTIVATION + type: string + splitCount: + default: 0 + description: >- + The number of order splits that happened before this routingplan was + created + example: 5 + minimum: 0 + type: number + status: + $ref: '#/components/schemas/RoutingPlanStatus' + statusHistory: + deprecated: true + description: >- +
+
This endpoint is deprecated and has been replaced.

@deprecated + For more detailed information, use the History field. Saves all status changes when creating or updating a routing plan type: array items: - $ref: '#/components/schemas/ServiceJobLineItemForCreation' - additionalInformation: + $ref: '#/components/schemas/RoutingPlanStatus' + history: type: array items: - $ref: '#/components/schemas/ServiceJobAdditionalInformationForCreation' - customAttributes: + $ref: '#/components/schemas/RoutingPlanHistory' + statusReasons: + type: array + items: + $ref: '#/components/schemas/RoutingPlanStatusReason' + consolidatedStatus: + $ref: '#/components/schemas/ConsolidatedRoutingPlanStatus' + targetAddress: + $ref: '#/components/schemas/TargetAddress' + targetAddressesByDeliveryEvent: + type: array + items: + $ref: '#/components/schemas/DeliveryEventTargetAddress' + processId: description: >- - Attributes that can be added to the service job. These attributes - cannot be used within fulfillment processes, but it could be useful - to have the information carried here. - type: object - targetTime: - description: At which time the service job is expected to be finished. - example: '2020-02-03T09:45:51.525Z' - format: date-time - type: string - tenantOrderId: - description: ID of the tenant order, the linked service jobs are part of + Id of the global process related to this entity. For example used + for starting the GDPR process and others. type: string - example: ocff-order-100 - serviceJobLinkRef: + targetTimeBaseDate: + description: This date is used as base/start to calculate the target time date. + example: '2020-02-03T08:45:50.525Z' + format: date-time type: string - description: ID of the Service Job Link, the Service Job should reference. - example: 41d43211-g5a1-gg22-a716-ba095e30ds1d - required: - - customServiceRef - - facilityRef - - targetTime - ServiceJobWithSearchPaths: - allOf: - - $ref: '#/components/schemas/ServiceJob' - additionalProperties: false - properties: - searchPaths: + customServices: type: array + minItems: 1 items: - type: string - required: - - searchPaths - ServiceJobs: - properties: - serviceJobs: - items: - $ref: '#/components/schemas/ServiceJobWithSearchPaths' - type: array - total: - description: Total number of found entities for this query - example: 42 - type: integer - type: object - ServiceJobOrderBy: - description: Attribute to order service job by - enum: - - TARGET_TIME_ASC - - TARGET_TIME_DESC - - LAST_MODIFIED_ASC - - LAST_MODIFIED_DESC - type: string - xml: - name: ServiceJobOrderBy - ServiceJobFilterChannel: - enum: - - COLLECT - - SHIPPING - type: string - xml: - name: ServiceJobFilterChannel - ServiceJobInProgressActionParameter: - additionalProperties: false - properties: - name: - $ref: '#/components/schemas/ServiceJobInProgressActionEnum' - version: - description: Version of the entity to be changed - minimum: 0 - type: integer - required: - - name - - version - ServiceJobObsoleteActionParameter: - additionalProperties: false - properties: - name: - $ref: '#/components/schemas/ServiceJobObsoleteActionEnum' - version: - description: Version of the entity to be changed - minimum: 0 - type: integer - required: - - name - - version - ServiceJobOpenActionParameter: - additionalProperties: false - properties: - name: - $ref: '#/components/schemas/ServiceJobOpenActionEnum' - version: - description: Version of the entity to be changed - minimum: 0 - type: integer - required: - - name - - version - ServiceJobInProgressActionEnum: - enum: - - StartServiceJob - type: string - ServiceJobFinishedActionParameter: - additionalProperties: false - properties: - name: - $ref: '#/components/schemas/ServiceJobFinishedActionEnum' - version: - description: Version of the entity to be changed - minimum: 0 - type: integer - required: - - name - - version - ServiceJobFinishedActionEnum: - enum: - - FinishServiceJob - type: string - ServiceJobOpenActionEnum: - enum: - - OpenServiceJob - type: string - ServiceJobObsoleteActionEnum: - enum: - - ObsoleteServiceJob - type: string - ServiceJobCancelledActionParameter: - additionalProperties: false - properties: - name: - $ref: '#/components/schemas/ServiceJobCancelledActionEnum' - version: - description: Version of the entity to be changed - minimum: 0 - type: integer + $ref: '#/components/schemas/CustomServiceReference' + provisioningTime: + description: The point in time by which the order is supposed to be provisioned. + example: '2020-02-03T08:45:50.525Z' + format: date-time + type: string required: - - name + - id + - orderDate + - created + - lastModified - version - ServiceJobCancelledActionEnum: - enum: - - CancelServiceJob - type: string - ServiceJobWaitingForInputActionParameter: - additionalProperties: false + - orderRef + - priority + - status + - consolidatedStatus + - decisionLogs + - routingRun + - finalizeRun + - processId + type: object + Transfer: properties: - name: - $ref: '#/components/schemas/ServiceJobWaitingForInputActionEnum' - version: - description: Version of the entity to be changed - minimum: 0 - type: integer + transferId: + type: string + transferType: + type: string + enum: + - SUPPLIER + - RECEIVER required: - - name - - version - ServiceJobWaitingForInputActionEnum: - enum: - - HoldServiceJob - type: string - ServiceJobActionsParameter: - anyOf: - - $ref: '#/components/schemas/ServiceJobInProgressActionParameter' - - $ref: '#/components/schemas/ServiceJobFinishedActionParameter' - - $ref: '#/components/schemas/ServiceJobCancelledActionParameter' - - $ref: '#/components/schemas/ServiceJobWaitingForInputActionParameter' - - $ref: '#/components/schemas/ServiceJobObsoleteActionParameter' - - $ref: '#/components/schemas/ServiceJobOpenActionParameter' - FacilityCustomServiceConnectionStatus: - type: string - enum: - - ACTIVE - - INACTIVE - FacilityCustomServiceConnection: + - transferId + - transferType + ExpectedLineItem: allOf: - - $ref: '#/components/schemas/VersionedResource' - additionalProperties: false + - $ref: '#/components/schemas/OrderLineItem' properties: - id: + transferId: type: string - status: - $ref: '#/components/schemas/FacilityCustomServiceConnectionStatus' facilityRef: type: string - customServiceRef: - type: string - executionTimeInMin: - type: integer required: - - id - - status - facilityRef - - customServiceRef - FacilityCustomServiceConnectionForUpdate: - additionalProperties: false - properties: - status: - $ref: '#/components/schemas/FacilityCustomServiceConnectionStatus' - executionTimeInMin: - type: integer - description: Time in minutes the custom service takes to be executed - example: 100 - version: - description: Version of the documentSet you want to update a document of - example: 42 - format: int64 - type: integer - required: - - version - FacilityCustomServiceConnectionForCreation: - additionalProperties: false + - transferId + RoutingPlanStatusReason: + anyOf: + - $ref: '#/components/schemas/RoutingPlanObsoleteStatusReason' + RoutingPlanObsoleteStatusReason: properties: - executionTimeInMin: - type: integer - description: Time in minutes the custom service takes to be executed - example: 100 + reason: + type: string + enum: + - REROUTE_AFTER_SHORTPICK + - MANUALLY_REROUTED + - MANUALLY_ASSIGNED status: - $ref: '#/components/schemas/FacilityCustomServiceConnectionStatus' + type: string + enum: + - OBSOLETE required: + - reason - status - StrippedFacilityCustomServiceConnections: - additionalProperties: false - properties: - facilityCustomServiceConnections: - items: - $ref: '#/components/schemas/FacilityCustomServiceConnection' - type: array - total: - description: Total number of found entities for this query - example: 42 - type: integer - type: object - LinkedServiceJobs: - additionalProperties: false - allOf: - - $ref: '#/components/schemas/VersionedResource' + CollectDelivery: properties: - id: - example: 9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1 - type: string - processRef: - description: >- - ProcessRef of the added ServiceJobs. All Service Jobs need to be - part of the same process - example: 9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1 - type: string facilityRef: - description: Id linked Facility from the includes service jobs - type: string - example: cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05 - targetTime: + description: >- + Reference to the facility where the consumer expects to collect the + items type: string - format: date-time - includedServiceJobLinkIds: - description: searchable field of all included service job link ids - items: - type: string - example: cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05 - type: array - minItems: 1 - includedServiceJobRefs: - description: searchable field of all included service job ids + paid: + default: false + description: Indicates if the order is already paid. + type: boolean + supplyingFacilities: + description: DEPRECATED items: + description: Reference of a Facility + example: 928f3730-bc48-4d85-b83f-3fd86b776178 type: string - example: cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05 - type: array - minItems: 1 - status: - $ref: '#/components/schemas/LinkedServiceJobsStatus' - serviceJobLinks: - items: - $ref: '#/components/schemas/ServiceJobLink' type: array - minItems: 1 - fullIdentifier: - type: string + supplyingFacilitiesConfigurations: description: >- - Full identifier of the service job. Using the full name of the - customer when created from an order. - example: 240429_lorem-42 - required: - - id - - serviceJobLinks - - processRef - - facilityRef - - includedServiceJobLinkIds - - includedServiceJobRefs - - status - - targetTime - LinkedServiceJobsStatus: - type: string - enum: - - OPEN - - IN_PROGRESS - - FINISHED - - CANCELLED - - OBSOLETE - LinkedServiceJobsForCreation: - additionalProperties: false - properties: - serviceJobLinks: + References of facility that could supply contents of the order to + another facility with specific configuration of its usage items: - $ref: '#/components/schemas/ServiceJobLinkForCreation' + $ref: '#/components/schemas/SupplyingFacilityConfiguration' type: array - minItems: 1 - fullIdentifier: + provisioningTime: + description: The point in time by which the order is supposed to be provisioned. + example: '2020-02-03T08:45:50.525Z' + format: date-time type: string - description: >- - Full identifier of the service job. Using the full name of the - customer when created from an order. - example: 240429_lorem-42 required: - - serviceJobLinks - ServiceJobLinkForCreation: + - facilityRef + type: object + PreferredCarrier: + description: Keys of the preferred carriers to handle out the order + type: string + PreferredCarrierWithProduct: additionalProperties: false properties: - serviceJobRef: + carrierKey: type: string - example: 0ed803c2-fa20-48d9-9c1b-0d243937a9ad - previousServiceJobRefs: - items: - type: string - example: 9f197dbf-c724-469b-90f1-dc94f20b2825 + example: DPD + carrierProduct: + type: string + example: WORLDWIDE + carrierServices: type: array - maxItems: 1 - minItems: 0 - nextServiceJobLinks: items: - $ref: '#/components/schemas/ServiceJobLinkForCreation' - type: array - minItems: 0 + $ref: '#/components/schemas/CarrierServices' required: - - serviceJobRef - - previousServiceJobRefs - - nextServiceJobLinks - ServiceJobLinkForAdding: - additionalProperties: false + - carrierKey + DeliveryReservationMode: + enum: + - SCHEDULED + - ASAP + DeliveryReservationPreferences: properties: - serviceJobRef: + mode: + $ref: '#/components/schemas/DeliveryReservationMode' + reservationTime: + example: '2020-02-03T09:45:51.525Z' + format: date-time type: string - example: 0ed803c2-fa20-48d9-9c1b-0d243937a9ad + type: object required: - - serviceJobRef - ServiceJobLink: - additionalProperties: false + - mode + DeliveryPreferences: properties: - id: - type: string - example: 0ed803c2-fa20-48d9-9c1b-0d243937a9ad - serviceJobRef: - type: string - example: 0ed803c2-fa20-48d9-9c1b-0d243937a9ad - previousServiceJobRefs: + collect: items: - type: string - example: 9f197dbf-c724-469b-90f1-dc94f20b2825 - type: array + $ref: '#/components/schemas/CollectDelivery' maxItems: 1 - minItems: 0 - previousServiceJobLinkRefs: - description: id of the created previous service job links - items: - type: string - example: 9f197dbf-c724-469b-90f1-dc94f20b2825 type: array - maxItems: 1 - minItems: 0 - nextServiceJobLinks: + shipping: + properties: + preferredCarriers: + items: + $ref: '#/components/schemas/PreferredCarrier' + type: array + preferredCarriersWithProduct: + items: + $ref: '#/components/schemas/PreferredCarrierWithProduct' + type: array + preselectedFacilities: + items: + $ref: '#/components/schemas/PreselectedFacility' + type: array + serviceLevel: + description: >- + DELIVERY: The parcel will reach the recipient according to the + cycle time of the carrier, typically 1-3 days when shipping + nationaly. SAMEDAY: The parcel will reach the recipient the same + day when ordering. + enum: + - DELIVERY + - SAMEDAY + type: string + carrierProductCategory: + $ref: '#/components/schemas/CarrierProductCategory' + desiredDeliveryTime: + example: '2020-02-03T09:45:51.525Z' + format: date-time + type: string + type: object + supplyingFacilities: + description: '@deprecated Use supplyingFacilities under collect' items: - $ref: '#/components/schemas/ServiceJobLink' + description: Reference of a Facility + example: 928f3730-bc48-4d85-b83f-3fd86b776178 + type: string type: array - minItems: 0 - required: - - id - - serviceJobRef - - previousServiceJobRefs - - previousServiceJobLinkRefs - - nextServiceJobLinks - InheritedServiceJobLineItem: + targetTime: + description: At which time the result is expected. + example: '2020-02-03T09:45:51.525Z' + format: date-time + type: string + reservationPreferences: + $ref: '#/components/schemas/DeliveryReservationPreferences' + type: object + ArticleItem: additionalProperties: false properties: - id: + tenantArticleRef: type: string quantity: - type: integer - description: Quantity of the items - example: 12 minimum: 1 - scannableCodes: - items: - type: string - description: Codes, that identify the article - example: '4012345678901' - type: array - article: - $ref: '#/components/schemas/ServiceJobLineItemArticle' - serviceJobRef: - type: string + type: number + type: object required: - - id - quantity - - article - - serviceJobRef - LinkedServiceJobsWithSearchPaths: + - tenantArticleRef + OrderActionsParameter: + oneOf: + - $ref: '#/components/schemas/OrderUnlockActionParameter' + - $ref: '#/components/schemas/OrderCancelActionParameter' + - $ref: '#/components/schemas/PromiseConfirmActionParameter' + - $ref: '#/components/schemas/PromiseExtendActionParameter' + - $ref: '#/components/schemas/OrderConsumerAddressChangeActionParameter' + - $ref: '#/components/schemas/OrderConsumerAddressesReplaceActionParameter' + AbstractOrderActionsParameter: + discriminator: + propertyName: name + properties: + name: + type: string + version: + description: Version of the entity to be changed + minimum: 0 + type: integer + required: + - name + - version + OrderUnlockActionParameter: allOf: - - $ref: '#/components/schemas/LinkedServiceJobs' - additionalProperties: false + - $ref: '#/components/schemas/AbstractOrderActionsParameter' properties: - searchPaths: - type: array - items: - type: string + name: + enum: + - UNLOCK + type: string required: - - searchPaths - LinkedServiceJobsPaginatedResult: - additionalProperties: false - type: object + - name + - version + OrderCancelActionParameter: + allOf: + - $ref: '#/components/schemas/AbstractOrderActionsParameter' properties: - total: - type: object - minimum: 0 - linkedServiceJobs: + cancelationReasonId: + description: ID of the cancelation reason + type: string + name: + enum: + - CANCEL + type: string + required: + - name + - version + OrderConsumerAddressChangeActionParameter: + allOf: + - $ref: '#/components/schemas/AbstractOrderActionsParameter' + properties: + name: + enum: + - CHANGE_CONSUMER_ADDRESS + type: string + consumerAddress: + $ref: '#/components/schemas/ConsumerAddress' + addressType: + $ref: '#/components/schemas/AddressType' + required: + - name + - version + - consumerAddress + - addressType + OrderConsumerAddressesReplaceActionParameter: + allOf: + - $ref: '#/components/schemas/AbstractOrderActionsParameter' + properties: + name: + enum: + - REPLACE_CONSUMER_ADDRESSES + type: string + consumerAddresses: type: array items: - $ref: '#/components/schemas/LinkedServiceJobsWithSearchPaths' + $ref: '#/components/schemas/ConsumerAddress' required: - - total - - linkedServiceJobs - LinkedServiceJobsOrderBy: - description: Attribute to order linked service jobs by - enum: - - LAST_MODIFIED_ASC - - LAST_MODIFIED_DESC - - TARGET_TIME_ASC - - TARGET_TIME_DESC - type: string - xml: - name: LinkedServiceJobsOrderBy - LinkedServiceJobsFilterChannel: - enum: - - COLLECT - - SHIPPING - type: string - xml: - name: LinkedServiceJobsFilterChannel - HealthResult: + - name + - version + - consumerAddresses + PromiseConfirmActionParameter: + allOf: + - $ref: '#/components/schemas/AbstractOrderActionsParameter' properties: - status: - $ref: '#/components/schemas/HealthStatus' - dependencies: - items: - $ref: '#/components/schemas/HealthDependencyStatus' - type: array - minItems: 1 - type: object + name: + enum: + - CONFIRM_PROMISE + type: string required: - - status - - dependencies - HealthDependencyStatus: + - name + - version + PromiseExtendActionParameter: + allOf: + - $ref: '#/components/schemas/AbstractOrderActionsParameter' properties: name: - example: database - description: Name of the component that is checked to be healthy + enum: + - EXTEND_PROMISE type: string - status: - $ref: '#/components/schemas/HealthStatus' - type: object required: - name - - status - HealthStatus: - enum: - - UP - - DOWN - type: string - CurrencyCode: - type: string + - version + ManualRerouteConfiguration: + deprecated: true description: >- - The currency code is a three-letter code that represents a currency in - the ISO 4217 standard. - enum: - - AED - - AFN - - ALL - - AMD - - ANG - - AOA - - ARS - - AUD - - AWG - - AZN - - BAM - - BBD - - BDT - - BGN - - BHD - - BIF - - BMD - - BND - - BOB - - BOV - - BRL - - BSD - - BTN - - BWP - - BYN - - BZD - - CAD - - CDF - - CHE - - CHF - - CHW - - CLF - - CLP - - CNY - - COP - - COU - - CRC - - CUC - - CUP - - CVE - - CZK - - DJF - - DKK - - DOP - - DZD - - EGP - - ERN - - ETB - - EUR - - FJD - - FKP - - GBP - - GEL - - GHS - - GIP - - GMD - - GNF - - GTQ - - GYD - - HKD - - HNL - - HTG - - HUF - - IDR - - ILS - - INR - - IQD - - IRR - - ISK - - JMD - - JOD - - JPY - - KES - - KGS - - KHR - - KMF - - KPW - - KRW - - KWD - - KYD - - KZT - - LAK - - LBP - - LKR - - LRD - - LSL - - LYD - - MAD - - MDL - - MGA - - MKD - - MMK - - MNT - - MOP - - MRU - - MUR - - MVR - - MWK - - MXN - - MXV - - MYR - - MZN - - NAD - - NGN - - NIO - - NOK - - NPR - - NZD - - OMR - - PAB - - PEN - - PGK - - PHP - - PKR - - PLN - - PYG - - QAR - - RON - - RSD - - RUB - - RWF - - SAR - - SBD - - SCR - - SDG - - SEK - - SGD - - SHP - - SLE - - SOS - - SRD - - SSP - - STN - - SVC - - SYP - - SZL - - THB - - TJS - - TMT - - TND - - TOP - - TRY - - TTD - - TWD - - TZS - - UAH - - UGX - - USD - - USN - - UYI - - UYU - - UYW - - UZS - - VED - - VES - - VND - - VUV - - WST - - XAF - - XAG - - XAU - - XBA - - XBB - - XBC - - XBD - - XCD - - XDR - - XOF - - XPD - - XPF - - XPT - - XSU - - XTS - - XUA - - XXX - - YER - - ZAR - - ZMW - - ZWL + @deprecated This config property is deprecated since 26/02/24. Use + GlobalManualRerouteConfiguration instead. + allOf: + - $ref: '#/components/schemas/VersionedResource' + properties: + active: + type: boolean + id: + type: string + required: + - active + type: object + RerouteTimeTriggeredConfiguration: + allOf: + - $ref: '#/components/schemas/VersionedResource' + required: + - clickAndCollectReroute + - shipFromStoreDeliveryReroute + - shipFromStoreSamedayReroute + properties: + clickAndCollectReroute: + $ref: '#/components/schemas/RerouteConfiguration' + shipFromStoreDeliveryReroute: + $ref: '#/components/schemas/RerouteConfiguration' + shipFromStoreSamedayReroute: + $ref: '#/components/schemas/RerouteConfiguration' + id: + type: string + PromisesConfiguration: + allOf: + - $ref: '#/components/schemas/VersionedResource' + required: + - invalidAfterTime + properties: + invalidAfterTime: + default: PT8H + description: >- + Default amount of time in ISO 8601 duration format after which an + promised order becomes invalid and is cancelled. The duration need + to be a multiple of 60 seconds. + type: string + pattern: ^P(?:(\d+W)|(\d+Y)?(\d+M)?(\d+D)?(?:T(\d+H)?(\d+M)?(\d+S)?)?)$ + id: + type: string + CapacityPlanningTimeframeConfiguration: + allOf: + - $ref: '#/components/schemas/VersionedResource' + properties: + days: + default: 100 + description: >- + The range in days per facility which defines how many days in the + future the capacity of the facility can be planned + example: '240' + minimum: 1 + type: integer + id: + type: string + required: + - days + type: object + RerouteConfiguration: + required: + - active + - rerouteTargetTimeHours + - rerouteAfterMinutes + properties: + active: + type: boolean + rerouteTargetTimeHours: + type: number + example: '48' + default: 48 + minimum: 1 + description: >- + Only pickjobs within the target time window are considered for + reroute. + rerouteAfterMinutes: + type: number + example: '60' + default: 1440 + minimum: 5 + description: The amount of minutes after which an automated reroute is executed + CancelationReasonForCreation: + allOf: + - $ref: '#/components/schemas/AbstractReasonForCreation' + type: object + xml: + name: CancelationReasonForCreation + CancelationReason: + allOf: + - $ref: '#/components/schemas/AbstractReason' + properties: + action: + enum: + - CANCELATION + type: string + required: + - action + type: object + xml: + name: CancelationReason + CancelationReasons: + allOf: + - $ref: '#/components/schemas/AbstractReasons' + properties: + reasons: + items: + $ref: '#/components/schemas/CancelationReason' + type: array + required: + - reasons + type: object + xml: + name: CancelationReasons + CancelationReasonForModification: + allOf: + - $ref: '#/components/schemas/AbstractReasonForModification' + type: object + xml: + name: CancelationReasonForModification + RerouteDescriptionForCreation: + allOf: + - $ref: '#/components/schemas/AbstractReasonForCreation' + type: object + xml: + name: RerouteDescriptionForCreation + RerouteDescriptionForModification: + allOf: + - $ref: '#/components/schemas/AbstractReasonForModification' + type: object + xml: + name: RerouteDescriptionForModification + RerouteDescription: + allOf: + - $ref: '#/components/schemas/AbstractReason' + properties: + action: + enum: + - REROUTE + type: string + required: + - action + type: object + xml: + name: RerouteDescription + RerouteDescriptions: + allOf: + - $ref: '#/components/schemas/AbstractReasons' + properties: + rerouteDescriptions: + items: + $ref: '#/components/schemas/RerouteDescription' + type: array + reasons: + items: + $ref: '#/components/schemas/RerouteDescription' + type: array + required: + - reasons + - rerouteDescriptions + type: object + CheckoutOptionsDeliveryTimePointRequest: + properties: + desiredDeliveryDate: + type: string + example: '2024-06-03T00:00:00.000Z' + format: date-time + description: The desired delivery date. (timestamp of the request) + tenantArticleIds: + type: array + items: + type: string + description: >- + The tenant articleIds for which the check is performed. The + provided items are considered individually. + example: DE-ZGT-4711 + minLength: 1 + maxLength: 50 + facilities: + description: Pair of facilityRef and latestPickingStart values + type: array + minLength: 1 + maxLength: 5 + items: + $ref: '#/components/schemas/FacilityRefLatestPickingStartPair' + required: + - facilities + - tenantArticleIds + - desiredDeliveryDate + CheckoutOptionsDeliveryTimePointResponse: + properties: + items: + type: array + items: + $ref: '#/components/schemas/CheckoutOptionsDeliveryTimePointResponseItem' + required: + - items + CheckoutOptionsDeliveryTimePointResponseItem: + properties: + tenantArticleId: + type: string + example: DE-ZGT-4711 + available: + type: number + example: 4 + facilityRef: + type: string + required: + - tenantArticleId + - available + - facilityRef + FacilityRefLatestPickingStartPair: + properties: + facilityRef: + type: string + latestPickingStart: + example: '2020-02-03T09:45:51.525Z' + format: date-time + type: string + required: + - facilityRef + - latestPickingStart InventoryArticle: type: object properties: attributes: type: array items: - $ref: '#/components/schemas/ArticleAttributeItem' + $ref: '#/components/schemas/ListingAttributeItem' imageUrl: type: string tenantArticleId: type: string title: type: string + titleLocalized: + $ref: '#/components/schemas/LocaleString' required: - imageUrl - tenantArticleId @@ -36286,6 +38757,378 @@ components: - upperBounds - period - point + RequestedDate: + type: object + properties: + type: + type: string + enum: + - ASAP + - TIME_POINT + value: + format: date-time + type: string + required: + - type + - value + Quantity: + type: object + properties: + unit: + type: string + value: + type: integer + minimum: 0 + format: int32 + required: + - value + InboundLineItem: + type: object + properties: + tenantArticleId: + type: string + quantity: + $ref: '#/components/schemas/Quantity' + stockProperties: + additionalProperties: + type: string + allOf: + - $ref: '#/components/schemas/StockPropertyPreset' + required: + - tenantArticleId + - quantity + PurchaseOrderSupplier: + type: object + properties: + name: + type: string + facilityRef: + type: string + InboundProcessPurchaseOrder: + type: object + properties: + id: + type: string + created: + format: date-time + type: string + lastModified: + format: date-time + type: string + orderDate: + type: string + format: date-time + requestedDate: + $ref: '#/components/schemas/RequestedDate' + requestedItems: + type: array + items: + $ref: '#/components/schemas/InboundLineItem' + status: + type: string + enum: + - OPEN + cancelled: + type: boolean + supplier: + $ref: '#/components/schemas/InboundProcessPurchaseOrderSupplier' + transfer: + $ref: '#/components/schemas/InboundProcessPurchaseOrderTransfer' + customAttributes: + type: object + nullable: true + description: >- + Attributes that can be added to this entity. These attributes + **cannot** be used within fulfillment processes, but enable you to + attach custom data from your systems to fulfillmenttools entities. + required: + - id + - created + - lastModified + - orderDate + - requestedDate + - requestedItems + - status + - cancelled + InboundReceipt: + type: object + properties: + asnRef: + type: string + receivedDate: + format: date-time + type: string + receivedItems: + maxItems: 200 + type: array + items: + $ref: '#/components/schemas/InboundReceiptLineItem' + comments: + maxItems: 20 + type: array + items: + $ref: '#/components/schemas/InboundReceiptComment' + status: + type: string + enum: + - IN_PROGRESS + - FINISHED + customAttributes: + type: object + nullable: true + description: >- + Attributes that can be added to this entity. These attributes + **cannot** be used within fulfillment processes, but enable you to + attach custom data from your systems to fulfillmenttools entities. + id: + type: string + required: + - receivedDate + - receivedItems + - comments + - id + InboundDeliveryReceivedPayload: + type: object + properties: + inboundProcessRef: + type: string + tenantInboundProcessRef: + type: string + purchaseOrder: + $ref: '#/components/schemas/InboundProcessPurchaseOrder' + facilityRef: + type: string + status: + type: string + enum: + - OPEN + - PARTIAL_DELIVERY + - ON_HOLD + - CLOSED + onHold: + type: boolean + receipt: + $ref: '#/components/schemas/InboundReceipt' + required: + - inboundProcessRef + - facilityRef + - status + - onHold + - receipt + InboundDeliveryFinishedPayload: + type: object + properties: + inboundProcessRef: + type: string + tenantInboundProcessRef: + type: string + purchaseOrder: + $ref: '#/components/schemas/InboundProcessPurchaseOrder' + facilityRef: + type: string + status: + type: string + enum: + - OPEN + - PARTIAL_DELIVERY + - ON_HOLD + - CLOSED + onHold: + type: boolean + receipts: + type: array + items: + $ref: '#/components/schemas/InboundReceipt' + required: + - inboundProcessRef + - facilityRef + - status + - onHold + - receipts + InboundDeliveryOnHoldPayload: + type: object + properties: + inboundProcessRef: + type: string + tenantInboundProcessRef: + type: string + purchaseOrder: + $ref: '#/components/schemas/InboundProcessPurchaseOrder' + facilityRef: + type: string + status: + type: string + enum: + - OPEN + - PARTIAL_DELIVERY + - ON_HOLD + - CLOSED + onHold: + type: boolean + required: + - inboundProcessRef + - facilityRef + - status + - onHold + InboundDeliveryReleasedPayload: + type: object + properties: + inboundProcessRef: + type: string + tenantInboundProcessRef: + type: string + purchaseOrder: + $ref: '#/components/schemas/InboundProcessPurchaseOrder' + facilityRef: + type: string + status: + type: string + enum: + - OPEN + - PARTIAL_DELIVERY + - ON_HOLD + - CLOSED + onHold: + type: boolean + required: + - inboundProcessRef + - facilityRef + - status + - onHold + InventoryFacilityStockShapeByTrait: + type: object + properties: + PICKABLE: + type: number + ACCESSIBLE: + type: number + required: + - PICKABLE + - ACCESSIBLE + InventoryFacilityStockDeltaShape: + type: object + properties: + totalAmount: + type: number + reserved: + type: number + safetyStock: + type: number + available: + type: number + deprecated: true + byTrait: + $ref: '#/components/schemas/InventoryFacilityStockShapeByTrait' + availableToPromise: + type: number + deprecated: true + readyToPick: + type: number + deprecated: true + availableForPicking: + type: number + stockCount: + type: number + availableOnStock: + type: number + stockOnHand: + type: number + required: + - totalAmount + - reserved + - safetyStock + - available + - byTrait + - availableToPromise + - readyToPick + - availableForPicking + - stockCount + - availableOnStock + - stockOnHand + InventoryFacilityStockStaleReason: + type: object + properties: + timestamp: + format: date-time + type: string + reasons: + type: array + items: + type: string + required: + - timestamp + - reasons + InventoryFacilityStockShape: + type: object + properties: + facilityRef: + type: string + tenantArticleId: + type: string + totalAmount: + type: number + reserved: + type: number + safetyStock: + type: number + available: + type: number + deprecated: true + description: >- + This field is deprecated and replaced by new availability concepts. + Please see + https://docs.fulfillmenttools.com/api-docs/use-cases/inventory-management/global-inventory/availability + for more information. + byTrait: + $ref: '#/components/schemas/InventoryFacilityStockShapeByTrait' + changeReason: + type: string + enum: + - UNKNOWN + availableToPromise: + type: number + deprecated: true + description: >- + This field is deprecated and replaced by new availability concepts. + Please see + https://docs.fulfillmenttools.com/api-docs/use-cases/inventory-management/global-inventory/availability + for more information. + readyToPick: + type: number + deprecated: true + description: >- + This field is deprecated and replaced by new availability concepts. + Please see + https://docs.fulfillmenttools.com/api-docs/use-cases/inventory-management/global-inventory/availability + for more information. + availableForPicking: + type: number + delta: + $ref: '#/components/schemas/InventoryFacilityStockDeltaShape' + staleReasons: + type: array + items: + $ref: '#/components/schemas/InventoryFacilityStockStaleReason' + stockOnHand: + type: number + availableOnStock: + type: number + required: + - facilityRef + - tenantArticleId + - totalAmount + - reserved + - safetyStock + - available + - byTrait + - changeReason + - availableToPromise + - readyToPick + - availableForPicking + - delta + - staleReasons + - stockOnHand + - availableOnStock RequestedDateASAP: type: object properties: @@ -36310,376 +39153,25 @@ components: required: - type - value - Quantity: + StockPropertyPreset: type: object properties: - unit: + expiry: type: string - value: - type: integer - minimum: 0 - format: int32 - required: - - value - InboundLineItem: - type: object - properties: - tenantArticleId: + batch: type: string - quantity: - $ref: '#/components/schemas/Quantity' - required: - - tenantArticleId - - quantity - PurchaseOrderSupplier: + InboundProcessPurchaseOrderSupplier: type: object properties: name: type: string - facilityRef: - type: string - InboundProcessPurchaseOrder: - type: object - properties: - id: - type: string - created: - format: date-time - type: string - lastModified: - format: date-time - type: string - orderDate: - type: string - format: date-time - requestedDate: - $ref: '#/components/schemas/RequestedDate' - requestedItems: - type: array - items: - $ref: '#/components/schemas/InboundLineItem' - status: - type: string - enum: - - OPEN - cancelled: - type: boolean - supplier: - $ref: '#/components/schemas/InboundProcessPurchaseOrderSupplier' - customAttributes: - type: object - nullable: true - description: >- - Attributes that can be added to this entity. These attributes - **cannot** be used within fulfillment processes, but enable you to - attach custom data from your systems to fulfillmenttools entities. - required: - - id - - created - - lastModified - - orderDate - - requestedDate - - requestedItems - - status - - cancelled - InboundReceipt: + InboundProcessPurchaseOrderTransfer: type: object properties: - asnRef: - type: string - receivedDate: - format: date-time - type: string - receivedItems: - maxItems: 200 - type: array - items: - $ref: '#/components/schemas/InboundReceiptLineItem' - comments: - maxItems: 20 - type: array - items: - $ref: '#/components/schemas/InboundReceiptComment' - status: - type: string - enum: - - IN_PROGRESS - - FINISHED - customAttributes: - type: object - nullable: true - description: >- - Attributes that can be added to this entity. These attributes - **cannot** be used within fulfillment processes, but enable you to - attach custom data from your systems to fulfillmenttools entities. id: type: string required: - - receivedDate - - receivedItems - - comments - id - InboundDeliveryReceivedPayload: - type: object - properties: - inboundProcessRef: - type: string - tenantInboundProcessRef: - type: string - purchaseOrder: - $ref: '#/components/schemas/InboundProcessPurchaseOrder' - facilityRef: - type: string - status: - type: string - enum: - - OPEN - - PARTIAL_DELIVERY - - ON_HOLD - - CLOSED - onHold: - type: boolean - receipt: - $ref: '#/components/schemas/InboundReceipt' - required: - - inboundProcessRef - - facilityRef - - status - - onHold - - receipt - InboundDeliveryFinishedPayload: - type: object - properties: - inboundProcessRef: - type: string - tenantInboundProcessRef: - type: string - purchaseOrder: - $ref: '#/components/schemas/InboundProcessPurchaseOrder' - facilityRef: - type: string - status: - type: string - enum: - - OPEN - - PARTIAL_DELIVERY - - ON_HOLD - - CLOSED - onHold: - type: boolean - receipts: - type: array - items: - $ref: '#/components/schemas/InboundReceipt' - required: - - inboundProcessRef - - facilityRef - - status - - onHold - - receipts - InboundDeliveryOnHoldPayload: - type: object - properties: - inboundProcessRef: - type: string - tenantInboundProcessRef: - type: string - purchaseOrder: - $ref: '#/components/schemas/InboundProcessPurchaseOrder' - facilityRef: - type: string - status: - type: string - enum: - - OPEN - - PARTIAL_DELIVERY - - ON_HOLD - - CLOSED - onHold: - type: boolean - required: - - inboundProcessRef - - facilityRef - - status - - onHold - InboundDeliveryReleasedPayload: - type: object - properties: - inboundProcessRef: - type: string - tenantInboundProcessRef: - type: string - purchaseOrder: - $ref: '#/components/schemas/InboundProcessPurchaseOrder' - facilityRef: - type: string - status: - type: string - enum: - - OPEN - - PARTIAL_DELIVERY - - ON_HOLD - - CLOSED - onHold: - type: boolean - required: - - inboundProcessRef - - facilityRef - - status - - onHold - InventoryFacilityStockShapeByTrait: - type: object - properties: - PICKABLE: - type: number - ACCESSIBLE: - type: number - required: - - PICKABLE - - ACCESSIBLE - InventoryFacilityStockDeltaShape: - type: object - properties: - totalAmount: - type: number - reserved: - type: number - safetyStock: - type: number - available: - type: number - deprecated: true - byTrait: - $ref: '#/components/schemas/InventoryFacilityStockShapeByTrait' - availableToPromise: - type: number - deprecated: true - readyToPick: - type: number - deprecated: true - availableForPicking: - type: number - stockCount: - type: number - availableOnStock: - type: number - stockOnHand: - type: number - required: - - totalAmount - - reserved - - safetyStock - - available - - byTrait - - availableToPromise - - readyToPick - - availableForPicking - - stockCount - - availableOnStock - - stockOnHand - InventoryFacilityStockStaleReason: - type: object - properties: - timestamp: - format: date-time - type: string - reasons: - type: array - items: - type: string - required: - - timestamp - - reasons - InventoryFacilityStockShape: - type: object - properties: - facilityRef: - type: string - tenantArticleId: - type: string - totalAmount: - type: number - reserved: - type: number - safetyStock: - type: number - available: - type: number - deprecated: true - description: >- - This field is deprecated and replaced by new availability concepts. - Please see - https://docs.fulfillmenttools.com/api-docs/use-cases/inventory-management/global-inventory/availability - for more information. - byTrait: - $ref: '#/components/schemas/InventoryFacilityStockShapeByTrait' - changeReason: - type: string - enum: - - UNKNOWN - availableToPromise: - type: number - deprecated: true - description: >- - This field is deprecated and replaced by new availability concepts. - Please see - https://docs.fulfillmenttools.com/api-docs/use-cases/inventory-management/global-inventory/availability - for more information. - readyToPick: - type: number - deprecated: true - description: >- - This field is deprecated and replaced by new availability concepts. - Please see - https://docs.fulfillmenttools.com/api-docs/use-cases/inventory-management/global-inventory/availability - for more information. - availableForPicking: - type: number - delta: - $ref: '#/components/schemas/InventoryFacilityStockDeltaShape' - staleReasons: - type: array - items: - $ref: '#/components/schemas/InventoryFacilityStockStaleReason' - stockOnHand: - type: number - availableOnStock: - type: number - required: - - facilityRef - - tenantArticleId - - totalAmount - - reserved - - safetyStock - - available - - byTrait - - changeReason - - availableToPromise - - readyToPick - - availableForPicking - - delta - - staleReasons - - stockOnHand - - availableOnStock - RequestedDate: - type: object - properties: - type: - type: string - enum: - - ASAP - - TIME_POINT - value: - format: date-time - type: string - required: - - type - - value - InboundProcessPurchaseOrderSupplier: - type: object - properties: - name: - type: string PurchaseOrder: type: object properties: @@ -36708,6 +39200,8 @@ components: type: boolean supplier: $ref: '#/components/schemas/InboundProcessPurchaseOrderSupplier' + transfer: + $ref: '#/components/schemas/InboundProcessPurchaseOrderTransfer' customAttributes: type: object nullable: true @@ -36932,13 +39426,6 @@ components: $ref: '#/components/schemas/InboundAttachmentLink' required: - content - StockPropertyPreset: - type: object - properties: - expiry: - type: string - receiptDate: - type: string InboundReceiptLineItem: type: object properties: @@ -37474,6 +39961,8 @@ components: InventoryFacilityConfiguration: type: object properties: + id: + type: string version: type: number isMixedStorage: @@ -37483,6 +39972,7 @@ components: outboundStockConfiguration: $ref: '#/components/schemas/OutboundStockConfiguration' required: + - id - version - facilityRef StorageLocationRecommendation: @@ -37535,21 +40025,6 @@ components: required: - tenantArticleId - title - StockSummaryExpectedStock: - type: object - properties: - expectedStockRef: - type: string - expectedDate: - $ref: '#/components/schemas/RequestedDate' - quantity: - $ref: '#/components/schemas/Quantity' - inboundProcessRef: - type: string - required: - - expectedStockRef - - expectedDate - - quantity ByTrait: type: object properties: @@ -37594,10 +40069,6 @@ components: safetyStock: type: number minimum: 0 - expectedStocks: - type: array - items: - $ref: '#/components/schemas/StockSummaryExpectedStock' byTrait: $ref: '#/components/schemas/ByTrait' availableForPicking: @@ -37631,7 +40102,6 @@ components: - totalAmount - available - safetyStock - - expectedStocks - byTrait - availableForPicking - availableToPromise @@ -37690,10 +40160,6 @@ components: safetyStock: type: number minimum: 0 - expectedStocks: - type: array - items: - $ref: '#/components/schemas/StockSummaryExpectedStock' byTrait: $ref: '#/components/schemas/ByTrait' availableForPicking: @@ -37741,7 +40207,6 @@ components: - totalAmount - available - safetyStock - - expectedStocks - byTrait - availableForPicking - availableToPromise @@ -37863,6 +40328,9 @@ components: receiptDate: format: date-time type: string + availableUntil: + format: date-time + type: string customAttributes: type: object nullable: true @@ -37928,6 +40396,9 @@ components: receiptDate: format: date-time type: string + availableUntil: + format: date-time + type: string customAttributes: type: object nullable: true @@ -38535,6 +41006,15 @@ components: required: - payload type: object + PickjobCanceledWebHookEvent: + allOf: + - $ref: '#/components/schemas/WebHookEvent' + properties: + payload: + $ref: '#/components/schemas/PickJob' + required: + - payload + type: object PackJobUpdatedWebHookEvent: allOf: - $ref: '#/components/schemas/WebHookEvent' @@ -38553,6 +41033,15 @@ components: required: - payload type: object + PackJobCanceledWebHookEvent: + allOf: + - $ref: '#/components/schemas/WebHookEvent' + properties: + payload: + $ref: '#/components/schemas/PackJob' + required: + - payload + type: object RoutingPlanNotRoutableWebHookEvent: allOf: - $ref: '#/components/schemas/WebHookEvent' diff --git a/src/fft-api/types/typescript-fetch-client/.swagger-codegen/VERSION b/src/fft-api/types/typescript-fetch-client/.swagger-codegen/VERSION index 248908e..e661578 100644 --- a/src/fft-api/types/typescript-fetch-client/.swagger-codegen/VERSION +++ b/src/fft-api/types/typescript-fetch-client/.swagger-codegen/VERSION @@ -1 +1 @@ -3.0.54 \ No newline at end of file +3.0.57 \ No newline at end of file diff --git a/src/fft-api/types/typescript-fetch-client/api.ts b/src/fft-api/types/typescript-fetch-client/api.ts index 1079d2a..2d5ea97 100644 --- a/src/fft-api/types/typescript-fetch-client/api.ts +++ b/src/fft-api/types/typescript-fetch-client/api.ts @@ -45,7 +45,7 @@ export namespace AbortPickJobAction { */ export interface AbstractArticle { /** - * 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. + * Attributes that can be added to this entity. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities. * @type {any} * @memberof AbstractArticle */ @@ -63,11 +63,17 @@ export interface AbstractArticle { */ tenantArticleId: string; /** - * + * The title of the product * @type {string} * @memberof AbstractArticle */ title: string; + /** + * The translations for the title of the product + * @type {LocaleString} + * @memberof AbstractArticle + */ + titleLocalized?: LocaleString; /** * weight value is in gram * @type {number} @@ -119,6 +125,12 @@ export interface AbstractFacilityCarrierConfiguration { * @memberof AbstractFacilityCarrierConfiguration */ key: string; + /** + * + * @type {string} + * @memberof AbstractFacilityCarrierConfiguration + */ + serviceUrl?: string; } /** * @@ -190,6 +202,7 @@ export namespace AbstractModificationAction { ModifyPickLineItem = 'ModifyPickLineItem', ModifyPickRunLineItem = 'ModifyPickRunLineItem', ModifyPackJob = 'ModifyPackJob', + PausePackJob = 'PausePackJob', ModifyPackLineItem = 'ModifyPackLineItem', ModifyFacility = 'ModifyFacility', ModifyListing = 'ModifyListing', @@ -221,11 +234,11 @@ export namespace AbstractModificationAction { ModifyStorageLocation = 'ModifyStorageLocation', ModifyPackingContainerType = 'ModifyPackingContainerType', ModifyPackingContainerTypeIcon = 'ModifyPackingContainerTypeIcon', - ReplaceCodesInPackingContainer = 'ReplaceCodesInPackingContainer', + ReplaceCodesInPackingTargetContainer = 'ReplaceCodesInPackingTargetContainer', ReplaceLoadUnitLineItems = 'ReplaceLoadUnitLineItems', - AddLineItemToPackingContainer = 'AddLineItemToPackingContainer', - RemoveLineItemFromPackingContainer = 'RemoveLineItemFromPackingContainer', - UpdateLineItemOnPackingContainer = 'UpdateLineItemOnPackingContainer', + AddLineItemToPackingTargetContainer = 'AddLineItemToPackingTargetContainer', + RemoveLineItemFromPackingTargetContainer = 'RemoveLineItemFromPackingTargetContainer', + UpdateLineItemOnPackingTargetContainer = 'UpdateLineItemOnPackingTargetContainer', ModifyCustomService = 'ModifyCustomService', UnlockOrder = 'UnlockOrder' } @@ -269,6 +282,112 @@ export interface AbstractOrderActionsParameter { */ export interface AbstractRatingConfiguration { } +/** + * + * @export + * @interface AbstractReason + */ +export interface AbstractReason extends AbstractReasonForCreation { + /** + * The date this entity was created at the platform. This value is generated by the service. + * @type {Date} + * @memberof AbstractReason + */ + created?: Date; + /** + * The date this entity was modified last. This value is generated by the service. + * @type {Date} + * @memberof AbstractReason + */ + lastModified?: Date; + /** + * The version of the document to be used in optimistic locking mechanisms. + * @type {number} + * @memberof AbstractReason + */ + version: number; + /** + * The id of the Reason + * @type {string} + * @memberof AbstractReason + */ + id: string; + /** + * The action this reason can be attached to. + * @type {string} + * @memberof AbstractReason + */ + action: string; +} +/** + * + * @export + * @interface AbstractReasonForCreation + */ +export interface AbstractReasonForCreation { + /** + * Text explaining the reason for a supported action. + * @type {string} + * @memberof AbstractReasonForCreation + */ + reason: string; + /** + * + * @type {LocaleString} + * @memberof AbstractReasonForCreation + */ + reasonLocalized: LocaleString; +} +/** + * + * @export + * @interface AbstractReasonForModification + */ +export interface AbstractReasonForModification { + /** + * Text explaining the reason for a supported action. + * @type {string} + * @memberof AbstractReasonForModification + */ + reason: string; + /** + * + * @type {LocaleString} + * @memberof AbstractReasonForModification + */ + reasonLocalized: LocaleString; + /** + * The version of the document to be used in optimistic locking mechanisms. + * @type {number} + * @memberof AbstractReasonForModification + */ + version: number; +} +/** + * + * @export + * @interface AbstractReasons + */ +export interface AbstractReasons { + /** + * + * @type {Array} + * @memberof AbstractReasons + */ + reasons: Array; + /** + * True if there are more results after the current page + * @type {boolean} + * @memberof AbstractReasons + */ + hasNextPage: boolean; + /** + * Total number of found entities for this query + * @type {number} + * @memberof AbstractReasons + */ + total: number; +} /** * * @export @@ -363,36 +482,55 @@ export interface AddItemReturnToItemReturnJob { /** * * @export - * @interface AddLineItemToPackingContainerAction + * @interface AddLineItemToPackingTargetContainerAction */ -export interface AddLineItemToPackingContainerAction extends AbstractModificationAction { +export interface AddLineItemToPackingTargetContainerAction extends AbstractModificationAction { /** - * Use AddLineItemToPackingContainer to add a line item to an existing packing container + * Use AddLineItemToPackingTargetContainer to add a line item to an existing packing container * @type {string} - * @memberof AddLineItemToPackingContainerAction + * @memberof AddLineItemToPackingTargetContainerAction */ - action: AddLineItemToPackingContainerAction.ActionEnum; + action: AddLineItemToPackingTargetContainerAction.ActionEnum; /** * - * @type {PackingContainerLineItemForCreation} - * @memberof AddLineItemToPackingContainerAction + * @type {PackingTargetContainerLineItemForCreation} + * @memberof AddLineItemToPackingTargetContainerAction */ - lineItem: PackingContainerLineItemForCreation; + lineItem: PackingTargetContainerLineItemForCreation; } /** * @export - * @namespace AddLineItemToPackingContainerAction + * @namespace AddLineItemToPackingTargetContainerAction */ -export namespace AddLineItemToPackingContainerAction { +export namespace AddLineItemToPackingTargetContainerAction { /** * @export * @enum {string} */ export enum ActionEnum { - AddLineItemToPackingContainer = 'AddLineItemToPackingContainer' + AddLineItemToPackingTargetContainer = 'AddLineItemToPackingTargetContainer' } } +/** + * + * @export + * @interface AddRefuseReasonParameter + */ +export interface AddRefuseReasonParameter { + /** + * + * @type {number} + * @memberof AddRefuseReasonParameter + */ + handoverConfigurationVersion: number; + /** + * + * @type {AvailableRefuseReasonForCreation} + * @memberof AddRefuseReasonParameter + */ + availableRefuseReasonForCreation: AvailableRefuseReasonForCreation; +} /** * * @export @@ -510,7 +648,8 @@ export enum AdditionalInformationValueType { STRING = 'STRING', BOOLEAN = 'BOOLEAN', NUMBER = 'NUMBER', - NOVALUE = 'NOVALUE' + NOVALUE = 'NOVALUE', + INPUTMULTILINESTRING = 'INPUT_MULTILINE_STRING' } /** * @@ -553,7 +692,7 @@ export interface Address { * @type {string} * @memberof Address */ - houseNumber: string; + houseNumber?: string; /** * * @type {Array} @@ -750,11 +889,17 @@ export interface ArticleAttributeItem { */ category?: ArticleAttributeItem.CategoryEnum; /** - * Providing the key %%subtitle%% (see example) here will cause the value to appear for example in the App directly under the title. With all other attributes also the key will be displayed in the clients. + * Providing the key %%subtitle%% (see example) here will cause the value to appear for example in the App directly under the title. With all other attributes also the key will be displayed in the clients. * @type {string} * @memberof ArticleAttributeItem */ key: string; + /** + * The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%% + * @type {LocaleString} + * @memberof ArticleAttributeItem + */ + keyLocalized?: LocaleString; /** * This value gives the priority in the respective attribute category. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. Attributes that have the highest priority might be selected for display in different articles of OCFF. Default Value is 1001. For details please contact the product owners. * @type {number} @@ -767,6 +912,12 @@ export interface ArticleAttributeItem { * @memberof ArticleAttributeItem */ value: string; + /** + * The translations for the key of the attribute. This can be only filled with a descriptive category + * @type {LocaleString} + * @memberof ArticleAttributeItem + */ + valueLocalized?: LocaleString; } /** @@ -859,13 +1010,13 @@ export interface ArticlePrice { * @type {number} * @memberof ArticlePrice */ - pricePerUnit?: number; + pricePerUnit: number; /** * The currency of the price as an ISO 4217 code. * @type {CurrencyCode} * @memberof ArticlePrice */ - currency?: CurrencyCode; + currency: CurrencyCode; } /** * @@ -1692,12 +1843,62 @@ export interface AvailableItemCondition { */ conditionLocalized?: LocaleString; } +/** + * + * @export + * @interface AvailableRefuseReasonForCreation + */ +export interface AvailableRefuseReasonForCreation { + /** + * + * @type {boolean} + * @memberof AvailableRefuseReasonForCreation + */ + active: boolean; + /** + * + * @type {LocaleString} + * @memberof AvailableRefuseReasonForCreation + */ + refusedReasonLocalized: LocaleString; +} +/** + * + * @export + * @interface AvailableRefuseReasonForUpdate + */ +export interface AvailableRefuseReasonForUpdate { + /** + * + * @type {boolean} + * @memberof AvailableRefuseReasonForUpdate + */ + active: boolean; + /** + * The version of the document to be used in optimistic locking mechanisms. + * @type {number} + * @memberof AvailableRefuseReasonForUpdate + */ + version: number; + /** + * + * @type {LocaleString} + * @memberof AvailableRefuseReasonForUpdate + */ + refusedReasonLocalized: LocaleString; +} /** * * @export * @interface AvailableRefusedReason */ export interface AvailableRefusedReason { + /** + * + * @type {boolean} + * @memberof AvailableRefusedReason + */ + active: boolean; /** * * @type {LocaleString} @@ -1724,6 +1925,34 @@ export interface AvailableReturnReason { */ reasonLocalized: LocaleString; } +/** + * The base for the calculation of the available until date. If it can't be resolved into a valid date (i.e. missing expiry value), an undefined \"availableUntil\" is the result + * @export + * @enum {string} + */ +export enum AvailableUntilCalculationBase { + EXPIRY = 'EXPIRY', + CREATION = 'CREATION' +} +/** + * + * @export + * @interface AvailableUntilDefinition + */ +export interface AvailableUntilDefinition { + /** + * + * @type {AvailableUntilCalculationBase} + * @memberof AvailableUntilDefinition + */ + calculationBase: AvailableUntilCalculationBase; + /** + * Moves the calculated date by the given period, defined in ISO-8601 duration notation. Use negative values to move the date backwards. Example: \"-P30D\" places the \"availableUntil\" value 30 days before the calculated date. + * @type {string} + * @memberof AvailableUntilDefinition + */ + modifier?: string; +} /** * Can this tenant use the backoffice for picking? * @export @@ -1763,6 +1992,35 @@ export interface BaseDecisionDetail { */ decisionType: DecisionType; } +/** + * + * @export + * @interface BaseValidation + */ +export interface BaseValidation { + /** + * + * @type {string} + * @memberof BaseValidation + */ + validationType: BaseValidation.ValidationTypeEnum; +} + +/** + * @export + * @namespace BaseValidation + */ +export namespace BaseValidation { + /** + * @export + * @enum {string} + */ + export enum ValidationTypeEnum { + STRING = 'STRING', + FLOAT = 'FLOAT', + INTEGER = 'INTEGER' + } +} /** * * @export @@ -1882,6 +2140,18 @@ export interface BringCarrierConfiguration extends CarrierConfiguration { * @memberof BringCarrierConfiguration */ returnProduct?: string; + /** + * + * @type {string} + * @memberof BringCarrierConfiguration + */ + trackAndTraceUrl?: string; + /** + * + * @type {string} + * @memberof BringCarrierConfiguration + */ + webhookFftHost?: string; } /** * @@ -1914,6 +2184,25 @@ export interface BringCarrierCredentials extends AbstractCarrierCredentials { */ authToken?: string; } +/** + * + * @export + * @interface BringFacilityCarrierConfiguration + */ +export interface BringFacilityCarrierConfiguration extends AbstractFacilityCarrierConfiguration { + /** + * + * @type {string} + * @memberof BringFacilityCarrierConfiguration + */ + trackAndTraceUrl?: string; + /** + * + * @type {string} + * @memberof BringFacilityCarrierConfiguration + */ + webhookFftHost?: string; +} /** * * @export @@ -2075,6 +2364,60 @@ export namespace CancelPickRunAction { CancelPickRun = 'CancelPickRun' } } +/** + * + * @export + * @interface CancelationReason + */ +export interface CancelationReason extends AbstractReason { + /** + * + * @type {string} + * @memberof CancelationReason + */ + action: CancelationReason.ActionEnum; +} + +/** + * @export + * @namespace CancelationReason + */ +export namespace CancelationReason { + /** + * @export + * @enum {string} + */ + export enum ActionEnum { + CANCELATION = 'CANCELATION' + } +} +/** + * + * @export + * @interface CancelationReasonForCreation + */ +export interface CancelationReasonForCreation extends AbstractReasonForCreation { +} +/** + * + * @export + * @interface CancelationReasonForModification + */ +export interface CancelationReasonForModification extends AbstractReasonForModification { +} +/** + * + * @export + * @interface CancelationReasons + */ +export interface CancelationReasons extends AbstractReasons { + /** + * + * @type {Array} + * @memberof CancelationReasons + */ + reasons: Array; +} /** * * @export @@ -2195,16 +2538,28 @@ export interface CarrierConfiguration extends VersionedResource { * @memberof CarrierConfiguration */ fallBackTrackAndTraceEmail?: string; + /** + * + * @type {Array} + * @memberof CarrierConfiguration + */ + nonDeliveryDaysPerCountryAndProvince?: Array; /** * * @type {Array} * @memberof CarrierConfiguration */ countryServiceMappings?: Array; -} -/** - * - * @export + /** + * + * @type {string} + * @memberof CarrierConfiguration + */ + serviceUrl?: string; +} +/** + * + * @export * @interface CarrierCountryServiceMapping */ export interface CarrierCountryServiceMapping { @@ -2421,6 +2776,82 @@ export interface CarrierCountryServiceMappingForUpdate { */ deliveryCosts?: Array; } +/** + * + * @export + * @interface CarrierCutoffConfiguration + */ +export interface CarrierCutoffConfiguration { + /** + * + * @type {string} + * @memberof CarrierCutoffConfiguration + */ + time: string; + /** + * + * @type {number} + * @memberof CarrierCutoffConfiguration + */ + capacity?: number; +} +/** + * + * @export + * @interface CarrierCutoffTimes + */ +export interface CarrierCutoffTimes { + /** + * + * @type {Array} + * @memberof CarrierCutoffTimes + */ + weekdays: Array; + /** + * + * @type {Array} + * @memberof CarrierCutoffTimes + */ + overwrites: Array; +} +/** + * + * @export + * @interface CarrierCutoffTimesOverwrite + */ +export interface CarrierCutoffTimesOverwrite { + /** + * + * @type {string} + * @memberof CarrierCutoffTimesOverwrite + */ + date: string; + /** + * + * @type {Array} + * @memberof CarrierCutoffTimesOverwrite + */ + cutoffConfigurations: Array; +} +/** + * + * @export + * @interface CarrierCutoffTimesWeekDay + */ +export interface CarrierCutoffTimesWeekDay { + /** + * + * @type {WeekDay} + * @memberof CarrierCutoffTimesWeekDay + */ + day: WeekDay; + /** + * + * @type {Array} + * @memberof CarrierCutoffTimesWeekDay + */ + cutoffConfigurations: Array; +} /** * Provided delivery of this CEP. Default: DELIVERY * @export @@ -2686,6 +3117,69 @@ export interface CheckoutOptionsCustomServices { */ name: string; } +/** + * + * @export + * @interface CheckoutOptionsDeliveryTimePointRequest + */ +export interface CheckoutOptionsDeliveryTimePointRequest { + /** + * The desired delivery date. (timestamp of the request) + * @type {Date} + * @memberof CheckoutOptionsDeliveryTimePointRequest + */ + desiredDeliveryDate: Date; + /** + * + * @type {Array} + * @memberof CheckoutOptionsDeliveryTimePointRequest + */ + tenantArticleIds: Array; + /** + * Pair of facilityRef and latestPickingStart values + * @type {Array} + * @memberof CheckoutOptionsDeliveryTimePointRequest + */ + facilities: Array; +} +/** + * + * @export + * @interface CheckoutOptionsDeliveryTimePointResponse + */ +export interface CheckoutOptionsDeliveryTimePointResponse { + /** + * + * @type {Array} + * @memberof CheckoutOptionsDeliveryTimePointResponse + */ + items: Array; +} +/** + * + * @export + * @interface CheckoutOptionsDeliveryTimePointResponseItem + */ +export interface CheckoutOptionsDeliveryTimePointResponseItem { + /** + * + * @type {string} + * @memberof CheckoutOptionsDeliveryTimePointResponseItem + */ + tenantArticleId: string; + /** + * + * @type {number} + * @memberof CheckoutOptionsDeliveryTimePointResponseItem + */ + available: number; + /** + * + * @type {string} + * @memberof CheckoutOptionsDeliveryTimePointResponseItem + */ + facilityRef: string; +} /** * * @export @@ -2916,6 +3410,12 @@ export interface CollectDelivery { * @memberof CollectDelivery */ supplyingFacilitiesConfigurations?: Array; + /** + * The point in time by which the order is supposed to be provisioned. + * @type {Date} + * @memberof CollectDelivery + */ + provisioningTime?: Date; } /** * @@ -2940,7 +3440,7 @@ export interface CompanyAddress { * @type {string} * @memberof CompanyAddress */ - houseNumber: string; + houseNumber?: string; /** * * @type {string} @@ -2981,7 +3481,9 @@ export interface ConfigurationsNotificationsBody1 { */ export enum ConnectAppTypeEnum { PICKING = 'PICKING', - INVENTORY = 'INVENTORY' + INVENTORY = 'INVENTORY', + OPERATIONSANDROID = 'OPERATIONS_ANDROID', + OPERATIONSIOS = 'OPERATIONS_IOS' } /** * This status consolidates many of the RoutingPlanStatus and offers a more detailes explanation of what happened to the routing plan. @@ -2990,6 +3492,7 @@ export enum ConnectAppTypeEnum { */ export enum ConsolidatedRoutingPlanStatus { ROUTED = 'ROUTED', + ROUTEDTHENREROUTED = 'ROUTED_THEN_REROUTED', PROCESSMANUALREROUTEDTHENROUTED = 'PROCESS_MANUAL_REROUTED_THEN_ROUTED', PROCESSMANUALREROUTEDTHENNOTROUTABLE = 'PROCESS_MANUAL_REROUTED_THEN_NOT_ROUTABLE', PROCESSMANUALREROUTEDTHENREROUTEDANDSPLIT = 'PROCESS_MANUAL_REROUTED_THEN_REROUTED_AND_SPLIT', @@ -3004,7 +3507,7 @@ export enum ConsolidatedRoutingPlanStatus { ROUTINGPLANREROUTETIMETRIGGEREDTHENREROUTED = 'ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED', ROUTINGPLANREROUTETIMETRIGGEREDTHENREROUTEDANDSPLIT = 'ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_AND_SPLIT', ROUTINGPLANSHORTPICKEDTHENREROUTED = 'ROUTING_PLAN_SHORTPICKED_THEN_REROUTED', - ROUTINGPLANSHORTPICKEDTHENSPLIT = 'ROUTINGPLAN_SHORTPICKED_THEN_SPLIT', + ROUTINGPLANSHORTPICKEDTHENSPLIT = 'ROUTING_PLAN_SHORTPICKED_THEN_SPLIT', ROUTINGPLANSHORTPICKEDTHENREROUTEDANDSPLIT = 'ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_AND_SPLIT', ROUTINGPLANREROUTESTOCKZEROTHENREROUTED = 'ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED', ROUTINGPLANREROUTESTOCKZEROTHENREROUTEDANDSPLIT = 'ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED_AND_SPLIT', @@ -3019,6 +3522,17 @@ export enum ConsolidatedRoutingPlanStatus { UNKNOWN = 'UNKNOWN', RETRYABLE = 'RETRYABLE', FAILEDREROUTE = 'FAILED_REROUTE', + ROUTEDTHENCANCELED = 'ROUTED_THEN_CANCELED', + ROUTEDANDSPLITTHENCANCELED = 'ROUTED_AND_SPLIT_THEN_CANCELED', + ROUTINGPLANSHORTPICKEDTHENSPLITTHENCANCELED = 'ROUTING_PLAN_SHORTPICKED_THEN_SPLIT_THEN_CANCELED', + ROUTINGPLANSHORTPICKEDTHENREROUTEDTHENCANCELED = 'ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_THEN_CANCELED', + ROUTINGPLANSHORTPICKEDTHENREROUTEDANDSPLITTHENCANCELED = 'ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED', + ROUTINGPLANREROUTETIMETRIGGEREDTHENREROUTEDTHENCANCELED = 'ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_THEN_CANCELED', + ROUTINGPLANREROUTETIMETRIGGEREDTHENREROUTEDANDSPLITTHENCANCELED = 'ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED', + FACILITYMANUALLYASSIGNEDTOPICKJOBTHENROUTEDTHENCANCELED = 'FACILITY_MANUALLY_ASSIGNED_TO_PICKJOB_THEN_ROUTED_THEN_CANCELED', + FACILITYMANUALLYASSIGNEDTOPROCESSTHENROUTEDTHENCANCELED = 'FACILITY_MANUALLY_ASSIGNED_TO_PROCESS_THEN_ROUTED_THEN_CANCELED', + PROCESSMANUALREROUTEDTHENROUTEDTHENCANCELED = 'PROCESS_MANUAL_REROUTED_THEN_ROUTED_THEN_CANCELED', + PROCESSMANUALREROUTEDTHENREROUTEDANDSPLITTHENCANCELED = 'PROCESS_MANUAL_REROUTED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED', CANCELED = 'CANCELED', NOTROUTABLE = 'NOT_ROUTABLE', WAITING = 'WAITING', @@ -3026,7 +3540,9 @@ export enum ConsolidatedRoutingPlanStatus { WAITINGTHENROUTED = 'WAITING_THEN_ROUTED', WAITINGTHENROUTEDANDSPLIT = 'WAITING_THEN_ROUTED_AND_SPLIT', WAITINGTHENNOTROUTABLE = 'WAITING_THEN_NOT_ROUTABLE', - WAITINGTHENWAITINGANDSPLIT = 'WAITING_THEN_WAITING_AND_SPLIT' + WAITINGTHENWAITINGANDSPLIT = 'WAITING_THEN_WAITING_AND_SPLIT', + LOCKED = 'LOCKED', + INITIAL = 'INITIAL' } /** * @@ -3476,7 +3992,7 @@ export interface CustomServiceDefinition { * @type {string} * @memberof CustomServiceDefinition */ - customServiceRef: string; + customServiceRef?: string; /** * if true all articles below this service are intrpreted as a bundle * @type {boolean} @@ -3891,6 +4407,19 @@ export interface DefaultPickingTimesConfiguration extends VersionedResource { */ pickingTimes: PickingTimes; } +/** + * + * @export + * @interface DeleteRefuseReasonParameter + */ +export interface DeleteRefuseReasonParameter { + /** + * + * @type {number} + * @memberof DeleteRefuseReasonParameter + */ + handoverConfigurationVersion: number; +} /** * * @export @@ -3920,7 +4449,7 @@ export interface DeliveryAddress { * @type {string} * @memberof DeliveryAddress */ - houseNumber: string; + houseNumber?: string; /** * * @type {string} @@ -3940,6 +4469,19 @@ export interface DeliveryAddress { */ street: string; } +/** + * + * @export + * @interface DeliveryAddressWithType + */ +export interface DeliveryAddressWithType extends DeliveryAddress { + /** + * + * @type {AddressType} + * @memberof DeliveryAddressWithType + */ + addressType: AddressType; +} /** * * @export @@ -4053,7 +4595,13 @@ export interface DeliveryNote { * @type {DeliveryAddress} * @memberof DeliveryNote */ - deliveryAddress: DeliveryAddress; + deliveryAddress?: DeliveryAddress; + /** + * if this field is filled, the delivery address will be taken from here according to this sorting: PARCEL_LOCKER > POSTAL_ADDRESS > INVOICE_ADDRESS. Each type is only allowed once. + * @type {Array} + * @memberof DeliveryNote + */ + deliveryAddresses?: Array; /** * * @type {Array} @@ -4310,6 +4858,12 @@ export interface DeliveryPreferences { * @memberof DeliveryPreferences */ targetTime?: Date; + /** + * + * @type {DeliveryReservationPreferences} + * @memberof DeliveryPreferences + */ + reservationPreferences?: DeliveryReservationPreferences; } /** * @@ -4347,6 +4901,12 @@ export interface DeliveryPreferencesShipping { * @memberof DeliveryPreferencesShipping */ carrierProductCategory?: CarrierProductCategory; + /** + * + * @type {Date} + * @memberof DeliveryPreferencesShipping + */ + desiredDeliveryTime?: Date; } /** @@ -4446,6 +5006,34 @@ export interface DeliveryPromiseShipment extends BasicDeliveryPromiseShipment { */ carriers: Array; } +/** + * + * @export + * @enum {string} + */ +export enum DeliveryReservationMode { + SCHEDULED = 'SCHEDULED', + ASAP = 'ASAP' +} +/** + * + * @export + * @interface DeliveryReservationPreferences + */ +export interface DeliveryReservationPreferences { + /** + * + * @type {DeliveryReservationMode} + * @memberof DeliveryReservationPreferences + */ + mode: DeliveryReservationMode; + /** + * + * @type {Date} + * @memberof DeliveryReservationPreferences + */ + reservationTime?: Date; +} /** * The destination for a delivery * @export @@ -4467,6 +5055,12 @@ export interface DhlV2CarrierConfiguration extends CarrierConfiguration { * @memberof DhlV2CarrierConfiguration */ alternativeReturnAddress?: FacilityAddress; + /** + * + * @type {string} + * @memberof DhlV2CarrierConfiguration + */ + trackAndTraceUrl?: string; } /** * @@ -4480,6 +5074,12 @@ export interface DhlV2FacilityCarrierConfiguration extends AbstractFacilityCarri * @memberof DhlV2FacilityCarrierConfiguration */ alternativeReturnAddress?: FacilityAddress; + /** + * + * @type {string} + * @memberof DhlV2FacilityCarrierConfiguration + */ + trackAndTraceUrl?: string; } /** * @@ -4654,7 +5254,8 @@ export enum DomainType { SHIPMENT = 'SHIPMENT', HANDOVER = 'HANDOVER', RETURN = 'RETURN', - SERVICEJOB = 'SERVICE_JOB' + SERVICEJOB = 'SERVICE_JOB', + ITEMRETURNJOB = 'ITEM_RETURN_JOB' } /** * @@ -4668,6 +5269,12 @@ export interface DpdChCarrierConfiguration extends CarrierConfiguration { * @memberof DpdChCarrierConfiguration */ alternativeSendAddress?: FacilityAddress; + /** + * + * @type {string} + * @memberof DpdChCarrierConfiguration + */ + trackAndTraceUrl?: string; } /** * @@ -4700,6 +5307,12 @@ export interface DpdChFacilityCarrierConfiguration extends AbstractFacilityCarri * @memberof DpdChFacilityCarrierConfiguration */ depot?: string; + /** + * + * @type {string} + * @memberof DpdChFacilityCarrierConfiguration + */ + trackAndTraceUrl?: string; } /** * @@ -4902,6 +5515,51 @@ export interface EstimatedDeliveryTime { */ maxDeliveryDays: number; } +/** + * + * @export + * @interface ExpectedLineItem + */ +export interface ExpectedLineItem extends OrderLineItem { + /** + * + * @type {string} + * @memberof ExpectedLineItem + */ + transferId: string; + /** + * + * @type {string} + * @memberof ExpectedLineItem + */ + facilityRef: string; +} +/** + * + * @export + * @interface ExpectedPickLineItem + */ +export interface ExpectedPickLineItem extends ExpectedPickLineItemForCreation { + /** + * The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity. + * @type {string} + * @memberof ExpectedPickLineItem + */ + id: string; +} +/** + * + * @export + * @interface ExpectedPickLineItemForCreation + */ +export interface ExpectedPickLineItemForCreation extends PickLineItemForCreation { + /** + * + * @type {string} + * @memberof ExpectedPickLineItemForCreation + */ + transferId: string; +} /** * * @export @@ -5063,55 +5721,257 @@ export enum ExpiryEntityStatus { /** * * @export - * @interface ExternalDocument + * @interface ExternalAction */ -export interface ExternalDocument extends VersionedResource { +export interface ExternalAction extends ExternalActionForReplacement { /** - * - * @type {DocumentType} - * @memberof ExternalDocument + * The date this entity was created at the platform. This value is generated by the service. + * @type {Date} + * @memberof ExternalAction */ - type: DocumentType; + created?: Date; /** - * - * @type {Section} - * @memberof ExternalDocument + * The date this entity was modified last. This value is generated by the service. + * @type {Date} + * @memberof ExternalAction */ - section: Section; + lastModified?: Date; /** - * - * @type {string} - * @memberof ExternalDocument + * The version of the document to be used in optimistic locking mechanisms. + * @type {number} + * @memberof ExternalAction */ - name?: string; + version: number; /** - * + * The id of this external action. It is generated during creation automatically and suits as the primary identifier of the described entity. * @type {string} - * @memberof ExternalDocument + * @memberof ExternalAction */ - path?: string; + id: string; /** - * + * Id of the global process related to this entity. * @type {string} - * @memberof ExternalDocument + * @memberof ExternalAction */ - id: string; + processRef: string; /** - * - * @type {number} - * @memberof ExternalDocument + * The name of this external action. + * @type {string} + * @memberof ExternalAction */ - priority?: number; + name: string; } /** * * @export - * @interface ExternalDocumentContentForUpdate + * @interface ExternalActionForCreation */ -export interface ExternalDocumentContentForUpdate { +export interface ExternalActionForCreation { /** - * - * @type {NamedFile} + * Id of the global process related to this entity. + * @type {string} + * @memberof ExternalActionForCreation + */ + processRef: string; + /** + * + * @type {LocaleString} + * @memberof ExternalActionForCreation + */ + nameLocalized: LocaleString; + /** + * + * @type {Array} + * @memberof ExternalActionForCreation + */ + groups: Array; + /** + * + * @type {ExternalFormActionDefinition | ExternalLinkActionDefinition} + * @memberof ExternalActionForCreation + */ + action: ExternalFormActionDefinition | ExternalLinkActionDefinition; +} +/** + * + * @export + * @interface ExternalActionForReplacement + */ +export interface ExternalActionForReplacement { + /** + * + * @type {number} + * @memberof ExternalActionForReplacement + */ + version: number; + /** + * + * @type {LocaleString} + * @memberof ExternalActionForReplacement + */ + nameLocalized: LocaleString; + /** + * + * @type {Array} + * @memberof ExternalActionForReplacement + */ + groups: Array; + /** + * + * @type {ExternalFormActionDefinition | ExternalLinkActionDefinition} + * @memberof ExternalActionForReplacement + */ + action: ExternalFormActionDefinition | ExternalLinkActionDefinition; +} +/** + * + * @export + * @interface ExternalActionLog + */ +export interface ExternalActionLog extends ExternalActionLogForCreation { + /** + * + * @type {string} + * @memberof ExternalActionLog + */ + id: string; + /** + * Id of the refered external action. + * @type {string} + * @memberof ExternalActionLog + */ + externalActionRef: string; + /** + * + * @type {Editor} + * @memberof ExternalActionLog + */ + editor: Editor; + /** + * The date this action has been executed + * @type {Date} + * @memberof ExternalActionLog + */ + created: Date; +} +/** + * + * @export + * @interface ExternalActionLogForCreation + */ +export interface ExternalActionLogForCreation { + /** + * + * @type {boolean} + * @memberof ExternalActionLogForCreation + */ + requiresAnonymization: boolean; + /** + * + * @type {ExternalLinkActionLogPayload | ExternalFormActionLogPayload} + * @memberof ExternalActionLogForCreation + */ + actionPayload: ExternalLinkActionLogPayload | ExternalFormActionLogPayload; +} +/** + * + * @export + * @interface ExternalActionLogs + */ +export interface ExternalActionLogs { + /** + * + * @type {Array} + * @memberof ExternalActionLogs + */ + externalActionLogs: Array; + /** + * Total number of found entities for this query + * @type {number} + * @memberof ExternalActionLogs + */ + total: number; +} +/** + * The type of an external action + * @export + * @enum {string} + */ +export enum ExternalActionType { + BLANKLINK = 'BLANK_LINK', + FORM = 'FORM' +} +/** + * + * @export + * @interface ExternalActions + */ +export interface ExternalActions { + /** + * + * @type {Array} + * @memberof ExternalActions + */ + externalActions: Array; + /** + * Total number of found entities for this query + * @type {number} + * @memberof ExternalActions + */ + total: number; +} +/** + * + * @export + * @interface ExternalDocument + */ +export interface ExternalDocument extends VersionedResource { + /** + * + * @type {DocumentType} + * @memberof ExternalDocument + */ + type: DocumentType; + /** + * + * @type {Section} + * @memberof ExternalDocument + */ + section: Section; + /** + * + * @type {string} + * @memberof ExternalDocument + */ + name?: string; + /** + * + * @type {string} + * @memberof ExternalDocument + */ + path?: string; + /** + * + * @type {string} + * @memberof ExternalDocument + */ + id: string; + /** + * + * @type {number} + * @memberof ExternalDocument + */ + priority?: number; +} +/** + * + * @export + * @interface ExternalDocumentContentForUpdate + */ +export interface ExternalDocumentContentForUpdate { + /** + * + * @type {NamedFile} * @memberof ExternalDocumentContentForUpdate */ file: NamedFile; @@ -5191,6 +6051,245 @@ export interface ExternalDocumentInSectionForCreation { */ priority?: number; } +/** + * + * @export + * @interface ExternalFormActionButton + */ +export interface ExternalFormActionButton { + /** + * + * @type {LocaleString} + * @memberof ExternalFormActionButton + */ + labelLocalized: LocaleString; + /** + * + * @type {string} + * @memberof ExternalFormActionButton + */ + label?: string; +} +/** + * + * @export + * @interface ExternalFormActionDefinition + */ +export interface ExternalFormActionDefinition { + /** + * + * @type {ExternalActionType} + * @memberof ExternalFormActionDefinition + */ + type: ExternalActionType; + /** + * + * @type {Array} + * @memberof ExternalFormActionDefinition + */ + elements: Array; + /** + * + * @type {ExternalFormActionButton} + * @memberof ExternalFormActionDefinition + */ + success: ExternalFormActionButton; + /** + * + * @type {ExternalFormActionButton} + * @memberof ExternalFormActionDefinition + */ + cancel?: ExternalFormActionButton; +} +/** + * + * @export + * @interface ExternalFormActionElement + */ +export interface ExternalFormActionElement { + /** + * it is only allowed to set a style for elementType TEXT + * @type {string} + * @memberof ExternalFormActionElement + */ + style?: ExternalFormActionElement.StyleEnum; + /** + * + * @type {LocaleString} + * @memberof ExternalFormActionElement + */ + titleLocalized: LocaleString; + /** + * + * @type {string} + * @memberof ExternalFormActionElement + */ + title?: string; + /** + * + * @type {ExternalFormActionElementType} + * @memberof ExternalFormActionElement + */ + elementType: ExternalFormActionElementType; +} + +/** + * @export + * @namespace ExternalFormActionElement + */ +export namespace ExternalFormActionElement { + /** + * @export + * @enum {string} + */ + export enum StyleEnum { + BODY = 'BODY', + INFO = 'INFO', + WARN = 'WARN', + ERROR = 'ERROR' + } +} +/** + * + * @export + * @enum {string} + */ +export enum ExternalFormActionElementType { + TEXTINPUT = 'TEXT_INPUT', + HEADLINE = 'HEADLINE', + SUBHEADLINE = 'SUBHEADLINE', + TEXT = 'TEXT' +} +/** + * + * @export + * @interface ExternalFormActionInputElement + */ +export interface ExternalFormActionInputElement { + /** + * + * @type {string} + * @memberof ExternalFormActionInputElement + */ + elementId: string; + /** + * + * @type {boolean} + * @memberof ExternalFormActionInputElement + */ + isMandatory?: boolean; + /** + * + * @type {StringValidation | IntegerValidation | FloatValidation} + * @memberof ExternalFormActionInputElement + */ + validation?: StringValidation | IntegerValidation | FloatValidation; + /** + * + * @type {string} + * @memberof ExternalFormActionInputElement + */ + style?: ExternalFormActionInputElement.StyleEnum; + /** + * + * @type {LocaleString} + * @memberof ExternalFormActionInputElement + */ + titleLocalized: LocaleString; + /** + * + * @type {string} + * @memberof ExternalFormActionInputElement + */ + title?: string; + /** + * + * @type {ExternalFormActionElementType} + * @memberof ExternalFormActionInputElement + */ + elementType: ExternalFormActionElementType; +} + +/** + * @export + * @namespace ExternalFormActionInputElement + */ +export namespace ExternalFormActionInputElement { + /** + * @export + * @enum {string} + */ + export enum StyleEnum { + BODY = 'BODY', + INFO = 'INFO', + WARN = 'WARN', + ERROR = 'ERROR' + } +} +/** + * + * @export + * @interface ExternalFormActionLogPayload + */ +export interface ExternalFormActionLogPayload { + /** + * + * @type {Array} + * @memberof ExternalFormActionLogPayload + */ + elements: Array; +} +/** + * + * @export + * @interface ExternalFormActionLogPayloadElement + */ +export interface ExternalFormActionLogPayloadElement { + /** + * + * @type {string} + * @memberof ExternalFormActionLogPayloadElement + */ + elementId: string; + /** + * + * @type {string} + * @memberof ExternalFormActionLogPayloadElement + */ + value: string; +} +/** + * + * @export + * @interface ExternalLinkActionDefinition + */ +export interface ExternalLinkActionDefinition { + /** + * + * @type {ExternalActionType} + * @memberof ExternalLinkActionDefinition + */ + type: ExternalActionType; + /** + * + * @type {string} + * @memberof ExternalLinkActionDefinition + */ + linkUrl: string; +} +/** + * + * @export + * @interface ExternalLinkActionLogPayload + */ +export interface ExternalLinkActionLogPayload { + /** + * The date when this link was opened. + * @type {Date} + * @memberof ExternalLinkActionLogPayload + */ + linkOpenedAt: Date; +} /** * * @export @@ -5348,6 +6447,18 @@ export interface FacilityAddressForCreationEmailAddresses { * @interface FacilityCarrierConnection */ export interface FacilityCarrierConnection extends VersionedResource { + /** + * + * @type {string} + * @memberof FacilityCarrierConnection + */ + id: string; + /** + * The id of the facility reference. + * @type {string} + * @memberof FacilityCarrierConnection + */ + facilityRef: string; /** * ID that references the configured carrier. * @type {string} @@ -5368,10 +6479,10 @@ export interface FacilityCarrierConnection extends VersionedResource { key: string; /** * Facility specific configuration for this carrier - * @type {GlsFacilityCarrierConfiguration | AngelFacilityCarrierConfiguration | PostNLFacilityCarrierConfiguration | DpdChFacilityCarrierConfiguration | DhlV2FacilityCarrierConfiguration | VceFacilityCarrierConfiguration} + * @type {GlsFacilityCarrierConfiguration | AngelFacilityCarrierConfiguration | PostNLFacilityCarrierConfiguration | DpdChFacilityCarrierConfiguration | DhlV2FacilityCarrierConfiguration | VceFacilityCarrierConfiguration | BringFacilityCarrierConfiguration | FedExFacilityCarrierConfiguration} * @memberof FacilityCarrierConnection */ - configuration?: GlsFacilityCarrierConfiguration | AngelFacilityCarrierConfiguration | PostNLFacilityCarrierConfiguration | DpdChFacilityCarrierConfiguration | DhlV2FacilityCarrierConfiguration | VceFacilityCarrierConfiguration; + configuration?: GlsFacilityCarrierConfiguration | AngelFacilityCarrierConfiguration | PostNLFacilityCarrierConfiguration | DpdChFacilityCarrierConfiguration | DhlV2FacilityCarrierConfiguration | VceFacilityCarrierConfiguration | BringFacilityCarrierConfiguration | FedExFacilityCarrierConfiguration; /** * Facility specific credentials for this carrier * @type {DHLV2BusinessCredentials | DpdChCarrierCredentials | PostNLCarrierCredentials | VceCarrierCredentials} @@ -5384,6 +6495,12 @@ export interface FacilityCarrierConnection extends VersionedResource { * @memberof FacilityCarrierConnection */ cutoffTime?: CutoffTime; + /** + * + * @type {CarrierCutoffTimes} + * @memberof FacilityCarrierConnection + */ + cutoffTimes: CarrierCutoffTimes; /** * * @type {Array} @@ -5429,22 +6546,28 @@ export interface FacilityCarrierConnection extends VersionedResource { export interface FacilityCarrierConnectionForCreation { /** * Facility specific credentials for this carrier - * @type {DHLV2BusinessCredentials | DpdChCarrierCredentials | PostNLCarrierCredentials} + * @type {DHLV2BusinessCredentials | DpdChCarrierCredentials | PostNLCarrierCredentials | VceCarrierCredentials} * @memberof FacilityCarrierConnectionForCreation */ - credentials?: DHLV2BusinessCredentials | DpdChCarrierCredentials | PostNLCarrierCredentials; + credentials?: DHLV2BusinessCredentials | DpdChCarrierCredentials | PostNLCarrierCredentials | VceCarrierCredentials; /** * Facility specific configuration for this carrier - * @type {GlsFacilityCarrierConfiguration | AngelFacilityCarrierConfiguration | PostNLFacilityCarrierConfiguration | DpdChFacilityCarrierConfiguration | DhlV2FacilityCarrierConfiguration | VceFacilityCarrierConfiguration} + * @type {GlsFacilityCarrierConfiguration | AngelFacilityCarrierConfiguration | PostNLFacilityCarrierConfiguration | DpdChFacilityCarrierConfiguration | DhlV2FacilityCarrierConfiguration | VceFacilityCarrierConfiguration | BringFacilityCarrierConfiguration | FedExFacilityCarrierConfiguration} * @memberof FacilityCarrierConnectionForCreation */ - configuration?: GlsFacilityCarrierConfiguration | AngelFacilityCarrierConfiguration | PostNLFacilityCarrierConfiguration | DpdChFacilityCarrierConfiguration | DhlV2FacilityCarrierConfiguration | VceFacilityCarrierConfiguration; + configuration?: GlsFacilityCarrierConfiguration | AngelFacilityCarrierConfiguration | PostNLFacilityCarrierConfiguration | DpdChFacilityCarrierConfiguration | DhlV2FacilityCarrierConfiguration | VceFacilityCarrierConfiguration | BringFacilityCarrierConfiguration | FedExFacilityCarrierConfiguration; /** * * @type {CutoffTime} * @memberof FacilityCarrierConnectionForCreation */ cutoffTime?: CutoffTime; + /** + * + * @type {CarrierCutoffTimes} + * @memberof FacilityCarrierConnectionForCreation + */ + cutoffTimes?: CarrierCutoffTimes; /** * * @type {Array} @@ -5496,16 +6619,22 @@ export interface FacilityCarrierConnectionForModification { credentials?: DHLV2BusinessCredentials | DpdChCarrierCredentials | PostNLCarrierCredentials | VceCarrierCredentials; /** * Facility specific configuration for this carrier - * @type {GlsFacilityCarrierConfiguration | AngelFacilityCarrierConfiguration | PostNLFacilityCarrierConfiguration | DpdChFacilityCarrierConfiguration | DhlV2FacilityCarrierConfiguration | VceFacilityCarrierConfiguration} + * @type {GlsFacilityCarrierConfiguration | AngelFacilityCarrierConfiguration | PostNLFacilityCarrierConfiguration | DpdChFacilityCarrierConfiguration | DhlV2FacilityCarrierConfiguration | VceFacilityCarrierConfiguration | BringFacilityCarrierConfiguration | FedExFacilityCarrierConfiguration} * @memberof FacilityCarrierConnectionForModification */ - configuration?: GlsFacilityCarrierConfiguration | AngelFacilityCarrierConfiguration | PostNLFacilityCarrierConfiguration | DpdChFacilityCarrierConfiguration | DhlV2FacilityCarrierConfiguration | VceFacilityCarrierConfiguration; + configuration?: GlsFacilityCarrierConfiguration | AngelFacilityCarrierConfiguration | PostNLFacilityCarrierConfiguration | DpdChFacilityCarrierConfiguration | DhlV2FacilityCarrierConfiguration | VceFacilityCarrierConfiguration | BringFacilityCarrierConfiguration | FedExFacilityCarrierConfiguration; /** * * @type {CutoffTime} * @memberof FacilityCarrierConnectionForModification */ cutoffTime?: CutoffTime; + /** + * + * @type {CarrierCutoffTimes} + * @memberof FacilityCarrierConnectionForModification + */ + cutoffTimes?: CarrierCutoffTimes; /** * * @type {Array} @@ -5924,6 +7053,25 @@ export interface FacilityPatchActions { */ version: number; } +/** + * + * @export + * @interface FacilityRefLatestPickingStartPair + */ +export interface FacilityRefLatestPickingStartPair { + /** + * + * @type {string} + * @memberof FacilityRefLatestPickingStartPair + */ + facilityRef: string; + /** + * + * @type {Date} + * @memberof FacilityRefLatestPickingStartPair + */ + latestPickingStart: Date; +} /** * The description of the service this facility offers. * @export @@ -6177,12 +7325,6 @@ export interface FacilityStockDistribution { * @memberof FacilityStockDistribution */ safetyStock: number; - /** - * - * @type {Array} - * @memberof FacilityStockDistribution - */ - expectedStocks: Array; /** * * @type {ByTrait} @@ -6386,6 +7528,19 @@ export interface Features { */ total?: number; } +/** + * + * @export + * @interface FedExFacilityCarrierConfiguration + */ +export interface FedExFacilityCarrierConfiguration extends AbstractFacilityCarrierConfiguration { + /** + * + * @type {string} + * @memberof FedExFacilityCarrierConfiguration + */ + trackAndTraceUrl?: string; +} /** * * @export @@ -6422,6 +7577,12 @@ export interface FedexCarrierConfiguration extends CarrierConfiguration { * @memberof FedexCarrierConfiguration */ defaultCommodityDescription: string; + /** + * + * @type {string} + * @memberof FedexCarrierConfiguration + */ + trackAndTraceUrl?: string; } /** * @@ -6693,6 +7854,32 @@ export interface FixedCountConfiguration { */ maxSplitCount: number; } +/** + * + * @export + * @interface FloatValidation + */ +export interface FloatValidation extends BaseValidation { + /** + * + * @type {number} + * @memberof FloatValidation + */ + minValue?: number; + /** + * + * @type {number} + * @memberof FloatValidation + */ + maxValue?: number; +} + +/** + * @export + * @namespace FloatValidation + */ +export namespace FloatValidation { +} /** * The response to a fulfillability request. * @export @@ -7245,6 +8432,18 @@ export interface GlsCarrierConfiguration extends CarrierConfiguration { * @memberof GlsCarrierConfiguration */ alternativeReturnAddressLocationId?: string; + /** + * + * @type {string} + * @memberof GlsCarrierConfiguration + */ + trackAndTraceUrl?: string; + /** + * + * @type {string} + * @memberof GlsCarrierConfiguration + */ + trackAndTraceWsdlUrl?: string; } /** * @@ -7264,6 +8463,18 @@ export interface GlsFacilityCarrierConfiguration extends AbstractFacilityCarrier * @memberof GlsFacilityCarrierConfiguration */ returnContactId?: string; + /** + * + * @type {string} + * @memberof GlsFacilityCarrierConfiguration + */ + trackAndTraceUrl?: string; + /** + * + * @type {string} + * @memberof GlsFacilityCarrierConfiguration + */ + trackAndTraceWsdlUrl?: string; } /** * @@ -7276,7 +8487,26 @@ export interface HandoverConfiguration extends VersionedResource { * @type {Array} * @memberof HandoverConfiguration */ - availableRefusedReasons: Array; + availableRefusedReasons?: Array; +} +/** + * + * @export + * @interface HandoverConfigurationForCreate + */ +export interface HandoverConfigurationForCreate { + /** + * + * @type {number} + * @memberof HandoverConfigurationForCreate + */ + version: number; + /** + * + * @type {Array} + * @memberof HandoverConfigurationForCreate + */ + availableRefusedReasons?: Array; } /** * @@ -7440,23 +8670,23 @@ export interface HandoverLineItem { */ article: HandoverLineItemArticle; /** - * The amount of articles that were picked for this handover line item. + * quantity of the specific item that has been provided for handover * @type {number} * @memberof HandoverLineItem */ - handedOverQuantity: number; + quantity: number; /** - * quantity of the specific article that has been ordered + * quantity of the specific item that has been handed over * @type {number} * @memberof HandoverLineItem */ - quantity: number; + handedOverQuantity: number; /** *

This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and / or might not be available at all times in your API instance. 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

- * @type {Array} + * @type {Array} * @memberof HandoverLineItem */ - substituteLineItems?: Array; + substituteLineItems?: Array; /** * * @type {Array} @@ -7478,10 +8708,29 @@ export interface HandoverLineItem { export interface HandoverLineItemArticle extends AbstractArticle { /** * - * @type {Array} + * @type {Array} * @memberof HandoverLineItemArticle */ - attributes?: Array; + attributes?: Array; +} +/** + * + * @export + * @interface HandoverSubstituteLineItem + */ +export interface HandoverSubstituteLineItem extends SubstituteLineItem { + /** + * quantity of the specific item to substitute the original line item that has been provided for handover + * @type {number} + * @memberof HandoverSubstituteLineItem + */ + quantity: number; + /** + * quantity of the specific item to substitute the original line item that has been handed over + * @type {number} + * @memberof HandoverSubstituteLineItem + */ + handedOverQuantity?: number; } /** * @@ -7561,6 +8810,12 @@ export interface Handoverjob extends VersionedResource { * @memberof Handoverjob */ processId?: string; + /** + * + * @type {string} + * @memberof Handoverjob + */ + operativeProcessRef?: string; /** * The reference to the shipment belonging to the handoverjob * @type {string} @@ -7632,7 +8887,13 @@ export interface Handoverjob extends VersionedResource { * @type {string} * @memberof Handoverjob */ - fullIdentifier?: string; + fullIdentifier?: string; + /** + * + * @type {Array} + * @memberof Handoverjob + */ + transfers?: Array; /** * Indicates if gdpr related data was anonymized * @type {boolean} @@ -7757,6 +9018,12 @@ export interface HandoverjobForCreation { * @memberof HandoverjobForCreation */ processId?: string; + /** + * + * @type {string} + * @memberof HandoverjobForCreation + */ + operativeProcessRef?: string; /** * The reference to the shipment belonging to the handoverjob * @type {string} @@ -7829,6 +9096,12 @@ export interface HandoverjobForCreation { * @memberof HandoverjobForCreation */ fullIdentifier?: string; + /** + * + * @type {Array} + * @memberof HandoverjobForCreation + */ + transfers?: Array; } /** @@ -8307,6 +9580,12 @@ export interface InboundLineItem { * @memberof InboundLineItem */ quantity: Quantity; + /** + * + * @type {StockPropertyPreset} + * @memberof InboundLineItem + */ + stockProperties?: StockPropertyPreset; } /** * @@ -8594,6 +9873,12 @@ export interface InboundProcessPurchaseOrder { * @memberof InboundProcessPurchaseOrder */ supplier?: InboundProcessPurchaseOrderSupplier; + /** + * + * @type {InboundProcessPurchaseOrderTransfer} + * @memberof InboundProcessPurchaseOrder + */ + transfer?: InboundProcessPurchaseOrderTransfer; /** * Attributes that can be added to this entity. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities. * @type {any} @@ -8760,6 +10045,19 @@ export interface InboundProcessPurchaseOrderSupplier { */ name?: string; } +/** + * + * @export + * @interface InboundProcessPurchaseOrderTransfer + */ +export interface InboundProcessPurchaseOrderTransfer { + /** + * + * @type {string} + * @memberof InboundProcessPurchaseOrderTransfer + */ + id: string; +} /** * * @export @@ -9273,6 +10571,32 @@ export namespace InputRequestedDate { TIMEPOINT = 'TIME_POINT' } } +/** + * + * @export + * @interface IntegerValidation + */ +export interface IntegerValidation extends BaseValidation { + /** + * + * @type {number} + * @memberof IntegerValidation + */ + minValue?: number; + /** + * + * @type {number} + * @memberof IntegerValidation + */ + maxValue?: number; +} + +/** + * @export + * @namespace IntegerValidation + */ +export namespace IntegerValidation { +} /** * * @export @@ -9281,10 +10605,10 @@ export namespace InputRequestedDate { export interface InventoryArticle { /** * - * @type {Array} + * @type {Array} * @memberof InventoryArticle */ - attributes?: Array; + attributes?: Array; /** * * @type {string} @@ -9303,6 +10627,12 @@ export interface InventoryArticle { * @memberof InventoryArticle */ title: string; + /** + * + * @type {LocaleString} + * @memberof InventoryArticle + */ + titleLocalized?: LocaleString; } /** * @@ -9379,6 +10709,12 @@ export interface InventoryConfigurationForPatch { * @interface InventoryFacilityConfiguration */ export interface InventoryFacilityConfiguration { + /** + * + * @type {string} + * @memberof InventoryFacilityConfiguration + */ + id: string; /** * * @type {number} @@ -9935,6 +11271,12 @@ export interface ItemReturnJobLineItemArticle extends AbstractArticle { * @memberof ItemReturnJobLineItemArticle */ attributes?: Array; + /** + * + * @type {Array} + * @memberof ItemReturnJobLineItemArticle + */ + prices?: Array; } /** * @@ -10032,7 +11374,13 @@ export interface ItemReturnLineItem extends ItemReturnLineItemForCreation { * @type {Array} * @memberof ItemReturnLineItem */ - reasons: Array; + reasons?: Array; + /** + * + * @type {ReturnedLineItemRefund} + * @memberof ItemReturnLineItem + */ + refund?: ReturnedLineItemRefund; } /** * @@ -10075,7 +11423,32 @@ export interface ItemReturnLineItemForCreation { * @type {Array} * @memberof ItemReturnLineItemForCreation */ - reasons: Array; + reasons?: Array; +} +/** + * + * @export + * @interface ItemReturnLineItemForUpdate + */ +export interface ItemReturnLineItemForUpdate { + /** + * + * @type {ItemReturnLineItemStatus} + * @memberof ItemReturnLineItemForUpdate + */ + status?: ItemReturnLineItemStatus; + /** + * + * @type {ReturnedLineItemRefund} + * @memberof ItemReturnLineItemForUpdate + */ + refund?: ReturnedLineItemRefund; + /** + * version of the overlaying itemReturnJob + * @type {number} + * @memberof ItemReturnLineItemForUpdate + */ + itemReturnJobVersion: number; } /** * @@ -10124,7 +11497,40 @@ export enum ItemReturnStatus { OPEN = 'OPEN', INPROGRESS = 'IN_PROGRESS', PAUSED = 'PAUSED', - FINISHED = 'FINISHED' + FINISHED = 'FINISHED', + WAITINGFORINPUT = 'WAITING_FOR_INPUT' +} +/** + * + * @export + * @interface ItemReturns + */ +export interface ItemReturns { + /** + * + * @type {Array} + * @memberof ItemReturns + */ + itemReturns: Array; + /** + * Total number of found entities for this query + * @type {number} + * @memberof ItemReturns + */ + totalCount: number; +} +/** + * + * @export + * @interface ItemReturnsWithSearchPaths + */ +export interface ItemReturnsWithSearchPaths extends ItemReturn { + /** + * + * @type {Array} + * @memberof ItemReturnsWithSearchPaths + */ + searchPaths: Array; } /** * @@ -10266,6 +11672,12 @@ export interface LinkedServiceJobs extends VersionedResource { * @memberof LinkedServiceJobs */ serviceJobLinks: Array; + /** + * + * @type {string} + * @memberof LinkedServiceJobs + */ + operativeProcessRef?: string; /** * Full identifier of the service job. Using the full name of the customer when created from an order. * @type {string} @@ -10294,12 +11706,24 @@ export interface LinkedServiceJobsForCreation { * @memberof LinkedServiceJobsForCreation */ serviceJobLinks: Array; + /** + * + * @type {string} + * @memberof LinkedServiceJobsForCreation + */ + operativeProcessRef?: string; /** * Full identifier of the service job. Using the full name of the customer when created from an order. * @type {string} * @memberof LinkedServiceJobsForCreation */ fullIdentifier?: string; + /** + * + * @type {LinkedServiceJobsStatus} + * @memberof LinkedServiceJobsForCreation + */ + status?: LinkedServiceJobsStatus; } /** * Attribute to order linked service jobs by @@ -10341,7 +11765,8 @@ export enum LinkedServiceJobsStatus { INPROGRESS = 'IN_PROGRESS', FINISHED = 'FINISHED', CANCELLED = 'CANCELLED', - OBSOLETE = 'OBSOLETE' + OBSOLETE = 'OBSOLETE', + NOTREADY = 'NOT_READY' } /** * @@ -10438,6 +11863,18 @@ export namespace Listing { * @interface ListingAttributeItem */ export interface ListingAttributeItem extends ArticleAttributeItem { + /** + * + * @type {LocaleString} + * @memberof ListingAttributeItem + */ + keyLocalized?: LocaleString; + /** + * + * @type {LocaleString} + * @memberof ListingAttributeItem + */ + valueLocalized?: LocaleString; } /** @@ -10507,6 +11944,12 @@ export interface ListingForCreation { * @memberof ListingForCreation */ title: string; + /** + * + * @type {LocaleString} + * @memberof ListingForCreation + */ + titleLocalized?: LocaleString; /** *

This endpoint is deprecated and has been replaced.

@deprecated This field is deprecated since 11th of September 2023. Use /api/stocks endpoints instead. * @type {Array} @@ -10567,6 +12010,12 @@ export interface ListingForCreation { * @memberof ListingForCreation */ stockProperties?: { [key: string]: StockPropertyDefinition; }; + /** + * + * @type {AvailableUntilDefinition} + * @memberof ListingForCreation + */ + stockAvailableUntil?: AvailableUntilDefinition; /** * * @type {ListingLegal} @@ -11150,7 +12599,7 @@ export interface LocaleConfiguration extends VersionedResource { id?: string; } /** - * + * Provides Localized values. The key is the locale, the value is the translation. See https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/localization#fallback-language-mechanism * @export * @interface LocaleString */ @@ -11524,6 +12973,12 @@ export interface ModifyAddress { * @memberof ModifyAddress */ country?: string; + /** + * + * @type {string} + * @memberof ModifyAddress + */ + province?: string; /** * Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here. * @type {any} @@ -12372,6 +13827,12 @@ export interface ModifyListingAction extends AbstractModificationAction { * @memberof ModifyListingAction */ title?: string; + /** + * + * @type {LocaleString} + * @memberof ModifyListingAction + */ + titleLocalized?: LocaleString; /** * * @type {Array} @@ -12420,6 +13881,12 @@ export interface ModifyListingAction extends AbstractModificationAction { * @memberof ModifyListingAction */ stockProperties?: { [key: string]: StockPropertyDefinition; }; + /** + * + * @type {AvailableUntilDefinition} + * @memberof ModifyListingAction + */ + stockAvailableUntil?: AvailableUntilDefinition; /** * * @type {ListingLegal} @@ -12807,6 +14274,18 @@ export interface ModifyParcelAction extends AbstractModificationAction { * @memberof ModifyParcelAction */ customAttributes?: any; + /** + * Only changable on status OPEN or FAILED of the existing Parcel + * @type {string} + * @memberof ModifyParcelAction + */ + carrierProduct?: string; + /** + * + * @type {ParcelServices} + * @memberof ModifyParcelAction + */ + services?: ParcelServices; } /** @@ -12966,6 +14445,14 @@ export namespace ModifyPickJobLastEditorAction { ModifyPickJobLastEditor = 'ModifyPickJobLastEditor' } } +/** + * + * @export + * @enum {string} + */ +export enum ModifyPickJobLineItemsActionEnum { + MODIFYPICKJOBLINEITEMS = 'MODIFY_PICK_JOB_LINE_ITEMS' +} /** * * @export @@ -12990,6 +14477,12 @@ export interface ModifyPickLineItemAction extends AbstractModificationAction { * @memberof ModifyPickLineItemAction */ picked?: number; + /** + * Date when the line has been picked. + * @type {Date} + * @memberof ModifyPickLineItemAction + */ + pickedAt?: Date; /** * Attributes that can be added to the pick ine item. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here. * @type {any} @@ -13038,6 +14531,12 @@ export interface ModifyPickLineItemAction extends AbstractModificationAction { * @memberof ModifyPickLineItemAction */ substituteLineItems?: Array; + /** + * + * @type {LocaleString} + * @memberof ModifyPickLineItemAction + */ + shortPickReasonLocalized?: LocaleString; } /** @@ -13053,6 +14552,31 @@ export namespace ModifyPickLineItemAction { ModifyPickLineItem = 'ModifyPickLineItem' } } +/** + * + * @export + * @interface ModifyPickLineItemsActionParameter + */ +export interface ModifyPickLineItemsActionParameter { + /** + * + * @type {ModifyPickJobLineItemsActionEnum} + * @memberof ModifyPickLineItemsActionParameter + */ + name: ModifyPickJobLineItemsActionEnum; + /** + * Version of the entity to be changed + * @type {number} + * @memberof ModifyPickLineItemsActionParameter + */ + version: number; + /** + * + * @type {Array} + * @memberof ModifyPickLineItemsActionParameter + */ + pickJobLineItemUpdates: Array; +} /** * * @export @@ -13735,20 +15259,104 @@ export interface NamedFile { * @type {string} * @memberof NamedFile */ - name: string; + name: string; +} +/** + * + * @export + * @interface NeedsPacking + */ +export interface NeedsPacking { + /** + * + * @type {boolean} + * @memberof NeedsPacking + */ + needsPacking: boolean; +} +/** + * + * @export + * @interface NonDeliveryDays + */ +export interface NonDeliveryDays { + /** + * + * @type {NonDeliveryType} + * @memberof NonDeliveryDays + */ + nonDeliveryType?: NonDeliveryType; + /** + * + * @type {Date} + * @memberof NonDeliveryDays + */ + nonDeliveryDay: Date; +} +/** + * + * @export + * @interface NonDeliveryDaysPerCountryAndProvince + */ +export interface NonDeliveryDaysPerCountryAndProvince { + /** + * + * @type {string} + * @memberof NonDeliveryDaysPerCountryAndProvince + */ + country: string; + /** + * + * @type {Array} + * @memberof NonDeliveryDaysPerCountryAndProvince + */ + nonDeliveryDays: Array; + /** + * + * @type {Array} + * @memberof NonDeliveryDaysPerCountryAndProvince + */ + recurringNonDeliveryWeekdays: Array; + /** + * + * @type {Array} + * @memberof NonDeliveryDaysPerCountryAndProvince + */ + nonDeliveryDaysPerProvince: Array; } /** * * @export - * @interface NeedsPacking + * @interface NonDeliveryDaysPerProvince */ -export interface NeedsPacking { +export interface NonDeliveryDaysPerProvince { /** * - * @type {boolean} - * @memberof NeedsPacking + * @type {string} + * @memberof NonDeliveryDaysPerProvince */ - needsPacking: boolean; + province: string; + /** + * + * @type {Array} + * @memberof NonDeliveryDaysPerProvince + */ + nonDeliveryDays: Array; + /** + * + * @type {Array} + * @memberof NonDeliveryDaysPerProvince + */ + recurringNonDeliveryWeekdays: Array; +} +/** + * + * @export + * @enum {string} + */ +export enum NonDeliveryType { + SINGLE = 'SINGLE', + RECURRING = 'RECURRING' } /** * @@ -14089,7 +15697,8 @@ export enum OperativeEntityType { PARCEL = 'PARCEL', SERVICEJOB = 'SERVICE_JOB', RESTOWITEM = 'RESTOW_ITEM', - ITEMRETURNJOB = 'ITEM_RETURN_JOB' + ITEMRETURNJOB = 'ITEM_RETURN_JOB', + LINKEDSERVICEJOBS = 'LINKED_SERVICE_JOBS' } /** * @@ -14153,6 +15762,25 @@ export interface OperativeProcessForCreation { */ entityChildren?: Array; } +/** + * + * @export + * @interface OperativeTransfer + */ +export interface OperativeTransfer { + /** + * The id of the transfer + * @type {string} + * @memberof OperativeTransfer + */ + id: string; + /** + * The type of the transfer + * @type {string} + * @memberof OperativeTransfer + */ + type: string; +} /** * * @export @@ -14177,6 +15805,12 @@ export interface Order extends OrderForCreation { * @memberof Order */ version: number; + /** + * + * @type {CancelationReason} + * @memberof Order + */ + cancelationReason?: CancelationReason; /** * Indicates if gdpr related data was anonymized * @type {boolean} @@ -14213,6 +15847,12 @@ export interface Order extends OrderForCreation { * @memberof Order */ schemaVersion?: number; + /** + * + * @type {OrderStatus} + * @memberof Order + */ + status: OrderStatus; } /** * @@ -14241,6 +15881,12 @@ export namespace OrderArticleAttributeItem { * @interface OrderCancelActionParameter */ export interface OrderCancelActionParameter extends AbstractOrderActionsParameter { + /** + * ID of the cancelation reason + * @type {string} + * @memberof OrderCancelActionParameter + */ + cancelationReasonId?: string; /** * * @type {string} @@ -14488,12 +16134,6 @@ export interface OrderForCreation { * @memberof OrderForCreation */ paymentInfo?: OrderPaymentInfo; - /** - * The point in time by which the order is supposed to be provisioned. - * @type {Date} - * @memberof OrderForCreation - */ - provisioningTime?: Date; /** * * @type {Array} @@ -14532,6 +16172,19 @@ export interface OrderForCreationConsumer { */ email?: string; } +/** + * + * @export + * @interface OrderIdCancelBody + */ +export interface OrderIdCancelBody { + /** + * ID of the cancelation reason + * @type {string} + * @memberof OrderIdCancelBody + */ + cancelationReasonId?: string; +} /** * * @export @@ -15086,6 +16739,12 @@ export interface PackJob extends VersionedResource { * @memberof PackJob */ processId: string; + /** + * + * @type {string} + * @memberof PackJob + */ + operativeProcessRef?: string; /** * Until when the pack job must be finished. * @type {Date} @@ -15116,6 +16775,12 @@ export interface PackJob extends VersionedResource { * @memberof PackJob */ recipient?: ConsumerAddress; + /** + * + * @type {ConsumerAddress} + * @memberof PackJob + */ + invoice?: ConsumerAddress; /** * * @type {string} @@ -15158,6 +16823,12 @@ export interface PackJob extends VersionedResource { * @memberof PackJob */ shortId?: string; + /** + * + * @type {Array} + * @memberof PackJob + */ + transfers?: Array; } /** @@ -15174,6 +16845,19 @@ export namespace PackJob { SHIPPING = 'SHIPPING' } } +/** + * + * @export + * @interface PackJobCanceledWebHookEvent + */ +export interface PackJobCanceledWebHookEvent extends WebHookEvent { + /** + * + * @type {PackJob} + * @memberof PackJobCanceledWebHookEvent + */ + payload: PackJob; +} /** * * @export @@ -15254,6 +16938,12 @@ export interface PackJobForCreation { * @memberof PackJobForCreation */ processId?: string; + /** + * + * @type {string} + * @memberof PackJobForCreation + */ + operativeProcessRef?: string; /** * * @type {string} @@ -15284,6 +16974,12 @@ export interface PackJobForCreation { * @memberof PackJobForCreation */ recipient?: ConsumerAddress; + /** + * + * @type {ConsumerAddress} + * @memberof PackJobForCreation + */ + invoice?: ConsumerAddress; /** * * @type {string} @@ -15296,6 +16992,12 @@ export interface PackJobForCreation { * @memberof PackJobForCreation */ shortId?: string; + /** + * + * @type {Array} + * @memberof PackJobForCreation + */ + transfers?: Array; } /** @@ -15333,10 +17035,10 @@ export enum PackJobOrderBy { export interface PackJobPatchActions { /** * - * @type {Array} + * @type {Array} * @memberof PackJobPatchActions */ - actions: Array; + actions: Array; /** * The version of the document to be used in optimistic locking mechanisms. * @type {number} @@ -15354,7 +17056,8 @@ export enum PackJobStatus { INPROGRESS = 'IN_PROGRESS', CLOSED = 'CLOSED', OBSOLETE = 'OBSOLETE', - CANCELED = 'CANCELED' + CANCELED = 'CANCELED', + PAUSED = 'PAUSED' } /** * @@ -15521,254 +17224,60 @@ export interface PackLineItemForCreation { stickers?: Array; /** * - * @type {Array} - * @memberof PackLineItemForCreation - */ - scannableCodes?: Array; -} -/** - * - * @export - * @interface PackingConfigurations - */ -export interface PackingConfigurations extends VersionedResource { - /** - * - * @type {PackingContainerRequiredConfiguration} - * @memberof PackingConfigurations - */ - packingContainerRequiredConfiguration?: PackingContainerRequiredConfiguration; - /** - * - * @type {PackingItemConfirmationNeededConfiguration} - * @memberof PackingConfigurations - */ - packingItemConfirmationNeededConfiguration?: PackingItemConfirmationNeededConfiguration; - /** - * - * @type {PackingSourceContainerConfiguration} - * @memberof PackingConfigurations - */ - packingSourceContainerConfiguration?: PackingSourceContainerConfiguration; - /** - * - * @type {PackingScanningConfiguration} - * @memberof PackingConfigurations - */ - scanningConfiguration?: PackingScanningConfiguration; -} -/** - * - * @export - * @interface PackingContainer - */ -export interface PackingContainer extends VersionedResource { - /** - * - * @type {Array} - * @memberof PackingContainer - */ - codes: Array; - /** - * - * @type {Array} - * @memberof PackingContainer - */ - lineItems: Array; - /** - * - * @type {string} - * @memberof PackingContainer - */ - packingContainerTypeRef: string; - /** - * - * @type {string} - * @memberof PackingContainer - */ - description?: string; - /** - * - * @type {LocaleString} - * @memberof PackingContainer - */ - descriptionLocalized?: LocaleString; - /** - * The id of the facility reference. The given ID has to be present in the system. But it is not updatable via PUT request - * @type {string} - * @memberof PackingContainer - */ - facilityRef: string; - /** - * - * @type {string} - * @memberof PackingContainer - */ - packJobRef: string; - /** - * - * @type {string} - * @memberof PackingContainer - */ - iconUrl?: string; - /** - * - * @type {string} - * @memberof PackingContainer - */ - id: string; - /** - * - * @type {ContainerDimensions} - * @memberof PackingContainer - */ - dimensions?: ContainerDimensions; - /** - * Maximal weight in gramm(gr) the container can be loaded with. - * @type {number} - * @memberof PackingContainer - */ - weightLimitInG?: number; - /** - * - * @type {string} - * @memberof PackingContainer - */ - name?: string; - /** - * - * @type {LocaleString} - * @memberof PackingContainer - */ - nameLocalized: LocaleString; -} -/** - * - * @export - * @interface PackingContainerActionsParameter - */ -export interface PackingContainerActionsParameter { -} -/** - * - * @export - * @interface PackingContainerAttributeItem - */ -export interface PackingContainerAttributeItem extends ArticleAttributeItem { -} - -/** - * @export - * @namespace PackingContainerAttributeItem - */ -export namespace PackingContainerAttributeItem { -} -/** - * - * @export - * @interface PackingContainerForCreation - */ -export interface PackingContainerForCreation { - /** - * - * @type {Array} - * @memberof PackingContainerForCreation - */ - codes: Array; - /** - * - * @type {Array} - * @memberof PackingContainerForCreation - */ - lineItems?: Array; - /** - * - * @type {string} - * @memberof PackingContainerForCreation - */ - packingContainerTypeRef: string; -} -/** - * - * @export - * @interface PackingContainerLineItem - */ -export interface PackingContainerLineItem extends PackingContainerLineItemForCreation { - /** - * The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity. - * @type {string} - * @memberof PackingContainerLineItem - */ - id: string; -} -/** - * - * @export - * @interface PackingContainerLineItemArticle - */ -export interface PackingContainerLineItemArticle extends AbstractArticle { - /** - * - * @type {Array} - * @memberof PackingContainerLineItemArticle + * @type {Array} + * @memberof PackLineItemForCreation */ - attributes?: Array; + scannableCodes?: Array; } /** * * @export - * @interface PackingContainerLineItemForCreation + * @interface PackLineItemForUpdate */ -export interface PackingContainerLineItemForCreation { - /** - * - * @type {PackingContainerLineItemArticle} - * @memberof PackingContainerLineItemForCreation - */ - article?: PackingContainerLineItemArticle; - /** - * Attributes that can be added to the line item. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here. - * @type {any} - * @memberof PackingContainerLineItemForCreation - */ - customAttributes?: any; +export interface PackLineItemForUpdate { /** - * Identifier for items unit of measurement. + * references the id of the packLineItem of a packJob * @type {string} - * @memberof PackingContainerLineItemForCreation + * @memberof PackLineItemForUpdate */ - measurementUnitKey?: string; + id: string; /** - * quantity of the specific article that has been ordered + * The amount of articles that were packed for this packline. Can't be more than picked before. * @type {number} - * @memberof PackingContainerLineItemForCreation - */ - quantity?: number; - /** - * - * @type {Array} - * @memberof PackingContainerLineItemForCreation + * @memberof PackLineItemForUpdate */ - scannableCodes?: Array; + packed: number; } /** * * @export - * @interface PackingContainerPatchActions + * @interface PackingConfigurations */ -export interface PackingContainerPatchActions { +export interface PackingConfigurations extends VersionedResource { /** * - * @type {Array} - * @memberof PackingContainerPatchActions + * @type {PackingContainerRequiredConfiguration} + * @memberof PackingConfigurations */ - actions: Array; + packingContainerRequiredConfiguration?: PackingContainerRequiredConfiguration; /** - * The version of the document to be used in optimistic locking mechanisms. - * @type {number} - * @memberof PackingContainerPatchActions + * + * @type {PackingItemConfirmationNeededConfiguration} + * @memberof PackingConfigurations */ - version: number; + packingItemConfirmationNeededConfiguration?: PackingItemConfirmationNeededConfiguration; + /** + * + * @type {PackingSourceContainerConfiguration} + * @memberof PackingConfigurations + */ + packingSourceContainerConfiguration?: PackingSourceContainerConfiguration; + /** + * + * @type {PackingScanningConfiguration} + * @memberof PackingConfigurations + */ + scanningConfiguration?: PackingScanningConfiguration; } /** * @@ -16064,6 +17573,219 @@ export interface PackingSourceContainerForCreation { */ codes?: Array; } +/** + * + * @export + * @interface PackingTargetContainer + */ +export interface PackingTargetContainer extends VersionedResource { + /** + * + * @type {Array} + * @memberof PackingTargetContainer + */ + codes: Array; + /** + * + * @type {Array} + * @memberof PackingTargetContainer + */ + lineItems: Array; + /** + * + * @type {string} + * @memberof PackingTargetContainer + */ + packingContainerTypeRef: string; + /** + * + * @type {string} + * @memberof PackingTargetContainer + */ + description?: string; + /** + * + * @type {LocaleString} + * @memberof PackingTargetContainer + */ + descriptionLocalized?: LocaleString; + /** + * The id of the facility reference. The given ID has to be present in the system. But it is not updatable via PUT request + * @type {string} + * @memberof PackingTargetContainer + */ + facilityRef: string; + /** + * + * @type {string} + * @memberof PackingTargetContainer + */ + packJobRef: string; + /** + * + * @type {string} + * @memberof PackingTargetContainer + */ + iconUrl?: string; + /** + * + * @type {string} + * @memberof PackingTargetContainer + */ + id: string; + /** + * + * @type {ContainerDimensions} + * @memberof PackingTargetContainer + */ + dimensions?: ContainerDimensions; + /** + * Maximal weight in gramm(gr) the container can be loaded with. + * @type {number} + * @memberof PackingTargetContainer + */ + weightLimitInG?: number; + /** + * + * @type {string} + * @memberof PackingTargetContainer + */ + name?: string; + /** + * + * @type {LocaleString} + * @memberof PackingTargetContainer + */ + nameLocalized: LocaleString; +} +/** + * + * @export + * @interface PackingTargetContainerActionsParameter + */ +export interface PackingTargetContainerActionsParameter { +} +/** + * + * @export + * @interface PackingTargetContainerAttributeItem + */ +export interface PackingTargetContainerAttributeItem extends ArticleAttributeItem { +} + +/** + * @export + * @namespace PackingTargetContainerAttributeItem + */ +export namespace PackingTargetContainerAttributeItem { +} +/** + * + * @export + * @interface PackingTargetContainerForCreation + */ +export interface PackingTargetContainerForCreation { + /** + * + * @type {Array} + * @memberof PackingTargetContainerForCreation + */ + codes: Array; + /** + * + * @type {Array} + * @memberof PackingTargetContainerForCreation + */ + lineItems?: Array; + /** + * + * @type {string} + * @memberof PackingTargetContainerForCreation + */ + packingContainerTypeRef: string; +} +/** + * + * @export + * @interface PackingTargetContainerLineItem + */ +export interface PackingTargetContainerLineItem extends PackingTargetContainerLineItemForCreation { + /** + * The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity. + * @type {string} + * @memberof PackingTargetContainerLineItem + */ + id: string; +} +/** + * + * @export + * @interface PackingTargetContainerLineItemArticle + */ +export interface PackingTargetContainerLineItemArticle extends AbstractArticle { + /** + * + * @type {Array} + * @memberof PackingTargetContainerLineItemArticle + */ + attributes?: Array; +} +/** + * + * @export + * @interface PackingTargetContainerLineItemForCreation + */ +export interface PackingTargetContainerLineItemForCreation { + /** + * + * @type {PackingTargetContainerLineItemArticle} + * @memberof PackingTargetContainerLineItemForCreation + */ + article: PackingTargetContainerLineItemArticle; + /** + * Attributes that can be added to the line item. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here. + * @type {any} + * @memberof PackingTargetContainerLineItemForCreation + */ + customAttributes?: any; + /** + * Identifier for items unit of measurement. + * @type {string} + * @memberof PackingTargetContainerLineItemForCreation + */ + measurementUnitKey?: string; + /** + * quantity of the specific article that has been ordered + * @type {number} + * @memberof PackingTargetContainerLineItemForCreation + */ + quantity: number; + /** + * + * @type {Array} + * @memberof PackingTargetContainerLineItemForCreation + */ + scannableCodes?: Array; +} +/** + * + * @export + * @interface PackingTargetContainerPatchActions + */ +export interface PackingTargetContainerPatchActions { + /** + * + * @type {Array} + * @memberof PackingTargetContainerPatchActions + */ + actions: Array; + /** + * The version of the document to be used in optimistic locking mechanisms. + * @type {number} + * @memberof PackingTargetContainerPatchActions + */ + version: number; +} /** * * @export @@ -16149,12 +17871,24 @@ export interface Parcel extends VersionedResource { * @memberof Parcel */ recipient: ConsumerAddress; + /** + * + * @type {ConsumerAddress} + * @memberof Parcel + */ + invoice?: ConsumerAddress; /** * * @type {string} * @memberof Parcel */ processRef: string; + /** + * + * @type {string} + * @memberof Parcel + */ + operativeProcessRef?: string; /** * * @type {Array} @@ -16215,6 +17949,12 @@ export interface Parcel extends VersionedResource { * @memberof Parcel */ productValue?: number; + /** + * + * @type {Array} + * @memberof Parcel + */ + transfers?: Array; } /** * @@ -16340,6 +18080,12 @@ export interface ParcelForCreation { * @memberof ParcelForCreation */ recipient?: ConsumerAddress; + /** + * + * @type {ConsumerAddress} + * @memberof ParcelForCreation + */ + invoice?: ConsumerAddress; /** * * @type {FacilityAddress} @@ -16376,6 +18122,12 @@ export interface ParcelForCreation { * @memberof ParcelForCreation */ result?: ParcelResult; + /** + * + * @type {Array} + * @memberof ParcelForCreation + */ + transfers?: Array; } /** * @@ -16687,7 +18439,8 @@ export enum ParcelStatus { DONE = 'DONE', FAILED = 'FAILED', CANCELED = 'CANCELED', - OBSOLETE = 'OBSOLETE' + OBSOLETE = 'OBSOLETE', + WAITINGFORINPUT = 'WAITING_FOR_INPUT' } /** * @@ -16830,11 +18583,44 @@ export interface PauseItemReturnActionParameter { */ name: PauseItemReturnActionEnum; /** - * Version of the entity to be changed - * @type {number} - * @memberof PauseItemReturnActionParameter + * Version of the entity to be changed + * @type {number} + * @memberof PauseItemReturnActionParameter + */ + itemReturnJobVersion: number; +} +/** + * + * @export + * @interface PausePackJobAction + */ +export interface PausePackJobAction extends AbstractModificationAction { + /** + * Use value 'PausePackJob', because you want to pause a packjob + * @type {string} + * @memberof PausePackJobAction + */ + action: PausePackJobAction.ActionEnum; + /** + * + * @type {Array} + * @memberof PausePackJobAction + */ + packLineItemsUpdate?: Array; +} + +/** + * @export + * @namespace PausePackJobAction + */ +export namespace PausePackJobAction { + /** + * @export + * @enum {string} */ - itemReturnJobVersion: number; + export enum ActionEnum { + PausePackJob = 'PausePackJob' + } } /** * @@ -16947,6 +18733,12 @@ export interface PickJob extends PickJobForCreation { * @memberof PickJob */ pickLineItems: Array; + /** + * + * @type {Array} + * @memberof PickJob + */ + expectedPickLineItems?: Array; /** * A short identifier that helps assigning a pickJob to a customer. This is automatically created during creation. * @type {string} @@ -17084,6 +18876,12 @@ export interface PickJobForCreation { * @memberof PickJobForCreation */ pickLineItems: Array; + /** + * + * @type {Array} + * @memberof PickJobForCreation + */ + expectedPickLineItems?: Array; /** * * @type {PaymentInformation} @@ -17138,6 +18936,12 @@ export interface PickJobForCreation { * @memberof PickJobForCreation */ preferredPickingMethods?: Array; + /** + * + * @type {Array} + * @memberof PickJobForCreation + */ + transfers?: Array; } /** * @@ -17344,7 +19148,8 @@ export enum PickJobStatus { RESTOWED = 'RESTOWED', EXPIRED = 'EXPIRED', CANCELED = 'CANCELED', - OBSOLETE = 'OBSOLETE' + OBSOLETE = 'OBSOLETE', + WAITINGFORINPUT = 'WAITING_FOR_INPUT' } /** * The status of a pickjob. These are the status that are still allowed to be used in the deprecated status field of ModifyPickJob actions @@ -17359,7 +19164,8 @@ export enum PickJobStatusUnprotected { REROUTED = 'REROUTED', REJECTED = 'REJECTED', RESTOWED = 'RESTOWED', - EXPIRED = 'EXPIRED' + EXPIRED = 'EXPIRED', + WAITINGFORINPUT = 'WAITING_FOR_INPUT' } /** * @@ -17428,6 +19234,12 @@ export interface PickLineItem extends PickLineItemForCreation { * @memberof PickLineItem */ secondaryPicked?: number; + /** + * Date when the line has been picked. + * @type {Date} + * @memberof PickLineItem + */ + pickedAt?: Date; /** * * @type {PickLineItemStatus} @@ -17476,6 +19288,12 @@ export interface PickLineItem extends PickLineItemForCreation { * @memberof PickLineItem */ scanningRules?: PickLineItemScanningRules; + /** + * + * @type {PickLineShortPickReason} + * @memberof PickLineItem + */ + shortPickReason?: PickLineShortPickReason; } /** * @@ -17485,10 +19303,10 @@ export interface PickLineItem extends PickLineItemForCreation { export interface PickLineItemArticle extends AbstractArticle { /** * - * @type {Array} + * @type {Array} * @memberof PickLineItemArticle */ - attributes?: Array; + attributes?: Array; /** * * @type {Array} @@ -17626,27 +19444,101 @@ export enum PickLineItemStatus { /** * * @export - * @interface PickLineShortPickReason + * @interface PickLineItemUpdate */ -export interface PickLineShortPickReason { +export interface PickLineItemUpdate { /** - * + * The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity. * @type {string} - * @memberof PickLineShortPickReason + * @memberof PickLineItemUpdate */ id: string; /** - * The version of the document to be used in optimistic locking mechanisms. + * The amount of articles that were picked for this pickline. + * @type {number} + * @memberof PickLineItemUpdate + */ + picked?: number; + /** + * Date when the line has been picked. example: '2024-02-03T08:45:51.525Z' format: date-time type: string * @type {any} - * @memberof PickLineShortPickReason + * @memberof PickLineItemUpdate */ - version: any; + pickedAt?: any; /** - * Flag to mark a reason as active or inactive + * Attributes that can be added to the pick ine item. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here. + * @type {any} + * @memberof PickLineItemUpdate + */ + customAttributes?: any; + /** + * * @type {boolean} - * @memberof PickLineShortPickReason + * @memberof PickLineItemUpdate */ - active: boolean; + stockEmptied?: boolean; + /** + * + * @type {Array} + * @memberof PickLineItemUpdate + */ + stickers?: Array; + /** + * + * @type {Array} + * @memberof PickLineItemUpdate + */ + partialStockLocations?: Array; + /** + * Scanned Codes of the given picked line item + * @type {Array} + * @memberof PickLineItemUpdate + */ + scannedCodes?: Array; + /** + * + * @type {PickLineItemStatus} + * @memberof PickLineItemUpdate + */ + status?: PickLineItemStatus; + /** + * + * @type {number} + * @memberof PickLineItemUpdate + */ + secondaryPicked?: number; + /** + *

This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and / or might not be available at all times in your API instance. 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

+ * @type {Array} + * @memberof PickLineItemUpdate + */ + substituteLineItems?: Array; + /** + * + * @type {PickLineItemUpdateShortPickReason} + * @memberof PickLineItemUpdate + */ + shortPickReason?: PickLineItemUpdateShortPickReason; +} +/** + * + * @export + * @interface PickLineItemUpdateShortPickReason + */ +export interface PickLineItemUpdateShortPickReason { + /** + * + * @type {LocaleString} + * @memberof PickLineItemUpdateShortPickReason + */ + reasonLocalized?: LocaleString; +} +/** + * + * @export + * @interface PickLineShortPickReason + */ +export interface PickLineShortPickReason { /** * translated reasonLocalized according to the given locale * @type {string} @@ -18211,6 +20103,12 @@ export interface PickingShortPickConfiguration { * @memberof PickingShortPickConfiguration */ confirmationOnShortPick: boolean; + /** + * + * @type {Array} + * @memberof PickingShortPickConfiguration + */ + shortPickReasons?: Array; } /** * @@ -18322,6 +20220,19 @@ export interface PickjobAbortedWebHookEvent extends WebHookEvent { */ payload: PickJob; } +/** + * + * @export + * @interface PickjobCanceledWebHookEvent + */ +export interface PickjobCanceledWebHookEvent extends WebHookEvent { + /** + * + * @type {PickJob} + * @memberof PickjobCanceledWebHookEvent + */ + payload: PickJob; +} /** * * @export @@ -18592,6 +20503,25 @@ export interface PostNLFacilityCarrierConfiguration extends AbstractFacilityCarr * @memberof PostNLFacilityCarrierConfiguration */ customerCode: string; + /** + * + * @type {string} + * @memberof PostNLFacilityCarrierConfiguration + */ + trackAndTraceUrl?: string; +} +/** + * + * @export + * @interface PostNlCarrierConfiguration + */ +export interface PostNlCarrierConfiguration extends CarrierConfiguration { + /** + * + * @type {string} + * @memberof PostNlCarrierConfiguration + */ + trackAndTraceUrl?: string; } /** * @@ -18926,6 +20856,12 @@ export interface Process extends VersionedResource { * @memberof Process */ operativeStatus?: ProcessStatus; + /** + * + * @type {ProcessStatus} + * @memberof Process + */ + returnStatus?: ProcessStatus; /** * Overview of the different domain adherent status of the process. * @type {{ [key: string]: DomainStatus; }} @@ -18962,6 +20898,12 @@ export interface Process extends VersionedResource { * @memberof Process */ serviceJobRefs?: Array; + /** + * References to the external actions connected to this process (if any). + * @type {Array} + * @memberof Process + */ + externalActionRefs?: Array; } /** * @@ -19075,6 +21017,31 @@ export interface Processes { */ total?: number; } +/** + * + * @export + * @interface ProductInformation + */ +export interface ProductInformation { + /** + * The name of the product used by the carrier + * @type {string} + * @memberof ProductInformation + */ + productName?: string; + /** + * + * @type {Array} + * @memberof ProductInformation + */ + mandatoryShippingAttributes?: Array; + /** + * + * @type {Array} + * @memberof ProductInformation + */ + mandatoryShippingItemAttributes?: Array; +} /** * * @export @@ -19270,6 +21237,12 @@ export interface PurchaseOrder { * @memberof PurchaseOrder */ supplier?: InboundProcessPurchaseOrderSupplier; + /** + * + * @type {InboundProcessPurchaseOrderTransfer} + * @memberof PurchaseOrder + */ + transfer?: InboundProcessPurchaseOrderTransfer; /** * Attributes that can be added to this entity. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities. * @type {any} @@ -20106,34 +22079,34 @@ export namespace RemoveFacilityCoordinatesActionParameter { /** * * @export - * @interface RemoveLineItemFromPackingContainerAction + * @interface RemoveLineItemFromPackingTargetContainerAction */ -export interface RemoveLineItemFromPackingContainerAction extends AbstractModificationAction { +export interface RemoveLineItemFromPackingTargetContainerAction extends AbstractModificationAction { /** - * Use RemoveLineItemFromPackingContainer to remove a line item from an existing packing container + * Use RemoveLineItemFromPackingTargetContainer to remove a line item from an existing packing container * @type {string} - * @memberof RemoveLineItemFromPackingContainerAction + * @memberof RemoveLineItemFromPackingTargetContainerAction */ - action: RemoveLineItemFromPackingContainerAction.ActionEnum; + action: RemoveLineItemFromPackingTargetContainerAction.ActionEnum; /** * Id of the PackLineItem you want to remove. * @type {string} - * @memberof RemoveLineItemFromPackingContainerAction + * @memberof RemoveLineItemFromPackingTargetContainerAction */ lineItemRef: string; } /** * @export - * @namespace RemoveLineItemFromPackingContainerAction + * @namespace RemoveLineItemFromPackingTargetContainerAction */ -export namespace RemoveLineItemFromPackingContainerAction { +export namespace RemoveLineItemFromPackingTargetContainerAction { /** * @export * @enum {string} */ export enum ActionEnum { - RemoveLineItemFromPackingContainer = 'RemoveLineItemFromPackingContainer' + RemoveLineItemFromPackingTargetContainer = 'RemoveLineItemFromPackingTargetContainer' } } /** @@ -20172,34 +22145,34 @@ export namespace RemovePickJobFromPickRunAction { /** * * @export - * @interface ReplaceCodesInPackingContainerAction + * @interface ReplaceCodesInPackingTargetContainerAction */ -export interface ReplaceCodesInPackingContainerAction extends AbstractModificationAction { +export interface ReplaceCodesInPackingTargetContainerAction extends AbstractModificationAction { /** - * Use ReplaceCodesInPackingContainer to add a code to an existing packing container + * Use ReplaceCodesInPackingTargetContainer to add a code to an existing packing container * @type {string} - * @memberof ReplaceCodesInPackingContainerAction + * @memberof ReplaceCodesInPackingTargetContainerAction */ - action: ReplaceCodesInPackingContainerAction.ActionEnum; + action: ReplaceCodesInPackingTargetContainerAction.ActionEnum; /** * * @type {Array} - * @memberof ReplaceCodesInPackingContainerAction + * @memberof ReplaceCodesInPackingTargetContainerAction */ codes?: Array; } /** * @export - * @namespace ReplaceCodesInPackingContainerAction + * @namespace ReplaceCodesInPackingTargetContainerAction */ -export namespace ReplaceCodesInPackingContainerAction { +export namespace ReplaceCodesInPackingTargetContainerAction { /** * @export * @enum {string} */ export enum ActionEnum { - ReplaceCodesInPackingContainer = 'ReplaceCodesInPackingContainer' + ReplaceCodesInPackingTargetContainer = 'ReplaceCodesInPackingTargetContainer' } } /** @@ -20238,38 +22211,38 @@ export namespace ReplaceLoadUnitLineItemsAction { /** * * @export - * @interface ReplacePackingContainerLineItemCodesAction + * @interface ReplacePackingTargetContainerLineItemCodesAction */ -export interface ReplacePackingContainerLineItemCodesAction { +export interface ReplacePackingTargetContainerLineItemCodesAction { /** * - * @type {ReplacePackingContainerLineItemCodesEnum} - * @memberof ReplacePackingContainerLineItemCodesAction + * @type {ReplacePackingTargetContainerLineItemCodesEnum} + * @memberof ReplacePackingTargetContainerLineItemCodesAction */ - name: ReplacePackingContainerLineItemCodesEnum; + name: ReplacePackingTargetContainerLineItemCodesEnum; /** * Version of the entity to be changed * @type {number} - * @memberof ReplacePackingContainerLineItemCodesAction + * @memberof ReplacePackingTargetContainerLineItemCodesAction */ version: number; /** * - * @type {ReplacePackingContainerLineItemCodesActionPayload} - * @memberof ReplacePackingContainerLineItemCodesAction + * @type {ReplacePackingTargetContainerLineItemCodesActionPayload} + * @memberof ReplacePackingTargetContainerLineItemCodesAction */ - payload: ReplacePackingContainerLineItemCodesActionPayload; + payload: ReplacePackingTargetContainerLineItemCodesActionPayload; } /** * * @export - * @interface ReplacePackingContainerLineItemCodesActionPayload + * @interface ReplacePackingTargetContainerLineItemCodesActionPayload */ -export interface ReplacePackingContainerLineItemCodesActionPayload { +export interface ReplacePackingTargetContainerLineItemCodesActionPayload { /** * * @type {Array} - * @memberof ReplacePackingContainerLineItemCodesActionPayload + * @memberof ReplacePackingTargetContainerLineItemCodesActionPayload */ codes: Array; } @@ -20278,7 +22251,7 @@ export interface ReplacePackingContainerLineItemCodesActionPayload { * @export * @enum {string} */ -export enum ReplacePackingContainerLineItemCodesEnum { +export enum ReplacePackingTargetContainerLineItemCodesEnum { ReplaceLineItemCodes = 'ReplaceLineItemCodes' } /** @@ -20426,70 +22399,48 @@ export interface RerouteConfiguration { * @export * @interface RerouteDescription */ -export interface RerouteDescription extends RerouteDescriptionForModification { - /** - * The date this entity was created at the platform. This value is generated by the service. - * @type {Date} - * @memberof RerouteDescription - */ - created?: Date; - /** - * The date this entity was modified last. This value is generated by the service. - * @type {Date} - * @memberof RerouteDescription - */ - lastModified?: Date; +export interface RerouteDescription extends AbstractReason { /** - * The version of the document to be used in optimistic locking mechanisms. - * @type {number} + * + * @type {string} * @memberof RerouteDescription */ - version: number; + action: RerouteDescription.ActionEnum; +} + +/** + * @export + * @namespace RerouteDescription + */ +export namespace RerouteDescription { /** - * The id of the RerouteReasonDescription - * @type {string} - * @memberof RerouteDescription + * @export + * @enum {string} */ - id: string; + export enum ActionEnum { + REROUTE = 'REROUTE' + } } /** * * @export * @interface RerouteDescriptionForCreation */ -export interface RerouteDescriptionForCreation { - /** - * Text explaining the reason for rerouting an order. - * @type {string} - * @memberof RerouteDescriptionForCreation - */ - reason: string; - /** - * - * @type {LocaleString} - * @memberof RerouteDescriptionForCreation - */ - reasonLocalized: LocaleString; +export interface RerouteDescriptionForCreation extends AbstractReasonForCreation { } /** * * @export * @interface RerouteDescriptionForModification */ -export interface RerouteDescriptionForModification extends RerouteDescriptionForCreation { - /** - * The version of the document to be used in optimistic locking mechanisms. - * @type {number} - * @memberof RerouteDescriptionForModification - */ - version: number; +export interface RerouteDescriptionForModification extends AbstractReasonForModification { } /** * * @export * @interface RerouteDescriptions */ -export interface RerouteDescriptions { +export interface RerouteDescriptions extends AbstractReasons { /** * * @type {Array} @@ -20497,17 +22448,11 @@ export interface RerouteDescriptions { */ rerouteDescriptions: Array; /** - * True if there are more results after the current page - * @type {boolean} - * @memberof RerouteDescriptions - */ - hasNextPage: boolean; - /** - * Total number of found entities for this query - * @type {number} + * + * @type {Array} * @memberof RerouteDescriptions */ - total: number; + reasons: Array; } /** * @@ -21333,6 +23278,12 @@ export interface ReturnNote { * @memberof ReturnNote */ deliveryAddress?: DeliveryAddress; + /** + * if this field is filled, the delivery address will be taken from here according to this sorting: INVOICE_ADDRESS > POSTAL_ADDRESS. Each type is only allowed once. + * @type {Array} + * @memberof ReturnNote + */ + deliveryAddresses?: Array; /** * * @type {string} @@ -21661,26 +23612,80 @@ export interface ReturnTypeConfiguration { * @type {ReturnConfigurationType} * @memberof ReturnTypeConfiguration */ - type: ReturnConfigurationType; + type: ReturnConfigurationType; +} +/** + * + * @export + * @interface Returned + */ +export interface Returned { + /** + * Reason of return. + * @type {string} + * @memberof Returned + */ + reason?: string; + /** + * Amount of item which is returned + * @type {number} + * @memberof Returned + */ + returnedAmount: number; +} +/** + * Either price or percent must be set, not both. + * @export + * @interface ReturnedLineItemRefund + */ +export interface ReturnedLineItemRefund { + /** + * + * @type {ReturnedLineItemRefundStatus} + * @memberof ReturnedLineItemRefund + */ + status: ReturnedLineItemRefundStatus; + /** + * + * @type {ReturnedLineItemRefundPrice} + * @memberof ReturnedLineItemRefund + */ + price?: ReturnedLineItemRefundPrice; + /** + * 0.0 - 100.0 amount of the line item price that should be refunded + * @type {number} + * @memberof ReturnedLineItemRefund + */ + percent?: number; } /** * * @export - * @interface Returned + * @interface ReturnedLineItemRefundPrice */ -export interface Returned { +export interface ReturnedLineItemRefundPrice { /** - * Reason of return. - * @type {string} - * @memberof Returned + * 0.0 till line item price that should be refunded + * @type {number} + * @memberof ReturnedLineItemRefundPrice */ - reason?: string; + value: number; /** - * Amount of item which is returned - * @type {number} - * @memberof Returned + * The currency of the price as an ISO 4217 code. + * @type {CurrencyCode} + * @memberof ReturnedLineItemRefundPrice */ - returnedAmount: number; + currency: CurrencyCode; +} +/** + * + * @export + * @enum {string} + */ +export enum ReturnedLineItemRefundStatus { + OPEN = 'OPEN', + INPROGRESS = 'IN_PROGRESS', + CLOSED = 'CLOSED' } /** * A list of all rolenames and permissions assigned to the user @@ -21829,6 +23834,18 @@ export enum RoutingDecisionContext { * @interface RoutingPlan */ export interface RoutingPlan extends VersionedResource { + /** + * + * @type {Array} + * @memberof RoutingPlan + */ + transfers?: Array; + /** + * + * @type {Array} + * @memberof RoutingPlan + */ + expectedLineItems?: Array; /** * * @type {DeliveryPreferences} @@ -21974,11 +23991,17 @@ export interface RoutingPlan extends VersionedResource { */ status: RoutingPlanStatus; /** - * + *

This endpoint is deprecated and has been replaced.

@deprecated For more detailed information, use the History field. Saves all status changes when creating or updating a routing plan * @type {Array} * @memberof RoutingPlan */ statusHistory?: Array; + /** + * + * @type {Array} + * @memberof RoutingPlan + */ + history?: Array; /** * * @type {Array} @@ -22060,6 +24083,25 @@ export interface RoutingPlanFallbackRoutingWebHookEvent extends WebHookEvent { */ payload: RoutingPlan; } +/** + * + * @export + * @interface RoutingPlanHistory + */ +export interface RoutingPlanHistory { + /** + * + * @type {RoutingPlanStatus} + * @memberof RoutingPlanHistory + */ + status: RoutingPlanStatus; + /** + * Information about the time, when a routing plan status is set + * @type {Date} + * @memberof RoutingPlanHistory + */ + created: Date; +} /** * * @export @@ -22296,7 +24338,8 @@ export enum RoutingPlanStatus { OBSOLETE = 'OBSOLETE', CANCELED = 'CANCELED', LOCKED = 'LOCKED', - PROMISED = 'PROMISED' + PROMISED = 'PROMISED', + REROUTED = 'REROUTED' } /** * @@ -22904,6 +24947,25 @@ export interface ServiceJobAdditionalInformationForCreation { */ value?: string | number | boolean; } +/** + * + * @export + * @interface ServiceJobAdditionalInformationForUpdate + */ +export interface ServiceJobAdditionalInformationForUpdate { + /** + * ID of the additional information + * @type {string} + * @memberof ServiceJobAdditionalInformationForUpdate + */ + additionalInformationRef: string; + /** + * Value of the additional information + * @type {string | number | boolean} + * @memberof ServiceJobAdditionalInformationForUpdate + */ + value?: string | number | boolean; +} /** * * @export @@ -22930,6 +24992,12 @@ export interface ServiceJobCancelledActionParameter { * @memberof ServiceJobCancelledActionParameter */ version: number; + /** + * + * @type {Array} + * @memberof ServiceJobCancelledActionParameter + */ + additionalInformation?: Array; } /** * @@ -22966,6 +25034,12 @@ export interface ServiceJobFinishedActionParameter { * @memberof ServiceJobFinishedActionParameter */ version: number; + /** + * + * @type {Array} + * @memberof ServiceJobFinishedActionParameter + */ + additionalInformation?: Array; } /** * @@ -23066,6 +25140,12 @@ export interface ServiceJobInProgressActionParameter { * @memberof ServiceJobInProgressActionParameter */ version: number; + /** + * + * @type {Array} + * @memberof ServiceJobInProgressActionParameter + */ + additionalInformation?: Array; } /** * @@ -23246,6 +25326,12 @@ export interface ServiceJobOpenActionParameter { * @memberof ServiceJobOpenActionParameter */ version: number; + /** + * + * @type {Array} + * @memberof ServiceJobOpenActionParameter + */ + additionalInformation?: Array; } /** * Attribute to order service job by @@ -23298,6 +25384,12 @@ export interface ServiceJobWaitingForInputActionParameter { * @memberof ServiceJobWaitingForInputActionParameter */ version: number; + /** + * + * @type {Array} + * @memberof ServiceJobWaitingForInputActionParameter + */ + additionalInformation?: Array; } /** * @@ -23537,7 +25629,7 @@ export interface ShipmentForCreation { * @type {ConsumerAddress} * @memberof ShipmentForCreation */ - targetAddress: ConsumerAddress; + targetAddress?: ConsumerAddress; /** * * @type {ConsumerAddress} @@ -23580,6 +25672,12 @@ export interface ShipmentForCreation { * @memberof ShipmentForCreation */ tags?: Array; + /** + * + * @type {Array} + * @memberof ShipmentForCreation + */ + transfers?: Array; } /** * @@ -23602,10 +25700,10 @@ export interface ShipmentLineItem extends ShipmentLineItemForCreation { export interface ShipmentLineItemArticle extends AbstractArticle { /** * - * @type {Array} + * @type {Array} * @memberof ShipmentLineItemArticle */ - attributes?: Array; + attributes?: Array; } /** * @@ -23724,41 +25822,17 @@ export interface ShipmentWithSearchPath extends Shipment { */ export interface ShortPickReason { /** - * + * translated reasonLocalized according to the given locale * @type {string} * @memberof ShortPickReason */ - id: string; - /** - * The version of the document to be used in optimistic locking mechanisms. - * @type {any} - * @memberof ShortPickReason - */ - version: any; - /** - * The date this entity was created at the platform. This value is generated by the service. - * @type {Date} - * @memberof ShortPickReason - */ - created: Date; - /** - * The date this entity was modified last. This value is generated by the service. - * @type {Date} - * @memberof ShortPickReason - */ - lastModified: Date; + reason?: string; /** * Flag to mark a reason as active or inactive * @type {boolean} * @memberof ShortPickReason */ active: boolean; - /** - * translated reasonLocalized according to the given locale - * @type {string} - * @memberof ShortPickReason - */ - reason?: string; /** * * @type {LocaleString} @@ -24131,6 +26205,12 @@ export interface Stock { * @memberof Stock */ receiptDate: Date; + /** + * + * @type {Date} + * @memberof Stock + */ + availableUntil?: Date; /** * Attributes that can be added to this entity. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities. * @type {any} @@ -24432,6 +26512,12 @@ export interface StockForCreation { * @memberof StockForCreation */ receiptDate?: Date; + /** + * + * @type {Date} + * @memberof StockForCreation + */ + availableUntil?: Date; /** * Attributes that can be added to this entity. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities. * @type {any} @@ -24685,7 +26771,7 @@ export interface StockPropertyPreset { * @type {string} * @memberof StockPropertyPreset */ - receiptDate?: string; + batch?: string; } /** * @@ -24786,12 +26872,6 @@ export interface StockSummaryDetails { * @memberof StockSummaryDetails */ safetyStock: number; - /** - * - * @type {Array} - * @memberof StockSummaryDetails - */ - expectedStocks: Array; /** * * @type {ByTrait} @@ -24835,37 +26915,6 @@ export interface StockSummaryDetails { */ channelAdjusted?: Array; } -/** - * - * @export - * @interface StockSummaryExpectedStock - */ -export interface StockSummaryExpectedStock { - /** - * - * @type {string} - * @memberof StockSummaryExpectedStock - */ - expectedStockRef: string; - /** - * - * @type {RequestedDate} - * @memberof StockSummaryExpectedStock - */ - expectedDate: RequestedDate; - /** - * - * @type {Quantity} - * @memberof StockSummaryExpectedStock - */ - quantity: Quantity; - /** - * - * @type {string} - * @memberof StockSummaryExpectedStock - */ - inboundProcessRef?: string; -} /** * * @export @@ -25188,6 +27237,32 @@ export enum StorageLocationType { SINGLESTORAGE = 'SINGLE_STORAGE', BULKSTORAGE = 'BULK_STORAGE' } +/** + * + * @export + * @interface StringValidation + */ +export interface StringValidation extends BaseValidation { + /** + * + * @type {number} + * @memberof StringValidation + */ + minLength?: number; + /** + * + * @type {number} + * @memberof StringValidation + */ + maxLength?: number; +} + +/** + * @export + * @namespace StringValidation + */ +export namespace StringValidation { +} /** * * @export @@ -25348,7 +27423,7 @@ export interface StrippedFacility extends VersionedResource { * @type {string} * @memberof StrippedFacility */ - houseNumber: string; + houseNumber?: string; /** * * @type {Array} @@ -26185,6 +28260,12 @@ export interface SubstituteLineItem { * @memberof SubstituteLineItem */ priority?: number; + /** + * Date when the line has been picked. + * @type {Date} + * @memberof SubstituteLineItem + */ + pickedAt?: Date; /** * quantity of the specific article that has been picked to substitute the ordered line item * @type {number} @@ -26212,10 +28293,10 @@ export interface SubstituteLineItem { export interface SubstituteLineItemArticle extends AbstractArticle { /** * - * @type {Array} + * @type {Array} * @memberof SubstituteLineItemArticle */ - attributes?: Array; + attributes?: Array; } /** * @@ -26235,6 +28316,12 @@ export interface SubstituteLineItemForCreation { * @memberof SubstituteLineItemForCreation */ tenantArticleId: string; + /** + * Date when the line has been picked. + * @type {Date} + * @memberof SubstituteLineItemForCreation + */ + pickedAt?: Date; } /** * @@ -26390,7 +28477,8 @@ export enum SupportedLocale { NlNL = 'nl_NL', FrFR = 'fr_FR', ItIT = 'it_IT', - NbNO = 'nb_NO' + NbNO = 'nb_NO', + EsES = 'es_ES' } /** * @@ -27413,6 +29501,40 @@ export enum TrackingStatus { Delayed = 'delayed', Notification = 'notification' } +/** + * + * @export + * @interface Transfer + */ +export interface Transfer { + /** + * + * @type {string} + * @memberof Transfer + */ + transferId: string; + /** + * + * @type {string} + * @memberof Transfer + */ + transferType: Transfer.TransferTypeEnum; +} + +/** + * @export + * @namespace Transfer + */ +export namespace Transfer { + /** + * @export + * @enum {string} + */ + export enum TransferTypeEnum { + SUPPLIER = 'SUPPLIER', + RECEIVER = 'RECEIVER' + } +} /** * * @export @@ -27488,82 +29610,101 @@ export namespace UpdateFacilityCoordinatesActionParameter { /** * * @export - * @interface UpdateLineItemOnPackingContainerAction + * @interface UpdateLineItemOnPackingTargetContainerAction */ -export interface UpdateLineItemOnPackingContainerAction extends AbstractModificationAction { +export interface UpdateLineItemOnPackingTargetContainerAction extends AbstractModificationAction { /** - * Use UpdateLineItemOnPackingContainer to change a line item on an existing packing container + * Use UpdateLineItemOnPackingTargetContainer to change a line item on an existing packing container * @type {string} - * @memberof UpdateLineItemOnPackingContainerAction + * @memberof UpdateLineItemOnPackingTargetContainerAction */ - action: UpdateLineItemOnPackingContainerAction.ActionEnum; + action: UpdateLineItemOnPackingTargetContainerAction.ActionEnum; /** * - * @type {PackingContainerLineItem} - * @memberof UpdateLineItemOnPackingContainerAction + * @type {PackingTargetContainerLineItem} + * @memberof UpdateLineItemOnPackingTargetContainerAction */ - lineItem: PackingContainerLineItem; + lineItem: PackingTargetContainerLineItem; } /** * @export - * @namespace UpdateLineItemOnPackingContainerAction + * @namespace UpdateLineItemOnPackingTargetContainerAction */ -export namespace UpdateLineItemOnPackingContainerAction { +export namespace UpdateLineItemOnPackingTargetContainerAction { /** * @export * @enum {string} */ export enum ActionEnum { - UpdateLineItemOnPackingContainer = 'UpdateLineItemOnPackingContainer' + UpdateLineItemOnPackingTargetContainer = 'UpdateLineItemOnPackingTargetContainer' } } /** * * @export - * @interface UpdatePackingContainerLineItemAction + * @interface UpdatePackingTargetContainerLineItemAction */ -export interface UpdatePackingContainerLineItemAction { +export interface UpdatePackingTargetContainerLineItemAction { /** * - * @type {UpdatePackingContainerLineItemEnum} - * @memberof UpdatePackingContainerLineItemAction + * @type {UpdatePackingTargetContainerLineItemEnum} + * @memberof UpdatePackingTargetContainerLineItemAction */ - name: UpdatePackingContainerLineItemEnum; + name: UpdatePackingTargetContainerLineItemEnum; /** * Version of the entity to be changed * @type {number} - * @memberof UpdatePackingContainerLineItemAction + * @memberof UpdatePackingTargetContainerLineItemAction */ version: number; /** * - * @type {UpdatePackingContainerLineItemActionPayload} - * @memberof UpdatePackingContainerLineItemAction + * @type {UpdatePackingTargetContainerLineItemActionPayload} + * @memberof UpdatePackingTargetContainerLineItemAction */ - payload: UpdatePackingContainerLineItemActionPayload; + payload: UpdatePackingTargetContainerLineItemActionPayload; } /** * * @export - * @interface UpdatePackingContainerLineItemActionPayload + * @interface UpdatePackingTargetContainerLineItemActionPayload */ -export interface UpdatePackingContainerLineItemActionPayload { +export interface UpdatePackingTargetContainerLineItemActionPayload { /** * - * @type {PackingContainerLineItem} - * @memberof UpdatePackingContainerLineItemActionPayload + * @type {PackingTargetContainerLineItem} + * @memberof UpdatePackingTargetContainerLineItemActionPayload */ - lineItem: PackingContainerLineItem; + lineItem: PackingTargetContainerLineItem; } /** * * @export * @enum {string} */ -export enum UpdatePackingContainerLineItemEnum { +export enum UpdatePackingTargetContainerLineItemEnum { UpdateLineItem = 'UpdateLineItem' } +/** + * + * @export + * @interface UpdateRefuseReasonParameter + */ +export interface UpdateRefuseReasonParameter { + /** + * + * @type {number} + * @memberof UpdateRefuseReasonParameter + */ + handoverConfigurationVersion: number; + /** + * + * @type {AvailableRefuseReasonForUpdate} + * @memberof UpdateRefuseReasonParameter + */ + availableRefuseReasonForUpdate: AvailableRefuseReasonForUpdate; +} /** * * @export @@ -27915,6 +30056,12 @@ export interface VceFacilityCarrierConfiguration extends AbstractFacilityCarrier * @memberof VceFacilityCarrierConfiguration */ alternativeReturnAddress?: FacilityAddress; + /** + * + * @type {string} + * @memberof VceFacilityCarrierConfiguration + */ + trackAndTraceUrl?: string; } /** * @@ -27941,6 +30088,33 @@ export interface VersionedResource { */ version: number; } +/** + * + * @export + * @enum {string} + */ +export enum WaitForInputItemReturnActionEnum { + WaitForInputItemReturn = 'WaitForInputItemReturn' +} +/** + * + * @export + * @interface WaitForInputItemReturnActionParameter + */ +export interface WaitForInputItemReturnActionParameter { + /** + * + * @type {WaitForInputItemReturnActionEnum} + * @memberof WaitForInputItemReturnActionParameter + */ + name: WaitForInputItemReturnActionEnum; + /** + * Version of the entity to be changed + * @type {number} + * @memberof WaitForInputItemReturnActionParameter + */ + itemReturnJobVersion: number; +} /** * * @export @@ -27960,6 +30134,20 @@ export interface WebHookEvent { */ eventId: string; } +/** + * A weekday + * @export + * @enum {string} + */ +export enum WeekDay { + MONDAY = 'MONDAY', + TUESDAY = 'TUESDAY', + WEDNESDAY = 'WEDNESDAY', + THURSDAY = 'THURSDAY', + FRIDAY = 'FRIDAY', + SATURDAY = 'SATURDAY', + SUNDAY = 'SUNDAY' +} /** * * @export