Go-to-Light Service 4.0.0.2397 - 121 - API License to Cloud Demo

<back to all web services

MissionsPush

Requires Authentication
The following routes are available for this service:
All Verbs/MissionsPush
"use strict";
export class Position {
    /** @param {{ID?:number,Key?:string,Pixel?:number,Width?:number,AreaID?:number,AreaLabel?:string,Label?:string,StockroomID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {string} */
    Key;
    /** @type {number} */
    Pixel;
    /** @type {number} */
    Width;
    /** @type {number} */
    AreaID;
    /** @type {string} */
    AreaLabel;
    /** @type {string} */
    Label;
    /** @type {?number} */
    StockroomID;
}
export class TraceabilityMissionDetail {
    /** @param {{IDMissionDetail?:number,PreparedQuantity?:number,Batch?:string,ContainerID?:number,ContainerName?:string,ContainerSizeXCm?:number,ContainerSizeYCm?:number,ContainerSizeZCm?:number,ContainerWeight?:number,StockroomID?:number,StockroomName?:string,Operator?:string,VersionSelected?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    IDMissionDetail;
    /** @type {number} */
    PreparedQuantity;
    /** @type {string} */
    Batch;
    /** @type {number} */
    ContainerID;
    /** @type {string} */
    ContainerName;
    /** @type {number} */
    ContainerSizeXCm;
    /** @type {number} */
    ContainerSizeYCm;
    /** @type {number} */
    ContainerSizeZCm;
    /** @type {number} */
    ContainerWeight;
    /** @type {number} */
    StockroomID;
    /** @type {string} */
    StockroomName;
    /** @type {string} */
    Operator;
    /** @type {string} */
    VersionSelected;
}
export class TraceabilityMissionDetailPacking {
    /** @param {{IDMissionDetail?:number,PreparedQuantity?:number,Batch?:string,ContainerID?:number,ContainerName?:string,ContainerSizeXCm?:number,ContainerSizeYCm?:number,ContainerSizeZCm?:number,ContainerWeight?:number,StockroomID?:number,StockroomName?:string,Operator?:string,VersionSelected?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    IDMissionDetail;
    /** @type {number} */
    PreparedQuantity;
    /** @type {string} */
    Batch;
    /** @type {number} */
    ContainerID;
    /** @type {string} */
    ContainerName;
    /** @type {number} */
    ContainerSizeXCm;
    /** @type {number} */
    ContainerSizeYCm;
    /** @type {number} */
    ContainerSizeZCm;
    /** @type {number} */
    ContainerWeight;
    /** @type {number} */
    StockroomID;
    /** @type {string} */
    StockroomName;
    /** @type {string} */
    Operator;
    /** @type {string} */
    VersionSelected;
}
export class Container {
    /** @param {{ContainerID?:number,ContainerCode?:string,Location?:string,DimensionX?:Object,DimensionY?:Object,DimensionZ?:Object,Deleted?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ContainerID;
    /** @type {string} */
    ContainerCode;
    /** @type {string} */
    Location;
    /** @type {Object} */
    DimensionX;
    /** @type {Object} */
    DimensionY;
    /** @type {Object} */
    DimensionZ;
    /** @type {boolean} */
    Deleted;
}
export class StockAdditional {
    /** @param {{StockID?:number,Gtin?:string,StockLocation?:string,PhysicalQuantityStockLocation?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    StockID;
    /** @type {string} */
    Gtin;
    /** @type {string} */
    StockLocation;
    /** @type {number} */
    PhysicalQuantityStockLocation;
}
export class Stock {
    /** @param {{StockID?:number,ProductID?:string,ProductAttributeID?:string,Reference?:string,Gtin?:string,GtinAttribute?:string,Label?:string,StockLocation?:string,PhysicalQuantityStockLocation?:number,ReserveStockLocation?:string,PhysicalQuantityReserveStockLocation?:number,NbSKUInPackage?:number,PackageReference?:string,NbSKUInPackage2?:number,PackageReference2?:string,Weight?:string,FillInBatchNumber?:boolean,FillInDate?:boolean,PictureURL?:string,StockAdditionals?:StockAdditional[],SearchKey?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    StockID;
    /** @type {string} */
    ProductID;
    /** @type {string} */
    ProductAttributeID;
    /** @type {string} */
    Reference;
    /** @type {string} */
    Gtin;
    /** @type {string} */
    GtinAttribute;
    /** @type {string} */
    Label;
    /** @type {string} */
    StockLocation;
    /** @type {number} */
    PhysicalQuantityStockLocation;
    /** @type {string} */
    ReserveStockLocation;
    /** @type {number} */
    PhysicalQuantityReserveStockLocation;
    /** @type {?number} */
    NbSKUInPackage;
    /** @type {string} */
    PackageReference;
    /** @type {?number} */
    NbSKUInPackage2;
    /** @type {string} */
    PackageReference2;
    /** @type {string} */
    Weight;
    /** @type {boolean} */
    FillInBatchNumber;
    /** @type {boolean} */
    FillInDate;
    /** @type {string} */
    PictureURL;
    /** @type {StockAdditional[]} */
    StockAdditionals = [];
    /** @type {string} */
    SearchKey;
}
export class MissionDetailComment {
    /** @param {{ID?:number,MissionDetailID?:number,Comment?:string,Timestamp?:string,Operator?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {number} */
    MissionDetailID;
    /** @type {string} */
    Comment;
    /** @type {?string} */
    Timestamp;
    /** @type {string} */
    Operator;
}
export class MissionDetail {
    /** @param {{ID?:number,MissionID?:number,Label?:string,Reference?:string,Quantity?:number,PreparedQuantity?:number,PackedQuantity?:number,Positions?:Position[],Tray?:string,StockLocation?:string,LineNumber?:number,Info?:string,GTIN?:string,SupplierReference?:string,PickingIndex?:number,TraceabilityDetails?:TraceabilityMissionDetail[],TraceabilityDetailsPacking?:TraceabilityMissionDetailPacking[],Substitutable?:boolean,SubstitutionRef?:string,TraceabilityBatch?:string,Data1?:string,Data2?:string,Data3?:string,Data4?:string,Data5?:string,Data6?:string,Data7?:string,Data8?:string,Data9?:string,Data10?:string,Data11?:string,Data12?:string,PackageReference?:string,NbSKUInPackage?:number,PackageReference2?:string,NbSKUInPackage2?:number,ContainerID?:number,Container?:Container,WeightPerItemInKg?:number,VolumePerItemInM3?:number,PictureURL?:string,Stock?:Stock,QuantityUnit?:string,Comments?:MissionDetailComment,ShortageQuantity?:number,ItemPreparationDate?:string,CreationDateTime?:string,QuantityDispatched?:number,Versions?:string[],QuantityBreakage?:number,IsProductCritical?:boolean,Owner?:string,StockroomID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {number} */
    MissionID;
    /** @type {string} */
    Label;
    /** @type {string} */
    Reference;
    /** @type {?number} */
    Quantity;
    /** @type {?number} */
    PreparedQuantity;
    /** @type {number} */
    PackedQuantity;
    /** @type {Position[]} */
    Positions = [];
    /** @type {string} */
    Tray;
    /** @type {string} */
    StockLocation;
    /** @type {?number} */
    LineNumber;
    /** @type {string} */
    Info;
    /** @type {string} */
    GTIN;
    /** @type {string} */
    SupplierReference;
    /** @type {number} */
    PickingIndex;
    /** @type {TraceabilityMissionDetail[]} */
    TraceabilityDetails = [];
    /** @type {TraceabilityMissionDetailPacking[]} */
    TraceabilityDetailsPacking = [];
    /** @type {?boolean} */
    Substitutable;
    /** @type {string} */
    SubstitutionRef;
    /** @type {string} */
    TraceabilityBatch;
    /** @type {string} */
    Data1;
    /** @type {string} */
    Data2;
    /** @type {string} */
    Data3;
    /** @type {string} */
    Data4;
    /** @type {string} */
    Data5;
    /** @type {string} */
    Data6;
    /** @type {string} */
    Data7;
    /** @type {string} */
    Data8;
    /** @type {string} */
    Data9;
    /** @type {string} */
    Data10;
    /** @type {string} */
    Data11;
    /** @type {string} */
    Data12;
    /** @type {string} */
    PackageReference;
    /** @type {?number} */
    NbSKUInPackage;
    /** @type {string} */
    PackageReference2;
    /** @type {?number} */
    NbSKUInPackage2;
    /** @type {?number} */
    ContainerID;
    /** @type {Container} */
    Container;
    /** @type {?number} */
    WeightPerItemInKg;
    /** @type {?number} */
    VolumePerItemInM3;
    /** @type {string} */
    PictureURL;
    /** @type {Stock} */
    Stock;
    /** @type {string} */
    QuantityUnit;
    /** @type {MissionDetailComment} */
    Comments;
    /** @type {?number} */
    ShortageQuantity;
    /** @type {?string} */
    ItemPreparationDate;
    /** @type {?string} */
    CreationDateTime;
    /** @type {?number} */
    QuantityDispatched;
    /** @type {string[]} */
    Versions = [];
    /** @type {number} */
    QuantityBreakage;
    /** @type {?boolean} */
    IsProductCritical;
    /** @type {string} */
    Owner;
    /** @type {number} */
    StockroomID;
}
export class Work {
    /** @param {{WorkID?:number,MissionID?:number,Owner?:string,Duration?:string,DateBegin?:string,DateEnd?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    WorkID;
    /** @type {number} */
    MissionID;
    /** @type {string} */
    Owner;
    /** @type {?string} */
    Duration;
    /** @type {?string} */
    DateBegin;
    /** @type {?string} */
    DateEnd;
}
/** @typedef {'New'|'PickingStarted'|'PickingFinished'|'PickingManuallyValidated'|'RamasseFinished'|'PackingFinished'} */
export var MissionState;
(function (MissionState) {
    MissionState["New"] = "New"
    MissionState["PickingStarted"] = "PickingStarted"
    MissionState["PickingFinished"] = "PickingFinished"
    MissionState["PickingManuallyValidated"] = "PickingManuallyValidated"
    MissionState["RamasseFinished"] = "RamasseFinished"
    MissionState["PackingFinished"] = "PackingFinished"
})(MissionState || (MissionState = {}));
export class ShippingDetails {
    /** @param {{MissionID?:number,ShippingWeight?:number,ShippingHeight?:number,ShippingLenght?:number,ShippingWidth?:number,ShippingCompany?:string,ShippingLastname?:string,ShippingFirstname?:string,ShippingAddress1?:string,ShippingAddress2?:string,ShippingAddress3?:string,ShippingPostcode?:string,ShippingCountry?:string,ShippingCity?:string,ShippingOther?:string,ShippingPhone?:string,ShippingMobilePhone?:string,ShippingMail?:string,CarrierName?:string,CarrierProductCode?:string,CarrierTrackingNumber?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    MissionID;
    /** @type {number} */
    ShippingWeight;
    /** @type {number} */
    ShippingHeight;
    /** @type {number} */
    ShippingLenght;
    /** @type {number} */
    ShippingWidth;
    /** @type {string} */
    ShippingCompany;
    /** @type {string} */
    ShippingLastname;
    /** @type {string} */
    ShippingFirstname;
    /** @type {string} */
    ShippingAddress1;
    /** @type {string} */
    ShippingAddress2;
    /** @type {string} */
    ShippingAddress3;
    /** @type {string} */
    ShippingPostcode;
    /** @type {string} */
    ShippingCountry;
    /** @type {string} */
    ShippingCity;
    /** @type {string} */
    ShippingOther;
    /** @type {string} */
    ShippingPhone;
    /** @type {string} */
    ShippingMobilePhone;
    /** @type {string} */
    ShippingMail;
    /** @type {string} */
    CarrierName;
    /** @type {string} */
    CarrierProductCode;
    /** @type {string} */
    CarrierTrackingNumber;
}
export class Mission {
    /** @param {{ID?:number,Name?:string,Info?:string,DeleteWhenComplete?:boolean,DateBegin?:string,DateEnd?:string,Owner?:string,FinderKey?:string,Details?:MissionDetail[],Containers?:Container[],Works?:Work[],Type?:string,Trolley?:string,Printer?:string,Cancelled?:boolean,Blocked?:boolean,MissionModification?:string,Carrier?:string,BatchId?:string,State?:MissionState,RelatedContainersFromOtherMissions?:Container[],TotalQuantity?:number,TotalQuantityPrepared?:number,TotalQuantityDispatched?:number,TotalQuantityPacked?:number,GenericData1?:string,GenericData2?:string,GenericData3?:string,Message?:string,TransportLabelPrinted?:boolean,OutputFileGenerated?:boolean,ShippingDetails?:ShippingDetails,ConnectorOrigin?:string,DispatchAnomalyTempTray?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {string} */
    Name;
    /** @type {string} */
    Info;
    /** @type {?boolean} */
    DeleteWhenComplete;
    /** @type {?string} */
    DateBegin;
    /** @type {?string} */
    DateEnd;
    /** @type {string} */
    Owner;
    /** @type {string} */
    FinderKey;
    /** @type {MissionDetail[]} */
    Details = [];
    /** @type {Container[]} */
    Containers = [];
    /** @type {Work[]} */
    Works = [];
    /** @type {string} */
    Type;
    /** @type {string} */
    Trolley;
    /** @type {string} */
    Printer;
    /** @type {?boolean} */
    Cancelled;
    /** @type {?boolean} */
    Blocked;
    /** @type {string} */
    MissionModification;
    /** @type {string} */
    Carrier;
    /** @type {string} */
    BatchId;
    /** @type {MissionState} */
    State;
    /** @type {Container[]} */
    RelatedContainersFromOtherMissions = [];
    /** @type {number} */
    TotalQuantity;
    /** @type {number} */
    TotalQuantityPrepared;
    /** @type {number} */
    TotalQuantityDispatched;
    /** @type {number} */
    TotalQuantityPacked;
    /** @type {string} */
    GenericData1;
    /** @type {string} */
    GenericData2;
    /** @type {string} */
    GenericData3;
    /** @type {string} */
    Message;
    /** @type {?boolean} */
    TransportLabelPrinted;
    /** @type {?boolean} */
    OutputFileGenerated;
    /** @type {ShippingDetails} */
    ShippingDetails;
    /** @type {string} */
    ConnectorOrigin;
    /** @type {string} */
    DispatchAnomalyTempTray;
}
export class MissionsPush {
    /** @param {{Missions?:Mission[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {Mission[]}
     * @description List of missions to push */
    Missions = [];
}

