diff --git a/src/fft-api/types/api-ctl.sh b/src/fft-api/types/api-ctl.sh index e8c24d3..2e6779e 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.57" +openApiVersion="3.0.61" 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 3105e8f..e995c2f 100644 --- a/src/fft-api/types/api.swagger.yaml +++ b/src/fft-api/types/api.swagger.yaml @@ -11,52 +11,6 @@ info: title: fulfillmenttools - simplifying retail complexity version: VERSIONLESS paths: - /api/artifacts/{platform}: - get: - parameters: - - description: Platform for which to list artifacts - in: path - name: platform - required: true - schema: - enum: - - android - type: string - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ArtifactMetadataItems' - description: All available artifacts for the selected platform - '400': - content: - application/json: - schema: - items: - $ref: '#/components/schemas/ApiError' - description: The given platform is invalid - '401': - content: - application/json: - schema: - items: - $ref: '#/components/schemas/ApiError' - description: Your user is not allowed to operate against this API instance - '403': - content: - application/json: - schema: - items: - $ref: '#/components/schemas/ApiError' - description: >- - Your user, although recognized, is not authorized to use this - endpoint - tags: - - Infrastructure - Artifacts - description: '' - operationId: getArtifacts - summary: Provides metadata for currently available artifacts for a platform /api/carriers: get: parameters: @@ -667,17 +621,17 @@ paths: description: '' operationId: deleteCarrierCountryServiceMapping summary: Delete a carrierCountryServiceMapping for carrier with given ID - /api/configurations/cutofftime: + /api/configurations/transittime: get: responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CutoffTimeConfiguration' + $ref: '#/components/schemas/TransitTimeConfiguration' description: >- - Cutoff time configuration was found & you were allowed to access it. - The result is in the body. + Transit time configuration was found & you were allowed to access + it. The result is in the body. '401': content: application/json: @@ -702,7 +656,7 @@ paths: $ref: '#/components/schemas/ApiError' description: Cutoff time configuration not found tags: - - Fulfillment Operations - Picking + - Last Mile Integration - Carriers description: >-
documentation

- operationId: getCutoffTimeConfiguration - summary: Get a tenant wide cutoff time config + operationId: getTransitTimeConfiguration + summary: Get a tenant wide transit time time config put: responses: '200': content: application/json: schema: - $ref: '#/components/schemas/CutoffTimeConfiguration' - description: Cutoff time configuration was written successfully + $ref: '#/components/schemas/TransitTimeConfiguration' + description: Transit time configuration was written successfully '401': content: application/json: @@ -744,9 +698,9 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Cutoff time configuration not found + description: Transit time configuration not found tags: - - Fulfillment Operations - Picking + - Last Mile Integration - Carriers description: >-
documentation

- operationId: putCutoffTimeConfiguration + operationId: putTransitTimeConfiguration requestBody: content: application/json: schema: - $ref: '#/components/schemas/CutoffTimeConfiguration' + $ref: '#/components/schemas/TransitTimeConfigurationForUpsert' required: true - summary: Update cutoff time configuration of a tenant - /api/configurations/tenant: + summary: Update transit time configuration of a tenant + /api/configurations/cutofftime: get: responses: '200': content: application/json: schema: - $ref: '#/components/schemas/TenantConfiguration' - description: >- - Tenant configuration was found & you were allowed to access it. The - result is in the body. - '401': - content: - application/json: - schema: - items: - $ref: '#/components/schemas/ApiError' - description: Your user is not allowed to operate against this API instance - '403': - content: - application/json: - schema: - items: - $ref: '#/components/schemas/ApiError' + $ref: '#/components/schemas/CutoffTimeConfiguration' description: >- - Your user, although recognized, is not authorized to use this - endpoint - '404': - content: - application/json: - schema: - items: - $ref: '#/components/schemas/ApiError' - description: Tenant configuration not found - tags: - - Core - Configuration - description: |- -
- -

This part of the API is currently under development. - That means that this endpoint, model, etc. can contain breaking changes - and / or might not be available at all times in your API instance. It - could disappear also without warning. Thus, it currently does not fall - under our SLA regulations. For details on this topic please check our - documentation -

- operationId: getTenantConfiguration - summary: Get a tenant config - put: - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TenantConfiguration' - description: Tenant configuration was written successfully + Cutoff time configuration was found & you were allowed to access it. + The result is in the body. '401': content: application/json: @@ -842,162 +751,304 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: Tenant configuration not found + description: Cutoff time configuration not found tags: - - Core - Configuration - description: |- -
- -

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

Upsert tenant configuration - operationId: putTenantConfiguration - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TenantConfigurationForUpsert' - required: true - summary: Update tenant configuration of a tenant - /api/configurations/deliverynote: - get: - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/DeliveryNoteConfiguration' - description: >- - Delivery note configuration was found & you were allowed to access - it. The result is in the body. - '401': - content: - application/json: - schema: - items: - $ref: '#/components/schemas/ApiError' - description: Your user is not allowed to operate against this API instance - '403': - content: - application/json: - schema: - items: - $ref: '#/components/schemas/ApiError' - description: >- - Your user, although recognized, is not authorized to use this - endpoint - '404': - content: - application/json: - schema: - items: - $ref: '#/components/schemas/ApiError' - description: Delivery note configuration not found - tags: - - Fulfillment Operations - Shipments - operationId: getDeliveryNoteConfiguration - summary: Get a tenant wide delivery configuration + documentation

+ operationId: getCutoffTimeConfiguration + summary: Get a tenant wide cutoff time config put: responses: '200': content: application/json: schema: - $ref: '#/components/schemas/DeliveryNoteConfiguration' - description: Delivery note configuration was successfully updated - '201': - content: - application/json: - schema: - $ref: '#/components/schemas/DeliveryNoteConfiguration' - description: Delivery note configuration was successfully created - '401': - content: - application/json: - schema: - items: - $ref: '#/components/schemas/ApiError' - description: Your user is not allowed to operate against this API instance - '403': - content: - application/json: - schema: - items: - $ref: '#/components/schemas/ApiError' - description: >- - Your user, although recognized, is not authorized to use this - endpoint - tags: - - Fulfillment Operations - Shipments - operationId: putDeliveryNoteConfiguration - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DeliveryNoteConfigurationForUpsert' - required: true - summary: Update delivery note configuration of a tenant - /api/configurations/tenantconnector: - get: - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TenantConnectorConfigurations' - description: >- - Configuration was found & you were allowed to access it. The result - is in the body. - '401': - content: - application/json: - schema: - items: - $ref: '#/components/schemas/ApiError' - description: Your user is not allowed to operate against this API instance - '403': - content: - application/json: - schema: - items: - $ref: '#/components/schemas/ApiError' - description: >- - Your user, although recognized, is not authorized to use this - endpoint - '404': - content: - application/json: - schema: - items: - $ref: '#/components/schemas/ApiError' - description: configuration not found - tags: - - Infrastructure - Artifacts - description: |- -
- -

This part of the API is currently under development. - That means that this endpoint, model, etc. can contain breaking changes - and / or might not be available at all times in your API instance. It - could disappear also without warning. Thus, it currently does not fall - under our SLA regulations. For details on this topic please check our - documentation -

- operationId: getTenantConnectorConfigurations - summary: Get a tenant wide app connector configuration - /api/configurations/packing: - get: - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PackingConfigurations' - description: Central Configuration of all packing related things + $ref: '#/components/schemas/CutoffTimeConfiguration' + description: Cutoff time configuration was written successfully + '401': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: Your user is not allowed to operate against this API instance + '403': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: >- + Your user, although recognized, is not authorized to use this + endpoint + '404': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: Cutoff time configuration not found + tags: + - Fulfillment Operations - Picking + description: >- +

This part of the API is currently under development. + That means that this endpoint, model, etc. can contain breaking changes + and / or might not be available at all times in your API instance. It + could disappear also without warning. Thus, it currently does not fall + under our SLA regulations. For details on this topic please check our + documentation

+ operationId: putCutoffTimeConfiguration + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CutoffTimeConfiguration' + required: true + summary: Update cutoff time configuration of a tenant + /api/configurations/tenant: + get: + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TenantConfiguration' + description: >- + Tenant configuration was found & you were allowed to access it. The + result is in the body. + '401': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: Your user is not allowed to operate against this API instance + '403': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: >- + Your user, although recognized, is not authorized to use this + endpoint + '404': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: Tenant configuration not found + tags: + - Core - Configuration + description: |- +
+ +

This part of the API is currently under development. + That means that this endpoint, model, etc. can contain breaking changes + and / or might not be available at all times in your API instance. It + could disappear also without warning. Thus, it currently does not fall + under our SLA regulations. For details on this topic please check our + documentation +

+ operationId: getTenantConfiguration + summary: Get a tenant config + put: + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TenantConfiguration' + description: Tenant configuration was written successfully + '401': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: Your user is not allowed to operate against this API instance + '403': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: >- + Your user, although recognized, is not authorized to use this + endpoint + '404': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: Tenant configuration not found + tags: + - Core - Configuration + description: |- +
+ +

This part of the API is currently under development. + That means that this endpoint, model, etc. can contain breaking changes + and / or might not be available at all times in your API instance. It + could disappear also without warning. Thus, it currently does not fall + under our SLA regulations. For details on this topic please check our + documentation +

Upsert tenant configuration + operationId: putTenantConfiguration + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TenantConfigurationForUpsert' + required: true + summary: Update tenant configuration of a tenant + /api/configurations/deliverynote: + get: + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryNoteConfiguration' + description: >- + Delivery note configuration was found & you were allowed to access + it. The result is in the body. + '401': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: Your user is not allowed to operate against this API instance + '403': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: >- + Your user, although recognized, is not authorized to use this + endpoint + '404': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: Delivery note configuration not found + tags: + - Fulfillment Operations - Shipments + operationId: getDeliveryNoteConfiguration + summary: Get a tenant wide delivery configuration + put: + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryNoteConfiguration' + description: Delivery note configuration was successfully updated + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryNoteConfiguration' + description: Delivery note configuration was successfully created + '401': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: Your user is not allowed to operate against this API instance + '403': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: >- + Your user, although recognized, is not authorized to use this + endpoint + tags: + - Fulfillment Operations - Shipments + operationId: putDeliveryNoteConfiguration + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeliveryNoteConfigurationForUpsert' + required: true + summary: Update delivery note configuration of a tenant + /api/configurations/tenantconnector: + get: + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/TenantConnectorConfigurations' + description: >- + Configuration was found & you were allowed to access it. The result + is in the body. + '401': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: Your user is not allowed to operate against this API instance + '403': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: >- + Your user, although recognized, is not authorized to use this + endpoint + '404': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: configuration not found + tags: + - Infrastructure - Artifacts + description: |- +
+ +

