///
// tslint:disable
/**
* fulfillmenttools - simplifying retail complexity
* This is the fulfillmenttools API documentation. Visit https://docs.fulfillmenttools.com/ for first steps.
*
* OpenAPI spec version: VERSIONLESS
* Contact: api@fulfillmenttools.com
*
* NOTE: This file is auto generated by the swagger code generator program.
* https://github.com/swagger-api/swagger-codegen.git
* Do not edit the file manually.
*/
import * as url from "url";
import * as isomorphicFetch from "isomorphic-fetch";
import { Configuration } from "./configuration";
const BASE_PATH = "/".replace(/\/+$/, "");
/**
*
* @export
*/
export const COLLECTION_FORMATS = {
csv: ",",
ssv: " ",
tsv: "\t",
pipes: "|",
};
/**
*
* @export
* @interface FetchAPI
*/
export interface FetchAPI {
(url: string, init?: any): Promise;
}
/**
*
* @export
* @interface FetchArgs
*/
export interface FetchArgs {
url: string;
options: any;
}
/**
*
* @export
* @class BaseAPI
*/
export class BaseAPI {
protected configuration: Configuration = {};
constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected fetch: FetchAPI = isomorphicFetch) {
if (configuration) {
this.configuration = configuration;
this.basePath = configuration.basePath || this.basePath;
}
}
}
/**
*
* @export
* @class RequiredError
* @extends {Error}
*/
export class RequiredError extends Error {
name = "RequiredError"
constructor(public field: string, msg?: string) {
super(msg);
}
}
/**
*
This endpoint is deprecated and has been replaced.
@deprecated Use api/pickjobs/:id/actions instead
* @export
* @interface AbortPickJobAction
*/
export interface AbortPickJobAction extends AbstractModificationAction {
/**
* Use value 'AbortPickJob', because you want to cancel a pickjob
* @type {string}
* @memberof AbortPickJobAction
*/
action: AbortPickJobAction.ActionEnum;
}
/**
* @export
* @namespace AbortPickJobAction
*/
export namespace AbortPickJobAction {
/**
* @export
* @enum {string}
*/
export enum ActionEnum {
AbortPickJob = 'AbortPickJob'
}
}
/**
*
* @export
* @interface AbstractArticle
*/
export interface AbstractArticle {
/**
* Attributes that can be added to this entity. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
* @type {any}
* @memberof AbstractArticle
*/
customAttributes?: any;
/**
* A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!
* @type {string}
* @memberof AbstractArticle
*/
imageUrl?: string;
/**
* This is a reference to an article number
* @type {string}
* @memberof AbstractArticle
*/
tenantArticleId: string;
/**
* The title of the product
* @type {string}
* @memberof AbstractArticle
*/
title: string;
/**
* The translations for the title of the product
* @type {LocaleString}
* @memberof AbstractArticle
*/
titleLocalized?: LocaleString;
/**
* weight value is in gram
* @type {number}
* @memberof AbstractArticle
*/
weight?: number;
}
/**
*
* @export
* @interface AbstractCarrierCredentials
*/
export interface AbstractCarrierCredentials {
/**
*
* @type {string}
* @memberof AbstractCarrierCredentials
*/
key: string;
}
/**
*
* @export
* @interface AbstractFacilityActionsParameter
*/
export interface AbstractFacilityActionsParameter {
/**
*
* @type {string}
* @memberof AbstractFacilityActionsParameter
*/
name: string;
/**
* Version of the entity to be changed
* @type {number}
* @memberof AbstractFacilityActionsParameter
*/
version: number;
}
/**
*
* @export
* @interface AbstractFacilityCarrierConfiguration
*/
export interface AbstractFacilityCarrierConfiguration {
/**
*
* @type {string}
* @memberof AbstractFacilityCarrierConfiguration
*/
key: string;
/**
*
* @type {string}
* @memberof AbstractFacilityCarrierConfiguration
*/
serviceUrl?: string;
}
/**
*
* @export
* @interface AbstractFulfillabilityConstraintType
*/
export interface AbstractFulfillabilityConstraintType {
/**
* Type of the constraint (must be supported by the fulfillmenttools platform).
* @type {string}
* @memberof AbstractFulfillabilityConstraintType
*/
type?: AbstractFulfillabilityConstraintType.TypeEnum;
/**
* Additional parameters needed for the referenced type of constraint.
* @type {any}
* @memberof AbstractFulfillabilityConstraintType
*/
value?: any;
}
/**
* @export
* @namespace AbstractFulfillabilityConstraintType
*/
export namespace AbstractFulfillabilityConstraintType {
/**
* @export
* @enum {string}
*/
export enum TypeEnum {
ITEMS = 'ITEMS'
}
}
/**
*
* @export
* @interface AbstractModificationAction
*/
export interface AbstractModificationAction {
/**
*
* @type {string}
* @memberof AbstractModificationAction
*/
action: AbstractModificationAction.ActionEnum;
}
/**
* @export
* @namespace AbstractModificationAction
*/
export namespace AbstractModificationAction {
/**
* @export
* @enum {string}
*/
export enum ActionEnum {
AddAllowedValueToTag = 'AddAllowedValueToTag',
ModifyPickJob = 'ModifyPickJob',
ModifyPickJobLastEditor = 'ModifyPickJobLastEditor',
RestartPickJob = 'RestartPickJob',
ResetPickJob = 'ResetPickJob',
CancelPickRun = 'CancelPickRun',
CancelHandoverjob = 'CancelHandoverjob',
AbortPickJob = 'AbortPickJob',
FinishPickRun = 'FinishPickRun',
StartPickRun = 'StartPickRun',
ModifyPickLineItem = 'ModifyPickLineItem',
ModifyPickRunLineItem = 'ModifyPickRunLineItem',
ModifyPackJob = 'ModifyPackJob',
PausePackJob = 'PausePackJob',
ModifyPackLineItem = 'ModifyPackLineItem',
ModifyFacility = 'ModifyFacility',
ModifyListing = 'ModifyListing',
ModifyRetainedOfflineStock = 'ModifyRetainedOfflineStock',
ModifyListingReactivationAfter = 'ModifyListingReactivationAfter',
ModifyUser = 'ModifyUser',
ModifyShipment = 'ModifyShipment',
ModifyHandoverjob = 'ModifyHandoverjob',
ModifyCarrier = 'ModifyCarrier',
ModifyShortpick = 'ModifyShortpick',
ModifyReturn = 'ModifyReturn',
ModifyReturnLineItem = 'ModifyReturnLineItem',
ModifyRoutingPlan = 'ModifyRoutingPlan',
ModifyFence = 'ModifyFence',
ModifyRating = 'ModifyRating',
ModifyTimingMode = 'ModifyTimingMode',
ModifyGlobalRoutingConfiguration = 'ModifyGlobalRoutingConfiguration',
ModifyOrderSplit = 'ModifyOrderSplit',
ModifyPrioritization = 'ModifyPrioritization',
ModifyLoadUnitType = 'ModifyLoadUnitType',
ModifyFeature = 'ModifyFeature',
ModifyParcel = 'ModifyParcel',
ModifyParcelLoadUnit = 'ModifyParcelLoadUnit',
ModifyRestowItem = 'ModifyRestowItem',
RemovePickJobFromPickRunAction = 'RemovePickJobFromPickRunAction',
ModifyPartialStock = 'ModifyPartialStock',
AddTagsToProcess = 'AddTagsToProcess',
AssignFacilityToProcess = 'AssignFacilityToProcess',
ModifyStorageLocation = 'ModifyStorageLocation',
ModifyPackingContainerType = 'ModifyPackingContainerType',
ModifyPackingContainerTypeIcon = 'ModifyPackingContainerTypeIcon',
ReplaceCodesInPackingTargetContainer = 'ReplaceCodesInPackingTargetContainer',
ReplaceLoadUnitLineItems = 'ReplaceLoadUnitLineItems',
AddLineItemToPackingTargetContainer = 'AddLineItemToPackingTargetContainer',
RemoveLineItemFromPackingTargetContainer = 'RemoveLineItemFromPackingTargetContainer',
UpdateLineItemOnPackingTargetContainer = 'UpdateLineItemOnPackingTargetContainer',
ModifyCustomService = 'ModifyCustomService',
UnlockOrder = 'UnlockOrder'
}
}
/**
*
* @export
* @interface AbstractModifyCarrierCredentials
*/
export interface AbstractModifyCarrierCredentials {
/**
*
* @type {string}
* @memberof AbstractModifyCarrierCredentials
*/
key: string;
}
/**
*
* @export
* @interface AbstractOrderActionsParameter
*/
export interface AbstractOrderActionsParameter {
/**
*
* @type {string}
* @memberof AbstractOrderActionsParameter
*/
name: string;
/**
* Version of the entity to be changed
* @type {number}
* @memberof AbstractOrderActionsParameter
*/
version: number;
}
/**
* Base Configuration for Ratings. See documentation for Details.
* @export
* @interface AbstractRatingConfiguration
*/
export interface AbstractRatingConfiguration {
}
/**
*
* @export
* @interface AbstractReason
*/
export interface AbstractReason extends AbstractReasonForCreation {
/**
* The date this entity was created at the platform. This value is generated by the service.
* @type {Date}
* @memberof AbstractReason
*/
created?: Date;
/**
* The date this entity was modified last. This value is generated by the service.
* @type {Date}
* @memberof AbstractReason
*/
lastModified?: Date;
/**
* The version of the document to be used in optimistic locking mechanisms.
* @type {number}
* @memberof AbstractReason
*/
version: number;
/**
* The id of the Reason
* @type {string}
* @memberof AbstractReason
*/
id: string;
/**
* The action this reason can be attached to.
* @type {string}
* @memberof AbstractReason
*/
action: string;
}
/**
*
* @export
* @interface AbstractReasonForCreation
*/
export interface AbstractReasonForCreation {
/**
* Text explaining the reason for a supported action.
* @type {string}
* @memberof AbstractReasonForCreation
*/
reason: string;
/**
*
* @type {LocaleString}
* @memberof AbstractReasonForCreation
*/
reasonLocalized: LocaleString;
}
/**
*
* @export
* @interface AbstractReasonForModification
*/
export interface AbstractReasonForModification {
/**
* Text explaining the reason for a supported action.
* @type {string}
* @memberof AbstractReasonForModification
*/
reason: string;
/**
*
* @type {LocaleString}
* @memberof AbstractReasonForModification
*/
reasonLocalized: LocaleString;
/**
* The version of the document to be used in optimistic locking mechanisms.
* @type {number}
* @memberof AbstractReasonForModification
*/
version: number;
}
/**
*
* @export
* @interface AbstractReasons
*/
export interface AbstractReasons {
/**
*
* @type {Array}
* @memberof AbstractReasons
*/
reasons: Array;
/**
* True if there are more results after the current page
* @type {boolean}
* @memberof AbstractReasons
*/
hasNextPage: boolean;
/**
* Total number of found entities for this query
* @type {number}
* @memberof AbstractReasons
*/
total: number;
}
/**
*
* @export
* @interface AddAllowedValueToTagAction
*/
export interface AddAllowedValueToTagAction extends AbstractModificationAction {
/**
* Use value 'AddAllowedValueToTag', because you want to add an allowed value to a tag
* @type {string}
* @memberof AddAllowedValueToTagAction
*/
action: AddAllowedValueToTagAction.ActionEnum;
/**
*
* @type {string}
* @memberof AddAllowedValueToTagAction
*/
allowedValue: string;
}
/**
* @export
* @namespace AddAllowedValueToTagAction
*/
export namespace AddAllowedValueToTagAction {
/**
* @export
* @enum {string}
*/
export enum ActionEnum {
AddAllowedValueToTag = 'AddAllowedValueToTag'
}
}
/**
*
* @export
* @interface AddChannelAction
*/
export interface AddChannelAction {
/**
*
* @type {string}
* @memberof AddChannelAction
*/
name: AddChannelAction.NameEnum;
/**
*
* @type {EmailNotificationChannelForCreation}
* @memberof AddChannelAction
*/
channel: EmailNotificationChannelForCreation;
/**
*
* @type {number}
* @memberof AddChannelAction
*/
version: number;
}
/**
* @export
* @namespace AddChannelAction
*/
export namespace AddChannelAction {
/**
* @export
* @enum {string}
*/
export enum NameEnum {
ADDCHANNEL = 'ADD_CHANNEL'
}
}
/**
*
* @export
* @interface AddItemReturnToItemReturnJob
*/
export interface AddItemReturnToItemReturnJob {
/**
*
* @type {ItemReturnForCreation}
* @memberof AddItemReturnToItemReturnJob
*/
itemReturnForCreation: ItemReturnForCreation;
/**
* Version of the itemReturnJob the itemReturn gets added to
* @type {number}
* @memberof AddItemReturnToItemReturnJob
*/
itemReturnJobVersion: number;
}
/**
*
* @export
* @interface AddLineItemToPackingTargetContainerAction
*/
export interface AddLineItemToPackingTargetContainerAction extends AbstractModificationAction {
/**
* Use AddLineItemToPackingTargetContainer to add a line item to an existing packing container
* @type {string}
* @memberof AddLineItemToPackingTargetContainerAction
*/
action: AddLineItemToPackingTargetContainerAction.ActionEnum;
/**
*
* @type {PackingTargetContainerLineItemForCreation}
* @memberof AddLineItemToPackingTargetContainerAction
*/
lineItem: PackingTargetContainerLineItemForCreation;
}
/**
* @export
* @namespace AddLineItemToPackingTargetContainerAction
*/
export namespace AddLineItemToPackingTargetContainerAction {
/**
* @export
* @enum {string}
*/
export enum ActionEnum {
AddLineItemToPackingTargetContainer = 'AddLineItemToPackingTargetContainer'
}
}
/**
*
* @export
* @interface AddRefuseReasonParameter
*/
export interface AddRefuseReasonParameter {
/**
*
* @type {number}
* @memberof AddRefuseReasonParameter
*/
handoverConfigurationVersion: number;
/**
*
* @type {AvailableRefuseReasonForCreation}
* @memberof AddRefuseReasonParameter
*/
availableRefuseReasonForCreation: AvailableRefuseReasonForCreation;
}
/**
*
* @export
* @interface AddRemoteConfigurationScopeParameter
*/
export interface AddRemoteConfigurationScopeParameter {
/**
*
* @type {RemoteConfigurationScopeForCreation}
* @memberof AddRemoteConfigurationScopeParameter
*/
scope: RemoteConfigurationScopeForCreation;
/**
*
* @type {number}
* @memberof AddRemoteConfigurationScopeParameter
*/
remoteConfigVersion: number;
}
/**
*
* @export
* @interface AddTagsToProcessAction
*/
export interface AddTagsToProcessAction extends AbstractModificationAction {
/**
* Use value 'AddTagsToProcess', because you want to modify a process
* @type {string}
* @memberof AddTagsToProcessAction
*/
action: AddTagsToProcessAction.ActionEnum;
/**
*
* @type {Array}
* @memberof AddTagsToProcessAction
*/
tags?: Array;
}
/**
* @export
* @namespace AddTagsToProcessAction
*/
export namespace AddTagsToProcessAction {
/**
* @export
* @enum {string}
*/
export enum ActionEnum {
AddTagsToProcess = 'AddTagsToProcess'
}
}
/**
*
* @export
* @interface AdditionalInformation
*/
export interface AdditionalInformation extends AdditionalInformationForCreation {
/**
*
* @type {string}
* @memberof AdditionalInformation
*/
id: string;
/**
*
* @type {string}
* @memberof AdditionalInformation
*/
name?: string;
/**
*
* @type {string}
* @memberof AdditionalInformation
*/
description?: string;
}
/**
*
* @export
* @interface AdditionalInformationForCreation
*/
export interface AdditionalInformationForCreation {
/**
*
* @type {LocaleString}
* @memberof AdditionalInformationForCreation
*/
nameLocalized: LocaleString;
/**
*
* @type {LocaleString}
* @memberof AdditionalInformationForCreation
*/
descriptionLocalized?: LocaleString;
/**
*
* @type {AdditionalInformationValueType}
* @memberof AdditionalInformationForCreation
*/
valueType: AdditionalInformationValueType;
/**
*
* @type {boolean}
* @memberof AdditionalInformationForCreation
*/
isMandatory?: boolean;
}
/**
*
* @export
* @enum {string}
*/
export enum AdditionalInformationValueType {
STRING = 'STRING',
BOOLEAN = 'BOOLEAN',
NUMBER = 'NUMBER',
NOVALUE = 'NOVALUE',
INPUTMULTILINESTRING = 'INPUT_MULTILINE_STRING'
}
/**
*
* @export
* @interface Address
*/
export interface Address {
/**
*
* @type {string}
* @memberof Address
*/
additionalAddressInfo?: string;
/**
*
* @type {string}
* @memberof Address
*/
city: string;
/**
* A two-digit country code as per ISO 3166-1 alpha-2
* @type {string}
* @memberof Address
*/
country: string;
/**
*
* @type {string}
* @memberof Address
*/
province?: string;
/**
* Attributes that can be added to the address. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
* @type {any}
* @memberof Address
*/
customAttributes?: any;
/**
*
* @type {string}
* @memberof Address
*/
houseNumber?: string;
/**
*
* @type {Array}
* @memberof Address
*/
phoneNumbers?: Array;
/**
*
* @type {string}
* @memberof Address
*/
postalCode: string;
/**
*
* @type {string}
* @memberof Address
*/
street: string;
}
/**
*
* @export
* @interface AddressPhoneNumbers
*/
export interface AddressPhoneNumbers {
/**
* Attributes that can be added to the phonenumber. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
* @type {any}
* @memberof AddressPhoneNumbers
*/
customAttributes?: any;
/**
* Can be used to give a description for the number, like \"private\", \"business number\", etc.
* @type {string}
* @memberof AddressPhoneNumbers
*/
label?: string;
/**
*
* @type {string}
* @memberof AddressPhoneNumbers
*/
type: AddressPhoneNumbers.TypeEnum;
/**
* The number itself. We do not enforce any format (yet).
* @type {string}
* @memberof AddressPhoneNumbers
*/
value: string;
}
/**
* @export
* @namespace AddressPhoneNumbers
*/
export namespace AddressPhoneNumbers {
/**
* @export
* @enum {string}
*/
export enum TypeEnum {
MOBILE = 'MOBILE',
PHONE = 'PHONE'
}
}
/**
* Type of this address, used e.g. for communication with the carrier. Use POSTAL_ADDRESS for the address where the order should be shipped to, INVOICE_ADDRESS for the address where the invoice is sent to and PARCEL_LOCKER if a parcel locker is used for this order.
* @export
* @enum {string}
*/
export enum AddressType {
POSTALADDRESS = 'POSTAL_ADDRESS',
PARCELLOCKER = 'PARCEL_LOCKER',
INVOICEADDRESS = 'INVOICE_ADDRESS'
}
/**
*
* @export
* @interface AlternativeReturnAddressConfiguration
*/
export interface AlternativeReturnAddressConfiguration {
/**
*
* @type {Array}
* @memberof AlternativeReturnAddressConfiguration
*/
alternativeReturnAddressPerTag: Array;
}
/**
*
* @export
* @interface AlternativeReturnAddressPerTag
*/
export interface AlternativeReturnAddressPerTag {
/**
* needs to be an existing tag id
* @type {string}
* @memberof AlternativeReturnAddressPerTag
*/
tagRef: string;
/**
*
* @type {Array}
* @memberof AlternativeReturnAddressPerTag
*/
matchingValues: Array;
/**
*
* @type {FacilityAddress}
* @memberof AlternativeReturnAddressPerTag
*/
alternativeReturnAddress: FacilityAddress;
}
/**
*
* @export
* @interface AngelCarrierCredentials
*/
export interface AngelCarrierCredentials extends AbstractCarrierCredentials {
/**
* Angel username
* @type {string}
* @memberof AngelCarrierCredentials
*/
username: string;
/**
* angel password
* @type {string}
* @memberof AngelCarrierCredentials
*/
password: string;
/**
* X-Auth-Token for callbacks from Angel
* @type {string}
* @memberof AngelCarrierCredentials
*/
authToken?: string;
}
/**
*
* @export
* @interface AngelFacilityCarrierConfiguration
*/
export interface AngelFacilityCarrierConfiguration extends AbstractFacilityCarrierConfiguration {
/**
* The id of the Pickup Location
* @type {string}
* @memberof AngelFacilityCarrierConfiguration
*/
pickupLocationId?: string;
}
/**
*
* @export
* @enum {string}
*/
export enum AnnounceItemReturnActionEnum {
AnnounceItemReturn = 'AnnounceItemReturn'
}
/**
*
* @export
* @interface AnnounceItemReturnActionParameter
*/
export interface AnnounceItemReturnActionParameter {
/**
*
* @type {AnnounceItemReturnActionEnum}
* @memberof AnnounceItemReturnActionParameter
*/
name: AnnounceItemReturnActionEnum;
/**
* Version of the entity to be changed
* @type {number}
* @memberof AnnounceItemReturnActionParameter
*/
itemReturnJobVersion: number;
}
/**
*
* @export
*/
export type ApiError = Array
/**
*
* @export
* @interface ArticleAttributeItem
*/
export interface ArticleAttributeItem {
/**
* This category is used by OCFF to customize implemented processes. Categorized attributes are used by various processes and tools throughout our platform. For a complete list of possible categories and the correct use of those please refer to the documentation. Default value: miscellaneous
* @type {string}
* @memberof ArticleAttributeItem
*/
category?: ArticleAttributeItem.CategoryEnum;
/**
* Providing the key %%subtitle%% (see example) here will cause the value to appear for example in the App directly under the title. With all other attributes also the key will be displayed in the clients.
* @type {string}
* @memberof ArticleAttributeItem
*/
key: string;
/**
* The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%
* @type {LocaleString}
* @memberof ArticleAttributeItem
*/
keyLocalized?: LocaleString;
/**
* This value gives the priority in the respective attribute category. The lower the value the higher is the priority, e.g. priority 1 is higher than priority 10. Attributes that have the highest priority might be selected for display in different articles of OCFF. Default Value is 1001. For details please contact the product owners.
* @type {number}
* @memberof ArticleAttributeItem
*/
priority?: number;
/**
*
* @type {string}
* @memberof ArticleAttributeItem
*/
value: string;
/**
* The translations for the key of the attribute. This can be only filled with a descriptive category
* @type {LocaleString}
* @memberof ArticleAttributeItem
*/
valueLocalized?: LocaleString;
}
/**
* @export
* @namespace ArticleAttributeItem
*/
export namespace ArticleAttributeItem {
/**
* @export
* @enum {string}
*/
export enum CategoryEnum {
Descriptive = 'descriptive',
Miscellaneous = 'miscellaneous',
PickingSequence = 'pickingSequence'
}
}
/**
*
* @export
* @interface ArticleAvailability
*/
export interface ArticleAvailability {
/**
*
* @type {string}
* @memberof ArticleAvailability
*/
tenantArticleId: string;
/**
*
* @type {number}
* @memberof ArticleAvailability
*/
availableStock: number;
/**
*
* @type {string}
* @memberof ArticleAvailability
*/
outOfStockBehaviour?: ArticleAvailability.OutOfStockBehaviourEnum;
/**
*
* @type {AvailabilityTimeframe}
* @memberof ArticleAvailability
*/
availabilityTimeframe?: AvailabilityTimeframe;
}
/**
* @export
* @namespace ArticleAvailability
*/
export namespace ArticleAvailability {
/**
* @export
* @enum {string}
*/
export enum OutOfStockBehaviourEnum {
BACKORDER = 'BACKORDER'
}
}
/**
*
* @export
* @interface ArticleItem
*/
export interface ArticleItem {
/**
*
* @type {string}
* @memberof ArticleItem
*/
tenantArticleRef: string;
/**
*
* @type {number}
* @memberof ArticleItem
*/
quantity: number;
}
/**
*
* @export
* @interface ArticlePrice
*/
export interface ArticlePrice {
/**
* Price value for a given currency per unit
* @type {number}
* @memberof ArticlePrice
*/
pricePerUnit: number;
/**
* The currency of the price as an ISO 4217 code.
* @type {CurrencyCode}
* @memberof ArticlePrice
*/
currency: CurrencyCode;
}
/**
*
* @export
* @interface ArticleStockForecast
*/
export interface ArticleStockForecast {
/**
*
* @type {string}
* @memberof ArticleStockForecast
*/
id: string;
/**
*
* @type {string}
* @memberof ArticleStockForecast
*/
tenantArticleId: string;
/**
*
* @type {Date}
* @memberof ArticleStockForecast
*/
created: Date;
/**
*
* @type {Date}
* @memberof ArticleStockForecast
*/
lastModified: Date;
/**
*
* @type {Date}
* @memberof ArticleStockForecast
*/
sourceDate: Date;
/**
*
* @type {Date}
* @memberof ArticleStockForecast
*/
targetDate: Date;
/**
*
* @type {Date}
* @memberof ArticleStockForecast
*/
loadTime: Date;
/**
*
* @type {number}
* @memberof ArticleStockForecast
*/
cumulated: number;
/**
*
* @type {Array}
* @memberof ArticleStockForecast
*/
cumulatedLowerBounds: Array;
/**
*
* @type {Array}
* @memberof ArticleStockForecast
*/
cumulatedUpperBounds: Array;
/**
*
* @type {Array}
* @memberof ArticleStockForecast
*/
lowerBounds: Array;
/**
*
* @type {Array}
* @memberof ArticleStockForecast
*/
upperBounds: Array;
/**
*
* @type {string}
* @memberof ArticleStockForecast
*/
period: ArticleStockForecast.PeriodEnum;
/**
*
* @type {number}
* @memberof ArticleStockForecast
*/
point: number;
}
/**
* @export
* @namespace ArticleStockForecast
*/
export namespace ArticleStockForecast {
/**
* @export
* @enum {string}
*/
export enum PeriodEnum {
DAILY = 'DAILY'
}
}
/**
*
* @export
* @interface ArtifactMetadataItem
*/
export interface ArtifactMetadataItem {
/**
* Date of the build of the artifact
* @type {Date}
* @memberof ArtifactMetadataItem
*/
buildDate: Date;
/**
*
* @type {ArtifactMetadataItemDownload}
* @memberof ArtifactMetadataItem
*/
download: ArtifactMetadataItemDownload;
/**
* Version Code of the artifact
* @type {number}
* @memberof ArtifactMetadataItem
*/
versionCode: number;
/**
* Version Name of the artifact
* @type {string}
* @memberof ArtifactMetadataItem
*/
versionName: string;
}
/**
*
* @export
* @interface ArtifactMetadataItemDownload
*/
export interface ArtifactMetadataItemDownload {
/**
* Expiration date of the download link
* @type {Date}
* @memberof ArtifactMetadataItemDownload
*/
expiration?: Date;
/**
* URL for the download of the artifact
* @type {string}
* @memberof ArtifactMetadataItemDownload
*/
url?: string;
}
/**
*
* @export
* @interface ArtifactMetadataItems
*/
export interface ArtifactMetadataItems {
/**
*
* @type {Array}
* @memberof ArtifactMetadataItems
*/
artifacts: Array;
/**
* Platform name for which the artifact list is generated
* @type {string}
* @memberof ArtifactMetadataItems
*/
platform: string;
}
/**
*
* @export
* @interface AssignFacilityToProcessAction
*/
export interface AssignFacilityToProcessAction extends AbstractModificationAction {
/**
* Use value to manually assign a facility to a process
* @type {string}
* @memberof AssignFacilityToProcessAction
*/
action: AssignFacilityToProcessAction.ActionEnum;
/**
*
* @type {string}
* @memberof AssignFacilityToProcessAction
*/
facilityRef: string;
/**
*
* @type {string}
* @memberof AssignFacilityToProcessAction
*/
rerouteDescriptionId?: string;
}
/**
* @export
* @namespace AssignFacilityToProcessAction
*/
export namespace AssignFacilityToProcessAction {
/**
* @export
* @enum {string}
*/
export enum ActionEnum {
AssignFacilityToProcess = 'AssignFacilityToProcess'
}
}
/**
*
* @export
* @interface AssignedGroup
*/
export interface AssignedGroup {
/**
*
* @type {string}
* @memberof AssignedGroup
*/
group: string;
/**
*
* @type {Array}
* @memberof AssignedGroup
*/
facilityRefs: Array;
}
/**
*
* @export
* @interface AssignmentItem
*/
export interface AssignmentItem {
/**
*
* @type {string}
* @memberof AssignmentItem
*/
tenantArticleId: string;
/**
*
* @type {string}
* @memberof AssignmentItem
*/
articleTitle?: string;
/**
*
* @type {number}
* @memberof AssignmentItem
*/
quantity: number;
}
/**
*
* @export
* @interface AuthenticationProvider
*/
export interface AuthenticationProvider {
/**
*
* @type {AuthenticationProviderType}
* @memberof AuthenticationProvider
*/
type: AuthenticationProviderType;
/**
*
* @type {string}
* @memberof AuthenticationProvider
*/
id?: string;
}
/**
*
* @export
* @enum {string}
*/
export enum AuthenticationProviderType {
EMAILPASSWORD = 'EMAIL_PASSWORD',
OIDC = 'OIDC'
}
/**
*
* @export
* @interface AvailabilityAllocation
*/
export interface AvailabilityAllocation {
/**
*
* @type {string}
* @memberof AvailabilityAllocation
*/
facilityRef: string;
/**
*
* @type {number}
* @memberof AvailabilityAllocation
*/
initialStockQuantity: number;
/**
*
* @type {string}
* @memberof AvailabilityAllocation
*/
groupRef: string;
/**
*
* @type {string}
* @memberof AvailabilityAllocation
*/
channelRef: string;
/**
*
* @type {string}
* @memberof AvailabilityAllocation
*/
id: string;
/**
*
* @type {number}
* @memberof AvailabilityAllocation
*/
version: number;
/**
*
* @type {Date}
* @memberof AvailabilityAllocation
*/
created: Date;
/**
*
* @type {Date}
* @memberof AvailabilityAllocation
*/
lastModified: Date;
}
/**
*
* @export
* @interface AvailabilityAllocationForCreationUnderGroup
*/
export interface AvailabilityAllocationForCreationUnderGroup {
/**
*
* @type {string}
* @memberof AvailabilityAllocationForCreationUnderGroup
*/
facilityRef: string;
/**
*
* @type {number}
* @memberof AvailabilityAllocationForCreationUnderGroup
*/
initialStockQuantity: number;
}
/**
*
* @export
* @interface AvailabilityAllocationForReplacement
*/
export interface AvailabilityAllocationForReplacement {
/**
*
* @type {number}
* @memberof AvailabilityAllocationForReplacement
*/
version: number;
/**
*
* @type {number}
* @memberof AvailabilityAllocationForReplacement
*/
initialStockQuantity: number;
/**
*
* @type {string}
* @memberof AvailabilityAllocationForReplacement
*/
groupId?: string;
}
/**
*
* @export
* @interface AvailabilityAllocationGroup
*/
export interface AvailabilityAllocationGroup {
/**
*
* @type {Array}
* @memberof AvailabilityAllocationGroup
*/
tenantArticleIds: Array;
/**
*
* @type {boolean}
* @memberof AvailabilityAllocationGroup
*/
active: boolean;
/**
*
* @type {AvailabilityAllocationPeriod}
* @memberof AvailabilityAllocationGroup
*/
activePeriod?: AvailabilityAllocationPeriod;
/**
*
* @type {string}
* @memberof AvailabilityAllocationGroup
*/
channelRef: string;
/**
*
* @type {string}
* @memberof AvailabilityAllocationGroup
*/
id: string;
/**
*
* @type {number}
* @memberof AvailabilityAllocationGroup
*/
version: number;
/**
*
* @type {Date}
* @memberof AvailabilityAllocationGroup
*/
created: Date;
/**
*
* @type {Date}
* @memberof AvailabilityAllocationGroup
*/
lastModified: Date;
}
/**
*
* @export
* @interface AvailabilityAllocationGroupForCreationUnderChannel
*/
export interface AvailabilityAllocationGroupForCreationUnderChannel {
/**
*
* @type {Array}
* @memberof AvailabilityAllocationGroupForCreationUnderChannel
*/
tenantArticleIds: Array;
/**
*
* @type {boolean}
* @memberof AvailabilityAllocationGroupForCreationUnderChannel
*/
active: boolean;
/**
*
* @type {AvailabilityAllocationPeriod}
* @memberof AvailabilityAllocationGroupForCreationUnderChannel
*/
activePeriod?: AvailabilityAllocationPeriod;
}
/**
*
* @export
* @interface AvailabilityAllocationGroupForReplacement
*/
export interface AvailabilityAllocationGroupForReplacement {
/**
*
* @type {number}
* @memberof AvailabilityAllocationGroupForReplacement
*/
version: number;
/**
*
* @type {boolean}
* @memberof AvailabilityAllocationGroupForReplacement
*/
active: boolean;
/**
*
* @type {AvailabilityAllocationPeriod}
* @memberof AvailabilityAllocationGroupForReplacement
*/
activePeriod?: AvailabilityAllocationPeriod;
}
/**
*
* @export
* @interface AvailabilityAllocationGroupPaginatedResult
*/
export interface AvailabilityAllocationGroupPaginatedResult {
/**
*
* @type {number}
* @memberof AvailabilityAllocationGroupPaginatedResult
*/
total: number;
/**
*
* @type {Array}
* @memberof AvailabilityAllocationGroupPaginatedResult
*/
groups: Array;
}
/**
*
* @export
* @interface AvailabilityAllocationPaginatedResult
*/
export interface AvailabilityAllocationPaginatedResult {
/**
*
* @type {number}
* @memberof AvailabilityAllocationPaginatedResult
*/
total: number;
/**
*
* @type {Array}
* @memberof AvailabilityAllocationPaginatedResult
*/
allocations: Array;
}
/**
*
* @export
* @interface AvailabilityAllocationPeriod
*/
export interface AvailabilityAllocationPeriod {
/**
*
* @type {Date}
* @memberof AvailabilityAllocationPeriod
*/
start?: Date;
/**
*
* @type {Date}
* @memberof AvailabilityAllocationPeriod
*/
end?: Date;
}
/**
*
* @export
* @interface AvailabilityChannel
*/
export interface AvailabilityChannel {
/**
*
* @type {string}
* @memberof AvailabilityChannel
*/
name: string;
/**
*
* @type {string}
* @memberof AvailabilityChannel
*/
strategy: AvailabilityChannel.StrategyEnum;
/**
*
* @type {number}
* @memberof AvailabilityChannel
*/
version: number;
/**
*
* @type {string}
* @memberof AvailabilityChannel
*/
id: string;
/**
*
* @type {Date}
* @memberof AvailabilityChannel
*/
created: Date;
/**
*
* @type {Date}
* @memberof AvailabilityChannel
*/
lastModified: Date;
}
/**
* @export
* @namespace AvailabilityChannel
*/
export namespace AvailabilityChannel {
/**
* @export
* @enum {string}
*/
export enum StrategyEnum {
REGULAR = 'REGULAR',
IRONRESERVE = 'IRON_RESERVE',
RESTRICT = 'RESTRICT'
}
}
/**
*
* @export
* @interface AvailabilityChannelForCreation
*/
export interface AvailabilityChannelForCreation {
/**
*
* @type {string}
* @memberof AvailabilityChannelForCreation
*/
name: string;
/**
*
* @type {string}
* @memberof AvailabilityChannelForCreation
*/
strategy: AvailabilityChannelForCreation.StrategyEnum;
}
/**
* @export
* @namespace AvailabilityChannelForCreation
*/
export namespace AvailabilityChannelForCreation {
/**
* @export
* @enum {string}
*/
export enum StrategyEnum {
REGULAR = 'REGULAR',
IRONRESERVE = 'IRON_RESERVE',
RESTRICT = 'RESTRICT'
}
}
/**
*
* @export
* @interface AvailabilityChannelForReplacement
*/
export interface AvailabilityChannelForReplacement {
/**
*
* @type {string}
* @memberof AvailabilityChannelForReplacement
*/
name: string;
/**
*
* @type {string}
* @memberof AvailabilityChannelForReplacement
*/
strategy: AvailabilityChannelForReplacement.StrategyEnum;
/**
*
* @type {number}
* @memberof AvailabilityChannelForReplacement
*/
version: number;
}
/**
* @export
* @namespace AvailabilityChannelForReplacement
*/
export namespace AvailabilityChannelForReplacement {
/**
* @export
* @enum {string}
*/
export enum StrategyEnum {
REGULAR = 'REGULAR',
IRONRESERVE = 'IRON_RESERVE',
RESTRICT = 'RESTRICT'
}
}
/**
*
* @export
* @interface AvailabilityChannelPaginatedResult
*/
export interface AvailabilityChannelPaginatedResult {
/**
*
* @type {number}
* @memberof AvailabilityChannelPaginatedResult
*/
total: number;
/**
*
* @type {Array}
* @memberof AvailabilityChannelPaginatedResult
*/
channels: Array;
}
/**
*
* @export
* @interface AvailabilityDuringRerouteStock
*/
export interface AvailabilityDuringRerouteStock {
/**
*
* @type {RerouteReason}
* @memberof AvailabilityDuringRerouteStock
*/
rerouteReason?: RerouteReason;
/**
*
* @type {number}
* @memberof AvailabilityDuringRerouteStock
*/
pickedQuantity?: number;
}
/**
*
* @export
* @interface AvailabilityDuringRouting
*/
export interface AvailabilityDuringRouting {
/**
*
* @type {string}
* @memberof AvailabilityDuringRouting
*/
tenantArticleId: string;
/**
*
* @type {string}
* @memberof AvailabilityDuringRouting
*/
articleTitle?: string;
/**
*
* @type {number}
* @memberof AvailabilityDuringRouting
*/
requestedQuantity: number;
/**
*
* @type {AvailabilityDuringRoutingStock}
* @memberof AvailabilityDuringRouting
*/
stockInformation: AvailabilityDuringRoutingStock;
/**
*
* @type {AvailabilityDuringRerouteStock}
* @memberof AvailabilityDuringRouting
*/
rerouteInformation?: AvailabilityDuringRerouteStock;
/**
*
* @type {AvailabilityDuringRoutingStock}
* @memberof AvailabilityDuringRouting
*/
stockInformationPostRerouteAdjustment?: AvailabilityDuringRoutingStock;
/**
*
* @type {Array}
* @memberof AvailabilityDuringRouting
*/
bundleInformation?: Array;
}
/**
*
* @export
* @interface AvailabilityDuringRoutingStock
*/
export interface AvailabilityDuringRoutingStock {
/**
*
* @type {number}
* @memberof AvailabilityDuringRoutingStock
*/
stock: number;
/**
*
* @type {number}
* @memberof AvailabilityDuringRoutingStock
*/
stockConsideringOfflineStock: number;
/**
*
* @type {number}
* @memberof AvailabilityDuringRoutingStock
*/
reserved: number;
/**
*
* @type {number}
* @memberof AvailabilityDuringRoutingStock
*/
available: number;
}
/**
*
* @export
* @interface AvailabilityTimeframe
*/
export interface AvailabilityTimeframe {
/**
*
* @type {Date}
* @memberof AvailabilityTimeframe
*/
start?: Date;
}
/**
*
* @export
* @interface AvailableItemCondition
*/
export interface AvailableItemCondition {
/**
*
* @type {LocaleString}
* @memberof AvailableItemCondition
*/
conditionLocalized?: LocaleString;
}
/**
*
* @export
* @interface AvailableRefuseReasonForCreation
*/
export interface AvailableRefuseReasonForCreation {
/**
*
* @type {boolean}
* @memberof AvailableRefuseReasonForCreation
*/
active: boolean;
/**
*
* @type {LocaleString}
* @memberof AvailableRefuseReasonForCreation
*/
refusedReasonLocalized: LocaleString;
}
/**
*
* @export
* @interface AvailableRefuseReasonForUpdate
*/
export interface AvailableRefuseReasonForUpdate {
/**
*
* @type {boolean}
* @memberof AvailableRefuseReasonForUpdate
*/
active: boolean;
/**
* The version of the document to be used in optimistic locking mechanisms.
* @type {number}
* @memberof AvailableRefuseReasonForUpdate
*/
version: number;
/**
*
* @type {LocaleString}
* @memberof AvailableRefuseReasonForUpdate
*/
refusedReasonLocalized: LocaleString;
}
/**
*
* @export
* @interface AvailableRefusedReason
*/
export interface AvailableRefusedReason {
/**
*
* @type {boolean}
* @memberof AvailableRefusedReason
*/
active: boolean;
/**
*
* @type {LocaleString}
* @memberof AvailableRefusedReason
*/
refusedReasonLocalized: LocaleString;
/**
* translated refusedReason selected from refusedReasonLocalized
* @type {string}
* @memberof AvailableRefusedReason
*/
refusedReason?: string;
}
/**
*
* @export
* @interface AvailableReturnReason
*/
export interface AvailableReturnReason {
/**
*
* @type {LocaleString}
* @memberof AvailableReturnReason
*/
reasonLocalized: LocaleString;
}
/**
* The base for the calculation of the available until date. If it can't be resolved into a valid date (i.e. missing expiry value), an undefined \"availableUntil\" is the result
* @export
* @enum {string}
*/
export enum AvailableUntilCalculationBase {
EXPIRY = 'EXPIRY',
CREATION = 'CREATION'
}
/**
*
* @export
* @interface AvailableUntilDefinition
*/
export interface AvailableUntilDefinition {
/**
*
* @type {AvailableUntilCalculationBase}
* @memberof AvailableUntilDefinition
*/
calculationBase: AvailableUntilCalculationBase;
/**
* Moves the calculated date by the given period, defined in ISO-8601 duration notation. Use negative values to move the date backwards. Example: \"-P30D\" places the \"availableUntil\" value 30 days before the calculated date.
* @type {string}
* @memberof AvailableUntilDefinition
*/
modifier?: string;
}
/**
* Can this tenant use the backoffice for picking?
* @export
* @interface BackofficePickingConfiguration
*/
export interface BackofficePickingConfiguration {
/**
*
* @type {boolean}
* @memberof BackofficePickingConfiguration
*/
active: boolean;
}
/**
*
* @export
* @interface Backordered
*/
export interface Backordered {
/**
*
* @type {Array}
* @memberof Backordered
*/
lineItems: Array;
}
/**
*
* @export
* @interface BaseDecisionDetail
*/
export interface BaseDecisionDetail {
/**
*
* @type {DecisionType}
* @memberof BaseDecisionDetail
*/
decisionType: DecisionType;
}
/**
*
* @export
* @interface BaseValidation
*/
export interface BaseValidation {
/**
*
* @type {string}
* @memberof BaseValidation
*/
validationType: BaseValidation.ValidationTypeEnum;
}
/**
* @export
* @namespace BaseValidation
*/
export namespace BaseValidation {
/**
* @export
* @enum {string}
*/
export enum ValidationTypeEnum {
STRING = 'STRING',
FLOAT = 'FLOAT',
INTEGER = 'INTEGER'
}
}
/**
*
* @export
* @interface BasicDeliveryPromiseShipment
*/
export interface BasicDeliveryPromiseShipment {
/**
*
* @type {Array}
* @memberof BasicDeliveryPromiseShipment
*/
lineItems: Array;
/**
*
* @type {BasicDeliveryPromiseShipmentFacility}
* @memberof BasicDeliveryPromiseShipment
*/
facility: BasicDeliveryPromiseShipmentFacility;
}
/**
*
* @export
* @interface BasicDeliveryPromiseShipmentFacility
*/
export interface BasicDeliveryPromiseShipmentFacility {
/**
*
* @type {string}
* @memberof BasicDeliveryPromiseShipmentFacility
*/
facilityRef: string;
/**
*
* @type {string}
* @memberof BasicDeliveryPromiseShipmentFacility
*/
facilityName: string;
}
/**
*
* @export
* @interface BasketItem
*/
export interface BasketItem {
/**
*
* @type {string}
* @memberof BasketItem
*/
tenantArticleId: string;
/**
*
* @type {number}
* @memberof BasketItem
*/
quantity: number;
}
/**
*
* @export
* @interface Brand
*/
export interface Brand extends VersionedResource {
/**
* The name of the brand for this listing
* @type {string}
* @memberof Brand
*/
name: string;
/**
*
* @type {string}
* @memberof Brand
*/
id: string;
}
/**
*
* @export
* @interface BrandForCreation
*/
export interface BrandForCreation {
/**
* The name of the brand for this listing
* @type {string}
* @memberof BrandForCreation
*/
name: string;
}
/**
*
* @export
* @interface Branding
*/
export interface Branding {
/**
* The logo URL for the tenant
* @type {string}
* @memberof Branding
*/
logoUrl: string;
/**
* The hexcode representation of the desired primary color.
* @type {string}
* @memberof Branding
*/
primaryColor: string;
}
/**
*
* @export
* @interface BringCarrierConfiguration
*/
export interface BringCarrierConfiguration extends CarrierConfiguration {
/**
* Bring Carrier customer number.
* @type {string}
* @memberof BringCarrierConfiguration
*/
customerId: string;
/**
* Bring Carrier support phone number.
* @type {string}
* @memberof BringCarrierConfiguration
*/
supportPhoneNumber: string;
/**
* Product that will be used for the shipment booking
* @type {string}
* @memberof BringCarrierConfiguration
*/
shipmentProduct?: string;
/**
* Product that will be used for return
* @type {string}
* @memberof BringCarrierConfiguration
*/
returnProduct?: string;
/**
*
* @type {string}
* @memberof BringCarrierConfiguration
*/
trackAndTraceUrl?: string;
/**
*
* @type {string}
* @memberof BringCarrierConfiguration
*/
webhookFftHost?: string;
}
/**
*
* @export
* @interface BringCarrierCredentials
*/
export interface BringCarrierCredentials extends AbstractCarrierCredentials {
/**
* Internal API Uid to communicate with the CEP Api
* @type {string}
* @memberof BringCarrierCredentials
*/
apiUid: string;
/**
* Internal API Key to communicate with the CEP Api
* @type {string}
* @memberof BringCarrierCredentials
*/
apiKey: string;
/**
* Url of the requesting client, can be a static value
* @type {string}
* @memberof BringCarrierCredentials
*/
clientUrl: string;
/**
* Identifier for Track&Trace Webhook
* @type {string}
* @memberof BringCarrierCredentials
*/
authToken?: string;
}
/**
*
* @export
* @interface BringFacilityCarrierConfiguration
*/
export interface BringFacilityCarrierConfiguration extends AbstractFacilityCarrierConfiguration {
/**
*
* @type {string}
* @memberof BringFacilityCarrierConfiguration
*/
trackAndTraceUrl?: string;
/**
*
* @type {string}
* @memberof BringFacilityCarrierConfiguration
*/
webhookFftHost?: string;
}
/**
*
* @export
* @interface BulkOperationError
*/
export interface BulkOperationError {
/**
*
* @type {string}
* @memberof BulkOperationError
*/
type: BulkOperationError.TypeEnum;
/**
*
* @type {string}
* @memberof BulkOperationError
*/
message: string;
}
/**
* @export
* @namespace BulkOperationError
*/
export namespace BulkOperationError {
/**
* @export
* @enum {string}
*/
export enum TypeEnum {
VALIDATION = 'VALIDATION',
UNKNOWN = 'UNKNOWN'
}
}
/**
*
* @export
* @enum {string}
*/
export enum BulkOperationResultStatus {
UPDATED = 'UPDATED',
CREATED = 'CREATED',
FAILED = 'FAILED'
}
/**
*
* @export
* @interface BundleInformation
*/
export interface BundleInformation {
/**
*
* @type {string}
* @memberof BundleInformation
*/
customServiceNodeId: string;
/**
*
* @type {number}
* @memberof BundleInformation
*/
requestedQuantity: number;
}
/**
*
* @export
* @interface ByTrait
*/
export interface ByTrait {
/**
*
* @type {number}
* @memberof ByTrait
*/
PICKABLE: number;
/**
*
* @type {number}
* @memberof ByTrait
*/
ACCESSIBLE: number;
}
/**
*
* @export
* @interface CallbackHeader
*/
export interface CallbackHeader {
/**
* This is the key of the header. e.g.: `Authorization`
* @type {string}
* @memberof CallbackHeader
*/
key: string;
/**
* This is the value for the header. e.g.: `Basic dXNlcm5hbWU6cGFzc3dvcmQ=`
* @type {string}
* @memberof CallbackHeader
*/
value: string;
}
/**
*
This endpoint is deprecated and has been replaced.
@deprecated Use api/handoverjobs/:id/actions instead
* @export
* @interface CancelHandoverjobAction
*/
export interface CancelHandoverjobAction extends AbstractModificationAction {
/**
* Use value 'CancelHandoverjob', because you want to cancel a handover job
* @type {string}
* @memberof CancelHandoverjobAction
*/
action: CancelHandoverjobAction.ActionEnum;
/**
*
* @type {HandoverJobCancelReason}
* @memberof CancelHandoverjobAction
*/
handoverJobCancelReason: HandoverJobCancelReason;
}
/**
* @export
* @namespace CancelHandoverjobAction
*/
export namespace CancelHandoverjobAction {
/**
* @export
* @enum {string}
*/
export enum ActionEnum {
CancelHandoverjob = 'CancelHandoverjob'
}
}
/**
*
This endpoint is deprecated and has been replaced.
@deprecated Use api/pickruns/:id/actions instead
* @export
* @interface CancelPickRunAction
*/
export interface CancelPickRunAction extends AbstractModificationAction {
/**
* Use value 'CancelPickRun', because you want to cancel a pickrun
* @type {string}
* @memberof CancelPickRunAction
*/
action: CancelPickRunAction.ActionEnum;
}
/**
* @export
* @namespace CancelPickRunAction
*/
export namespace CancelPickRunAction {
/**
* @export
* @enum {string}
*/
export enum ActionEnum {
CancelPickRun = 'CancelPickRun'
}
}
/**
*
* @export
* @interface CancelationReason
*/
export interface CancelationReason extends AbstractReason {
/**
*
* @type {string}
* @memberof CancelationReason
*/
action: CancelationReason.ActionEnum;
}
/**
* @export
* @namespace CancelationReason
*/
export namespace CancelationReason {
/**
* @export
* @enum {string}
*/
export enum ActionEnum {
CANCELATION = 'CANCELATION'
}
}
/**
*
* @export
* @interface CancelationReasonForCreation
*/
export interface CancelationReasonForCreation extends AbstractReasonForCreation {
}
/**
*
* @export
* @interface CancelationReasonForModification
*/
export interface CancelationReasonForModification extends AbstractReasonForModification {
}
/**
*
* @export
* @interface CancelationReasons
*/
export interface CancelationReasons extends AbstractReasons {
/**
*
* @type {Array}
* @memberof CancelationReasons
*/
reasons: Array;
}
/**
*
* @export
* @enum {string}
*/
export enum CapabilityStatus {
Enabled = 'enabled',
Inactive = 'inactive',
Disabled = 'disabled'
}
/**
*
* @export
* @interface CapacityPlanningTimeframeConfiguration
*/
export interface CapacityPlanningTimeframeConfiguration extends VersionedResource {
/**
* The range in days per facility which defines how many days in the future the capacity of the facility can be planned
* @type {number}
* @memberof CapacityPlanningTimeframeConfiguration
*/
days: number;
/**
*
* @type {string}
* @memberof CapacityPlanningTimeframeConfiguration
*/
id?: string;
}
/**
*
* @export
* @interface Carrier
*/
export interface Carrier extends CarrierForCreation {
/**
* The date this entity was created at the platform. This value is generated by the service.
* @type {Date}
* @memberof Carrier
*/
created?: Date;
/**
* The date this entity was modified last. This value is generated by the service.
* @type {Date}
* @memberof Carrier
*/
lastModified?: Date;
/**
* The version of the document to be used in optimistic locking mechanisms.
* @type {number}
* @memberof Carrier
*/
version: number;
/**
* The id of the carrier
* @type {string}
* @memberof Carrier
*/
id: string;
/**
*
* @type {CarrierDeliveryType}
* @memberof Carrier
*/
deliveryType?: CarrierDeliveryType;
/**
*
* @type {CarrierLifecycle}
* @memberof Carrier
*/
lifecycle?: CarrierLifecycle;
/**
*
* @type {Array}
* @memberof Carrier
*/
parcelLabelClassifications?: Array;
}
/**
*
* @export
* @interface CarrierConfiguration
*/
export interface CarrierConfiguration extends VersionedResource {
/**
*
* @type {string}
* @memberof CarrierConfiguration
*/
id?: string;
/**
*
* @type {string}
* @memberof CarrierConfiguration
*/
carrierRef: string;
/**
* When enabled, a return label will be created by creating a shipping label
* @type {boolean}
* @memberof CarrierConfiguration
*/
returnLabel: boolean;
/**
* It is an amount of percentage for packaging weight which will be added to the calculated shipping weight
* @type {number}
* @memberof CarrierConfiguration
*/
additionalWeightInPercent?: number;
/**
* Indicates if the content of a parcel must be weighed before ordering a label
* @type {boolean}
* @memberof CarrierConfiguration
*/
mustBeWeighed?: boolean;
/**
* EmailAddress used to receive track and trace information when no other emailaddress was provided
* @type {string}
* @memberof CarrierConfiguration
*/
fallBackTrackAndTraceEmail?: string;
/**
*
* @type {Array}
* @memberof CarrierConfiguration
*/
nonDeliveryDaysPerCountryAndProvince?: Array;
/**
*
* @type {Array}
* @memberof CarrierConfiguration
*/
countryServiceMappings?: Array;
/**
*
* @type {string}
* @memberof CarrierConfiguration
*/
serviceUrl?: string;
}
/**
*
* @export
* @interface CarrierCountryServiceMapping
*/
export interface CarrierCountryServiceMapping {
/**
* unique identifier for a countryServiceMapping
* @type {string}
* @memberof CarrierCountryServiceMapping
*/
id: string;
/**
*
* @type {RegionInformation}
* @memberof CarrierCountryServiceMapping
*/
source: RegionInformation;
/**
* The destination regions this mapping should be applied to.
* @type {Array}
* @memberof CarrierCountryServiceMapping
*/
destinations: Array;
/**
*
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.
* @type {Array}
* @memberof CarrierCountryServiceMapping
*/
destinationCountries?: Array;
/**
*
* @type {Array}
* @memberof CarrierCountryServiceMapping
*/
mandatoryShippingAttributes?: Array;
/**
*
* @type {Array}
* @memberof CarrierCountryServiceMapping
*/
mandatoryShippingItemAttributes?: Array;
/**
*
* @type {string}
* @memberof CarrierCountryServiceMapping
*/
product?: string;
/**
*
* @type {CarrierProductCategory}
* @memberof CarrierCountryServiceMapping
*/
carrierProductCategory?: CarrierProductCategory;
/**
*
* @type {CarrierTransitTime}
* @memberof CarrierCountryServiceMapping
*/
transitTime?: CarrierTransitTime;
/**
*
* @type {Array}
* @memberof CarrierCountryServiceMapping
*/
deliveryCosts?: Array;
}
/**
*
* @export
* @interface CarrierCountryServiceMappingForCreation
*/
export interface CarrierCountryServiceMappingForCreation {
/**
* The version of the carrier configuration to be used in optimistic locking mechanisms.
* @type {number}
* @memberof CarrierCountryServiceMappingForCreation
*/
carrierConfigurationVersion: number;
/**
*
* @type {RegionInformation}
* @memberof CarrierCountryServiceMappingForCreation
*/
source: RegionInformation;
/**
* The destination regions this mapping should be applied to.
* @type {Array}
* @memberof CarrierCountryServiceMappingForCreation
*/
destinations: Array;
/**
*
This endpoint is deprecated and has been replaced.
@deprecated Use source instead.
* @type {string}
* @memberof CarrierCountryServiceMappingForCreation
*/
sourceCountry?: string;
/**
*
This endpoint is deprecated and has been replaced.
@deprecated Use destination instead.
* @type {Array}
* @memberof CarrierCountryServiceMappingForCreation
*/
destinationCountries?: Array;
/**
*
* @type {Array}
* @memberof CarrierCountryServiceMappingForCreation
*/
mandatoryShippingAttributes?: Array;
/**
*
* @type {Array}
* @memberof CarrierCountryServiceMappingForCreation
*/
mandatoryShippingItemAttributes?: Array;
/**
*
* @type {string}
* @memberof CarrierCountryServiceMappingForCreation
*/
product?: string;
/**
*
* @type {CarrierProductCategory}
* @memberof CarrierCountryServiceMappingForCreation
*/
carrierProductCategory?: CarrierProductCategory;
/**
*
* @type {CarrierTransitTime}
* @memberof CarrierCountryServiceMappingForCreation
*/
transitTime?: CarrierTransitTime;
/**
*
* @type {Array}
* @memberof CarrierCountryServiceMappingForCreation
*/
deliveryCosts?: Array;
}
/**
*
* @export
* @interface CarrierCountryServiceMappingForUpdate
*/
export interface CarrierCountryServiceMappingForUpdate {
/**
* The version of the document to be used in optimistic locking mechanisms.
* @type {number}
* @memberof CarrierCountryServiceMappingForUpdate
*/
carrierConfigurationVersion: number;
/**
*
* @type {RegionInformation}
* @memberof CarrierCountryServiceMappingForUpdate
*/
source?: RegionInformation;
/**
* The destination regions this mapping should be applied to.
* @type {Array}
* @memberof CarrierCountryServiceMappingForUpdate
*/
destinations?: Array;
/**
*
This endpoint is deprecated and has been replaced.
@deprecated Use source instead.
* @type {string}
* @memberof CarrierCountryServiceMappingForUpdate
*/
sourceCountry?: string;
/**
*
This endpoint is deprecated and has been replaced.
@deprecated Use destination instead.
* @type {Array}
* @memberof CarrierCountryServiceMappingForUpdate
*/
destinationCountries?: Array;
/**
*
* @type {Array}
* @memberof CarrierCountryServiceMappingForUpdate
*/
mandatoryShippingAttributes?: Array;
/**
*
* @type {Array}
* @memberof CarrierCountryServiceMappingForUpdate
*/
mandatoryShippingItemAttributes?: Array;
/**
*
* @type {string}
* @memberof CarrierCountryServiceMappingForUpdate
*/
product?: string;
/**
*
* @type {CarrierProductCategory}
* @memberof CarrierCountryServiceMappingForUpdate
*/
carrierProductCategory?: CarrierProductCategory;
/**
*
* @type {CarrierTransitTime}
* @memberof CarrierCountryServiceMappingForUpdate
*/
transitTime?: CarrierTransitTime;
/**
*
* @type {Array}
* @memberof CarrierCountryServiceMappingForUpdate
*/
deliveryCosts?: Array;
}
/**
*
* @export
* @interface CarrierCutoffConfiguration
*/
export interface CarrierCutoffConfiguration {
/**
*
* @type {string}
* @memberof CarrierCutoffConfiguration
*/
time: string;
/**
*
* @type {number}
* @memberof CarrierCutoffConfiguration
*/
capacity?: number;
}
/**
*
* @export
* @interface CarrierCutoffTimes
*/
export interface CarrierCutoffTimes {
/**
*
* @type {Array}
* @memberof CarrierCutoffTimes
*/
weekdays: Array;
/**
*
* @type {Array}
* @memberof CarrierCutoffTimes
*/
overwrites: Array;
}
/**
*
* @export
* @interface CarrierCutoffTimesOverwrite
*/
export interface CarrierCutoffTimesOverwrite {
/**
*
* @type {string}
* @memberof CarrierCutoffTimesOverwrite
*/
date: string;
/**
*
* @type {Array}
* @memberof CarrierCutoffTimesOverwrite
*/
cutoffConfigurations: Array;
}
/**
*
* @export
* @interface CarrierCutoffTimesWeekDay
*/
export interface CarrierCutoffTimesWeekDay {
/**
*
* @type {WeekDay}
* @memberof CarrierCutoffTimesWeekDay
*/
day: WeekDay;
/**
*
* @type {Array}
* @memberof CarrierCutoffTimesWeekDay
*/
cutoffConfigurations: Array;
}
/**
* Provided delivery of this CEP. Default: DELIVERY
* @export
* @enum {string}
*/
export enum CarrierDeliveryType {
SAMEDAY = 'SAMEDAY',
DELIVERY = 'DELIVERY'
}
/**
*
* @export
* @interface CarrierForCreation
*/
export interface CarrierForCreation {
/**
*
* @type {AbstractCarrierCredentials}
* @memberof CarrierForCreation
*/
credentials?: AbstractCarrierCredentials;
/**
* References the KEP. Currently allowed values are DHL_V2, DPD_CH, ANGEL, GLS, FEDEX, POSTNL, BRING, UPS, POST_NORD, DHL_EXPRESS, CUSTOM and to distinct between multiple custom carriers one can use CUSTOM_ combined with a unique name.
* @type {string}
* @memberof CarrierForCreation
*/
key: string;
/**
*
* @type {string}
* @memberof CarrierForCreation
*/
logoUrl?: string;
/**
* This is the well known name for a supported CEP partner. Can be adapted to the clients needs.
* @type {string}
* @memberof CarrierForCreation
*/
name: string;
/**
*
* @type {CarrierStatus}
* @memberof CarrierForCreation
*/
status?: CarrierStatus;
/**
* Default weight for a parcel in gram
* @type {number}
* @memberof CarrierForCreation
*/
defaultParcelWeightInGram?: number;
/**
*
* @type {Array}
* @memberof CarrierForCreation
*/
parcelLabelClassifications?: Array;
/**
* Setting to enable the Client to ask for the parcel product value while ordering a label. This information is mandatory for sending parcels between different countries (customs declaration)
* @type {boolean}
* @memberof CarrierForCreation
*/
productValueNeeded?: boolean;
}
/**
*
* @export
* @interface CarrierIdConfigurationBody
*/
export interface CarrierIdConfigurationBody {
}
/**
* Used to determine if a carrier is available for configuration. GA carriers are generally available and are covered by our SLA. BETA carriers are available, but subject to change and not covered by SLA. ALPHA carriers are not implemented completely, yet. Default: GA
* @export
* @enum {string}
*/
export enum CarrierLifecycle {
GA = 'GA',
BETA = 'BETA',
ALPHA = 'ALPHA'
}
/**
*
* @export
* @interface CarrierPatchActions
*/
export interface CarrierPatchActions {
/**
*
* @type {Array}
* @memberof CarrierPatchActions
*/
actions: Array;
/**
* The version of the document to be used in optimistic locking mechanisms.
* @type {number}
* @memberof CarrierPatchActions
*/
version: number;
}
/**
*
* @export
* @enum {string}
*/
export enum CarrierProductCategory {
STANDARD = 'STANDARD',
EXPRESS = 'EXPRESS',
VALUE = 'VALUE',
FORWARDING = 'FORWARDING'
}
/**
* Services which should be booked from carrier
* @export
* @enum {string}
*/
export enum CarrierServices {
SIGNATURE = 'SIGNATURE'
}
/**
* It is taken into consideration for all carriers. Default: INACTIVE
* @export
* @enum {string}
*/
export enum CarrierStatus {
ACTIVE = 'ACTIVE',
INACTIVE = 'INACTIVE'
}
/**
*
* @export
* @interface CarrierTransitTime
*/
export interface CarrierTransitTime {
/**
* Minimum days a carrier needs for transit
* @type {number}
* @memberof CarrierTransitTime
*/
minTransitDays: number;
/**
* Maximum days a carrier needs for transit
* @type {number}
* @memberof CarrierTransitTime
*/
maxTransitDays: number;
}
/**
*
* @export
* @interface ChannelStockAvailability
*/
export interface ChannelStockAvailability {
/**
*
* @type {string}
* @memberof ChannelStockAvailability
*/
channelRef: string;
/**
*
* @type {number}
* @memberof ChannelStockAvailability
*/
availableForPicking: number;
/**
*
* @type {number}
* @memberof ChannelStockAvailability
*/
availableOnStock: number;
}
/**
*
* @export
* @interface CheckoutOptionsAvailability
*/
export interface CheckoutOptionsAvailability {
/**
*
* @type {string}
* @memberof CheckoutOptionsAvailability
*/
tenantArticleId: string;
/**
*
* @type {number}
* @memberof CheckoutOptionsAvailability
*/
available: number;
/**
*
* @type {Date}
* @memberof CheckoutOptionsAvailability
*/
preOrderReleaseDate?: Date;
/**
*
* @type {boolean}
* @memberof CheckoutOptionsAvailability
*/
isBackOrderable: boolean;
}
/**
*
* @export
* @interface CheckoutOptionsConsumerAddress
*/
export interface CheckoutOptionsConsumerAddress {
/**
*
* @type {string}
* @memberof CheckoutOptionsConsumerAddress
*/
city?: string;
/**
* A two-digit country code as per ISO 3166-1 alpha-2
* @type {string}
* @memberof CheckoutOptionsConsumerAddress
*/
country: string;
/**
*
* @type {string}
* @memberof CheckoutOptionsConsumerAddress
*/
province?: string;
/**
*
* @type {string}
* @memberof CheckoutOptionsConsumerAddress
*/
houseNumber?: string;
/**
*
* @type {string}
* @memberof CheckoutOptionsConsumerAddress
*/
postalCode?: string;
/**
*
* @type {string}
* @memberof CheckoutOptionsConsumerAddress
*/
street?: string;
}
/**
*
* @export
* @interface CheckoutOptionsCustomServices
*/
export interface CheckoutOptionsCustomServices {
/**
*
* @type {string}
* @memberof CheckoutOptionsCustomServices
*/
customServiceRef: string;
/**
*
* @type {string}
* @memberof CheckoutOptionsCustomServices
*/
name: string;
}
/**
*
* @export
* @interface CheckoutOptionsDeliveryEarliestRequest
*/
export interface CheckoutOptionsDeliveryEarliestRequest {
/**
* The date from which to search for the earliest potential delivery date. Defaults to \"now\" (timestamp of the request)
* @type {Date}
* @memberof CheckoutOptionsDeliveryEarliestRequest
*/
earliestDeliveryDate?: Date;
/**
*
* @type {Array}
* @memberof CheckoutOptionsDeliveryEarliestRequest
*/
tenantArticleIds: Array;
/**
*
* @type {CheckoutOptionsConsumerAddress}
* @memberof CheckoutOptionsDeliveryEarliestRequest
*/
consumerAddress?: CheckoutOptionsConsumerAddress;
}
/**
*
* @export
* @interface CheckoutOptionsDeliveryEarliestResponse
*/
export interface CheckoutOptionsDeliveryEarliestResponse {
/**
* The results of the corresponding request containing information, if present, on when the items can supposingly be delivered earliest. Please note: When it was not possible to calculate the delivery information for a requested tenantArticleId there is no entry here.
* @type {Array}
* @memberof CheckoutOptionsDeliveryEarliestResponse
*/
checkoutOptions: Array;
}
/**
*
* @export
* @interface CheckoutOptionsDeliveryEarliestResponseItem
*/
export interface CheckoutOptionsDeliveryEarliestResponseItem {
/**
*
* @type {string}
* @memberof CheckoutOptionsDeliveryEarliestResponseItem
*/
tenantArticleId: string;
/**
*
* @type {Date}
* @memberof CheckoutOptionsDeliveryEarliestResponseItem
*/
earliestPredictedDeliveryDate?: Date;
/**
* List of available carriers.
* @type {Array}
* @memberof CheckoutOptionsDeliveryEarliestResponseItem
*/
availableCarriers?: Array;
}
/**
*
* @export
* @interface CheckoutOptionsDeliveryEarliestResponseItemAvailableCarrier
*/
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;
/**
*
* @type {string}
* @memberof CheckoutOptionsDeliveryPreferencesPreferredCarriersWithProduct
*/
carrierProduct?: string;
/**
*
* @type {Array}
* @memberof CheckoutOptionsDeliveryPreferencesPreferredCarriersWithProduct
*/
carrierServices?: Array;
/**
*
* @type {string}
* @memberof CheckoutOptionsDeliveryPreferencesPreferredCarriersWithProduct
*/
carrierProductCategory?: string;
}
/**
*
* @export
* @interface CheckoutOptionsDeliveryTimePeriodRequest
*/
export interface CheckoutOptionsDeliveryTimePeriodRequest {
/**
* The start of the evaluated time period. Defaults to \"now\" (timestamp of the request)
* @type {Date}
* @memberof CheckoutOptionsDeliveryTimePeriodRequest
*/
startDate?: Date;
/**
* The end of the evaluated time period. Default is the start date + 60 days. Please note that the maximum time period can not exceed 60 days.
* @type {Date}
* @memberof CheckoutOptionsDeliveryTimePeriodRequest
*/
endDate?: Date;
/**
* Items, that are considered to be delivered together.
* @type {Array}
* @memberof CheckoutOptionsDeliveryTimePeriodRequest
*/
basket: Array;
/**
*
* @type {CheckoutOptionsConsumerAddress}
* @memberof CheckoutOptionsDeliveryTimePeriodRequest
*/
consumerAddress?: CheckoutOptionsConsumerAddress;
/**
*
* @type {CheckoutOptionsDeliveryPreferences}
* @memberof CheckoutOptionsDeliveryTimePeriodRequest
*/
deliveryPreferences?: CheckoutOptionsDeliveryPreferences;
}
/**
*
* @export
* @interface CheckoutOptionsDeliveryTimePeriodResponse
*/
export interface CheckoutOptionsDeliveryTimePeriodResponse {
/**
*
* @type {Array}
* @memberof CheckoutOptionsDeliveryTimePeriodResponse
*/
checkoutOptions: Array;
}
/**
*
* @export
* @interface CheckoutOptionsDeliveryTimePeriodResponseItem
*/
export interface CheckoutOptionsDeliveryTimePeriodResponseItem {
/**
*
* @type {string}
* @memberof CheckoutOptionsDeliveryTimePeriodResponseItem
*/
overallStatus: CheckoutOptionsDeliveryTimePeriodResponseItem.OverallStatusEnum;
/**
*
* @type {Date}
* @memberof CheckoutOptionsDeliveryTimePeriodResponseItem
*/
date: Date;
/**
*
* @type {Array}
* @memberof CheckoutOptionsDeliveryTimePeriodResponseItem
*/
availableCarriers?: Array;
}
/**
* @export
* @namespace CheckoutOptionsDeliveryTimePeriodResponseItem
*/
export namespace CheckoutOptionsDeliveryTimePeriodResponseItem {
/**
* @export
* @enum {string}
*/
export enum OverallStatusEnum {
ALL = 'ALL',
PARTIAL = 'PARTIAL',
NONE = 'NONE'
}
}
/**
*
* @export
* @interface CheckoutOptionsDeliveryTimePointRequest
*/
export interface CheckoutOptionsDeliveryTimePointRequest {
/**
* The desired delivery date. (timestamp of the request)
* @type {Date}
* @memberof CheckoutOptionsDeliveryTimePointRequest
*/
desiredDeliveryDate: Date;
/**
*
* @type {Array}
* @memberof CheckoutOptionsDeliveryTimePointRequest
*/
tenantArticleIds: Array;
/**
* Pair of facilityRef and latestPickingStart values
* @type {Array}
* @memberof CheckoutOptionsDeliveryTimePointRequest
*/
facilities: Array;
}
/**
*
* @export
* @interface CheckoutOptionsDeliveryTimePointResponse
*/
export interface CheckoutOptionsDeliveryTimePointResponse {
/**
*
* @type {Array}
* @memberof CheckoutOptionsDeliveryTimePointResponse
*/
items: Array;
}
/**
*
* @export
* @interface CheckoutOptionsDeliveryTimePointResponseItem
*/
export interface CheckoutOptionsDeliveryTimePointResponseItem {
/**
*
* @type {string}
* @memberof CheckoutOptionsDeliveryTimePointResponseItem
*/
tenantArticleId: string;
/**
*
* @type {number}
* @memberof CheckoutOptionsDeliveryTimePointResponseItem
*/
available: number;
/**
*
* @type {string}
* @memberof CheckoutOptionsDeliveryTimePointResponseItem
*/
facilityRef: string;
}
/**
*
* @export
* @interface CheckoutOptionsFacilityForCNC
*/
export interface CheckoutOptionsFacilityForCNC {
/**
*
* @type {string}
* @memberof CheckoutOptionsFacilityForCNC
*/
facilityRef: string;
/**
*
* @type {string}
* @memberof CheckoutOptionsFacilityForCNC
*/
name: string;
/**
*
* @type {FacilityAddress}
* @memberof CheckoutOptionsFacilityForCNC
*/
address: FacilityAddress;
/**
*
* @type {Array}
* @memberof CheckoutOptionsFacilityForCNC
*/
closingDays: Array;
/**
*
* @type {PickingTimes}
* @memberof CheckoutOptionsFacilityForCNC
*/
pickingTimes: PickingTimes;
/**
*
* @type {Array}
* @memberof CheckoutOptionsFacilityForCNC
*/
availabilities: Array;
/**
*
* @type {Array}
* @memberof CheckoutOptionsFacilityForCNC
*/
customServices: Array;
/**
*
* @type {Date}
* @memberof CheckoutOptionsFacilityForCNC
*/
targetTime: Date;
}
/**
*
* @export
* @interface CheckoutOptionsFacilityForSFS
*/
export interface CheckoutOptionsFacilityForSFS {
/**
*
* @type {string}
* @memberof CheckoutOptionsFacilityForSFS
*/
facilityRef: string;
/**
*
* @type {string}
* @memberof CheckoutOptionsFacilityForSFS
*/
name: string;
/**
*
* @type {Array}
* @memberof CheckoutOptionsFacilityForSFS
*/
availabilities: Array;
/**
*
* @type {Array}
* @memberof CheckoutOptionsFacilityForSFS
*/
deliveryOptions: Array;
/**
*
* @type {Array}
* @memberof CheckoutOptionsFacilityForSFS
*/
customServices: Array;
}
/**
*
* @export
* @interface CheckoutOptionsInput
*/
export interface CheckoutOptionsInput {
/**
*
* @type {CheckoutOptionsConsumerAddress}
* @memberof CheckoutOptionsInput
*/
consumerAddress?: CheckoutOptionsConsumerAddress;
/**
*
* @type {DeliveryPreferences}
* @memberof CheckoutOptionsInput
*/
deliveryPreferences: DeliveryPreferences;
/**
*
* @type {Array}
* @memberof CheckoutOptionsInput
*/
orderLineItems: Array;
/**
*
* @type {Array}
* @memberof CheckoutOptionsInput
*/
tags?: Array;
/**
*
* @type {Array}
* @memberof CheckoutOptionsInput
*/
customServices?: Array;
/**
*
* @type {GeoFence}
* @memberof CheckoutOptionsInput
*/
geoFence?: GeoFence;
/**
*
* @type {boolean}
* @memberof CheckoutOptionsInput
*/
filterDuplicates?: boolean;
}
/**
*
* @export
* @interface ClickAndCollectRerouteConfiguration
*/
export interface ClickAndCollectRerouteConfiguration {
/**
*
* @type {boolean}
* @memberof ClickAndCollectRerouteConfiguration
*/
active: boolean;
/**
*
* @type {RerouteType}
* @memberof ClickAndCollectRerouteConfiguration
*/
rerouteType?: RerouteType;
}
/**
* At this day the facility is closed and does not do picking
* @export
* @interface ClosingDay
*/
export interface ClosingDay {
/**
* The day at which the Facility is closed
* @type {Date}
* @memberof ClosingDay
*/
date: Date;
/**
* The reason why the Facility is closed on this day
* @type {string}
* @memberof ClosingDay
*/
reason: string;
/**
*
* @type {string}
* @memberof ClosingDay
*/
recurrence: ClosingDay.RecurrenceEnum;
}
/**
* @export
* @namespace ClosingDay
*/
export namespace ClosingDay {
/**
* @export
* @enum {string}
*/
export enum RecurrenceEnum {
YEARLY = 'YEARLY',
NONRECURRING = 'NONRECURRING'
}
}
/**
*
* @export
* @interface CollectDelivery
*/
export interface CollectDelivery {
/**
* Reference to the facility where the consumer expects to collect the items
* @type {string}
* @memberof CollectDelivery
*/
facilityRef: string;
/**
* Indicates if the order is already paid.
* @type {boolean}
* @memberof CollectDelivery
*/
paid?: boolean;
/**
* DEPRECATED
* @type {Array}
* @memberof CollectDelivery
*/
supplyingFacilities?: Array;
/**
* References of facility that could supply contents of the order to another facility with specific configuration of its usage
* @type {Array}
* @memberof CollectDelivery
*/
supplyingFacilitiesConfigurations?: Array;
/**
* The point in time by which the order is supposed to be provisioned.
* @type {Date}
* @memberof CollectDelivery
*/
provisioningTime?: Date;
}
/**
*
* @export
* @interface CompanyAddress
*/
export interface CompanyAddress {
/**
*
* @type {string}
* @memberof CompanyAddress
*/
city: string;
/**
*
* @type {string}
* @memberof CompanyAddress
*/
country: string;
/**
*
* @type {string}
* @memberof CompanyAddress
*/
houseNumber?: string;
/**
*
* @type {string}
* @memberof CompanyAddress
*/
name: string;
/**
*
* @type {string}
* @memberof CompanyAddress
*/
postalCode: string;
/**
*
* @type {string}
* @memberof CompanyAddress
*/
street: string;
}
/**
*
* @export
* @interface ConfigurationsNotificationsBody
*/
export interface ConfigurationsNotificationsBody {
}
/**
*
* @export
* @interface ConfigurationsNotificationsBody1
*/
export interface ConfigurationsNotificationsBody1 {
}
/**
* The type of possible Apps
* @export
* @enum {string}
*/
export enum ConnectAppTypeEnum {
PICKING = 'PICKING',
INVENTORY = 'INVENTORY',
OPERATIONSANDROID = 'OPERATIONS_ANDROID',
OPERATIONSIOS = 'OPERATIONS_IOS'
}
/**
* This status consolidates many of the RoutingPlanStatus and offers a more detailes explanation of what happened to the routing plan.
* @export
* @enum {string}
*/
export enum ConsolidatedRoutingPlanStatus {
ROUTED = 'ROUTED',
ROUTEDTHENREROUTED = 'ROUTED_THEN_REROUTED',
PROCESSMANUALREROUTEDTHENROUTED = 'PROCESS_MANUAL_REROUTED_THEN_ROUTED',
PROCESSMANUALREROUTEDTHENNOTROUTABLE = 'PROCESS_MANUAL_REROUTED_THEN_NOT_ROUTABLE',
PROCESSMANUALREROUTEDTHENREROUTEDANDSPLIT = 'PROCESS_MANUAL_REROUTED_THEN_REROUTED_AND_SPLIT',
ROUTINGPLANREROUTEDTHENROUTEDTOSAMEFACILITY = 'ROUTING_PLAN_REROUTED_THEN_ROUTED_TO_SAME_FACILITY',
ROUTINGPLANSHORTPICKEDTHENROUTEDTOSAMEFACILITY = 'ROUTING_PLAN_SHORTPICKED_THEN_ROUTED_TO_SAME_FACILITY',
ROUTINGPLANCREATEDTHENROUTING = 'ROUTING_PLAN_CREATED_THEN_ROUTING',
ROUTINGPLANCREATEDTHENPLANNED = 'ROUTING_PLAN_CREATED_THEN_PLANNED',
ROUTINGPLANREROUTEDTHENFAILED = 'ROUTING_PLAN_REROUTED_THEN_FAILED',
FACILITYMANUALLYASSIGNEDTOPICKJOBTHENROUTED = 'FACILITY_MANUALLY_ASSIGNED_TO_PICKJOB_THEN_ROUTED',
FACILITYMANUALLYASSIGNEDTOPROCESSTHENROUTED = 'FACILITY_MANUALLY_ASSIGNED_TO_PROCESS_THEN_ROUTED',
STOCKUPDATERECEIVEDTHENREACTIVATED = 'STOCK_UPDATE_RECEIVED_THEN_REACTIVATED',
ROUTINGPLANREROUTETIMETRIGGEREDTHENREROUTED = 'ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED',
ROUTINGPLANREROUTETIMETRIGGEREDTHENREROUTEDANDSPLIT = 'ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_AND_SPLIT',
ROUTINGPLANSHORTPICKEDTHENREROUTED = 'ROUTING_PLAN_SHORTPICKED_THEN_REROUTED',
ROUTINGPLANSHORTPICKEDTHENSPLIT = 'ROUTING_PLAN_SHORTPICKED_THEN_SPLIT',
ROUTINGPLANSHORTPICKEDTHENREROUTEDANDSPLIT = 'ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_AND_SPLIT',
ROUTINGPLANREROUTESTOCKZEROTHENREROUTED = 'ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED',
ROUTINGPLANREROUTESTOCKZEROTHENREROUTEDANDSPLIT = 'ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED_AND_SPLIT',
ROUTINGPLANREROUTESTOCKZEROTHENREROUTEDTOSAMEFACILITY = 'ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED_TO_SAME_FACILITY',
PICKJOBREJECTEDTHENREROUTED = 'PICKJOB_REJECTED_THEN_REROUTED',
PICKJOBREJECTEDTHENNOTROUTABLE = 'PICKJOB_REJECTED_THEN_NOT_ROUTABLE',
PICKJOBREJECTEDTHENROUTEDANDSPLIT = 'PICKJOB_REJECTED_THEN_ROUTED_AND_SPLIT',
ROUTEDANDSPLIT = 'ROUTED_AND_SPLIT',
OBSOLETE = 'OBSOLETE',
OBSOLETEWASROUTED = 'OBSOLETE_WAS_ROUTED',
OBSOLETEWASSHORTPICKED = 'OBSOLETE_WAS_SHORTPICKED',
UNKNOWN = 'UNKNOWN',
RETRYABLE = 'RETRYABLE',
FAILEDREROUTE = 'FAILED_REROUTE',
ROUTEDTHENCANCELED = 'ROUTED_THEN_CANCELED',
ROUTEDANDSPLITTHENCANCELED = 'ROUTED_AND_SPLIT_THEN_CANCELED',
ROUTINGPLANSHORTPICKEDTHENSPLITTHENCANCELED = 'ROUTING_PLAN_SHORTPICKED_THEN_SPLIT_THEN_CANCELED',
ROUTINGPLANSHORTPICKEDTHENREROUTEDTHENCANCELED = 'ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_THEN_CANCELED',
ROUTINGPLANSHORTPICKEDTHENREROUTEDANDSPLITTHENCANCELED = 'ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED',
ROUTINGPLANREROUTETIMETRIGGEREDTHENREROUTEDTHENCANCELED = 'ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_THEN_CANCELED',
ROUTINGPLANREROUTETIMETRIGGEREDTHENREROUTEDANDSPLITTHENCANCELED = 'ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED',
FACILITYMANUALLYASSIGNEDTOPICKJOBTHENROUTEDTHENCANCELED = 'FACILITY_MANUALLY_ASSIGNED_TO_PICKJOB_THEN_ROUTED_THEN_CANCELED',
FACILITYMANUALLYASSIGNEDTOPROCESSTHENROUTEDTHENCANCELED = 'FACILITY_MANUALLY_ASSIGNED_TO_PROCESS_THEN_ROUTED_THEN_CANCELED',
PROCESSMANUALREROUTEDTHENROUTEDTHENCANCELED = 'PROCESS_MANUAL_REROUTED_THEN_ROUTED_THEN_CANCELED',
PROCESSMANUALREROUTEDTHENREROUTEDANDSPLITTHENCANCELED = 'PROCESS_MANUAL_REROUTED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED',
CANCELED = 'CANCELED',
NOTROUTABLE = 'NOT_ROUTABLE',
WAITING = 'WAITING',
WAITINGANDSPLIT = 'WAITING_AND_SPLIT',
WAITINGTHENROUTED = 'WAITING_THEN_ROUTED',
WAITINGTHENROUTEDANDSPLIT = 'WAITING_THEN_ROUTED_AND_SPLIT',
WAITINGTHENNOTROUTABLE = 'WAITING_THEN_NOT_ROUTABLE',
WAITINGTHENWAITINGANDSPLIT = 'WAITING_THEN_WAITING_AND_SPLIT',
LOCKED = 'LOCKED',
INITIAL = 'INITIAL'
}
/**
*
* @export
* @interface ConsumerAddress
*/
export interface ConsumerAddress extends Address {
/**
*
* @type {string}
* @memberof ConsumerAddress
*/
companyName?: string;
/**
*
* @type {string}
* @memberof ConsumerAddress
*/
firstName?: string;
/**
*
* @type {string}
* @memberof ConsumerAddress
*/
lastName?: string;
/**
*
* @type {string}
* @memberof ConsumerAddress
*/
salutation?: string;
/**
*
* @type {string}
* @memberof ConsumerAddress
*/
email?: string;
/**
*
* @type {AddressType}
* @memberof ConsumerAddress
*/
addressType?: AddressType;
/**
*
* @type {Coordinates}
* @memberof ConsumerAddress
*/
coordinates?: Coordinates;
}
/**
*
* @export
* @interface ContainerDimensions
*/
export interface ContainerDimensions {
/**
* The height of the container (in cm)
* @type {number}
* @memberof ContainerDimensions
*/
heightInCm?: number;
/**
* The length of the container (in cm)
* @type {number}
* @memberof ContainerDimensions
*/
lengthInCm?: number;
/**
* The weight of the container (in g)
* @type {number}
* @memberof ContainerDimensions
*/
weightInG?: number;
/**
* The width of the container (in cm)
* @type {number}
* @memberof ContainerDimensions
*/
widthInCm?: number;
}
/**
*
* @export
* @interface ContextReference
*/
export interface ContextReference {
/**
*
* @type {string}
* @memberof ContextReference
*/
reference: string;
/**
*
* @type {RoutingDecisionContext}
* @memberof ContextReference
*/
routingDecisionContext: RoutingDecisionContext;
}
/**
* Coordinates of the WGS84 geodetic reference system in Mercator projection, as used e.g. by the Google Maps API
* @export
* @interface Coordinates
*/
export interface Coordinates {
/**
* Latitude value
* @type {number}
* @memberof Coordinates
*/
lat: number;
/**
* Longitude value
* @type {number}
* @memberof Coordinates
*/
lon: number;
}
/**
* ISO 3166 ALPHA-2 of country
* @export
*/
export type CountryCode = string
/**
*
* @export
* @interface CountryLanguageMapping
*/
export interface CountryLanguageMapping {
[key: string]: string;
}
/**
* The currency code is a three-letter code that represents a currency in the ISO 4217 standard.
* @export
* @enum {string}
*/
export enum CurrencyCode {
AED = 'AED',
AFN = 'AFN',
ALL = 'ALL',
AMD = 'AMD',
ANG = 'ANG',
AOA = 'AOA',
ARS = 'ARS',
AUD = 'AUD',
AWG = 'AWG',
AZN = 'AZN',
BAM = 'BAM',
BBD = 'BBD',
BDT = 'BDT',
BGN = 'BGN',
BHD = 'BHD',
BIF = 'BIF',
BMD = 'BMD',
BND = 'BND',
BOB = 'BOB',
BOV = 'BOV',
BRL = 'BRL',
BSD = 'BSD',
BTN = 'BTN',
BWP = 'BWP',
BYN = 'BYN',
BZD = 'BZD',
CAD = 'CAD',
CDF = 'CDF',
CHE = 'CHE',
CHF = 'CHF',
CHW = 'CHW',
CLF = 'CLF',
CLP = 'CLP',
CNY = 'CNY',
COP = 'COP',
COU = 'COU',
CRC = 'CRC',
CUC = 'CUC',
CUP = 'CUP',
CVE = 'CVE',
CZK = 'CZK',
DJF = 'DJF',
DKK = 'DKK',
DOP = 'DOP',
DZD = 'DZD',
EGP = 'EGP',
ERN = 'ERN',
ETB = 'ETB',
EUR = 'EUR',
FJD = 'FJD',
FKP = 'FKP',
GBP = 'GBP',
GEL = 'GEL',
GHS = 'GHS',
GIP = 'GIP',
GMD = 'GMD',
GNF = 'GNF',
GTQ = 'GTQ',
GYD = 'GYD',
HKD = 'HKD',
HNL = 'HNL',
HTG = 'HTG',
HUF = 'HUF',
IDR = 'IDR',
ILS = 'ILS',
INR = 'INR',
IQD = 'IQD',
IRR = 'IRR',
ISK = 'ISK',
JMD = 'JMD',
JOD = 'JOD',
JPY = 'JPY',
KES = 'KES',
KGS = 'KGS',
KHR = 'KHR',
KMF = 'KMF',
KPW = 'KPW',
KRW = 'KRW',
KWD = 'KWD',
KYD = 'KYD',
KZT = 'KZT',
LAK = 'LAK',
LBP = 'LBP',
LKR = 'LKR',
LRD = 'LRD',
LSL = 'LSL',
LYD = 'LYD',
MAD = 'MAD',
MDL = 'MDL',
MGA = 'MGA',
MKD = 'MKD',
MMK = 'MMK',
MNT = 'MNT',
MOP = 'MOP',
MRU = 'MRU',
MUR = 'MUR',
MVR = 'MVR',
MWK = 'MWK',
MXN = 'MXN',
MXV = 'MXV',
MYR = 'MYR',
MZN = 'MZN',
NAD = 'NAD',
NGN = 'NGN',
NIO = 'NIO',
NOK = 'NOK',
NPR = 'NPR',
NZD = 'NZD',
OMR = 'OMR',
PAB = 'PAB',
PEN = 'PEN',
PGK = 'PGK',
PHP = 'PHP',
PKR = 'PKR',
PLN = 'PLN',
PYG = 'PYG',
QAR = 'QAR',
RON = 'RON',
RSD = 'RSD',
RUB = 'RUB',
RWF = 'RWF',
SAR = 'SAR',
SBD = 'SBD',
SCR = 'SCR',
SDG = 'SDG',
SEK = 'SEK',
SGD = 'SGD',
SHP = 'SHP',
SLE = 'SLE',
SOS = 'SOS',
SRD = 'SRD',
SSP = 'SSP',
STN = 'STN',
SVC = 'SVC',
SYP = 'SYP',
SZL = 'SZL',
THB = 'THB',
TJS = 'TJS',
TMT = 'TMT',
TND = 'TND',
TOP = 'TOP',
TRY = 'TRY',
TTD = 'TTD',
TWD = 'TWD',
TZS = 'TZS',
UAH = 'UAH',
UGX = 'UGX',
USD = 'USD',
USN = 'USN',
UYI = 'UYI',
UYU = 'UYU',
UYW = 'UYW',
UZS = 'UZS',
VED = 'VED',
VES = 'VES',
VND = 'VND',
VUV = 'VUV',
WST = 'WST',
XAF = 'XAF',
XAG = 'XAG',
XAU = 'XAU',
XBA = 'XBA',
XBB = 'XBB',
XBC = 'XBC',
XBD = 'XBD',
XCD = 'XCD',
XDR = 'XDR',
XOF = 'XOF',
XPD = 'XPD',
XPF = 'XPF',
XPT = 'XPT',
XSU = 'XSU',
XTS = 'XTS',
XUA = 'XUA',
XXX = 'XXX',
YER = 'YER',
ZAR = 'ZAR',
ZMW = 'ZMW',
ZWL = 'ZWL'
}
/**
*
* @export
* @interface CustomAttributableVersionedResource
*/
export interface CustomAttributableVersionedResource extends VersionedResource {
/**
* Attributes that can be added to this entity. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
* @type {any}
* @memberof CustomAttributableVersionedResource
*/
customAttributes?: any;
}
/**
*
* @export
* @interface CustomAttributesResource
*/
export interface CustomAttributesResource {
/**
* Attributes that can be added to this entity. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.
* @type {any}
* @memberof CustomAttributesResource
*/
customAttributes?: any;
}
/**
* Include all different claims could be assigned to a user
* @export
* @interface CustomClaims
*/
export interface CustomClaims {
/**
*
* @type {UserRoles}
* @memberof CustomClaims
*/
roles: UserRoles;
}
/**
* You can supply a CUSTOM Prioritization rule. In order to successfully supply such a rule you also need to provide an evaluatable Expression in vmExpression. This expression needs to return an integer value that adds additional priority to an order.
* @export
* @interface CustomPrioritizationRule
*/
export interface CustomPrioritizationRule extends PrioritizationRule {
/**
*
* @type {string}
* @memberof CustomPrioritizationRule
*/
vmExpression: string;
}
/**
*
* @export
* @interface CustomService
*/
export interface CustomService extends VersionedResource {
/**
*
* @type {CustomServiceStatus}
* @memberof CustomService
*/
status: CustomServiceStatus;
/**
*
* @type {LocaleString}
* @memberof CustomService
*/
nameLocalized: LocaleString;
/**
*
* @type {LocaleString}
* @memberof CustomService
*/
descriptionLocalized?: LocaleString;
/**
*
* @type {number}
* @memberof CustomService
*/
executionTimeInMin?: number;
/**
*
* @type {boolean}
* @memberof CustomService
*/
itemsReturnable?: boolean;
/**
*
* @type {ItemsRequiredEnum}
* @memberof CustomService
*/
itemsRequired: ItemsRequiredEnum;
/**
*
* @type {Array}
* @memberof CustomService
*/
additionalInformation?: Array;
/**
*
* @type {string}
* @memberof CustomService
*/
id: string;
/**
*
* @type {string}
* @memberof CustomService
*/
name?: string;
/**
*
* @type {string}
* @memberof CustomService
*/
description?: string;
}
/**
*
* @export
* @interface CustomServiceDefinition
*/
export interface CustomServiceDefinition {
/**
* A reference to the custom service to be applied to the orderline items
* @type {string}
* @memberof CustomServiceDefinition
*/
customServiceRef?: string;
/**
* if true all articles below this service are intrpreted as a bundle
* @type {boolean}
* @memberof CustomServiceDefinition
*/
isBundled?: boolean;
/**
* Additional information necessary to fulfil the custom service
* @type {Array}
* @memberof CustomServiceDefinition
*/
additionalInformation?: Array;
}
/**
*
* @export
* @interface CustomServiceDefinitionAdditionalInformation
*/
export interface CustomServiceDefinitionAdditionalInformation {
/**
* A reference to the specific additional information of the custom service
* @type {string}
* @memberof CustomServiceDefinitionAdditionalInformation
*/
additionalInformationRef: string;
/**
* The value of the additional information
* @type {string | number | boolean}
* @memberof CustomServiceDefinitionAdditionalInformation
*/
value?: string | number | boolean;
}
/**
*
* @export
* @interface CustomServiceForCreation
*/
export interface CustomServiceForCreation {
/**
*
* @type {CustomServiceStatus}
* @memberof CustomServiceForCreation
*/
status: CustomServiceStatus;
/**
*
* @type {LocaleString}
* @memberof CustomServiceForCreation
*/
nameLocalized: LocaleString;
/**
*
* @type {LocaleString}
* @memberof CustomServiceForCreation
*/
descriptionLocalized?: LocaleString;
/**
*
* @type {number}
* @memberof CustomServiceForCreation
*/
executionTimeInMin?: number;
/**
*
* @type {boolean}
* @memberof CustomServiceForCreation
*/
itemsReturnable?: boolean;
/**
*
* @type {ItemsRequiredEnum}
* @memberof CustomServiceForCreation
*/
itemsRequired: ItemsRequiredEnum;
/**
*
* @type {Array}
* @memberof CustomServiceForCreation
*/
additionalInformation?: Array;
}
/**
*
* @export
* @interface CustomServiceItem
*/
export interface CustomServiceItem extends CustomServiceItemForCreation {
/**
*
* @type {string}
* @memberof CustomServiceItem
*/
id: string;
/**
*
* @type {Array}
* @memberof CustomServiceItem
*/
customServiceItems: Array;
}
/**
*
* @export
* @interface CustomServiceItemForCreation
*/
export interface CustomServiceItemForCreation {
/**
*
* @type {CustomServiceDefinition}
* @memberof CustomServiceItemForCreation
*/
customServiceDefinition: CustomServiceDefinition;
/**
*
* @type {Array}
* @memberof CustomServiceItemForCreation
*/
articleItems: Array;
/**
*
* @type {Array}
* @memberof CustomServiceItemForCreation
*/
customServiceItems: Array;
}
/**
*
* @export
* @interface CustomServicePatchActions
*/
export interface CustomServicePatchActions {
/**
*
* @type {Array}
* @memberof CustomServicePatchActions
*/
actions: Array;
/**
* The version of the document to be used in optimistic locking mechanisms.
* @type {number}
* @memberof CustomServicePatchActions
*/
version: number;
}
/**
*
* @export
* @interface CustomServiceReference
*/
export interface CustomServiceReference extends CustomServiceReferenceForCreation {
/**
*
* @type {string}
* @memberof CustomServiceReference
*/
id: string;
/**
*
* @type {Array}
* @memberof CustomServiceReference
*/
customServiceItems: Array;
}
/**
*
* @export
* @interface CustomServiceReferenceForCreation
*/
export interface CustomServiceReferenceForCreation {
/**
*
* @type {CustomServiceDefinition}
* @memberof CustomServiceReferenceForCreation
*/
customServiceDefinition: CustomServiceDefinition;
/**
*
* @type {Array}
* @memberof CustomServiceReferenceForCreation
*/
articleItems: Array;
/**
*
* @type {Array}
* @memberof CustomServiceReferenceForCreation
*/
customServiceItems: Array;
}
/**
*
* @export
* @enum {string}
*/
export enum CustomServiceStatus {
ENABLED = 'ENABLED',
DISABLED = 'DISABLED'
}
/**
*
* @export
* @interface CutoffTime
*/
export interface CutoffTime {
/**
*
* @type {number}
* @memberof CutoffTime
*/
hour: number;
/**
*
* @type {number}
* @memberof CutoffTime
*/
minute: number;
}
/**
*
* @export
* @interface CutoffTimeConfiguration
*/
export interface CutoffTimeConfiguration extends VersionedResource {
/**
*
* @type {CutoffTime}
* @memberof CutoffTimeConfiguration
*/
clickAndCollect: CutoffTime;
/**
*
* @type {CutoffTime}
* @memberof CutoffTimeConfiguration
*/
shipFromStore: CutoffTime;
/**
*
* @type {string}
* @memberof CutoffTimeConfiguration
*/
id?: string;
}
/**
*
* @export
* @interface DHLV2BusinessCredentials
*/
export interface DHLV2BusinessCredentials extends AbstractCarrierCredentials {
/**
* Abrechnungsnummer DHL Paket, displayed in the DHL Geschäftskundenportal under 'Vertragspositionen'
* @type {string}
* @memberof DHLV2BusinessCredentials
*/
billingNumber: string;
/**
* Abrechnungsnummer DHL Retoure, displayed in the DHL Geschäftskundenportal under 'Vertragspositionen'
* @type {string}
* @memberof DHLV2BusinessCredentials
*/
retoureBillingNumber?: string;
/**
* Abrechnungsnummer DHL international shipping, displayed in the DHL Geschäftskundenportal under 'Vertragspositionen'
* @type {string}
* @memberof DHLV2BusinessCredentials
*/
internationalBillingNumber?: string;
/**
* Password you use to login to the DHL Geschäftskundenportal
* @type {string}
* @memberof DHLV2BusinessCredentials
*/
dhlBusinessPassword: string;
/**
* Username (Benutzername) you use to login to the DHL Geschäftskundenportal
* @type {string}
* @memberof DHLV2BusinessCredentials
*/
dhlBusinessUsername: string;
/**
* (optional) User group to use to obtain a label
* @type {string}
* @memberof DHLV2BusinessCredentials
*/
dhlBusinessUsergroup?: string;
}
/**
*
* @export
* @interface DHLV2CarrierCredentials
*/
export interface DHLV2CarrierCredentials extends AbstractCarrierCredentials {
/**
* Internal API Key to communicate with the DHL Api
* @type {string}
* @memberof DHLV2CarrierCredentials
*/
apiKey: string;
/**
*
* @type {DHLV2BusinessCredentials}
* @memberof DHLV2CarrierCredentials
*/
fallback?: DHLV2BusinessCredentials;
}
/**
*
* @export
* @interface DecisionLog
*/
export interface DecisionLog extends VersionedResource {
/**
*
* @type {string}
* @memberof DecisionLog
*/
id: string;
/**
*
* @type {number}
* @memberof DecisionLog
*/
routingRun: number;
/**
*
* @type {Array}
* @memberof DecisionLog
*/
facilityDecisions: Array;
/**
*
* @type {OrderSplitDecision}
* @memberof DecisionLog
*/
orderSplitDecision?: OrderSplitDecision;
/**
*
* @type {RoutingStatistics}
* @memberof DecisionLog
*/
statistics: RoutingStatistics;
/**
*
* @type {RoutingResults}
* @memberof DecisionLog
*/
results: RoutingResults;
/**
*
* @type {string}
* @memberof DecisionLog
*/
routingPlanRef: string;
}
/**
*
* @export
* @interface DecisionLogFacilityInfo
*/
export interface DecisionLogFacilityInfo {
/**
*
* @type {string}
* @memberof DecisionLogFacilityInfo
*/
name: string;
/**
*
* @type {string}
* @memberof DecisionLogFacilityInfo
*/
facilityRef: string;
}
/**
*
* @export
* @interface DecisionLogRef
*/
export interface DecisionLogRef {
/**
*
* @type {number}
* @memberof DecisionLogRef
*/
routingRun?: number;
/**
* A reference to the finalizer decision log
* @type {string}
* @memberof DecisionLogRef
*/
url: string;
}
/**
*
* @export
* @enum {string}
*/
export enum DecisionType {
FENCE = 'FENCE',
TOOLKIT = 'TOOLKIT',
TOOLKITCOMPARISON = 'TOOLKITCOMPARISON',
RATING = 'RATING'
}
/**
*
* @export
* @interface DefaultPickingTimesConfiguration
*/
export interface DefaultPickingTimesConfiguration extends VersionedResource {
/**
*
* @type {PickingTimes}
* @memberof DefaultPickingTimesConfiguration
*/
pickingTimes: PickingTimes;
}
/**
*
* @export
* @interface DeleteRefuseReasonParameter
*/
export interface DeleteRefuseReasonParameter {
/**
*
* @type {number}
* @memberof DeleteRefuseReasonParameter
*/
handoverConfigurationVersion: number;
}
/**
*
* @export
* @interface DeliveryAddress
*/
export interface DeliveryAddress {
/**
*
* @type {string}
* @memberof DeliveryAddress
*/
city: string;
/**
*
* @type {string}
* @memberof DeliveryAddress
*/
companyName?: string;
/**
*
* @type {string}
* @memberof DeliveryAddress
*/
firstName?: string;
/**
*
* @type {string}
* @memberof DeliveryAddress
*/
houseNumber?: string;
/**
*
* @type {string}
* @memberof DeliveryAddress
*/
lastName?: string;
/**
*
* @type {string}
* @memberof DeliveryAddress
*/
postalCode: string;
/**
*
* @type {string}
* @memberof DeliveryAddress
*/
street: string;
}
/**
*
* @export
* @interface DeliveryAddressWithType
*/
export interface DeliveryAddressWithType extends DeliveryAddress {
/**
*
* @type {AddressType}
* @memberof DeliveryAddressWithType
*/
addressType: AddressType;
}
/**
*
* @export
* @interface DeliveryArea
*/
export interface DeliveryArea {
/**
* A two-digit country code as per ISO 3166-1 alpha-2
* @type {string}
* @memberof DeliveryArea
*/
country: string;
/**
*
* @type {string}
* @memberof DeliveryArea
*/
postalCode: string;
}
/**
*
* @export
* @interface DeliveryCost
*/
export interface DeliveryCost {
/**
* The cost of sending with a carrier
* @type {number}
* @memberof DeliveryCost
*/
cost: number;
/**
* currency as 3 letter iso code
* @type {string}
* @memberof DeliveryCost
*/
currency: string;
}
/**
*
* @export
* @interface DeliveryEvent
*/
export interface DeliveryEvent {
/**
*
* @type {DeliveryTarget}
* @memberof DeliveryEvent
*/
deliveryTarget: DeliveryTarget;
/**
*
* @type {string}
* @memberof DeliveryEvent
*/
deliveryTrigger: DeliveryEvent.DeliveryTriggerEnum;
}
/**
* @export
* @namespace DeliveryEvent
*/
export namespace DeliveryEvent {
/**
* @export
* @enum {string}
*/
export enum DeliveryTriggerEnum {
DEFAULT = 'DEFAULT'
}
}
/**
*
* @export
* @interface DeliveryEventTargetAddress
*/
export interface DeliveryEventTargetAddress {
/**
*
* @type {string}
* @memberof DeliveryEventTargetAddress
*/
facilityRef: string;
/**
*
* @type {TargetAddress}
* @memberof DeliveryEventTargetAddress
*/
targetAddress: TargetAddress;
/**
*
* @type {DeliveryEvent}
* @memberof DeliveryEventTargetAddress
*/
deliveryEvent: DeliveryEvent;
}
/**
*
* @export
* @interface DeliveryNote
*/
export interface DeliveryNote {
/**
*
* @type {CompanyAddress}
* @memberof DeliveryNote
*/
companyAddress?: CompanyAddress;
/**
*
* @type {DeliveryAddress}
* @memberof DeliveryNote
*/
deliveryAddress?: DeliveryAddress;
/**
* if this field is filled, the delivery address will be taken from here according to this sorting: PARCEL_LOCKER > POSTAL_ADDRESS > INVOICE_ADDRESS. Each type is only allowed once.
* @type {Array}
* @memberof DeliveryNote
*/
deliveryAddresses?: Array;
/**
*
* @type {Array}
* @memberof DeliveryNote
*/
items: Array;
/**
*
* @type {OrderInformation}
* @memberof DeliveryNote
*/
orderInformation: OrderInformation;
}
/**
*
* @export
* @interface DeliveryNoteConfiguration
*/
export interface DeliveryNoteConfiguration extends VersionedResource {
/**
*
* @type {LocaleString}
* @memberof DeliveryNoteConfiguration
*/
articleIdLabel: LocaleString;
/**
*
* @type {LocaleString}
* @memberof DeliveryNoteConfiguration
*/
articleTitleLabel: LocaleString;
/**
*
* @type {CompanyAddress}
* @memberof DeliveryNoteConfiguration
*/
companyAddress?: CompanyAddress;
/**
*
* @type {LocaleString}
* @memberof DeliveryNoteConfiguration
*/
description?: LocaleString;
/**
*
* @type {LocaleString}
* @memberof DeliveryNoteConfiguration
*/
disclaimer?: LocaleString;
/**
*
* @type {LocaleString}
* @memberof DeliveryNoteConfiguration
*/
headline: LocaleString;
/**
*
* @type {string}
* @memberof DeliveryNoteConfiguration
*/
id: string;
/**
*
* @type {string}
* @memberof DeliveryNoteConfiguration
*/
logoUrl?: string;
/**
*
* @type {LocaleString}
* @memberof DeliveryNoteConfiguration
*/
substituteText?: LocaleString;
/**
*
* @type {LocaleString}
* @memberof DeliveryNoteConfiguration
*/
orderDateLabel: LocaleString;
/**
*
* @type {LocaleString}
* @memberof DeliveryNoteConfiguration
*/
orderNumberLabel: LocaleString;
/**
*
* @type {LocaleString}
* @memberof DeliveryNoteConfiguration
*/
pageLabel: LocaleString;
/**
*
* @type {LocaleString}
* @memberof DeliveryNoteConfiguration
*/
quantityLabel: LocaleString;
/**
*
* @type {PdfBackgroundConfiguration}
* @memberof DeliveryNoteConfiguration
*/
pdfBackgroundConfiguration?: PdfBackgroundConfiguration;
}
/**
*
* @export
* @interface DeliveryNoteConfigurationForUpsert
*/
export interface DeliveryNoteConfigurationForUpsert {
/**
*
* @type {LocaleString}
* @memberof DeliveryNoteConfigurationForUpsert
*/
articleIdLabel: LocaleString;
/**
*
* @type {LocaleString}
* @memberof DeliveryNoteConfigurationForUpsert
*/
articleTitleLabel: LocaleString;
/**
*
* @type {CompanyAddress}
* @memberof DeliveryNoteConfigurationForUpsert
*/
companyAddress?: CompanyAddress;
/**
*
* @type {LocaleString}
* @memberof DeliveryNoteConfigurationForUpsert
*/
description?: LocaleString;
/**
*
* @type {LocaleString}
* @memberof DeliveryNoteConfigurationForUpsert
*/
disclaimer?: LocaleString;
/**
*
* @type {LocaleString}
* @memberof DeliveryNoteConfigurationForUpsert
*/
headline: LocaleString;
/**
*
* @type {NamedFile}
* @memberof DeliveryNoteConfigurationForUpsert
*/
logo?: NamedFile;
/**
*
* @type {PdfBackgroundConfigurationForUpsert}
* @memberof DeliveryNoteConfigurationForUpsert
*/
pdfBackgroundConfiguration?: PdfBackgroundConfigurationForUpsert;
/**
*
* @type {LocaleString}
* @memberof DeliveryNoteConfigurationForUpsert
*/
orderDateLabel: LocaleString;
/**
*
* @type {LocaleString}
* @memberof DeliveryNoteConfigurationForUpsert
*/
orderNumberLabel: LocaleString;
/**
*
* @type {LocaleString}
* @memberof DeliveryNoteConfigurationForUpsert
*/
pageLabel: LocaleString;
/**
*
* @type {LocaleString}
* @memberof DeliveryNoteConfigurationForUpsert
*/
quantityLabel: LocaleString;
/**
*
* @type {LocaleString}
* @memberof DeliveryNoteConfigurationForUpsert
*/
substituteText?: LocaleString;
/**
* Version field is used in the optimistic locking process. If the configuration doesn't exists, this field is ignored.
* @type {number}
* @memberof DeliveryNoteConfigurationForUpsert
*/
version: number;
}
/**
*
* @export
* @interface DeliveryNoteItem
*/
export interface DeliveryNoteItem {
/**
*
* @type {string}
* @memberof DeliveryNoteItem
*/
id: string;
/**
*
* @type {string}
* @memberof DeliveryNoteItem
*/
quantity: string;
/**
*
* @type {string}
* @memberof DeliveryNoteItem
*/
title: string;
/**
* Titel of the item which is substituted through this item
* @type {string}
* @memberof DeliveryNoteItem
*/
substitutes?: string;
}
/**
*
* @export
* @interface DeliveryPreferences
*/
export interface DeliveryPreferences {
/**
*
* @type {Array}
* @memberof DeliveryPreferences
*/
collect?: Array;
/**
*
* @type {DeliveryPreferencesShipping}
* @memberof DeliveryPreferences
*/
shipping?: DeliveryPreferencesShipping;
/**
* @deprecated Use supplyingFacilities under collect
* @type {Array}
* @memberof DeliveryPreferences
*/
supplyingFacilities?: Array;
/**
* At which time the result is expected.
* @type {Date}
* @memberof DeliveryPreferences
*/
targetTime?: Date;
/**
*
* @type {DeliveryReservationPreferences}
* @memberof DeliveryPreferences
*/
reservationPreferences?: DeliveryReservationPreferences;
}
/**
*
* @export
* @interface DeliveryPreferencesShipping
*/
export interface DeliveryPreferencesShipping {
/**
*
* @type {Array}
* @memberof DeliveryPreferencesShipping
*/
preferredCarriers?: Array;
/**
*
* @type {Array}
* @memberof DeliveryPreferencesShipping
*/
preferredCarriersWithProduct?: Array;
/**
*
* @type {Array}
* @memberof DeliveryPreferencesShipping
*/
preselectedFacilities?: Array;
/**
* 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.
* @type {string}
* @memberof DeliveryPreferencesShipping
*/
serviceLevel?: DeliveryPreferencesShipping.ServiceLevelEnum;
/**
*
* @type {CarrierProductCategory}
* @memberof DeliveryPreferencesShipping
*/
carrierProductCategory?: CarrierProductCategory;
/**
*
* @type {Date}
* @memberof DeliveryPreferencesShipping
*/
desiredDeliveryTime?: Date;
}
/**
* @export
* @namespace DeliveryPreferencesShipping
*/
export namespace DeliveryPreferencesShipping {
/**
* @export
* @enum {string}
*/
export enum ServiceLevelEnum {
DELIVERY = 'DELIVERY',
SAMEDAY = 'SAMEDAY'
}
}
/**
*
* @export
* @interface DeliveryPromiseCollect
*/
export interface DeliveryPromiseCollect extends BasicDeliveryPromiseShipment {
/**
*
* @type {Date}
* @memberof DeliveryPromiseCollect
*/
targetTime: Date;
}
/**
*
* @export
* @interface DeliveryPromiseLineItem
*/
export interface DeliveryPromiseLineItem {
/**
*
* @type {string}
* @memberof DeliveryPromiseLineItem
*/
tenantArticleId?: string;
/**
*
* @type {string}
* @memberof DeliveryPromiseLineItem
*/
title?: string;
/**
*
* @type {number}
* @memberof DeliveryPromiseLineItem
*/
quantity?: number;
/**
*
* @type {number}
* @memberof DeliveryPromiseLineItem
*/
available?: number;
/**
*
* @type {string}
* @memberof DeliveryPromiseLineItem
*/
outOfStockBehaviour?: DeliveryPromiseLineItem.OutOfStockBehaviourEnum;
/**
*
* @type {AvailabilityTimeframe}
* @memberof DeliveryPromiseLineItem
*/
availabilityTimeframe?: AvailabilityTimeframe;
}
/**
* @export
* @namespace DeliveryPromiseLineItem
*/
export namespace DeliveryPromiseLineItem {
/**
* @export
* @enum {string}
*/
export enum OutOfStockBehaviourEnum {
BACKORDER = 'BACKORDER'
}
}
/**
*
* @export
* @interface DeliveryPromiseShipment
*/
export interface DeliveryPromiseShipment extends BasicDeliveryPromiseShipment {
/**
*
* @type {Array}
* @memberof DeliveryPromiseShipment
*/
carriers: Array;
}
/**
*
* @export
* @enum {string}
*/
export enum DeliveryReservationMode {
SCHEDULED = 'SCHEDULED',
ASAP = 'ASAP',
ALAP = 'ALAP'
}
/**
*
* @export
* @interface DeliveryReservationPreferences
*/
export interface DeliveryReservationPreferences {
/**
*
* @type {DeliveryReservationMode}
* @memberof DeliveryReservationPreferences
*/
mode: DeliveryReservationMode;
/**
*
* @type {Date}
* @memberof DeliveryReservationPreferences
*/
reservationTime?: Date;
}
/**
* The destination for a delivery
* @export
* @enum {string}
*/
export enum DeliveryTarget {
STORE = 'SHIP_TO_STORE',
CUSTOMER = 'SHIP_TO_CUSTOMER'
}
/**
*
* @export
* @interface DhlV2CarrierConfiguration
*/
export interface DhlV2CarrierConfiguration extends CarrierConfiguration {
/**
*
* @type {FacilityAddress}
* @memberof DhlV2CarrierConfiguration
*/
alternativeReturnAddress?: FacilityAddress;
/**
*
* @type {string}
* @memberof DhlV2CarrierConfiguration
*/
trackAndTraceUrl?: string;
}
/**
*
* @export
* @interface DhlV2FacilityCarrierConfiguration
*/
export interface DhlV2FacilityCarrierConfiguration extends AbstractFacilityCarrierConfiguration {
/**
*
* @type {FacilityAddress}
* @memberof DhlV2FacilityCarrierConfiguration
*/
alternativeReturnAddress?: FacilityAddress;
/**
*
* @type {string}
* @memberof DhlV2FacilityCarrierConfiguration
*/
trackAndTraceUrl?: string;
}
/**
*
* @export
* @enum {string}
*/
export enum DocumentCategory {
EXTERNAL = 'EXTERNAL',
DELIVERYNOTE = 'DELIVERYNOTE',
RETURNNOTE = 'RETURNNOTE',
SENDLABEL = 'SENDLABEL',
RETURNLABEL = 'RETURNLABEL'
}
/**
*
* @export
* @interface DocumentHandling
*/
export interface DocumentHandling {
/**
*
* @type {DocumentHandlingSendLabel}
* @memberof DocumentHandling
*/
sendLabel: DocumentHandlingSendLabel;
}
/**
*
* @export
* @interface DocumentHandlingSendLabel
*/
export interface DocumentHandlingSendLabel {
/**
*
* @type {boolean}
* @memberof DocumentHandlingSendLabel
*/
enabled: boolean;
}
/**
*
* @export
* @enum {string}
*/
export enum DocumentOperations {
PRINT = 'PRINT',
VIEW = 'VIEW'
}
/**
*
* @export
* @interface DocumentSet
*/
export interface DocumentSet extends VersionedResource {
/**
*
* @type {string}
* @memberof DocumentSet
*/
id: string;
/**
*
* @type {string}
* @memberof DocumentSet
*/
facilityRef?: string;
/**
*
* @type {Array}
* @memberof DocumentSet
*/
documents?: Array;
}
/**
*
* @export
* @enum {string}
*/
export enum DocumentStatus {
AVAILABLE = 'AVAILABLE',
LOADING = 'LOADING',
REQUESTABLE = 'REQUESTABLE',
CANCELED = 'CANCELED',
WAITINGFORINPUT = 'WAITING_FOR_INPUT'
}
/**
*
* @export
* @enum {string}
*/
export enum DocumentType {
PDF = 'PDF',
PNG = 'PNG',
JPG = 'JPG',
GIF = 'GIF',
JPEG = 'JPEG'
}
/**
*
* @export
* @interface DomainConfiguration
*/
export interface DomainConfiguration extends VersionedResource {
/**
* User's default domain for authentication
* @type {string}
* @memberof DomainConfiguration
*/
value: string;
/**
*
* @type {string}
* @memberof DomainConfiguration
*/
id?: string;
}
/**
*
* @export
* @enum {string}
*/
export enum DomainStatus {
PENDING = 'PENDING',
CREATED = 'CREATED',
INPROGRESS = 'IN_PROGRESS',
STUCK = 'STUCK',
FINISHED = 'FINISHED',
CANCELED = 'CANCELED',
OBSOLETE = 'OBSOLETE'
}
/**
* This item represent a process status change triggered by a specific domain.
* @export
* @interface DomainStatusHistoryItem
*/
export interface DomainStatusHistoryItem {
/**
* Timestamp of the moment at which the state was notified by the domain.
* @type {Date}
* @memberof DomainStatusHistoryItem
*/
timestamp: Date;
/**
*
* @type {DomainType}
* @memberof DomainStatusHistoryItem
*/
domain: DomainType;
/**
* The id of the domain entity that caused the status change.
* @type {string}
* @memberof DomainStatusHistoryItem
*/
domainRef: string;
/**
*
* @type {DomainStatus}
* @memberof DomainStatusHistoryItem
*/
domainEntityProcessStatus: DomainStatus;
}
/**
*
* @export
* @enum {string}
*/
export enum DomainType {
ORDER = 'ORDER',
ROUTINGPLAN = 'ROUTING_PLAN',
PICKJOB = 'PICKJOB',
PACKJOB = 'PACKJOB',
SHIPMENT = 'SHIPMENT',
HANDOVER = 'HANDOVER',
RETURN = 'RETURN',
SERVICEJOB = 'SERVICE_JOB',
ITEMRETURNJOB = 'ITEM_RETURN_JOB'
}
/**
*
* @export
* @interface DpdChCarrierConfiguration
*/
export interface DpdChCarrierConfiguration extends CarrierConfiguration {
/**
*
* @type {FacilityAddress}
* @memberof DpdChCarrierConfiguration
*/
alternativeSendAddress?: FacilityAddress;
/**
*
* @type {string}
* @memberof DpdChCarrierConfiguration
*/
trackAndTraceUrl?: string;
}
/**
*
* @export
* @interface DpdChCarrierCredentials
*/
export interface DpdChCarrierCredentials extends AbstractCarrierCredentials {
/**
* Delis ID to create a DPD CH auth token
* @type {string}
* @memberof DpdChCarrierCredentials
*/
delisId: string;
/**
* Password to create a DPD CH auth token
* @type {string}
* @memberof DpdChCarrierCredentials
*/
password: string;
}
/**
*
* @export
* @interface DpdChFacilityCarrierConfiguration
*/
export interface DpdChFacilityCarrierConfiguration extends AbstractFacilityCarrierConfiguration {
/**
*
* @type {string}
* @memberof DpdChFacilityCarrierConfiguration
*/
depot?: string;
/**
*
* @type {string}
* @memberof DpdChFacilityCarrierConfiguration
*/
trackAndTraceUrl?: string;
}
/**
*
* @export
* @interface Editor
*/
export interface Editor {
/**
* ID of the user who edits the pickjob
* @type {string}
* @memberof Editor
*/
userId?: string;
/**
* username of the user who edits the pickjob
* @type {string}
* @memberof Editor
*/
username: string;
}
/**
*
* @export
* @interface EmailNotificationChannel
*/
export interface EmailNotificationChannel {
/**
*
* @type {boolean}
* @memberof EmailNotificationChannel
*/
enabled: boolean;
/**
* Supported events for triggering external notifications: - PICK_JOB_CREATED: Available for facility scoped config and tenant wide config - ROUTING_PLAN_NOT_ROUTABLE: Available for tenant wide config - ROUTING_PLAN_WAITING: Available for tenant wide config
* @type {Array}
* @memberof EmailNotificationChannel
*/
events: Array;
/**
*
* @type {string}
* @memberof EmailNotificationChannel
*/
type: string;
/**
*
* @type {string}
* @memberof EmailNotificationChannel
*/
id: string;
/**
*
* @type {Array}
* @memberof EmailNotificationChannel
*/
receiver: Array;
}
/**
* @export
* @namespace EmailNotificationChannel
*/
export namespace EmailNotificationChannel {
/**
* @export
* @enum {string}
*/
export enum EventsEnum {
PICKJOBCREATED = 'PICK_JOB_CREATED',
ROUTINGPLANNOTROUTABLE = 'ROUTING_PLAN_NOT_ROUTABLE',
ROUTINGPLANWAITING = 'ROUTING_PLAN_WAITING'
}
}
/**
*
* @export
* @interface EmailNotificationChannelForCreation
*/
export interface EmailNotificationChannelForCreation {
/**
*
* @type {boolean}
* @memberof EmailNotificationChannelForCreation
*/
enabled: boolean;
/**
* Supported events for triggering external notifications: - PICK_JOB_CREATED: Available for facility scoped config and tenant wide config - ROUTING_PLAN_NOT_ROUTABLE: Available for tenant wide config - ROUTING_PLAN_WAITING: Available for tenant wide config
* @type {Array}
* @memberof EmailNotificationChannelForCreation
*/
events: Array;
/**
*
* @type {string}
* @memberof EmailNotificationChannelForCreation
*/
type: string;
/**
*
* @type {Array}
* @memberof EmailNotificationChannelForCreation
*/
receiver: Array;
}
/**
* @export
* @namespace EmailNotificationChannelForCreation
*/
export namespace EmailNotificationChannelForCreation {
/**
* @export
* @enum {string}
*/
export enum EventsEnum {
PICKJOBCREATED = 'PICK_JOB_CREATED',
ROUTINGPLANNOTROUTABLE = 'ROUTING_PLAN_NOT_ROUTABLE',
ROUTINGPLANWAITING = 'ROUTING_PLAN_WAITING'
}
}
/**
*
* @export
* @interface EmailReceiver
*/
export interface EmailReceiver {
/**
*
* @type {string}
* @memberof EmailReceiver
*/
email: string;
/**
*
* @type {SupportedLocale}
* @memberof EmailReceiver
*/
language: SupportedLocale;
}
/**
*
* @export
* @interface Entity
*/
export interface Entity extends VersionedResource {
/**
* The id of the entity.
* @type {string}
* @memberof Entity
*/
id: string;
}
/**
*
* @export
* @interface ErrorInner
*/
export interface ErrorInner {
/**
*
* @type {string}
* @memberof ErrorInner
*/
description?: string;
/**
* The version provided within an invalid request.
* @type {number}
* @memberof ErrorInner
*/
requestVersion?: number;
/**
*
* @type {string}
* @memberof ErrorInner
*/
summary: string;
/**
*
* @type {number}
* @memberof ErrorInner
*/
version?: number;
}
/**
*
* @export
* @interface EstimatedDeliveryTime
*/
export interface EstimatedDeliveryTime {
/**
* Minimum total delivery time in days
* @type {number}
* @memberof EstimatedDeliveryTime
*/
minDeliveryDays: number;
/**
* Maximum total delivery time in days
* @type {number}
* @memberof EstimatedDeliveryTime
*/
maxDeliveryDays: number;
}
/**
*
* @export
* @interface ExpectedLineItem
*/
export interface ExpectedLineItem extends OrderLineItem {
/**
*
* @type {string}
* @memberof ExpectedLineItem
*/
transferId: string;
/**
*
* @type {string}
* @memberof ExpectedLineItem
*/
facilityRef: string;
}
/**
*
* @export
* @interface ExpectedPickLineItem
*/
export interface ExpectedPickLineItem extends ExpectedPickLineItemForCreation {
/**
* The id of this lineItem. It is generated during creation automatically and suits as the primary identifier of the described entity.
* @type {string}
* @memberof ExpectedPickLineItem
*/
id: string;
}
/**
*
* @export
* @interface ExpectedPickLineItemForCreation
*/
export interface ExpectedPickLineItemForCreation extends PickLineItemForCreation {
/**
*
* @type {string}
* @memberof ExpectedPickLineItemForCreation
*/
transferId: string;
}
/**
*
* @export
* @interface ExpiryConfiguration
*/
export interface ExpiryConfiguration extends VersionedResource {
/**
*
* @type {number}
* @memberof ExpiryConfiguration
*/
provisioningTimeOffsetInMinutes: number;
}
/**
*
* @export
* @interface ExpiryEntity
*/
export interface ExpiryEntity {
/**
* Generated identifier of this entity
* @type {string}
* @memberof ExpiryEntity
*/
id: string;
/**
* The version of the document to be used in optimistic locking mechanisms.
* @type {number}
* @memberof ExpiryEntity
*/
version: number;
/**
* The date this entity was created at the platform. This value is generated by the service.
* @type {Date}
* @memberof ExpiryEntity
*/
created: Date;
/**
* The date this entity was modified last. This value is generated by the service.
* @type {Date}
* @memberof ExpiryEntity
*/
lastModified: Date;
/**
* Reference to the Process of this Entity
* @type {string}
* @memberof ExpiryEntity
*/
processRef: string;
/**
* Planned time where this entity should be provided or handed over to the customer
* @type {Date}
* @memberof ExpiryEntity
*/
provisioningTime: Date;
/**
* Time where the connected process expires, if not fulfilled
* @type {Date}
* @memberof ExpiryEntity
*/
expiryTime: Date;
/**
*
* @type {ExpiryEntityStatus}
* @memberof ExpiryEntity
*/
status: ExpiryEntityStatus;
}
/**
*
* @export
* @interface ExpiryEntityFilter
*/
export interface ExpiryEntityFilter {
/**
* process of the entity you want to load
* @type {string}
* @memberof ExpiryEntityFilter
*/
processRef?: string;
/**
*
* @type {ExpiryEntityStatus}
* @memberof ExpiryEntityFilter
*/
status?: ExpiryEntityStatus;
/**
* start date range for expiryTime
* @type {any}
* @memberof ExpiryEntityFilter
*/
startDate?: any;
/**
* end date range for expiryTime
* @type {any}
* @memberof ExpiryEntityFilter
*/
endDate?: any;
}
/**
*
* @export
* @interface ExpiryEntityForCreation
*/
export interface ExpiryEntityForCreation {
/**
* Reference to the Process for which this expiry entity will be created
* @type {string}
* @memberof ExpiryEntityForCreation
*/
processRef: string;
/**
* Planned time where this entity should be provided or handed over to the customer
* @type {Date}
* @memberof ExpiryEntityForCreation
*/
provisioningTime: Date;
/**
*
* @type {ExpiryEntityStatus}
* @memberof ExpiryEntityForCreation
*/
status: ExpiryEntityStatus;
}
/**
*
* @export
* @interface ExpiryEntityForUpdate
*/
export interface ExpiryEntityForUpdate {
/**
* version of the entity you want to alter
* @type {number}
* @memberof ExpiryEntityForUpdate
*/
version: number;
/**
* Planned time where this entity should be provided or handed over to the customer
* @type {Date}
* @memberof ExpiryEntityForUpdate
*/
provisioningTime?: Date;
/**
*
* @type {ExpiryEntityStatus}
* @memberof ExpiryEntityForUpdate
*/
status?: ExpiryEntityStatus;
}
/**
*
* @export
* @enum {string}
*/
export enum ExpiryEntityStatus {
ACTIVE = 'ACTIVE',
INACTIVE = 'INACTIVE'
}
/**
*
* @export
* @interface ExternalAction
*/
export interface ExternalAction extends ExternalActionForReplacement {
/**
* The date this entity was created at the platform. This value is generated by the service.
* @type {Date}
* @memberof ExternalAction
*/
created?: Date;
/**
* The date this entity was modified last. This value is generated by the service.
* @type {Date}
* @memberof ExternalAction
*/
lastModified?: Date;
/**
* The version of the document to be used in optimistic locking mechanisms.
* @type {number}
* @memberof ExternalAction
*/
version: number;
/**
* The id of this external action. It is generated during creation automatically and suits as the primary identifier of the described entity.
* @type {string}
* @memberof ExternalAction
*/
id: string;
/**
* Id of the global process related to this entity.
* @type {string}
* @memberof ExternalAction
*/
processRef: string;
/**
* The name of this external action.
* @type {string}
* @memberof ExternalAction
*/
name: string;
}
/**
*
* @export
* @interface ExternalActionForCreation
*/
export interface ExternalActionForCreation {
/**
* Id of the global process related to this entity.
* @type {string}
* @memberof ExternalActionForCreation
*/
processRef: string;
/**
*
* @type {LocaleString}
* @memberof ExternalActionForCreation
*/
nameLocalized: LocaleString;
/**
*
* @type {Array}
* @memberof ExternalActionForCreation
*/
groups: Array;
/**
*
* @type {ExternalFormActionDefinition | ExternalLinkActionDefinition}
* @memberof ExternalActionForCreation
*/
action: ExternalFormActionDefinition | ExternalLinkActionDefinition;
}
/**
*
* @export
* @interface ExternalActionForReplacement
*/
export interface ExternalActionForReplacement {
/**
*
* @type {number}
* @memberof ExternalActionForReplacement
*/
version: number;
/**
*
* @type {LocaleString}
* @memberof ExternalActionForReplacement
*/
nameLocalized: LocaleString;
/**
*
* @type {Array}
* @memberof ExternalActionForReplacement
*/
groups: Array;
/**
*
* @type {ExternalFormActionDefinition | ExternalLinkActionDefinition}
* @memberof ExternalActionForReplacement
*/
action: ExternalFormActionDefinition | ExternalLinkActionDefinition;
}
/**
*
* @export
* @interface ExternalActionLog
*/
export interface ExternalActionLog extends ExternalActionLogForCreation {
/**
*
* @type {string}
* @memberof ExternalActionLog
*/
id: string;
/**
* Id of the refered external action.
* @type {string}
* @memberof ExternalActionLog
*/
externalActionRef: string;
/**
*
* @type {Editor}
* @memberof ExternalActionLog
*/
editor: Editor;
/**
* The date this action has been executed
* @type {Date}
* @memberof ExternalActionLog
*/
created: Date;
}
/**
*
* @export
* @interface ExternalActionLogForCreation
*/
export interface ExternalActionLogForCreation {
/**
*
* @type {boolean}
* @memberof ExternalActionLogForCreation
*/
requiresAnonymization: boolean;
/**
*
* @type {ExternalLinkActionLogPayload | ExternalFormActionLogPayload}
* @memberof ExternalActionLogForCreation
*/
actionPayload: ExternalLinkActionLogPayload | ExternalFormActionLogPayload;
}
/**
*
* @export
* @interface ExternalActionLogs
*/
export interface ExternalActionLogs {
/**
*
* @type {Array}
* @memberof ExternalActionLogs
*/
externalActionLogs: Array;
/**
* Total number of found entities for this query
* @type {number}
* @memberof ExternalActionLogs
*/
total: number;
}
/**
* The type of an external action
* @export
* @enum {string}
*/
export enum ExternalActionType {
BLANKLINK = 'BLANK_LINK',
FORM = 'FORM'
}
/**
*
* @export
* @interface ExternalActions
*/
export interface ExternalActions {
/**
*
* @type {Array}
* @memberof ExternalActions
*/
externalActions: Array;
/**
* Total number of found entities for this query
* @type {number}
* @memberof ExternalActions
*/
total: number;
}
/**
*
* @export
* @interface ExternalDocument
*/
export interface ExternalDocument extends VersionedResource {
/**
*
* @type {DocumentType}
* @memberof ExternalDocument
*/
type: DocumentType;
/**
*
* @type {Section}
* @memberof ExternalDocument
*/
section: Section;
/**
*
* @type {string}
* @memberof ExternalDocument
*/
name?: string;
/**
*
* @type {string}
* @memberof ExternalDocument
*/
path?: string;
/**
*
* @type {string}
* @memberof ExternalDocument
*/
id: string;
/**
*
* @type {number}
* @memberof ExternalDocument
*/
priority?: number;
}
/**
*
* @export
* @interface ExternalDocumentContentForUpdate
*/
export interface ExternalDocumentContentForUpdate {
/**
*
* @type {NamedFile}
* @memberof ExternalDocumentContentForUpdate
*/
file: NamedFile;
/**
* Version of documentSet to which this document belongs.
* @type {number}
* @memberof ExternalDocumentContentForUpdate
*/
documentSetVersion: number;
}
/**
*
* @export
* @interface ExternalDocumentForCreation
*/
export interface ExternalDocumentForCreation {
/**
*
* @type {DocumentType}
* @memberof ExternalDocumentForCreation
*/
type: DocumentType;
/**
*
* @type {Section}
* @memberof ExternalDocumentForCreation
*/
section: Section;
/**
*
* @type {NamedFile}
* @memberof ExternalDocumentForCreation
*/
file?: NamedFile;
/**
*
* @type {number}
* @memberof ExternalDocumentForCreation
*/
priority?: number;
}
/**
*
* @export
* @interface ExternalDocumentForUpdate
*/
export interface ExternalDocumentForUpdate extends VersionedResource {
/**
*
* @type {NamedFile}
* @memberof ExternalDocumentForUpdate
*/
file: NamedFile;
}
/**
*
* @export
* @interface ExternalDocumentInSectionForCreation
*/
export interface ExternalDocumentInSectionForCreation {
/**
*
* @type {DocumentType}
* @memberof ExternalDocumentInSectionForCreation
*/
type: DocumentType;
/**
*
* @type {NamedFile}
* @memberof ExternalDocumentInSectionForCreation
*/
file?: NamedFile;
/**
*
* @type {number}
* @memberof ExternalDocumentInSectionForCreation
*/
priority?: number;
}
/**
*
* @export
* @interface ExternalFormActionButton
*/
export interface ExternalFormActionButton {
/**
*
* @type {LocaleString}
* @memberof ExternalFormActionButton
*/
labelLocalized: LocaleString;
/**
*
* @type {string}
* @memberof ExternalFormActionButton
*/
label?: string;
}
/**
*
* @export
* @interface ExternalFormActionDefinition
*/
export interface ExternalFormActionDefinition {
/**
*
* @type {ExternalActionType}
* @memberof ExternalFormActionDefinition
*/
type: ExternalActionType;
/**
*
* @type {Array}
* @memberof ExternalFormActionDefinition
*/
elements: Array;
/**
*
* @type {ExternalFormActionButton}
* @memberof ExternalFormActionDefinition
*/
success: ExternalFormActionButton;
/**
*
* @type {ExternalFormActionButton}
* @memberof ExternalFormActionDefinition
*/
cancel?: ExternalFormActionButton;
}
/**
*
* @export
* @interface ExternalFormActionElement
*/
export interface ExternalFormActionElement {
/**
* it is only allowed to set a style for elementType TEXT
* @type {string}
* @memberof ExternalFormActionElement
*/
style?: ExternalFormActionElement.StyleEnum;
/**
*
* @type {LocaleString}
* @memberof ExternalFormActionElement
*/
titleLocalized: LocaleString;
/**
*
* @type {string}
* @memberof ExternalFormActionElement
*/
title?: string;
/**
*
* @type {ExternalFormActionElementType}
* @memberof ExternalFormActionElement
*/
elementType: ExternalFormActionElementType;
}
/**
* @export
* @namespace ExternalFormActionElement
*/
export namespace ExternalFormActionElement {
/**
* @export
* @enum {string}
*/
export enum StyleEnum {
BODY = 'BODY',
INFO = 'INFO',
WARN = 'WARN',
ERROR = 'ERROR'
}
}
/**
*
* @export
* @enum {string}
*/
export enum ExternalFormActionElementType {
TEXTINPUT = 'TEXT_INPUT',
HEADLINE = 'HEADLINE',
SUBHEADLINE = 'SUBHEADLINE',
TEXT = 'TEXT'
}
/**
*
* @export
* @interface ExternalFormActionInputElement
*/
export interface ExternalFormActionInputElement {
/**
*
* @type {string}
* @memberof ExternalFormActionInputElement
*/
elementId: string;
/**
*
* @type {boolean}
* @memberof ExternalFormActionInputElement
*/
isMandatory?: boolean;
/**
*
* @type {StringValidation | IntegerValidation | FloatValidation}
* @memberof ExternalFormActionInputElement
*/
validation?: StringValidation | IntegerValidation | FloatValidation;
/**
*
* @type {string}
* @memberof ExternalFormActionInputElement
*/
style?: ExternalFormActionInputElement.StyleEnum;
/**
*
* @type {LocaleString}
* @memberof ExternalFormActionInputElement
*/
titleLocalized: LocaleString;
/**
*
* @type {string}
* @memberof ExternalFormActionInputElement
*/
title?: string;
/**
*
* @type {ExternalFormActionElementType}
* @memberof ExternalFormActionInputElement
*/
elementType: ExternalFormActionElementType;
}
/**
* @export
* @namespace ExternalFormActionInputElement
*/
export namespace ExternalFormActionInputElement {
/**
* @export
* @enum {string}
*/
export enum StyleEnum {
BODY = 'BODY',
INFO = 'INFO',
WARN = 'WARN',
ERROR = 'ERROR'
}
}
/**
*
* @export
* @interface ExternalFormActionLogPayload
*/
export interface ExternalFormActionLogPayload {
/**
*
* @type {Array}
* @memberof ExternalFormActionLogPayload
*/
elements: Array;
}
/**
*
* @export
* @interface ExternalFormActionLogPayloadElement
*/
export interface ExternalFormActionLogPayloadElement {
/**
*
* @type {string}
* @memberof ExternalFormActionLogPayloadElement
*/
elementId: string;
/**
*
* @type {string}
* @memberof ExternalFormActionLogPayloadElement
*/
value: string;
}
/**
*
* @export
* @interface ExternalLinkActionDefinition
*/
export interface ExternalLinkActionDefinition {
/**
*
* @type {ExternalActionType}
* @memberof ExternalLinkActionDefinition
*/
type: ExternalActionType;
/**
*
* @type {string}
* @memberof ExternalLinkActionDefinition
*/
linkUrl: string;
}
/**
*
* @export
* @interface ExternalLinkActionLogPayload
*/
export interface ExternalLinkActionLogPayload {
/**
* The date when this link was opened.
* @type {Date}
* @memberof ExternalLinkActionLogPayload
*/
linkOpenedAt: Date;
}
/**
*
* @export
* @interface ExternalPrintableDocumentForCreation
*/
export interface ExternalPrintableDocumentForCreation {
/**
*
* @type {DocumentType}
* @memberof ExternalPrintableDocumentForCreation
*/
type: DocumentType;
/**
*
* @type {NamedFile}
* @memberof ExternalPrintableDocumentForCreation
*/
file?: NamedFile;
/**
*
* @type {number}
* @memberof ExternalPrintableDocumentForCreation
*/
priority?: number;
/**
* Offered operations for this document
* @type {Array}
* @memberof ExternalPrintableDocumentForCreation
*/
operations?: Array;
}
/**
*
* @export
* @interface Facility
*/
export interface Facility extends FacilityForCreation {
/**
* The date this entity was created at the platform. This value is generated by the service.
* @type {Date}
* @memberof Facility
*/
created?: Date;
/**
* The date this entity was modified last. This value is generated by the service.
* @type {Date}
* @memberof Facility
*/
lastModified?: Date;
/**
* The version of the document to be used in optimistic locking mechanisms.
* @type {number}
* @memberof Facility
*/
version: number;
/**
*
* @type {FacilityAddress}
* @memberof Facility
*/
address: FacilityAddress;
/**
*
* @type {Array}
* @memberof Facility
*/
configs?: Array;
/**
* The id of this facility. It is generated during creation automatically and suits as the primary identifier of the described entity.
* @type {string}
* @memberof Facility
*/
id: string;
/**
*
* @type {FacilityStatus}
* @memberof Facility
*/
status: FacilityStatus;
}
/**
* @export
* @namespace Facility
*/
export namespace Facility {
}
/**
*
* @export
* @interface FacilityActionsParameter
*/
export interface FacilityActionsParameter {
}
/**
*
* @export
* @interface FacilityAddress
*/
export interface FacilityAddress extends FacilityAddressForCreation {
/**
*
* @type {TimeZone}
* @memberof FacilityAddress
*/
resolvedTimeZone?: TimeZone;
}
/**
*
* @export
* @interface FacilityAddressForCreation
*/
export interface FacilityAddressForCreation extends Address {
/**
*
* @type {string}
* @memberof FacilityAddressForCreation
*/
companyName: string;
/**
*
* @type {Array}
* @memberof FacilityAddressForCreation
*/
emailAddresses?: Array;
/**
*
* @type {Coordinates}
* @memberof FacilityAddressForCreation
*/
resolvedCoordinates?: Coordinates;
}
/**
*
* @export
* @interface FacilityAddressForCreationEmailAddresses
*/
export interface FacilityAddressForCreationEmailAddresses {
/**
* Human readable information who is the recipient for emails sent to this address.
* @type {string}
* @memberof FacilityAddressForCreationEmailAddresses
*/
recipient?: string;
/**
*
* @type {string}
* @memberof FacilityAddressForCreationEmailAddresses
*/
value: string;
}
/**
*
* @export
* @interface FacilityCarrierConnection
*/
export interface FacilityCarrierConnection extends VersionedResource {
/**
*
* @type {string}
* @memberof FacilityCarrierConnection
*/
id: string;
/**
* The id of the facility reference.
* @type {string}
* @memberof FacilityCarrierConnection
*/
facilityRef: string;
/**
* ID that references the configured carrier.
* @type {string}
* @memberof FacilityCarrierConnection
*/
carrierRef: string;
/**
*
* @type {CarrierDeliveryType}
* @memberof FacilityCarrierConnection
*/
deliveryType?: CarrierDeliveryType;
/**
*
* @type {string}
* @memberof FacilityCarrierConnection
*/
key: string;
/**
* Facility specific configuration for this carrier
* @type {GlsFacilityCarrierConfiguration | AngelFacilityCarrierConfiguration | PostNLFacilityCarrierConfiguration | DpdChFacilityCarrierConfiguration | DhlV2FacilityCarrierConfiguration | VceFacilityCarrierConfiguration | BringFacilityCarrierConfiguration | FedExFacilityCarrierConfiguration}
* @memberof FacilityCarrierConnection
*/
configuration?: GlsFacilityCarrierConfiguration | AngelFacilityCarrierConfiguration | PostNLFacilityCarrierConfiguration | DpdChFacilityCarrierConfiguration | DhlV2FacilityCarrierConfiguration | VceFacilityCarrierConfiguration | BringFacilityCarrierConfiguration | FedExFacilityCarrierConfiguration;
/**
* Facility specific credentials for this carrier
* @type {DHLV2BusinessCredentials | DpdChCarrierCredentials | PostNLCarrierCredentials | VceCarrierCredentials}
* @memberof FacilityCarrierConnection
*/
credentials?: DHLV2BusinessCredentials | DpdChCarrierCredentials | PostNLCarrierCredentials | VceCarrierCredentials;
/**
*
* @type {CutoffTime}
* @memberof FacilityCarrierConnection
*/
cutoffTime?: CutoffTime;
/**
*
* @type {CarrierCutoffTimes}
* @memberof FacilityCarrierConnection
*/
cutoffTimes: CarrierCutoffTimes;
/**
*
* @type {Array}
* @memberof FacilityCarrierConnection
*/
deliveryAreas?: Array;
/**
* This is the well known name for a supported CEP partner. Can be adapted to the clients needs.
* @type {string}
* @memberof FacilityCarrierConnection
*/
name?: string;
/**
*
* @type {CarrierStatus}
* @memberof FacilityCarrierConnection
*/
status: CarrierStatus;
/**
*
* @type {Array}
* @memberof FacilityCarrierConnection
*/
parcelLabelClassifications?: Array;
/**
*
* @type {Array}
* @memberof FacilityCarrierConnection
*/
tags?: Array;
/**
*
* @type {Array}
* @memberof FacilityCarrierConnection
*/
validDeliveryTargets?: Array;
}
/**
*
* @export
* @interface FacilityCarrierConnectionForCreation
*/
export interface FacilityCarrierConnectionForCreation {
/**
* Facility specific credentials for this carrier
* @type {DHLV2BusinessCredentials | DpdChCarrierCredentials | PostNLCarrierCredentials | VceCarrierCredentials}
* @memberof FacilityCarrierConnectionForCreation
*/
credentials?: DHLV2BusinessCredentials | DpdChCarrierCredentials | PostNLCarrierCredentials | VceCarrierCredentials;
/**
* Facility specific configuration for this carrier
* @type {GlsFacilityCarrierConfiguration | AngelFacilityCarrierConfiguration | PostNLFacilityCarrierConfiguration | DpdChFacilityCarrierConfiguration | DhlV2FacilityCarrierConfiguration | VceFacilityCarrierConfiguration | BringFacilityCarrierConfiguration | FedExFacilityCarrierConfiguration}
* @memberof FacilityCarrierConnectionForCreation
*/
configuration?: GlsFacilityCarrierConfiguration | AngelFacilityCarrierConfiguration | PostNLFacilityCarrierConfiguration | DpdChFacilityCarrierConfiguration | DhlV2FacilityCarrierConfiguration | VceFacilityCarrierConfiguration | BringFacilityCarrierConfiguration | FedExFacilityCarrierConfiguration;
/**
*
* @type {CutoffTime}
* @memberof FacilityCarrierConnectionForCreation
*/
cutoffTime?: CutoffTime;
/**
*
* @type {CarrierCutoffTimes}
* @memberof FacilityCarrierConnectionForCreation
*/
cutoffTimes?: CarrierCutoffTimes;
/**
*
* @type {Array}
* @memberof FacilityCarrierConnectionForCreation
*/
deliveryAreas?: Array;
/**
* This is the well known name for a supported CEP partner. Can be adapted to the clients needs.
* @type {string}
* @memberof FacilityCarrierConnectionForCreation
*/
name?: string;
/**
*
* @type {CarrierStatus}
* @memberof FacilityCarrierConnectionForCreation
*/
status?: CarrierStatus;
/**
*
* @type {Array}
* @memberof FacilityCarrierConnectionForCreation
*/
parcelLabelClassifications?: Array;
/**
*
* @type {Array}
* @memberof FacilityCarrierConnectionForCreation
*/
tags?: Array;
/**
*
* @type {Array}
* @memberof FacilityCarrierConnectionForCreation
*/
validDeliveryTargets?: Array;
}
/**
*
* @export
* @interface FacilityCarrierConnectionForModification
*/
export interface FacilityCarrierConnectionForModification {
/**
* Facility specific credentials for this carrier
* @type {DHLV2BusinessCredentials | DpdChCarrierCredentials | PostNLCarrierCredentials | VceCarrierCredentials}
* @memberof FacilityCarrierConnectionForModification
*/
credentials?: DHLV2BusinessCredentials | DpdChCarrierCredentials | PostNLCarrierCredentials | VceCarrierCredentials;
/**
* Facility specific configuration for this carrier
* @type {GlsFacilityCarrierConfiguration | AngelFacilityCarrierConfiguration | PostNLFacilityCarrierConfiguration | DpdChFacilityCarrierConfiguration | DhlV2FacilityCarrierConfiguration | VceFacilityCarrierConfiguration | BringFacilityCarrierConfiguration | FedExFacilityCarrierConfiguration}
* @memberof FacilityCarrierConnectionForModification
*/
configuration?: GlsFacilityCarrierConfiguration | AngelFacilityCarrierConfiguration | PostNLFacilityCarrierConfiguration | DpdChFacilityCarrierConfiguration | DhlV2FacilityCarrierConfiguration | VceFacilityCarrierConfiguration | BringFacilityCarrierConfiguration | FedExFacilityCarrierConfiguration;
/**
*
* @type {CutoffTime}
* @memberof FacilityCarrierConnectionForModification
*/
cutoffTime?: CutoffTime;
/**
*
* @type {CarrierCutoffTimes}
* @memberof FacilityCarrierConnectionForModification
*/
cutoffTimes?: CarrierCutoffTimes;
/**
*
* @type {Array}
* @memberof FacilityCarrierConnectionForModification
*/
deliveryAreas?: Array;
/**
* This is the well known name for a supported CEP partner. Can be adapted to the clients needs.
* @type {string}
* @memberof FacilityCarrierConnectionForModification
*/
name?: string;
/**
*
* @type {CarrierStatus}
* @memberof FacilityCarrierConnectionForModification
*/
status?: CarrierStatus;
/**
*
* @type {Array}
* @memberof FacilityCarrierConnectionForModification
*/
parcelLabelClassifications?: Array;
/**
*
* @type {Array}
* @memberof FacilityCarrierConnectionForModification
*/
tags?: Array;
/**
*
* @type {number}
* @memberof FacilityCarrierConnectionForModification
*/
version: number;
/**
*
* @type {Array}
* @memberof FacilityCarrierConnectionForModification
*/
validDeliveryTargets?: Array;
}
/**
*
* @export
* @interface FacilityCreatedWebHookEvent
*/
export interface FacilityCreatedWebHookEvent extends WebHookEvent {
/**
*
* @type {Facility}
* @memberof FacilityCreatedWebHookEvent
*/
payload: Facility;
}
/**
*
* @export
* @interface FacilityCustomServiceConnection
*/
export interface FacilityCustomServiceConnection extends VersionedResource {
/**
*
* @type {string}
* @memberof FacilityCustomServiceConnection
*/
id: string;
/**
*
* @type {FacilityCustomServiceConnectionStatus}
* @memberof FacilityCustomServiceConnection
*/
status: FacilityCustomServiceConnectionStatus;
/**
*
* @type {string}
* @memberof FacilityCustomServiceConnection
*/
facilityRef: string;
/**
*
* @type {string}
* @memberof FacilityCustomServiceConnection
*/
customServiceRef: string;
/**
*
* @type {number}
* @memberof FacilityCustomServiceConnection
*/
executionTimeInMin?: number;
}
/**
*
* @export
* @interface FacilityCustomServiceConnectionForCreation
*/
export interface FacilityCustomServiceConnectionForCreation {
/**
* Time in minutes the custom service takes to be executed
* @type {number}
* @memberof FacilityCustomServiceConnectionForCreation
*/
executionTimeInMin?: number;
/**
*
* @type {FacilityCustomServiceConnectionStatus}
* @memberof FacilityCustomServiceConnectionForCreation
*/
status: FacilityCustomServiceConnectionStatus;
}
/**
*
* @export
* @interface FacilityCustomServiceConnectionForUpdate
*/
export interface FacilityCustomServiceConnectionForUpdate {
/**
*
* @type {FacilityCustomServiceConnectionStatus}
* @memberof FacilityCustomServiceConnectionForUpdate
*/
status?: FacilityCustomServiceConnectionStatus;
/**
* Time in minutes the custom service takes to be executed
* @type {number}
* @memberof FacilityCustomServiceConnectionForUpdate
*/
executionTimeInMin?: number;
/**
* Version of the documentSet you want to update a document of
* @type {number}
* @memberof FacilityCustomServiceConnectionForUpdate
*/
version: number;
}
/**
*
* @export
* @enum {string}
*/
export enum FacilityCustomServiceConnectionStatus {
ACTIVE = 'ACTIVE',
INACTIVE = 'INACTIVE'
}
/**
*
* @export
* @interface FacilityDecision
*/
export interface FacilityDecision {
/**
*
* @type {DecisionLogFacilityInfo}
* @memberof FacilityDecision
*/
facility: DecisionLogFacilityInfo;
/**
*
* @type {Array}
* @memberof FacilityDecision
*/
orderFences: Array;
/**
*
* @type {Array}
* @memberof FacilityDecision
*/
orderLineItemFences: Array;
/**
*
* @type {Array}
* @memberof FacilityDecision
*/
orderRatings: Array;
/**
*
* @type {Array}
* @memberof FacilityDecision
*/
availabilities: Array;
/**
*
* @type {number}
* @memberof FacilityDecision
*/
totalPenalty?: number;
/**
*
* @type {number}
* @memberof FacilityDecision
*/
rank?: number;
/**
*
* @type {boolean}
* @memberof FacilityDecision
*/
isBestRated?: boolean;
/**
*
* @type {boolean}
* @memberof FacilityDecision
*/
isBestAvailable?: boolean;
/**
*
* @type {boolean}
* @memberof FacilityDecision
*/
isBestReassignmentCandidate?: boolean;
}
/**
*
* @export
* @interface FacilityDeletedWebHookEvent
*/
export interface FacilityDeletedWebHookEvent extends WebHookEvent {
/**
* The id of the deleted facility
* @type {string}
* @memberof FacilityDeletedWebHookEvent
*/
payload: string;
}
/**
*
* @export
* @interface FacilityForCreation
*/
export interface FacilityForCreation {
/**
*
* @type {FacilityAddressForCreation}
* @memberof FacilityForCreation
*/
address: FacilityAddressForCreation;
/**
* Days of the year where the facility is closed and doesn't allows picking
* @type {Array}
* @memberof FacilityForCreation
*/
closingDays?: Array;
/**
*
* @type {FacilityForCreationContact}
* @memberof FacilityForCreation
*/
contact?: FacilityForCreationContact;
/**
* Attributes that can be added to the facility. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
* @type {any}
* @memberof FacilityForCreation
*/
customAttributes?: any;
/**
* Duration in minutes until an order is processed
* @type {number}
* @memberof FacilityForCreation
*/
fulfillmentProcessBuffer?: number;
/**
*
* @type {string}
* @memberof FacilityForCreation
*/
locationType?: FacilityForCreation.LocationTypeEnum;
/**
*
* @type {string}
* @memberof FacilityForCreation
*/
name: string;
/**
* The range in days per facility which defines how many days in the future the capacity of the facility can be planned
* @type {number}
* @memberof FacilityForCreation
*/
capacityPlanningTimeframe?: number;
/**
*
* @type {PickingTimes}
* @memberof FacilityForCreation
*/
pickingTimes?: PickingTimes;
/**
* Picking Methods supported by this facility.
* @type {Array}
* @memberof FacilityForCreation
*/
pickingMethods?: Array;
/**
*
* @type {ScanningRuleConfiguration}
* @memberof FacilityForCreation
*/
scanningRule?: ScanningRuleConfiguration;
/**
*
* @type {Array}
* @memberof FacilityForCreation
*/
services?: Array;
/**
*
* @type {FacilityStatus}
* @memberof FacilityForCreation
*/
status?: FacilityStatus;
/**
* The id of the facility in the tenants own system
* @type {string}
* @memberof FacilityForCreation
*/
tenantFacilityId?: string;
/**
* Indicates that configured capacity limits for picking times are considered
* @type {boolean}
* @memberof FacilityForCreation
*/
capacityEnabled?: boolean;
/**
*
* @type {Array}
* @memberof FacilityForCreation
*/
tags?: Array;
}
/**
* @export
* @namespace FacilityForCreation
*/
export namespace FacilityForCreation {
/**
* @export
* @enum {string}
*/
export enum LocationTypeEnum {
STORE = 'STORE',
WAREHOUSE = 'WAREHOUSE',
EXTERNAL = 'EXTERNAL'
}
}
/**
*
* @export
* @interface FacilityForCreationContact
*/
export interface FacilityForCreationContact {
/**
* Attributes that can be added to the contact. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
* @type {any}
* @memberof FacilityForCreationContact
*/
customAttributes?: any;
/**
*
* @type {string}
* @memberof FacilityForCreationContact
*/
firstName: string;
/**
*
* @type {string}
* @memberof FacilityForCreationContact
*/
lastName: string;
/**
*
* @type {string}
* @memberof FacilityForCreationContact
*/
roleDescription?: string;
}
/**
*
* @export
* @interface FacilityForCreationServices
*/
export interface FacilityForCreationServices {
/**
*
* @type {FacilityServiceType}
* @memberof FacilityForCreationServices
*/
type: FacilityServiceType;
}
/**
* Attribute to order a facility list
* @export
* @enum {string}
*/
export enum FacilityOrderBy {
NAME = 'NAME',
CREATED = 'CREATED',
POSTALCODEASC = 'POSTAL_CODE_ASC'
}
/**
*
* @export
* @interface FacilityPatchActions
*/
export interface FacilityPatchActions {
/**
*
* @type {Array}
* @memberof FacilityPatchActions
*/
actions: Array;
/**
* The version of the document to be used in optimistic locking mechanisms.
* @type {number}
* @memberof FacilityPatchActions
*/
version: number;
}
/**
*
* @export
* @interface FacilityRefLatestPickingStartPair
*/
export interface FacilityRefLatestPickingStartPair {
/**
*
* @type {string}
* @memberof FacilityRefLatestPickingStartPair
*/
facilityRef: string;
/**
*
* @type {Date}
* @memberof FacilityRefLatestPickingStartPair
*/
latestPickingStart: Date;
}
/**
* The description of the service this facility offers.
* @export
* @enum {string}
*/
export enum FacilityServiceType {
SHIPFROMSTORE = 'SHIP_FROM_STORE',
PICKUP = 'PICKUP'
}
/**
* The state of the facility. ONLINE means that this facility can process new orders and pickjobs, SUSPENDED means it cannot get new orders but is able to fulfill the current workload and OFFLINE means that it cannot fulfill any new or existing orders. Processes already running might be rescheduled to another facility depending on the preferences.
* @export
* @enum {string}
*/
export enum FacilityStatus {
ONLINE = 'ONLINE',
SUSPENDED = 'SUSPENDED',
OFFLINE = 'OFFLINE'
}
/**
*
* @export
* @interface FacilityStock
*/
export interface FacilityStock {
/**
*
* @type {number}
* @memberof FacilityStock
*/
available: number;
/**
*
* @type {number}
* @memberof FacilityStock
*/
reserved: number;
/**
*
* @type {number}
* @memberof FacilityStock
*/
value: number;
/**
*
* @type {string}
* @memberof FacilityStock
*/
tenantArticleId: string;
/**
*
* @type {string}
* @memberof FacilityStock
*/
facilityRef: string;
/**
*
* @type {string}
* @memberof FacilityStock
*/
id: string;
}
/**
*
* @export
* @interface FacilityStockBulkOperation
*/
export interface FacilityStockBulkOperation {
/**
*
* @type {string}
* @memberof FacilityStockBulkOperation
*/
tenantArticleId: string;
/**
*
* @type {number}
* @memberof FacilityStockBulkOperation
*/
value: number;
}
/**
*
* @export
* @interface FacilityStockBulkOperations
*/
export interface FacilityStockBulkOperations {
/**
*
* @type {Array}
* @memberof FacilityStockBulkOperations
*/
operations: Array;
}
/**
*
* @export
* @interface FacilityStockBulkResult
*/
export interface FacilityStockBulkResult {
/**
*
* @type {string}
* @memberof FacilityStockBulkResult
*/
tenantArticleId: string;
/**
*
* @type {string}
* @memberof FacilityStockBulkResult
*/
facilityRef: string;
/**
*
* @type {string}
* @memberof FacilityStockBulkResult
*/
status: FacilityStockBulkResult.StatusEnum;
/**
*
* @type {BulkOperationError}
* @memberof FacilityStockBulkResult
*/
error?: BulkOperationError;
}
/**
* @export
* @namespace FacilityStockBulkResult
*/
export namespace FacilityStockBulkResult {
/**
* @export
* @enum {string}
*/
export enum StatusEnum {
UPDATED = 'UPDATED',
CREATED = 'CREATED',
FAILED = 'FAILED'
}
}
/**
*
* @export
* @interface FacilityStockConfiguration
*/
export interface FacilityStockConfiguration extends VersionedResource {
/**
*
* @type {string}
* @memberof FacilityStockConfiguration
*/
id: string;
/**
*
* @type {FacilityStockConfigurationListingReactivationAfter}
* @memberof FacilityStockConfiguration
*/
listingReactivationAfter: FacilityStockConfigurationListingReactivationAfter;
/**
*
* @type {FacilityStockConfigurationRetainedOfflineStock}
* @memberof FacilityStockConfiguration
*/
retainedOfflineStock: FacilityStockConfigurationRetainedOfflineStock;
/**
*
* @type {FacilityStockConfigurationShortpick}
* @memberof FacilityStockConfiguration
*/
shortpick: FacilityStockConfigurationShortpick;
}
/**
*
* @export
* @interface FacilityStockConfigurationListingReactivationAfter
*/
export interface FacilityStockConfigurationListingReactivationAfter {
/**
* The disabling of listings is enabled or disabled.
* @type {boolean}
* @memberof FacilityStockConfigurationListingReactivationAfter
*/
active?: boolean;
/**
* Time in hours that has to pass for a deactivated listing (e.g. due to manual deactivation or as a result of a shortpick ) to be become active again.
* @type {number}
* @memberof FacilityStockConfigurationListingReactivationAfter
*/
value?: number;
}
/**
*
* @export
* @interface FacilityStockConfigurationRetainedOfflineStock
*/
export interface FacilityStockConfigurationRetainedOfflineStock {
/**
* The retained Offline Stock is enabled or disabled.
* @type {boolean}
* @memberof FacilityStockConfigurationRetainedOfflineStock
*/
active?: boolean;
/**
* The overall percentage of stock that should be reserved to offline clients.
* @type {number}
* @memberof FacilityStockConfigurationRetainedOfflineStock
*/
value?: number;
}
/**
*
* @export
* @interface FacilityStockConfigurationShortpick
*/
export interface FacilityStockConfigurationShortpick {
/**
* Inventory adjustment in the case of insufficient order picking
* @type {boolean}
* @memberof FacilityStockConfigurationShortpick
*/
active: boolean;
}
/**
*
* @export
* @interface FacilityStockDistribution
*/
export interface FacilityStockDistribution {
/**
*
* @type {number}
* @memberof FacilityStockDistribution
*/
reserved: number;
/**
*
* @type {number}
* @memberof FacilityStockDistribution
*/
totalAmount: number;
/**
* This field is deprecated and replaced by new availability concepts. Please see https://docs.fulfillmenttools.com/api-docs/use-cases/inventory-management/global-inventory/availability for more information.
* @type {number}
* @memberof FacilityStockDistribution
*/
available: number;
/**
*
* @type {number}
* @memberof FacilityStockDistribution
*/
safetyStock: number;
/**
*
* @type {ByTrait}
* @memberof FacilityStockDistribution
*/
byTrait: ByTrait;
/**
*
* @type {number}
* @memberof FacilityStockDistribution
*/
availableForPicking: number;
/**
* This field is deprecated and replaced by new availability concepts. Please see https://docs.fulfillmenttools.com/api-docs/use-cases/inventory-management/global-inventory/availability for more information.
* @type {number}
* @memberof FacilityStockDistribution
*/
availableToPromise: number;
/**
* This field is deprecated and replaced by new availability concepts. Please see https://docs.fulfillmenttools.com/api-docs/use-cases/inventory-management/global-inventory/availability for more information.
* @type {number}
* @memberof FacilityStockDistribution
*/
readyToPick: number;
/**
*
* @type {number}
* @memberof FacilityStockDistribution
*/
availableOnStock: number;
/**
*
* @type {number}
* @memberof FacilityStockDistribution
*/
stockOnHand: number;
/**
*
* @type {Array}
* @memberof FacilityStockDistribution
*/
channelAdjusted?: Array;
/**
*
* @type {string}
* @memberof FacilityStockDistribution
*/
facilityId: string;
/**
*
* @type {string}
* @memberof FacilityStockDistribution
*/
facilityName: string;
/**
*
* @type {Array}
* @memberof FacilityStockDistribution
*/
facilityServiceTypes?: Array;
/**
*
* @type {FacilityStatus}
* @memberof FacilityStockDistribution
*/
facilityStatus?: FacilityStatus;
/**
*
* @type {number}
* @memberof FacilityStockDistribution
*/
price: number;
}
/**
*
* @export
* @interface FacilityUpdatedWebHookEvent
*/
export interface FacilityUpdatedWebHookEvent extends WebHookEvent {
/**
*
* @type {Facility}
* @memberof FacilityUpdatedWebHookEvent
*/
payload: Facility;
}
/**
*
* @export
* @interface FallbackFacilityConfiguration
*/
export interface FallbackFacilityConfiguration {
/**
*
* @type {Array}
* @memberof FallbackFacilityConfiguration
*/
facilityRefs: Array;
/**
*
* @type {boolean}
* @memberof FallbackFacilityConfiguration
*/
active: boolean;
/**
* Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.
* @type {string}
* @memberof FallbackFacilityConfiguration
*/
fallbackAfterTime: string;
}
/**
*
* @export
* @interface FallbackFacilityConfigurationForPatch
*/
export interface FallbackFacilityConfigurationForPatch {
/**
*
* @type {Array}
* @memberof FallbackFacilityConfigurationForPatch
*/
facilityRefs?: Array;
/**
*
* @type {boolean}
* @memberof FallbackFacilityConfigurationForPatch
*/
active?: boolean;
/**
* Default amount of time in ISO 8601 duration format after which a not routable routingplan is routed to a configured fallback facility.
* @type {string}
* @memberof FallbackFacilityConfigurationForPatch
*/
fallbackAfterTime?: string;
}
/**
*
* @export
* @interface Feature
*/
export interface Feature extends VersionedResource {
/**
*
* @type {string}
* @memberof Feature
*/
name: string;
/**
*
* @type {FeatureStatus}
* @memberof Feature
*/
status: FeatureStatus;
}
/**
*
* @export
* @interface FeaturePatchActions
*/
export interface FeaturePatchActions {
/**
*
* @type {Array