///
// 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: any;
}
/**
*
* @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