This part of the API is currently under development. + That means that this endpoint, model, etc. can contain breaking changes + and / or might not be available at all times in your API instance. It + could disappear also without warning. Thus, it currently does not fall + under our SLA regulations. For details on this topic please check our + documentation +

+ operationId: getTenantConnectorConfigurations + summary: Get a tenant wide app connector configuration + /api/configurations/packing: + get: + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/PackingConfigurations' + description: Central Configuration of all packing related things '401': content: application/json: @@ -10078,6 +10129,118 @@ paths: description: '' operationId: getPackJobDeliveryNote summary: Get a deliverynote for the pack job with the given ID + /api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}/returnnote: + get: + parameters: + - description: ID of the pack job for which you want to get a deliverynote + in: path + name: packJobId + required: true + schema: + type: string + - description: ID of the PackingTargetContainer + in: path + name: targetcontainerId + required: true + schema: + type: string + - description: >- + Provide the localized values for the return note. If not provided + the default locale is used. For example de_DE. + in: query + name: locale + schema: + type: string + responses: + '200': + content: + application/pdf: {} + description: Returns a return note for the PackingTargetContainer. + '401': + content: + application/pdf: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: Your user is not allowed to operate against this API instance + '403': + content: + application/pdf: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: >- + Your user, although recognized, is not authorized to use this + endpoint + '404': + content: + application/pdf: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: Entity not found + tags: + - Fulfillment Operations - Packing + description: '' + operationId: getReturnNotesForPackingTargetContainer + summary: Get the return note for the packingTargetContainer with the given ID + /api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}/deliverynote: + get: + parameters: + - description: ID of the pack job for which you want to get a deliverynote + in: path + name: packJobId + required: true + schema: + type: string + - description: >- + ID of the packingTargetContainer for which you want to get a + deliverynote + in: path + name: targetcontainerId + required: true + schema: + type: string + - description: >- + Provide the localized values for the delivery note. If not provided + the default locale is used. For example de_DE. + in: query + name: locale + schema: + type: string + responses: + '200': + content: + application/pdf: {} + description: The deliverynote for the given packingTargetContainer + '401': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: Your user is not allowed to operate against this API instance + '403': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: >- + Your user, although recognized, is not authorized to use this + endpoint + '404': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: Entity not found + tags: + - Fulfillment Operations - Packing + description: '' + operationId: getPackingTargetContainerDeliveryNote + summary: Get a deliverynote for the packingTargetContainer with the given ID /api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}: get: parameters: @@ -12938,7 +13101,7 @@ paths: $ref: '#/components/schemas/ApiError' description: External action not found tags: - - Core - Processes - External Actions + - Core - External Actions description: >-
-
-
-
-
@@ -15686,7 +15849,7 @@ paths: Your user, although recognized, is not authorized to use this endpoint tags: - - DOMS - Cancelation reasons + - DOMS - Orders operationId: postCancelationReason requestBody: content: @@ -15746,9 +15909,9 @@ paths: schema: items: $ref: '#/components/schemas/ApiError' - description: User not found + description: Cancelation reason not found tags: - - DOMS - Cancelation reasons + - DOMS - Orders description: >-
@@ -15818,7 +15981,7 @@ paths: documentation

operationId: putCancelationReason - summary: Update a reroute description + summary: Update a cancelation reason delete: parameters: - description: ID of the cancelation reason you intend to delete @@ -15856,7 +16019,7 @@ paths: $ref: '#/components/schemas/ApiError' description: Cancelation reason not found tags: - - DOMS - Cancelation reasons + - DOMS - Orders description: |-
@@ -16811,6 +16974,53 @@ paths: - DOMS - Orders operationId: orderAction summary: Call a single action on a given order + /api/orders/{orderId}/orderlineitems/{orderLineItemId}/actions: + post: + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OrderLineItemActionsParameter' + parameters: + - description: Reference to the order you want to call the action for + in: path + name: orderId + required: true + schema: + type: string + - description: Reference to the order line item you want to call the action for + in: path + name: orderLineItemId + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Order' + description: Updated Order in the body. + '401': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: Your user is not allowed to operate against this API instance + '403': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: >- + Your user, although recognized, is not authorized to use this + endpoint + tags: + - DOMS - Orders + operationId: orderLineItemAction + summary: Call a single action on a given order and line item /api/routing/commands/reroute: post: responses: @@ -18293,6 +18503,93 @@ paths: description: Desired order routing configuration to create/update required: true summary: Change the tenant wide order routing configuration + /api/configurations/ordercancelation: + get: + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OrderCancelationConfiguration' + description: The Order Cancelation Configuration can be found in the body. + '401': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: Your user is not allowed to operate against this API instance + '403': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: >- + Your user, although recognized, is not authorized to use this + endpoint + tags: + - DOMS - Routing Plans + description: >- +

This part of the API is currently under development. + That means that this endpoint, model, etc. can contain breaking changes + and / or might not be available at all times in your API instance. It + 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: getOrderCancelationConfiguration + summary: Get the tenant wide order cancelation configuration + put: + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/OrderCancelationConfiguration' + description: The order cancelation configuration was successfully updated. + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/OrderCancelationConfiguration' + description: The order cancelation configuration was successfully created. + '400': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: Invalid input. See response for details + '401': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: Your user is not allowed to operate against this API instance + '403': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/ApiError' + description: >- + Your user, although recognized, is not authorized to use this + endpoint + tags: + - DOMS - Routing Plans + description: '' + operationId: putOrderCancelationConfiguration + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OrderCancelationConfiguration' + description: Desired order cancelation configuration to create/update + required: true + summary: Change the tenant wide order cancelation configuration /api/articles: get: operationId: getArticles @@ -18603,6 +18900,11 @@ paths: type: array items: type: string + - name: scannableCode + required: false + in: query + schema: + type: string - name: status required: false in: query @@ -22383,9 +22685,9 @@ components: $ref: '#/components/schemas/NonDeliveryType' default: SINGLE nonDeliveryDay: - example: '2020-02-03T08:45:50.525Z' - format: date-time type: string + pattern: ^\d{4}-\d{2}-\d{2}$ + example: '2020-02-03' required: - nonDeliveryDay NonDeliveryType: @@ -22607,6 +22909,33 @@ components: required: - clearName - version + TransitTimeConfiguration: + allOf: + - $ref: '#/components/schemas/VersionedResource' + properties: + calculationStrategy: + type: string + enum: + - EARLIEST + - LATEST + id: + type: string + required: + - id + - calculationStrategy + type: object + TransitTimeConfigurationForUpsert: + allOf: + - $ref: '#/components/schemas/VersionedResource' + properties: + calculationStrategy: + type: string + enum: + - EARLIEST + - LATEST + required: + - calculationStrategy + type: object CutoffTimeConfiguration: allOf: - $ref: '#/components/schemas/VersionedResource' @@ -22925,6 +23254,7 @@ components: - SIGNATURE - CUSTOMER_SIGNATURE - ADULT_SIGNATURE + - SATURDAY_DELIVERY type: string DHLV2CarrierCredentials: allOf: @@ -23990,7 +24320,20 @@ components: - version type: object HandoverLineItem: + additionalProperties: false + allOf: + - $ref: '#/components/schemas/HandoverLineItemForCreation' + properties: + id: + type: string + required: + - id + HandoverLineItemForCreation: properties: + refused: + type: array + items: + $ref: '#/components/schemas/RefusedItem' article: $ref: '#/components/schemas/HandoverLineItemArticle' quantity: @@ -24062,6 +24405,12 @@ components: format: int64 minimum: 0 type: integer + id: + type: string + refused: + type: array + items: + $ref: '#/components/schemas/RefusedItem' required: - quantity - article @@ -24070,6 +24419,9 @@ components: - $ref: '#/components/schemas/VersionedResource' - $ref: '#/components/schemas/HandoverjobForCreation' - properties: + handoverJobLineItems: + items: + $ref: '#/components/schemas/HandoverLineItem' anonymized: description: Indicates if gdpr related data was anonymized example: false @@ -24126,7 +24478,7 @@ components: type: string handoverJobLineItems: items: - $ref: '#/components/schemas/HandoverLineItem' + $ref: '#/components/schemas/HandoverLineItemForCreation' type: array loadUnitRefs: description: Reference to array of load unit Refs @@ -26474,6 +26826,9 @@ components: customerSignature: description: Signature from the ordering customer needed type: boolean + saturdayDelivery: + description: Saturday Delivery + type: boolean Parcel: additionalProperties: false allOf: @@ -26555,6 +26910,9 @@ components: the currency given under paymentInformation.currency type: number example: 12.5 + shortId: + type: string + example: AA12-1 transfers: type: array minItems: 0 @@ -26614,6 +26972,9 @@ components: $ref: '#/components/schemas/PaymentInformation' pickUpInformation: $ref: '#/components/schemas/ParcelPickUpInformation' + shortId: + type: string + example: AA12-1 productValue: description: >- Monetary value of all goods in this parcel. Needed for sending cross @@ -26670,6 +27031,10 @@ components: type: string parcelItemValue: $ref: '#/components/schemas/ParcelItemValue' + parcelItemArticleAttributes: + items: + $ref: '#/components/schemas/ArticleAttributeItem' + type: array weightInGram: type: integer nullable: true @@ -26678,6 +27043,14 @@ components: required: - id type: object + ParcelArticleAttributeItemForUpdate: + additionalProperties: false + allOf: + - $ref: '#/components/schemas/ArticleAttributeItem' + required: + - key + - value + - category ParcelPickUpInformation: additionalProperties: false nullable: true @@ -26720,19 +27093,33 @@ components: description: amount of the given items example: 5 hsCode: + deprecated: true + description: Deprecated - use article.attribute.hsCode instead type: string maxLength: 50 description: - description: Description of the given item/items + deprecated: true + description: >- + Description - article.title will be used instead - of the given + item/items example: Item Description type: string weightInGram: + deprecated: true type: integer - description: Weight of a single item in gram + description: >- + Deprecated - use article.attribute.weightPerUnit instead - Weight of + a single item in gram example: 10000 parcelItemValue: + deprecated: true + description: >- + Deprecated - use article.attribute.pricePerUnit and + article.attribute.currency instead $ref: '#/components/schemas/ParcelItemValue' countryOfManufacture: + deprecated: true + description: Deprecated - use article.attribute.countryOfManufacture instead type: string article: $ref: '#/components/schemas/ParcelItemArticle' @@ -26985,6 +27372,10 @@ components: type: array items: $ref: '#/components/schemas/MandatoryShippingAttribute' + mandatoryShippingArticleAttributes: + type: array + items: + $ref: '#/components/schemas/MandatoryShippingArticleAttribute' mandatoryShippingItemAttributes: type: array items: @@ -27107,9 +27498,15 @@ components: $ref: '#/components/schemas/ArticleAttributeItem' type: array prices: + deprecated: true items: $ref: '#/components/schemas/ArticlePrice' type: array + description: >- +
+
This endpoint is deprecated and has been + replaced.