JavaScript MissionsPush DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /MissionsPush HTTP/1.1 
Host: clouddemo.pickeos.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Missions: 
	[
		{
			ID: 0,
			Name: String,
			Info: String,
			DeleteWhenComplete: False,
			DateBegin: 0001-01-01,
			DateEnd: 0001-01-01,
			Owner: String,
			FinderKey: String,
			Details: 
			[
				{
					ID: 0,
					MissionID: 0,
					Label: String,
					Reference: String,
					Quantity: 0,
					PreparedQuantity: 0,
					PackedQuantity: 0,
					Positions: 
					[
						{
							ID: 0,
							Key: String,
							Pixel: 0,
							Width: 0,
							AreaID: 0,
							AreaLabel: String,
							Label: String,
							StockroomID: 0
						}
					],
					Tray: String,
					StockLocation: String,
					LineNumber: 0,
					Info: String,
					GTIN: String,
					SupplierReference: String,
					PickingIndex: 0,
					TraceabilityDetails: 
					[
						{
							IDMissionDetail: 0,
							PreparedQuantity: 0,
							Batch: String,
							ContainerID: 0,
							ContainerName: String,
							ContainerSizeXCm: 0,
							ContainerSizeYCm: 0,
							ContainerSizeZCm: 0,
							ContainerWeight: 0,
							StockroomID: 0,
							StockroomName: String,
							Operator: String,
							VersionSelected: String
						}
					],
					TraceabilityDetailsPacking: 
					[
						{
							IDMissionDetail: 0,
							PreparedQuantity: 0,
							Batch: String,
							ContainerID: 0,
							ContainerName: String,
							ContainerSizeXCm: 0,
							ContainerSizeYCm: 0,
							ContainerSizeZCm: 0,
							ContainerWeight: 0,
							StockroomID: 0,
							StockroomName: String,
							Operator: String,
							VersionSelected: String
						}
					],
					Substitutable: False,
					SubstitutionRef: String,
					TraceabilityBatch: String,
					Data1: String,
					Data2: String,
					Data3: String,
					Data4: String,
					Data5: String,
					Data6: String,
					Data7: String,
					Data8: String,
					Data9: String,
					Data10: String,
					Data11: String,
					Data12: String,
					PackageReference: String,
					NbSKUInPackage: 0,
					PackageReference2: String,
					NbSKUInPackage2: 0,
					ContainerID: 0,
					Container: 
					{
						ContainerID: 0,
						ContainerCode: String,
						Location: String,
						DimensionX: {},
						DimensionY: {},
						DimensionZ: {},
						Deleted: False
					},
					WeightPerItemInKg: 0,
					VolumePerItemInM3: 0,
					PictureURL: String,
					Stock: 
					{
						StockID: 0,
						ProductID: String,
						ProductAttributeID: String,
						Reference: String,
						Gtin: String,
						GtinAttribute: String,
						Label: String,
						StockLocation: String,
						PhysicalQuantityStockLocation: 0,
						ReserveStockLocation: String,
						PhysicalQuantityReserveStockLocation: 0,
						NbSKUInPackage: 0,
						PackageReference: String,
						NbSKUInPackage2: 0,
						PackageReference2: String,
						Weight: String,
						FillInBatchNumber: False,
						FillInDate: False,
						PictureURL: String,
						StockAdditionals: 
						[
							{
								StockID: 0,
								Gtin: String,
								StockLocation: String,
								PhysicalQuantityStockLocation: 0
							}
						],
						SearchKey: String-String-String-String-String
					},
					QuantityUnit: String,
					Comments: 
					{
						ID: 0,
						MissionDetailID: 0,
						Comment: String,
						Timestamp: 0001-01-01,
						Operator: String
					},
					ShortageQuantity: 0,
					ItemPreparationDate: 0001-01-01,
					CreationDateTime: 0001-01-01,
					QuantityDispatched: 0,
					Versions: 
					[
						String
					],
					QuantityBreakage: 0,
					IsProductCritical: False,
					Owner: String,
					StockroomID: 0
				}
			],
			Containers: 
			[
				{
					ContainerID: 0,
					ContainerCode: String,
					Location: String,
					DimensionX: {},
					DimensionY: {},
					DimensionZ: {},
					Deleted: False
				}
			],
			Works: 
			[
				{
					WorkID: 0,
					MissionID: 0,
					Owner: String,
					Duration: PT0S,
					DateBegin: 0001-01-01,
					DateEnd: 0001-01-01
				}
			],
			Type: String,
			Trolley: String,
			Printer: String,
			Cancelled: False,
			Blocked: False,
			MissionModification: String,
			Carrier: String,
			BatchId: String,
			State: New,
			RelatedContainersFromOtherMissions: 
			[
				{
					ContainerID: 0,
					ContainerCode: String,
					Location: String,
					DimensionX: {},
					DimensionY: {},
					DimensionZ: {},
					Deleted: False
				}
			],
			TotalQuantity: 0,
			TotalQuantityPrepared: 0,
			TotalQuantityDispatched: 0,
			TotalQuantityPacked: 0,
			GenericData1: String,
			GenericData2: String,
			GenericData3: String,
			Message: String,
			TransportLabelPrinted: False,
			OutputFileGenerated: False,
			ShippingDetails: 
			{
				MissionID: 0,
				ShippingWeight: 0,
				ShippingHeight: 0,
				ShippingLenght: 0,
				ShippingWidth: 0,
				ShippingCompany: String,
				ShippingLastname: String,
				ShippingFirstname: String,
				ShippingAddress1: String,
				ShippingAddress2: String,
				ShippingAddress3: String,
				ShippingPostcode: String,
				ShippingCountry: String,
				ShippingCity: String,
				ShippingOther: String,
				ShippingPhone: String,
				ShippingMobilePhone: String,
				ShippingMail: String,
				CarrierName: String,
				CarrierProductCode: String,
				CarrierTrackingNumber: String
			},
			ConnectorOrigin: String,
			DispatchAnomalyTempTray: String
		}
	]
}