type: object xml: name: PickLineItemArticle @@ -27579,6 +27976,8 @@ components: HandoverJobActionsParameter: anyOf: - $ref: '#/components/schemas/HandoverJobCancelActionParameter' + - $ref: '#/components/schemas/HandoverJobLineItemUpdateActionParameter' + - $ref: '#/components/schemas/FinishHandoverJobActionParameter' HandoverJobCancelActionParameter: additionalProperties: false properties: @@ -27599,10 +27998,129 @@ components: - name - version - payload + HandoverJobLineItemUpdateActionParameter: + additionalProperties: false + properties: + name: + $ref: '#/components/schemas/HandoverJobLineItemUpdateActionEnum' + version: + description: Version of the entity to be changed + minimum: 0 + type: integer + lineItem: + additionalProperties: false + properties: + id: + type: string + refused: + items: + $ref: '#/components/schemas/RefusedItemForUpdate' + substituteItems: + type: array + items: + $ref: '#/components/schemas/HandoverSubstituteLineItemForUpdate' + required: + - id + required: + - name + - version + - lineItem + FinishHandoverJobActionParameter: + additionalProperties: false + properties: + name: + $ref: '#/components/schemas/FinishHandoverJobActionEnum' + version: + description: Version of the entity to be changed + minimum: 0 + type: integer + lineItems: + additionalProperties: false + type: array + items: + $ref: '#/components/schemas/FinishHandoverJobLineItem' + required: + - name + - version + - lineItems + RefusedItem: + properties: + quantity: + type: integer + minimum: 0 + reason: + type: string + reasonLocalized: + $ref: '#/components/schemas/LocaleString' + comment: + type: string + required: + - quantity + RefusedItemForUpdate: + properties: + quantity: + type: integer + minimum: 0 + reasonLocalized: + $ref: '#/components/schemas/LocaleString' + comment: + type: string + required: + - quantity + HandoverSubstituteLineItemForUpdate: + properties: + id: + type: string + refused: + type: array + items: + $ref: '#/components/schemas/RefusedItemForUpdate' + required: + - id + FinishHandoverJobLineItem: + additionalProperties: false + properties: + id: + type: string + handedOverQuantity: + type: number + refused: + type: array + items: + $ref: '#/components/schemas/RefusedItemForUpdate' + substituteLineItems: + type: array + items: + $ref: '#/components/schemas/FinishHandoverJobSubstituteLineItem' + required: + - id + - handedOverQuantity + FinishHandoverJobSubstituteLineItem: + properties: + id: + type: string + handedOverQuantity: + minimum: 0 + type: integer + refused: + type: array + items: + $ref: '#/components/schemas/RefusedItemForUpdate' + required: + - id + - handedOverQuantity HandoverJobCancelActionEnum: enum: - CANCEL type: string + HandoverJobLineItemUpdateActionEnum: + enum: + - UPDATE_LINEITEM + type: string + FinishHandoverJobActionEnum: + enum: + - FINISH_HANDOVER_JOB + type: string ModifyPickRunLineItemAction: allOf: - $ref: '#/components/schemas/AbstractModificationAction' @@ -27727,10 +28245,12 @@ components: properties: carrierKey: type: string + carrierProductCategory: + $ref: '#/components/schemas/CarrierProductCategory' carrierProduct: description: >- Desired product of given carrier to choose when ordering a - label + label, this is specific to a carrier type: string example: EXPRESS carrierServices: @@ -28078,6 +28598,7 @@ components: - PICKJOB - HANDOVERJOB - PARCEL + - PACKING_TARGET_CONTAINER type: string DocumentType: enum: @@ -29031,7 +29552,7 @@ components: type: array type: object xml: - name: PickLineItemArticle + name: ShipmentLineItemArticle ShipmentLineItemForCreation: properties: article: @@ -29640,6 +30161,12 @@ components: - $ref: '#/components/schemas/ArticleAttributeItem' SubstituteLineItem: properties: + id: + type: string + refused: + type: array + items: + $ref: '#/components/schemas/RefusedItem' article: $ref: '#/components/schemas/SubstituteLineItemArticle' priority: @@ -29896,6 +30423,14 @@ components: - it_IT - nb_NO - es_ES + - cs_CZ + - sk_SK + - pt_PT + - sl_SI + - ro_RO + - bg_BG + - hr_HR + - hu_HU example: de_DE type: string SupportedLocales: @@ -30379,19 +30914,34 @@ components: $ref: '#/components/schemas/RegionInformation' minItems: 1 type: array + mandatoryShippingArticleAttributes: + items: + $ref: '#/components/schemas/MandatoryShippingArticleAttribute' + type: array + minItems: 0 mandatoryShippingAttributes: items: $ref: '#/components/schemas/MandatoryShippingAttribute' type: array minItems: 0 mandatoryShippingItemAttributes: + deprecated: true + description: Deprecated - use mandatoryShippingArticleAttributes instead items: $ref: '#/components/schemas/MandatoryShippingItemAttribute' type: array minItems: 0 - product: - type: string - example: EXPRESS + products: + type: array + items: + type: string + example: EXPRESS + description: Array of products for the given mapping + carrierServices: + type: array + items: + $ref: '#/components/schemas/CarrierServices' + description: Services which can be provided by the carrier carrierProductCategory: $ref: '#/components/schemas/CarrierProductCategory' transitTime: @@ -30422,14 +30972,14 @@ components:

This endpoint is deprecated and has been - replaced.

Deprecated - Use source instead. + replaced.

@deprecated - Use source instead. example: DE destinationCountries: description: >-

This endpoint is deprecated and has been - replaced.

Deprecated - Use destination instead. + replaced.

@deprecated - Use destination instead. items: $ref: '#/components/schemas/CountryCode' minItems: 1 @@ -30487,9 +31037,16 @@ components: $ref: '#/components/schemas/MandatoryShippingItemAttribute' type: array minItems: 0 - product: - type: string - example: EXPRESS + mandatoryShippingArticleAttributes: + items: + $ref: '#/components/schemas/MandatoryShippingArticleAttribute' + type: array + minItems: 0 + products: + type: array + items: + type: string + example: EXPRESS carrierProductCategory: $ref: '#/components/schemas/CarrierProductCategory' transitTime: @@ -30555,9 +31112,17 @@ components: $ref: '#/components/schemas/MandatoryShippingItemAttribute' type: array minItems: 0 - product: - type: string - example: EXPRESS + mandatoryShippingArticleAttributes: + items: + $ref: '#/components/schemas/MandatoryShippingArticleAttribute' + type: array + minItems: 0 + products: + type: array + items: + type: string + example: EXPRESS + description: Array of products for the given mapping carrierProductCategory: $ref: '#/components/schemas/CarrierProductCategory' transitTime: @@ -30571,6 +31136,9 @@ components: required: - carrierConfigurationVersion CarrierProductCategory: + description: >- + Desired product class to choose when ordering a label, this is not a + carrier specific value type: string enum: - STANDARD @@ -30594,6 +31162,7 @@ components: - maxTransitDays - minTransitDays MandatoryShippingItemAttribute: + additionalProperties: false properties: referencedField: type: string @@ -30605,7 +31174,15 @@ components: - parcelItemValue.currency - countryOfManufacture - tenantArticleId - description: 'Deprecated: quantity, this field is now mandatory in the item' + description: |- + Deprecated: + - description: article.title will be used instead + - weightInGram: use MandatoryShippingArticleAttribute.attributes.weightPerUnit + - quantity, this field is now mandatory in the item + - parcelItemValue.value: use MandatoryShippingArticleAttribute.attributes.pricePerUnit + - parcelItemValue.currency: use MandatoryShippingArticleAttribute.attributes.currency + - countryOfManufacture: use MandatoryShippingArticleAttribute.attributes.countryOfManufacture + - tenantArticleId: mandatory on line item article dataType: type: string enum: @@ -30617,7 +31194,46 @@ components: descriptionLocalized: $ref: '#/components/schemas/LocaleString' type: object + MandatoryShippingArticleAttribute: + additionalProperties: false + properties: + referencedField: + $ref: >- + #/components/schemas/MandatoryShippingArticleAttributeReferencedField + dataType: + $ref: '#/components/schemas/MandatoryShippingArticleAttributeDataType' + category: + $ref: '#/components/schemas/MandatoryShippingArticleAttributeCategory' + description: + type: string + descriptionLocalized: + $ref: '#/components/schemas/LocaleString' + type: object + required: + - referencedField + - dataType + - category + - descriptionLocalized + MandatoryShippingArticleAttributeReferencedField: + enum: + - attributes.weightPerUnit + - attributes.hsCode + - attributes.currency + - attributes.valuePerUnit + - attributes.countryOfManufacture + type: string + MandatoryShippingArticleAttributeCategory: + enum: + - customs + - dimensions + type: string + MandatoryShippingArticleAttributeDataType: + enum: + - NUMBER + - STRING + type: string MandatoryShippingAttribute: + additionalProperties: false properties: referencedField: type: string @@ -30626,6 +31242,13 @@ components: - productValue - pickUpInformation.startTime - pickUpInformation.endTime + description: >- + - dimensions.weight: will be calculated from + MandatoryShippingArticleAttribute.attributes.weightPerUnit if items + with weightPerUnit is set on all items - productValue: will be + calculated from + MandatoryShippingArticleAttribute.attributes.pricePerUnit if items + with pricePerUnit is set on all items dataType: type: string enum: @@ -31479,6 +32102,9 @@ components: - $ref: '#/components/schemas/VersionedResource' - $ref: '#/components/schemas/PackingTargetContainerForCreation' properties: + documentsRef: + description: Reference to the documents collection from this entity + type: string description: type: string descriptionLocalized: @@ -31491,6 +32117,8 @@ components: type: string packJobRef: type: string + shortId: + type: string operativeProcessRef: type: string iconUrl: @@ -31511,6 +32139,10 @@ components: lineItems: items: $ref: '#/components/schemas/PackingTargetContainerLineItem' + parcels: + type: array + items: + $ref: '#/components/schemas/Parcel' required: - id - nameLocalized @@ -32455,6 +33087,11 @@ components: returnable: type: number minimum: 0 + notReturnableItemsExists: + type: boolean + description: >- + Marks if some of the items could be not refundable. E.g. through + altering via a ServiceJob via engraving. required: - id - article @@ -32489,6 +33126,11 @@ components: delivered: type: number minimum: 1 + notReturnableItemsExists: + type: boolean + description: >- + Marks if some of the items could be not refundable. E.g. through + altering via a ServiceJob via engraving. scannableCodes: items: type: string @@ -33537,6 +34179,7 @@ components: enum: - BLANK_LINK - FORM + - COMMENT ExternalFormActionDefinition: additionalProperties: false properties: @@ -33562,8 +34205,8 @@ components: $ref: '#/components/schemas/ExternalFormActionButton' required: - elements - - success - type + - cancel type: object xml: name: ExternalFormActionDefinition @@ -33706,6 +34349,19 @@ components: type: object xml: name: ExternalLinkActionDefinition + ExternalCommentActionDefinition: + description: >- + This action provides a possibility to set comments. It also enables a + possibility to save action results for other actions. + additionalProperties: false + properties: + type: + $ref: '#/components/schemas/ExternalActionType' + required: + - type + type: object + xml: + name: ExternalCommentActionDefinition ExternalActionForCreation: properties: processRef: @@ -33724,6 +34380,7 @@ components: oneOf: - $ref: '#/components/schemas/ExternalFormActionDefinition' - $ref: '#/components/schemas/ExternalLinkActionDefinition' + - $ref: '#/components/schemas/ExternalCommentActionDefinition' discriminator: propertyName: type mapping: @@ -33756,6 +34413,7 @@ components: oneOf: - $ref: '#/components/schemas/ExternalFormActionDefinition' - $ref: '#/components/schemas/ExternalLinkActionDefinition' + - $ref: '#/components/schemas/ExternalCommentActionDefinition' discriminator: propertyName: type mapping: @@ -33860,6 +34518,27 @@ components: type: object xml: name: ExternalFormActionLogPayload + ExternalCommentActionLogPayload: + description: >- + This action payload provides a possibility to set comments. It also + enables a possibility to save action results for other actions. + additionalProperties: false + properties: + comment: + description: The actual comment. + type: string + minLength: 1 + externalActionRef: + description: >- + An existing external action id you want to link with. The action + have to be in the same process. + type: string + minLength: 1 + required: + - comment + type: object + xml: + name: ExternalCommentActionLogPayload ExternalActionLogForCreation: properties: requiresAnonymization: @@ -33868,6 +34547,7 @@ components: oneOf: - $ref: '#/components/schemas/ExternalLinkActionLogPayload' - $ref: '#/components/schemas/ExternalFormActionLogPayload' + - $ref: '#/components/schemas/ExternalCommentActionLogPayload' required: - requiresAnonymization - actionPayload @@ -34395,6 +35075,13 @@ components: type: array items: $ref: '#/components/schemas/AdditionalInformationForCreation' + customAttributes: + type: object + nullable: true + description: >- + Attributes that can be added to custom service. These attributes + cannot be used within fulfillment processes, but it could be useful + to have the information carried here. type: object required: - nameLocalized @@ -35447,6 +36134,7 @@ components: - insurance - shop - dimensions + - carrierService description: |- This category is used by OCFF to customize implemented processes. Categorized attributes are used by various processes and tools @@ -35490,6 +36178,15 @@ components: filled with a descriptive category allOf: - $ref: '#/components/schemas/LocaleString' + type: + type: string + description: The type of the attribute. + default: STRING + enum: + - STRING + - NUMBER + - CURRENCY + - BOOLEAN required: - key - value @@ -35876,12 +36573,17 @@ components: name: type: string example: DHL + carrierRef: + type: string nonDeliveryDays: type: array items: description: ISO 3166-2 province code type: string example: DE-NW + required: + - name + - carrierRef CheckoutOptionsInput: additionalProperties: false properties: @@ -35926,6 +36628,11 @@ components: type: string isBackOrderable: type: boolean + latestPickingStart: + format: date-time + type: string + carrier: + $ref: '#/components/schemas/CheckoutOptionsAvailabilityCarrier' required: - tenantArticleId - available @@ -35933,9 +36640,23 @@ components: type: object xml: name: CheckoutOptionsAvailability + CheckoutOptionsAvailabilityCarrier: + additionalProperties: false + properties: + carrierRef: + type: string + carrierProductCategory: + $ref: '#/components/schemas/CarrierProductCategory' + required: + - carrierRef + type: object + xml: + name: CheckoutOptionsAvailabilityCarrier PromiseCarrier: additionalProperties: false properties: + carrierRef: + type: string carrierKey: type: string carrierName: @@ -35947,11 +36668,8 @@ components: deliveryPromiseValidUntil: type: string format: date-time - latestPickingStart: - example: '2020-02-03T09:45:51.525Z' - format: date-time - type: string required: + - carrierRef - carrierKey - carrierName - products @@ -36017,6 +36735,7 @@ components: $ref: '#/components/schemas/CheckoutOptionsConsumerAddress' required: - tenantArticleIds + - consumerAddress CheckoutOptionsDeliveryTimePeriodResponse: properties: checkoutOptions: @@ -36949,6 +37668,9 @@ components: type: boolean isBestReassignmentCandidate: type: boolean + latestPickingStart: + type: string + format: date-time required: - facility - orderFences @@ -38229,6 +38951,40 @@ components: type: object xml: name: DecisionLogRef + OrderCancelationConfiguration: + 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 configuration is to define specific rules for canceling orders such as the forced cancelation. + properties: + 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 + id: + type: string + version: + description: >- + The version of the document to be used in optimistic locking + mechanisms. + example: 42 + format: int64 + type: integer + allowForceCancelOrder: + type: boolean + required: + - version + - allowForceCancelOrder + type: object RoutingConfiguration: additionalProperties: false description: >- @@ -38258,9 +39014,13 @@ components: format: date-time type: string prioritizationRules: + deprecated: true description: >- - Contains the routing configuration for prioritization & routing for - the whole tenant +
+
This endpoint is deprecated and has been replaced.

@deprecated Contains the routing configuration for + prioritization & routing for the whole tenant items: $ref: '#/components/schemas/PrioritizationRule' type: array @@ -38565,6 +39325,8 @@ components: minItems: 1 items: $ref: '#/components/schemas/CustomServiceReference' + latestPickingStart: + $ref: '#/components/schemas/LatestPickingStart' provisioningTime: description: The point in time by which the order is supposed to be provisioned. example: '2020-02-03T08:45:50.525Z' @@ -38585,6 +39347,23 @@ components: - finalizeRun - processId type: object + LatestPickingStart: + type: object + properties: + latestPickingStartDate: + example: '2020-02-03T08:45:50.525Z' + format: date-time + type: string + targetTime: + example: '2020-02-03T08:45:50.525Z' + format: date-time + type: string + carrierRef: + type: string + required: + - carrierRef + - latestPickingStartDate + - targetTime Transfer: properties: transferId: @@ -38701,36 +39480,7 @@ components: 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' - desiredDeliveryTime: - example: '2020-02-03T09:45:51.525Z' - format: date-time - type: string - type: object + $ref: '#/components/schemas/DeliveryPreferencesShipping' supplyingFacilities: description: '@deprecated Use supplyingFacilities under collect' items: @@ -38746,6 +39496,37 @@ components: reservationPreferences: $ref: '#/components/schemas/DeliveryReservationPreferences' type: object + DeliveryPreferencesShipping: + 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 ArticleItem: additionalProperties: false properties: @@ -38762,6 +39543,7 @@ components: oneOf: - $ref: '#/components/schemas/OrderUnlockActionParameter' - $ref: '#/components/schemas/OrderCancelActionParameter' + - $ref: '#/components/schemas/OrderForceCancelActionParameter' - $ref: '#/components/schemas/PromiseConfirmActionParameter' - $ref: '#/components/schemas/PromiseExtendActionParameter' - $ref: '#/components/schemas/OrderConsumerAddressChangeActionParameter' @@ -38779,6 +39561,22 @@ components: required: - name - version + OrderLineItemActionsParameter: + oneOf: + - $ref: '#/components/schemas/OrderLineItemCustomAttributesUpdateParameter' + AbstractOrderLineItemActionsParameter: + discriminator: + propertyName: name + properties: + name: + type: string + version: + description: Version of the order to be changed + minimum: 0 + type: integer + required: + - name + - version OrderUnlockActionParameter: allOf: - $ref: '#/components/schemas/AbstractOrderActionsParameter' @@ -38804,6 +39602,17 @@ components: required: - name - version + OrderForceCancelActionParameter: + allOf: + - $ref: '#/components/schemas/AbstractOrderActionsParameter' + properties: + name: + enum: + - FORCE_CANCEL + type: string + required: + - name + - version OrderConsumerAddressChangeActionParameter: allOf: - $ref: '#/components/schemas/AbstractOrderActionsParameter' @@ -38837,6 +39646,25 @@ components: - name - version - consumerAddresses + OrderLineItemCustomAttributesUpdateParameter: + allOf: + - $ref: '#/components/schemas/AbstractOrderLineItemActionsParameter' + properties: + name: + enum: + - UPDATE_CUSTOM_ATTRIBUTES + type: string + 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. If no customAttributes exist + yet, they will be created for this line item. + type: object + required: + - name + - version + - customAttributes PromiseConfirmActionParameter: allOf: - $ref: '#/components/schemas/AbstractOrderActionsParameter' @@ -38945,6 +39773,13 @@ components: default: 1440 minimum: 5 description: The amount of minutes after which an automated reroute is executed + leadTimeBeforeTimeTriggeredReroute: + type: number + example: '480' + description: >- + How many minutes before a time triggered reroute a notification + should be sent. Should be smaller than rerouteAfterMinutes + minimum: 1 CancelationReasonForCreation: allOf: - $ref: '#/components/schemas/AbstractReasonForCreation' @@ -39037,7 +39872,7 @@ components: default: now endDate: type: string - example: 2024-07-013T00:00:00.000Z + example: '2024-07-13T00:00:00.000Z' format: date-time description: >- The end of the evaluated time period. Default is the start date + 60 @@ -39053,9 +39888,10 @@ components: consumerAddress: $ref: '#/components/schemas/CheckoutOptionsConsumerAddress' deliveryPreferences: - $ref: '#/components/schemas/CheckoutOptionsDeliveryPreferences' + $ref: '#/components/schemas/DeliveryPreferencesShipping' required: - basket + - consumerAddress CheckoutOptionsDeliveryTimePointRequest: properties: desiredDeliveryDate: @@ -39106,27 +39942,6 @@ components: - tenantArticleId - available - facilityRef - CheckoutOptionsDeliveryPreferences: - properties: - serviceLevel: - description: >- - DELIVERY: The parcel will reach the recipient according to the cycle - time of the carrier, typically 1-3 days when shipping nationaly. - - EXPRESS: The parcel will reach the recipient using an express - service level. - enum: - - DELIVERY - - EXPRESS - type: string - preferredCarriers: - type: array - example: DPD - items: - type: string - preferredCarriersWithProduct: - $ref: >- - #/components/schemas/CheckoutOptionsDeliveryPreferencesPreferredCarriersWithProduct BasketItem: properties: tenantArticleId: @@ -39138,22 +39953,6 @@ components: required: - tenantArticleId - quantity - CheckoutOptionsDeliveryPreferencesPreferredCarriersWithProduct: - properties: - carrierKey: - type: string - example: DPD - carrierProduct: - type: string - example: WORLDWIDE - carrierServices: - type: array - items: - type: string - example: SIGNATURE - carrierProductCategory: - type: string - example: STANDARD FacilityRefLatestPickingStartPair: properties: facilityRef: @@ -40386,9 +41185,6 @@ components: properties: version: type: number - enableStorageLocationOverview: - type: boolean - deprecated: true isMixedStorage: type: boolean nullable: true @@ -40399,14 +41195,10 @@ components: properties: version: type: number - enableStorageLocationOverview: - type: boolean - deprecated: true isMixedStorage: type: boolean required: - version - - enableStorageLocationOverview OutboundTagFilter: type: object properties: @@ -41691,6 +42483,15 @@ components: required: - payload type: object + RefundTriggerWebHookEvent: + allOf: + - $ref: '#/components/schemas/WebHookEvent' + properties: + payload: + $ref: '#/components/schemas/ItemReturn' + required: + - payload + type: object EmailReceiver: type: object properties: @@ -41720,6 +42521,7 @@ components: type: string enum: - PICK_JOB_CREATED + - UPCOMING_TIME_TRIGGERED_REROUTE - ROUTING_PLAN_NOT_ROUTABLE - ROUTING_PLAN_WAITING type: @@ -41799,6 +42601,7 @@ components: type: string enum: - PICK_JOB_CREATED + - UPCOMING_TIME_TRIGGERED_REROUTE - ROUTING_PLAN_NOT_ROUTABLE - ROUTING_PLAN_WAITING type: @@ -42076,8 +42879,12 @@ tags: Endpoints used by shops to get the current available pickup stores and available service levels like Same-Day delivery. name: DOMS - Checkout Options + - description: Get operative processes. + name: Fulfillment Operations - Operative Process - description: Endpoints to Create, Update and Read pickjobs. name: Fulfillment Operations - Picking + - description: Endpoints to Create, Update and Read Custom Service Jobs. + name: Fulfillment Operations - Custom Services - description: Endpoints to manipulate Restow Items. name: Fulfillment Operations - Restow - description: Endpoints to Create, Update and Read packjobs. @@ -42094,14 +42901,26 @@ tags: name: Last Mile Integration - Carriers - description: Endpoints to Create, Update and Read Inbound Processes. name: Inventory Management - Inbound + - description: Endpoints to Configure and get Channel Availability. + name: Inventory Management - Channel Availability - description: Endpoints to Create, Update and Read Stocks. name: Inventory Management - Stocks - description: Endpoints to Read and configure Processes. name: Core - Processes + - description: >- + Endpoints to attach external actions to processes and append logs to + external actions. + name: Core - External Actions + - description: >- + Endpoints to Read and Modifiy Expires, e.g. by extending the + provisioningTime. + name: Core - Expiries - description: Endpoints to Create, Update and Read Document Sets. name: Core - Document Sets - description: Endpoints to Create, Update and Read Custom Services. name: Core - Custom Services + - description: Endpoints to Configure Notifications on FFT events. + name: Core - Notification Center - description: Endpoints to Create, Update and Read facilities. name: Core - Facilities - description: Endpoints to Create, Update and Read Facility Listings. 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 e661578..22a2403 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.57 \ No newline at end of file +3.0.61 \ 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 9f6467e..8e815e7 100644 --- a/src/fft-api/types/typescript-fetch-client/api.ts +++ b/src/fft-api/types/typescript-fetch-client/api.ts @@ -281,6 +281,25 @@ export interface AbstractOrderActionsParameter { */ version: number; } +/** + * + * @export + * @interface AbstractOrderLineItemActionsParameter + */ +export interface AbstractOrderLineItemActionsParameter { + /** + * + * @type {string} + * @memberof AbstractOrderLineItemActionsParameter + */ + name: string; + /** + * Version of the order to be changed + * @type {number} + * @memberof AbstractOrderLineItemActionsParameter + */ + version: number; +} /** * Base Configuration for Ratings. See documentation for Details. * @export @@ -924,6 +943,12 @@ export interface ArticleAttributeItem { * @memberof ArticleAttributeItem */ valueLocalized?: LocaleString; + /** + * The type of the attribute. + * @type {string} + * @memberof ArticleAttributeItem + */ + type?: ArticleAttributeItem.TypeEnum; } /** @@ -942,7 +967,18 @@ export namespace ArticleAttributeItem { Customs = 'customs', Insurance = 'insurance', Shop = 'shop', - Dimensions = 'dimensions' + Dimensions = 'dimensions', + CarrierService = 'carrierService' + } + /** + * @export + * @enum {string} + */ + export enum TypeEnum { + STRING = 'STRING', + NUMBER = 'NUMBER', + CURRENCY = 'CURRENCY', + BOOLEAN = 'BOOLEAN' } } /** @@ -2611,13 +2647,13 @@ export interface CarrierCountryServiceMapping extends StaticCarrierCountryServic */ id: string; /** - *

This endpoint is deprecated and has been replaced.

Deprecated - Use source instead. + *

This endpoint is deprecated and has been replaced.

@deprecated - Use source instead. * @type {string} * @memberof CarrierCountryServiceMapping */ sourceCountry?: string; /** - *

This endpoint is deprecated and has been replaced.

Deprecated - Use destination instead. + *

This endpoint is deprecated and has been replaced.

@deprecated - Use destination instead. * @type {Array} * @memberof CarrierCountryServiceMapping */ @@ -2673,10 +2709,16 @@ export interface CarrierCountryServiceMappingForCreation { mandatoryShippingItemAttributes?: Array; /** * - * @type {string} + * @type {Array} * @memberof CarrierCountryServiceMappingForCreation */ - product?: string; + mandatoryShippingArticleAttributes?: Array; + /** + * + * @type {Array} + * @memberof CarrierCountryServiceMappingForCreation + */ + products?: Array; /** * * @type {CarrierProductCategory} @@ -2746,10 +2788,16 @@ export interface CarrierCountryServiceMappingForUpdate { mandatoryShippingItemAttributes?: Array; /** * - * @type {string} + * @type {Array} + * @memberof CarrierCountryServiceMappingForUpdate + */ + mandatoryShippingArticleAttributes?: Array; + /** + * Array of products for the given mapping + * @type {Array} * @memberof CarrierCountryServiceMappingForUpdate */ - product?: string; + products?: Array; /** * * @type {CarrierProductCategory} @@ -2946,7 +2994,7 @@ export interface CarrierPatchActions { version: number; } /** - * + * Desired product class to choose when ordering a label, this is not a carrier specific value * @export * @enum {string} */ @@ -2964,7 +3012,8 @@ export enum CarrierProductCategory { export enum CarrierServices { SIGNATURE = 'SIGNATURE', CUSTOMERSIGNATURE = 'CUSTOMER_SIGNATURE', - ADULTSIGNATURE = 'ADULT_SIGNATURE' + ADULTSIGNATURE = 'ADULT_SIGNATURE', + SATURDAYDELIVERY = 'SATURDAY_DELIVERY' } /** * It is taken into consideration for all carriers. Default: INACTIVE @@ -3049,6 +3098,37 @@ export interface CheckoutOptionsAvailability { * @memberof CheckoutOptionsAvailability */ isBackOrderable: boolean; + /** + * + * @type {Date} + * @memberof CheckoutOptionsAvailability + */ + latestPickingStart?: Date; + /** + * + * @type {CheckoutOptionsAvailabilityCarrier} + * @memberof CheckoutOptionsAvailability + */ + carrier?: CheckoutOptionsAvailabilityCarrier; +} +/** + * + * @export + * @interface CheckoutOptionsAvailabilityCarrier + */ +export interface CheckoutOptionsAvailabilityCarrier { + /** + * + * @type {string} + * @memberof CheckoutOptionsAvailabilityCarrier + */ + carrierRef: string; + /** + * + * @type {CarrierProductCategory} + * @memberof CheckoutOptionsAvailabilityCarrier + */ + carrierProductCategory?: CarrierProductCategory; } /** * @@ -3135,7 +3215,7 @@ export interface CheckoutOptionsDeliveryEarliestRequest { * @type {CheckoutOptionsConsumerAddress} * @memberof CheckoutOptionsDeliveryEarliestRequest */ - consumerAddress?: CheckoutOptionsConsumerAddress; + consumerAddress: CheckoutOptionsConsumerAddress; } /** * @@ -3186,84 +3266,19 @@ export interface CheckoutOptionsDeliveryEarliestResponseItemAvailableCarrier { * @type {string} * @memberof CheckoutOptionsDeliveryEarliestResponseItemAvailableCarrier */ - name?: string; - /** - * - * @type {Array} - * @memberof CheckoutOptionsDeliveryEarliestResponseItemAvailableCarrier - */ - nonDeliveryDays?: Array; -} -/** - * - * @export - * @interface CheckoutOptionsDeliveryPreferences - */ -export interface CheckoutOptionsDeliveryPreferences { - /** - * DELIVERY: The parcel will reach the recipient according to the cycle time of the carrier, typically 1-3 days when shipping nationaly. EXPRESS: The parcel will reach the recipient using an express service level. - * @type {string} - * @memberof CheckoutOptionsDeliveryPreferences - */ - serviceLevel?: CheckoutOptionsDeliveryPreferences.ServiceLevelEnum; - /** - * - * @type {Array} - * @memberof CheckoutOptionsDeliveryPreferences - */ - preferredCarriers?: Array; - /** - * - * @type {CheckoutOptionsDeliveryPreferencesPreferredCarriersWithProduct} - * @memberof CheckoutOptionsDeliveryPreferences - */ - preferredCarriersWithProduct?: CheckoutOptionsDeliveryPreferencesPreferredCarriersWithProduct; -} - -/** - * @export - * @namespace CheckoutOptionsDeliveryPreferences - */ -export namespace CheckoutOptionsDeliveryPreferences { - /** - * @export - * @enum {string} - */ - export enum ServiceLevelEnum { - DELIVERY = 'DELIVERY', - EXPRESS = 'EXPRESS' - } -} -/** - * - * @export - * @interface CheckoutOptionsDeliveryPreferencesPreferredCarriersWithProduct - */ -export interface CheckoutOptionsDeliveryPreferencesPreferredCarriersWithProduct { - /** - * - * @type {string} - * @memberof CheckoutOptionsDeliveryPreferencesPreferredCarriersWithProduct - */ - carrierKey?: string; + name: string; /** * * @type {string} - * @memberof CheckoutOptionsDeliveryPreferencesPreferredCarriersWithProduct + * @memberof CheckoutOptionsDeliveryEarliestResponseItemAvailableCarrier */ - carrierProduct?: string; + carrierRef: string; /** * * @type {Array} - * @memberof CheckoutOptionsDeliveryPreferencesPreferredCarriersWithProduct - */ - carrierServices?: Array; - /** - * - * @type {string} - * @memberof CheckoutOptionsDeliveryPreferencesPreferredCarriersWithProduct + * @memberof CheckoutOptionsDeliveryEarliestResponseItemAvailableCarrier */ - carrierProductCategory?: string; + nonDeliveryDays?: Array; } /** * @@ -3294,13 +3309,13 @@ export interface CheckoutOptionsDeliveryTimePeriodRequest { * @type {CheckoutOptionsConsumerAddress} * @memberof CheckoutOptionsDeliveryTimePeriodRequest */ - consumerAddress?: CheckoutOptionsConsumerAddress; + consumerAddress: CheckoutOptionsConsumerAddress; /** * - * @type {CheckoutOptionsDeliveryPreferences} + * @type {DeliveryPreferencesShipping} * @memberof CheckoutOptionsDeliveryTimePeriodRequest */ - deliveryPreferences?: CheckoutOptionsDeliveryPreferences; + deliveryPreferences?: DeliveryPreferencesShipping; } /** * @@ -4201,6 +4216,12 @@ export interface CustomService extends VersionedResource { * @memberof CustomService */ additionalInformation?: Array; + /** + * Attributes that can be added to custom service. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here. + * @type {any} + * @memberof CustomService + */ + customAttributes?: any; /** * * @type {string} @@ -4318,6 +4339,12 @@ export interface CustomServiceForCreation { * @memberof CustomServiceForCreation */ additionalInformation?: Array; + /** + * Attributes that can be added to custom service. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here. + * @type {any} + * @memberof CustomServiceForCreation + */ + customAttributes?: any; } /** * @@ -5628,6 +5655,7 @@ export namespace EmailNotificationChannel { */ export enum EventsEnum { PICKJOBCREATED = 'PICK_JOB_CREATED', + UPCOMINGTIMETRIGGEREDREROUTE = 'UPCOMING_TIME_TRIGGERED_REROUTE', ROUTINGPLANNOTROUTABLE = 'ROUTING_PLAN_NOT_ROUTABLE', ROUTINGPLANWAITING = 'ROUTING_PLAN_WAITING' } @@ -5675,6 +5703,7 @@ export namespace EmailNotificationChannelForCreation { */ export enum EventsEnum { PICKJOBCREATED = 'PICK_JOB_CREATED', + UPCOMINGTIMETRIGGEREDREROUTE = 'UPCOMING_TIME_TRIGGERED_REROUTE', ROUTINGPLANNOTROUTABLE = 'ROUTING_PLAN_NOT_ROUTABLE', ROUTINGPLANWAITING = 'ROUTING_PLAN_WAITING' } @@ -6083,10 +6112,10 @@ export interface ExternalActionForCreation { groups: Array; /** * - * @type {ExternalFormActionDefinition | ExternalLinkActionDefinition} + * @type {ExternalFormActionDefinition | ExternalLinkActionDefinition | ExternalCommentActionDefinition} * @memberof ExternalActionForCreation */ - action: ExternalFormActionDefinition | ExternalLinkActionDefinition; + action: ExternalFormActionDefinition | ExternalLinkActionDefinition | ExternalCommentActionDefinition; } /** * @@ -6114,10 +6143,10 @@ export interface ExternalActionForReplacement { groups: Array; /** * - * @type {ExternalFormActionDefinition | ExternalLinkActionDefinition} + * @type {ExternalFormActionDefinition | ExternalLinkActionDefinition | ExternalCommentActionDefinition} * @memberof ExternalActionForReplacement */ - action: ExternalFormActionDefinition | ExternalLinkActionDefinition; + action: ExternalFormActionDefinition | ExternalLinkActionDefinition | ExternalCommentActionDefinition; } /** * @@ -6164,10 +6193,10 @@ export interface ExternalActionLogForCreation { requiresAnonymization: boolean; /** * - * @type {ExternalLinkActionLogPayload | ExternalFormActionLogPayload} + * @type {ExternalLinkActionLogPayload | ExternalFormActionLogPayload | ExternalCommentActionLogPayload} * @memberof ExternalActionLogForCreation */ - actionPayload: ExternalLinkActionLogPayload | ExternalFormActionLogPayload; + actionPayload: ExternalLinkActionLogPayload | ExternalFormActionLogPayload | ExternalCommentActionLogPayload; } /** * @@ -6195,7 +6224,8 @@ export interface ExternalActionLogs { */ export enum ExternalActionType { BLANKLINK = 'BLANK_LINK', - FORM = 'FORM' + FORM = 'FORM', + COMMENT = 'COMMENT' } /** * @@ -6216,6 +6246,38 @@ export interface ExternalActions { */ total: number; } +/** + * This action provides a possibility to set comments. It also enables a possibility to save action results for other actions. + * @export + * @interface ExternalCommentActionDefinition + */ +export interface ExternalCommentActionDefinition { + /** + * + * @type {ExternalActionType} + * @memberof ExternalCommentActionDefinition + */ + type: ExternalActionType; +} +/** + * This action payload provides a possibility to set comments. It also enables a possibility to save action results for other actions. + * @export + * @interface ExternalCommentActionLogPayload + */ +export interface ExternalCommentActionLogPayload { + /** + * The actual comment. + * @type {string} + * @memberof ExternalCommentActionLogPayload + */ + comment: string; + /** + * An existing external action id you want to link with. The action have to be in the same process. + * @type {string} + * @memberof ExternalCommentActionLogPayload + */ + externalActionRef?: string; +} /** * * @export @@ -6389,13 +6451,13 @@ export interface ExternalFormActionDefinition { * @type {ExternalFormActionButton} * @memberof ExternalFormActionDefinition */ - success: ExternalFormActionButton; + success?: ExternalFormActionButton; /** * * @type {ExternalFormActionButton} * @memberof ExternalFormActionDefinition */ - cancel?: ExternalFormActionButton; + cancel: ExternalFormActionButton; } /** * @@ -7143,6 +7205,12 @@ export interface FacilityDecision { * @memberof FacilityDecision */ isBestReassignmentCandidate?: boolean; + /** + * + * @type {Date} + * @memberof FacilityDecision + */ + latestPickingStart?: Date; } /** * @@ -8056,6 +8124,95 @@ export interface FilterEntity { */ valueLocalized: LocaleString; } +/** + * + * @export + * @enum {string} + */ +export enum FinishHandoverJobActionEnum { + FINISHHANDOVERJOB = 'FINISH_HANDOVER_JOB' +} +/** + * + * @export + * @interface FinishHandoverJobActionParameter + */ +export interface FinishHandoverJobActionParameter { + /** + * + * @type {FinishHandoverJobActionEnum} + * @memberof FinishHandoverJobActionParameter + */ + name: FinishHandoverJobActionEnum; + /** + * Version of the entity to be changed + * @type {number} + * @memberof FinishHandoverJobActionParameter + */ + version: number; + /** + * + * @type {Array} + * @memberof FinishHandoverJobActionParameter + */ + lineItems: Array; +} +/** + * + * @export + * @interface FinishHandoverJobLineItem + */ +export interface FinishHandoverJobLineItem { + /** + * + * @type {string} + * @memberof FinishHandoverJobLineItem + */ + id: string; + /** + * + * @type {number} + * @memberof FinishHandoverJobLineItem + */ + handedOverQuantity: number; + /** + * + * @type {Array} + * @memberof FinishHandoverJobLineItem + */ + refused?: Array; + /** + * + * @type {Array} + * @memberof FinishHandoverJobLineItem + */ + substituteLineItems?: Array; +} +/** + * + * @export + * @interface FinishHandoverJobSubstituteLineItem + */ +export interface FinishHandoverJobSubstituteLineItem { + /** + * + * @type {string} + * @memberof FinishHandoverJobSubstituteLineItem + */ + id: string; + /** + * + * @type {number} + * @memberof FinishHandoverJobSubstituteLineItem + */ + handedOverQuantity: number; + /** + * + * @type {Array} + * @memberof FinishHandoverJobSubstituteLineItem + */ + refused?: Array; +} /** * * @export @@ -8906,6 +9063,64 @@ export interface HandoverJobHandedOverWebHookEvent extends WebHookEvent { */ payload: Handoverjob; } +/** + * + * @export + * @enum {string} + */ +export enum HandoverJobLineItemUpdateActionEnum { + UPDATELINEITEM = 'UPDATE_LINEITEM' +} +/** + * + * @export + * @interface HandoverJobLineItemUpdateActionParameter + */ +export interface HandoverJobLineItemUpdateActionParameter { + /** + * + * @type {HandoverJobLineItemUpdateActionEnum} + * @memberof HandoverJobLineItemUpdateActionParameter + */ + name: HandoverJobLineItemUpdateActionEnum; + /** + * Version of the entity to be changed + * @type {number} + * @memberof HandoverJobLineItemUpdateActionParameter + */ + version: number; + /** + * + * @type {HandoverJobLineItemUpdateActionParameterLineItem} + * @memberof HandoverJobLineItemUpdateActionParameter + */ + lineItem: HandoverJobLineItemUpdateActionParameterLineItem; +} +/** + * + * @export + * @interface HandoverJobLineItemUpdateActionParameterLineItem + */ +export interface HandoverJobLineItemUpdateActionParameterLineItem { + /** + * + * @type {string} + * @memberof HandoverJobLineItemUpdateActionParameterLineItem + */ + id: string; + /** + * + * @type {Array} + * @memberof HandoverJobLineItemUpdateActionParameterLineItem + */ + refused?: Array; + /** + * + * @type {Array} + * @memberof HandoverJobLineItemUpdateActionParameterLineItem + */ + substituteItems?: Array; +} /** * STATUS_TARGET_TIME_LAST_MODIFIED_DATE is deprecated * @export @@ -8958,57 +9173,76 @@ export interface HandoverJobTagConfiguration extends VersionedResource { * @export * @interface HandoverLineItem */ -export interface HandoverLineItem { +export interface HandoverLineItem extends HandoverLineItemForCreation { /** * - * @type {HandoverLineItemArticle} + * @type {string} * @memberof HandoverLineItem */ + id: string; +} +/** + * + * @export + * @interface HandoverLineItemArticle + */ +export interface HandoverLineItemArticle extends AbstractArticle { + /** + * + * @type {Array} + * @memberof HandoverLineItemArticle + */ + attributes?: Array; +} +/** + * + * @export + * @interface HandoverLineItemForCreation + */ +export interface HandoverLineItemForCreation { + /** + * + * @type {Array} + * @memberof HandoverLineItemForCreation + */ + refused?: Array; + /** + * + * @type {HandoverLineItemArticle} + * @memberof HandoverLineItemForCreation + */ article: HandoverLineItemArticle; /** * quantity of the specific item that has been provided for handover * @type {number} - * @memberof HandoverLineItem + * @memberof HandoverLineItemForCreation */ quantity: number; /** * quantity of the specific item that has been handed over * @type {number} - * @memberof HandoverLineItem + * @memberof HandoverLineItemForCreation */ 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} - * @memberof HandoverLineItem + * @memberof HandoverLineItemForCreation */ substituteLineItems?: Array; /** * * @type {Array} - * @memberof HandoverLineItem + * @memberof HandoverLineItemForCreation */ tags?: Array; /** * * @type {Array} - * @memberof HandoverLineItem + * @memberof HandoverLineItemForCreation */ stickers?: Array; } -/** - * - * @export - * @interface HandoverLineItemArticle - */ -export interface HandoverLineItemArticle extends AbstractArticle { - /** - * - * @type {Array} - * @memberof HandoverLineItemArticle - */ - attributes?: Array; -} /** * * @export @@ -9027,6 +9261,37 @@ export interface HandoverSubstituteLineItem extends SubstituteLineItem { * @memberof HandoverSubstituteLineItem */ handedOverQuantity?: number; + /** + * + * @type {string} + * @memberof HandoverSubstituteLineItem + */ + id?: string; + /** + * + * @type {Array} + * @memberof HandoverSubstituteLineItem + */ + refused?: Array; +} +/** + * + * @export + * @interface HandoverSubstituteLineItemForUpdate + */ +export interface HandoverSubstituteLineItemForUpdate { + /** + * + * @type {string} + * @memberof HandoverSubstituteLineItemForUpdate + */ + id: string; + /** + * + * @type {Array} + * @memberof HandoverSubstituteLineItemForUpdate + */ + refused?: Array; } /** * @@ -9280,10 +9545,10 @@ export interface HandoverjobForCreation { facilityRef: string; /** * - * @type {Array} + * @type {Array} * @memberof HandoverjobForCreation */ - handoverJobLineItems?: Array; + handoverJobLineItems?: Array; /** * Reference to array of load unit Refs * @type {Array} @@ -10961,12 +11226,6 @@ export interface InventoryConfiguration { * @memberof InventoryConfiguration */ version: number; - /** - * - * @type {boolean} - * @memberof InventoryConfiguration - */ - enableStorageLocationOverview: boolean; /** * * @type {boolean} @@ -10986,12 +11245,6 @@ export interface InventoryConfigurationForPatch { * @memberof InventoryConfigurationForPatch */ version: number; - /** - * - * @type {boolean} - * @memberof InventoryConfigurationForPatch - */ - enableStorageLocationOverview?: boolean; /** * * @type {boolean} @@ -11560,6 +11813,12 @@ export interface ItemReturnJobLineItem extends ItemReturnJobLineItemForCreation * @memberof ItemReturnJobLineItem */ returnable: number; + /** + * Marks if some of the items could be not refundable. E.g. through altering via a ServiceJob via engraving. + * @type {boolean} + * @memberof ItemReturnJobLineItem + */ + notReturnableItemsExists?: boolean; } /** * @@ -11598,6 +11857,12 @@ export interface ItemReturnJobLineItemForCreation { * @memberof ItemReturnJobLineItemForCreation */ delivered: number; + /** + * Marks if some of the items could be not refundable. E.g. through altering via a ServiceJob via engraving. + * @type {boolean} + * @memberof ItemReturnJobLineItemForCreation + */ + notReturnableItemsExists?: boolean; /** * * @type {Array} @@ -11901,6 +12166,31 @@ export interface LastDomainEntityStatusItem { */ entityId: string; } +/** + * + * @export + * @interface LatestPickingStart + */ +export interface LatestPickingStart { + /** + * + * @type {Date} + * @memberof LatestPickingStart + */ + latestPickingStartDate: Date; + /** + * + * @type {Date} + * @memberof LatestPickingStart + */ + targetTime: Date; + /** + * + * @type {string} + * @memberof LatestPickingStart + */ + carrierRef: string; +} /** * * @export @@ -12991,6 +13281,73 @@ export interface Location { */ scannableCodes?: Array; } +/** + * + * @export + * @interface MandatoryShippingArticleAttribute + */ +export interface MandatoryShippingArticleAttribute { + /** + * + * @type {MandatoryShippingArticleAttributeReferencedField} + * @memberof MandatoryShippingArticleAttribute + */ + referencedField: MandatoryShippingArticleAttributeReferencedField; + /** + * + * @type {MandatoryShippingArticleAttributeDataType} + * @memberof MandatoryShippingArticleAttribute + */ + dataType: MandatoryShippingArticleAttributeDataType; + /** + * + * @type {MandatoryShippingArticleAttributeCategory} + * @memberof MandatoryShippingArticleAttribute + */ + category: MandatoryShippingArticleAttributeCategory; + /** + * + * @type {string} + * @memberof MandatoryShippingArticleAttribute + */ + description?: string; + /** + * + * @type {LocaleString} + * @memberof MandatoryShippingArticleAttribute + */ + descriptionLocalized: LocaleString; +} +/** + * + * @export + * @enum {string} + */ +export enum MandatoryShippingArticleAttributeCategory { + Customs = 'customs', + Dimensions = 'dimensions' +} +/** + * + * @export + * @enum {string} + */ +export enum MandatoryShippingArticleAttributeDataType { + NUMBER = 'NUMBER', + STRING = 'STRING' +} +/** + * + * @export + * @enum {string} + */ +export enum MandatoryShippingArticleAttributeReferencedField { + WeightPerUnit = 'attributes.weightPerUnit', + HsCode = 'attributes.hsCode', + Currency = 'attributes.currency', + ValuePerUnit = 'attributes.valuePerUnit', + CountryOfManufacture = 'attributes.countryOfManufacture' +} /** * * @export @@ -12998,7 +13355,7 @@ export interface Location { */ export interface MandatoryShippingAttribute { /** - * + * - dimensions.weight: will be calculated from MandatoryShippingArticleAttribute.attributes.weightPerUnit if items with weightPerUnit is set on all items - productValue: will be calculated from MandatoryShippingArticleAttribute.attributes.pricePerUnit if items with pricePerUnit is set on all items * @type {string} * @memberof MandatoryShippingAttribute */ @@ -13055,7 +13412,7 @@ export namespace MandatoryShippingAttribute { */ export interface MandatoryShippingItemAttribute { /** - * Deprecated: quantity, this field is now mandatory in the item + * Deprecated: - description: article.title will be used instead - weightInGram: use MandatoryShippingArticleAttribute.attributes.weightPerUnit - quantity, this field is now mandatory in the item - parcelItemValue.value: use MandatoryShippingArticleAttribute.attributes.pricePerUnit - parcelItemValue.currency: use MandatoryShippingArticleAttribute.attributes.currency - countryOfManufacture: use MandatoryShippingArticleAttribute.attributes.countryOfManufacture - tenantArticleId: mandatory on line item article * @type {string} * @memberof MandatoryShippingItemAttribute */ @@ -15608,10 +15965,10 @@ export interface NonDeliveryDays { nonDeliveryType?: NonDeliveryType; /** * - * @type {Date} + * @type {string} * @memberof NonDeliveryDays */ - nonDeliveryDay: Date; + nonDeliveryDay: string; } /** * @@ -16225,9 +16582,40 @@ export namespace OrderCancelActionParameter { * @export * @enum {string} */ - export enum NameEnum { - CANCEL = 'CANCEL' - } + export enum NameEnum { + CANCEL = 'CANCEL' + } +} +/** + *

This part of the API is currently under development. That means that this endpoint, model, etc. can contain breaking changes and / or might not be available at all times in your API instance. It 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 configuration is to define specific rules for canceling orders such as the forced cancelation. + * @export + * @interface OrderCancelationConfiguration + */ +export interface OrderCancelationConfiguration { + /** + * The date this order was created at the platform. This value is generated by the service. + * @type {Date} + * @memberof OrderCancelationConfiguration + */ + created?: Date; + /** + * + * @type {string} + * @memberof OrderCancelationConfiguration + */ + id?: string; + /** + * The version of the document to be used in optimistic locking mechanisms. + * @type {number} + * @memberof OrderCancelationConfiguration + */ + version: number; + /** + * + * @type {boolean} + * @memberof OrderCancelationConfiguration + */ + allowForceCancelOrder: boolean; } /** * @@ -16493,6 +16881,33 @@ export interface OrderForCreationConsumer { */ email?: string; } +/** + * + * @export + * @interface OrderForceCancelActionParameter + */ +export interface OrderForceCancelActionParameter extends AbstractOrderActionsParameter { + /** + * + * @type {string} + * @memberof OrderForceCancelActionParameter + */ + name: OrderForceCancelActionParameter.NameEnum; +} + +/** + * @export + * @namespace OrderForceCancelActionParameter + */ +export namespace OrderForceCancelActionParameter { + /** + * @export + * @enum {string} + */ + export enum NameEnum { + FORCECANCEL = 'FORCE_CANCEL' + } +} /** * * @export @@ -16538,6 +16953,13 @@ export interface OrderLineItem extends OrderLineItemForCreation { */ id: string; } +/** + * + * @export + * @interface OrderLineItemActionsParameter + */ +export interface OrderLineItemActionsParameter { +} /** * * @export @@ -16551,6 +16973,39 @@ export interface OrderLineItemArticle extends AbstractArticle { */ attributes?: Array; } +/** + * + * @export + * @interface OrderLineItemCustomAttributesUpdateParameter + */ +export interface OrderLineItemCustomAttributesUpdateParameter extends AbstractOrderLineItemActionsParameter { + /** + * + * @type {string} + * @memberof OrderLineItemCustomAttributesUpdateParameter + */ + name: OrderLineItemCustomAttributesUpdateParameter.NameEnum; + /** + * 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. If no customAttributes exist yet, they will be created for this line item. + * @type {any} + * @memberof OrderLineItemCustomAttributesUpdateParameter + */ + customAttributes: any; +} + +/** + * @export + * @namespace OrderLineItemCustomAttributesUpdateParameter + */ +export namespace OrderLineItemCustomAttributesUpdateParameter { + /** + * @export + * @enum {string} + */ + export enum NameEnum { + UPDATECUSTOMATTRIBUTES = 'UPDATE_CUSTOM_ATTRIBUTES' + } +} /** * * @export @@ -17918,6 +18373,12 @@ export interface PackingTargetContainer extends VersionedResource { * @memberof PackingTargetContainer */ packingContainerTypeRef: string; + /** + * Reference to the documents collection from this entity + * @type {string} + * @memberof PackingTargetContainer + */ + documentsRef?: string; /** * * @type {string} @@ -17942,6 +18403,12 @@ export interface PackingTargetContainer extends VersionedResource { * @memberof PackingTargetContainer */ packJobRef: string; + /** + * + * @type {string} + * @memberof PackingTargetContainer + */ + shortId?: string; /** * * @type {string} @@ -17984,6 +18451,12 @@ export interface PackingTargetContainer extends VersionedResource { * @memberof PackingTargetContainer */ nameLocalized: LocaleString; + /** + * + * @type {Array} + * @memberof PackingTargetContainer + */ + parcels?: Array; } /** * @@ -18282,6 +18755,12 @@ export interface Parcel extends VersionedResource { * @memberof Parcel */ productValue?: number; + /** + * + * @type {string} + * @memberof Parcel + */ + shortId?: string; /** * * @type {Array} @@ -18289,6 +18768,20 @@ export interface Parcel extends VersionedResource { */ transfers?: Array; } +/** + * + * @export + * @interface ParcelArticleAttributeItemForUpdate + */ +export interface ParcelArticleAttributeItemForUpdate extends ArticleAttributeItem { +} + +/** + * @export + * @namespace ParcelArticleAttributeItemForUpdate + */ +export namespace ParcelArticleAttributeItemForUpdate { +} /** * * @export @@ -18449,6 +18942,12 @@ export interface ParcelForCreation { * @memberof ParcelForCreation */ pickUpInformation?: ParcelPickUpInformation; + /** + * + * @type {string} + * @memberof ParcelForCreation + */ + shortId?: string; /** * 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} @@ -18487,19 +18986,19 @@ export interface ParcelItem { */ quantity: number; /** - * + * Deprecated - use article.attribute.hsCode instead * @type {string} * @memberof ParcelItem */ hsCode?: string; /** - * Description of the given item/items + * Description - article.title will be used instead - of the given item/items * @type {string} * @memberof ParcelItem */ description?: string; /** - * Weight of a single item in gram + * Deprecated - use article.attribute.weightPerUnit instead - Weight of a single item in gram * @type {number} * @memberof ParcelItem */ @@ -18511,7 +19010,7 @@ export interface ParcelItem { */ parcelItemValue?: ParcelItemValue; /** - * + * Deprecated - use article.attribute.countryOfManufacture instead * @type {string} * @memberof ParcelItem */ @@ -18603,6 +19102,12 @@ export interface ParcelItemForUpdate { * @memberof ParcelItemForUpdate */ parcelItemValue?: ParcelItemValue; + /** + * + * @type {Array} + * @memberof ParcelItemForUpdate + */ + parcelItemArticleAttributes?: Array; /** * Weight of a single item in gram * @type {number} @@ -18858,6 +19363,12 @@ export interface ParcelServices { * @memberof ParcelServices */ customerSignature?: boolean; + /** + * Saturday Delivery + * @type {boolean} + * @memberof ParcelServices + */ + saturdayDelivery?: boolean; } /** * @@ -19739,7 +20250,7 @@ export interface PickLineItemArticle extends AbstractArticle { */ attributes?: Array; /** - * + *

This endpoint is deprecated and has been replaced.

* @type {Array} * @memberof PickLineItemArticle */ @@ -20788,7 +21299,13 @@ export interface PickjobDeliveryInformationForCreationDetailsShipping { */ carrierKey?: string; /** - * Desired product of given carrier to choose when ordering a label + * + * @type {CarrierProductCategory} + * @memberof PickjobDeliveryInformationForCreationDetailsShipping + */ + carrierProductCategory?: CarrierProductCategory; + /** + * Desired product of given carrier to choose when ordering a label, this is specific to a carrier * @type {string} * @memberof PickjobDeliveryInformationForCreationDetailsShipping */ @@ -21485,6 +22002,12 @@ export interface ProductInformation { * @memberof ProductInformation */ mandatoryShippingAttributes?: Array; + /** + * + * @type {Array} + * @memberof ProductInformation + */ + mandatoryShippingArticleAttributes?: Array; /** * * @type {Array} @@ -21498,6 +22021,12 @@ export interface ProductInformation { * @interface PromiseCarrier */ export interface PromiseCarrier { + /** + * + * @type {string} + * @memberof PromiseCarrier + */ + carrierRef: string; /** * * @type {string} @@ -21522,12 +22051,6 @@ export interface PromiseCarrier { * @memberof PromiseCarrier */ deliveryPromiseValidUntil?: Date; - /** - * - * @type {Date} - * @memberof PromiseCarrier - */ - latestPickingStart?: Date; } /** * @@ -22263,6 +22786,75 @@ export namespace ReceiptForCreation { FINISHED = 'FINISHED' } } +/** + * + * @export + * @interface RefundTriggerWebHookEvent + */ +export interface RefundTriggerWebHookEvent extends WebHookEvent { + /** + * + * @type {ItemReturn} + * @memberof RefundTriggerWebHookEvent + */ + payload: ItemReturn; +} +/** + * + * @export + * @interface RefusedItem + */ +export interface RefusedItem { + /** + * + * @type {number} + * @memberof RefusedItem + */ + quantity: number; + /** + * + * @type {string} + * @memberof RefusedItem + */ + reason?: string; + /** + * + * @type {LocaleString} + * @memberof RefusedItem + */ + reasonLocalized?: LocaleString; + /** + * + * @type {string} + * @memberof RefusedItem + */ + comment?: string; +} +/** + * + * @export + * @interface RefusedItemForUpdate + */ +export interface RefusedItemForUpdate { + /** + * + * @type {number} + * @memberof RefusedItemForUpdate + */ + quantity: number; + /** + * + * @type {LocaleString} + * @memberof RefusedItemForUpdate + */ + reasonLocalized?: LocaleString; + /** + * + * @type {string} + * @memberof RefusedItemForUpdate + */ + comment?: string; +} /** * * @export @@ -22849,6 +23441,12 @@ export interface RerouteConfiguration { * @memberof RerouteConfiguration */ rerouteAfterMinutes: number; + /** + * How many minutes before a time triggered reroute a notification should be sent. Should be smaller than rerouteAfterMinutes + * @type {number} + * @memberof RerouteConfiguration + */ + leadTimeBeforeTimeTriggeredReroute?: number; } /** * @@ -24198,7 +24796,7 @@ export interface RoutingConfiguration { */ lastModified?: Date; /** - * Contains the routing configuration for prioritization & routing for the whole tenant + *

This endpoint is deprecated and has been replaced.

@deprecated Contains the routing configuration for prioritization & routing for the whole tenant * @type {Array} * @memberof RoutingConfiguration */ @@ -24500,6 +25098,12 @@ export interface RoutingPlan extends VersionedResource { * @memberof RoutingPlan */ customServices?: Array; + /** + * + * @type {LatestPickingStart} + * @memberof RoutingPlan + */ + latestPickingStart?: LatestPickingStart; /** * The point in time by which the order is supposed to be provisioned. * @type {Date} @@ -25229,7 +25833,8 @@ export enum Section { PACKJOB = 'PACKJOB', PICKJOB = 'PICKJOB', HANDOVERJOB = 'HANDOVERJOB', - PARCEL = 'PARCEL' + PARCEL = 'PARCEL', + PACKINGTARGETCONTAINER = 'PACKING_TARGET_CONTAINER' } /** * @@ -26512,6 +27117,12 @@ export interface StaticCarrierCountryServiceMapping { * @memberof StaticCarrierCountryServiceMapping */ destinations: Array; + /** + * + * @type {Array} + * @memberof StaticCarrierCountryServiceMapping + */ + mandatoryShippingArticleAttributes?: Array; /** * * @type {Array} @@ -26519,17 +27130,23 @@ export interface StaticCarrierCountryServiceMapping { */ mandatoryShippingAttributes?: Array; /** - * + * Deprecated - use mandatoryShippingArticleAttributes instead * @type {Array} * @memberof StaticCarrierCountryServiceMapping */ mandatoryShippingItemAttributes?: Array; /** - * - * @type {string} + * Array of products for the given mapping + * @type {Array} + * @memberof StaticCarrierCountryServiceMapping + */ + products?: Array; + /** + * Services which can be provided by the carrier + * @type {Array} * @memberof StaticCarrierCountryServiceMapping */ - product?: string; + carrierServices?: Array; /** * * @type {CarrierProductCategory} @@ -28785,6 +29402,18 @@ export namespace SubstituteAttributeItem { * @interface SubstituteLineItem */ export interface SubstituteLineItem { + /** + * + * @type {string} + * @memberof SubstituteLineItem + */ + id?: string; + /** + * + * @type {Array} + * @memberof SubstituteLineItem + */ + refused?: Array; /** * * @type {SubstituteLineItemArticle} @@ -29015,7 +29644,15 @@ export enum SupportedLocale { FrFR = 'fr_FR', ItIT = 'it_IT', NbNO = 'nb_NO', - EsES = 'es_ES' + EsES = 'es_ES', + CsCZ = 'cs_CZ', + SkSK = 'sk_SK', + PtPT = 'pt_PT', + SlSI = 'sl_SI', + RoRO = 'ro_RO', + BgBG = 'bg_BG', + HrHR = 'hr_HR', + HuHU = 'hu_HU' } /** * @@ -30091,6 +30728,68 @@ export namespace Transfer { RECEIVER = 'RECEIVER' } } +/** + * + * @export + * @interface TransitTimeConfiguration + */ +export interface TransitTimeConfiguration extends VersionedResource { + /** + * + * @type {string} + * @memberof TransitTimeConfiguration + */ + calculationStrategy: TransitTimeConfiguration.CalculationStrategyEnum; + /** + * + * @type {string} + * @memberof TransitTimeConfiguration + */ + id: string; +} + +/** + * @export + * @namespace TransitTimeConfiguration + */ +export namespace TransitTimeConfiguration { + /** + * @export + * @enum {string} + */ + export enum CalculationStrategyEnum { + EARLIEST = 'EARLIEST', + LATEST = 'LATEST' + } +} +/** + * + * @export + * @interface TransitTimeConfigurationForUpsert + */ +export interface TransitTimeConfigurationForUpsert extends VersionedResource { + /** + * + * @type {string} + * @memberof TransitTimeConfigurationForUpsert + */ + calculationStrategy: TransitTimeConfigurationForUpsert.CalculationStrategyEnum; +} + +/** + * @export + * @namespace TransitTimeConfigurationForUpsert + */ +export namespace TransitTimeConfigurationForUpsert { + /** + * @export + * @enum {string} + */ + export enum CalculationStrategyEnum { + EARLIEST = 'EARLIEST', + LATEST = 'LATEST' + } +} /** * * @export