| 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 = [];
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<MissionsPush xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoToLightAPI">
<Missions>
<Mission>
<BatchId>String</BatchId>
<Blocked>false</Blocked>
<Cancelled>false</Cancelled>
<Carrier>String</Carrier>
<ConnectorOrigin>String</ConnectorOrigin>
<Containers>
<Container>
<ContainerCode>String</ContainerCode>
<ContainerID>0</ContainerID>
<Deleted>false</Deleted>
<DimensionX />
<DimensionY />
<DimensionZ />
<Location>String</Location>
</Container>
</Containers>
<DateBegin>0001-01-01T00:00:00</DateBegin>
<DateEnd>0001-01-01T00:00:00</DateEnd>
<DeleteWhenComplete>false</DeleteWhenComplete>
<Details>
<MissionDetail>
<Comments>
<Comment>String</Comment>
<ID>0</ID>
<MissionDetailID>0</MissionDetailID>
<Operator>String</Operator>
<Timestamp>0001-01-01T00:00:00</Timestamp>
</Comments>
<Container>
<ContainerCode>String</ContainerCode>
<ContainerID>0</ContainerID>
<Deleted>false</Deleted>
<DimensionX />
<DimensionY />
<DimensionZ />
<Location>String</Location>
</Container>
<ContainerID>0</ContainerID>
<CreationDateTime>0001-01-01T00:00:00</CreationDateTime>
<Data1>String</Data1>
<Data10>String</Data10>
<Data11>String</Data11>
<Data12>String</Data12>
<Data2>String</Data2>
<Data3>String</Data3>
<Data4>String</Data4>
<Data5>String</Data5>
<Data6>String</Data6>
<Data7>String</Data7>
<Data8>String</Data8>
<Data9>String</Data9>
<GTIN>String</GTIN>
<ID>0</ID>
<Info>String</Info>
<IsProductCritical>false</IsProductCritical>
<ItemPreparationDate>0001-01-01T00:00:00</ItemPreparationDate>
<Label>String</Label>
<LineNumber>0</LineNumber>
<MissionID>0</MissionID>
<NbSKUInPackage>0</NbSKUInPackage>
<NbSKUInPackage2>0</NbSKUInPackage2>
<Owner>String</Owner>
<PackageReference>String</PackageReference>
<PackageReference2>String</PackageReference2>
<PackedQuantity>0</PackedQuantity>
<PickingIndex>0</PickingIndex>
<PictureURL>String</PictureURL>
<Positions>
<Position>
<AreaID>0</AreaID>
<AreaLabel>String</AreaLabel>
<ID>0</ID>
<Key>String</Key>
<Label>String</Label>
<Pixel>0</Pixel>
<StockroomID>0</StockroomID>
<Width>0</Width>
</Position>
</Positions>
<PreparedQuantity>0</PreparedQuantity>
<Quantity>0</Quantity>
<QuantityBreakage>0</QuantityBreakage>
<QuantityDispatched>0</QuantityDispatched>
<QuantityUnit>String</QuantityUnit>
<Reference>String</Reference>
<ShortageQuantity>0</ShortageQuantity>
<Stock>
<FillInBatchNumber>false</FillInBatchNumber>
<FillInDate>false</FillInDate>
<Gtin>String</Gtin>
<GtinAttribute>String</GtinAttribute>
<Label>String</Label>
<NbSKUInPackage>0</NbSKUInPackage>
<NbSKUInPackage2>0</NbSKUInPackage2>
<PackageReference>String</PackageReference>
<PackageReference2>String</PackageReference2>
<PhysicalQuantityReserveStockLocation>0</PhysicalQuantityReserveStockLocation>
<PhysicalQuantityStockLocation>0</PhysicalQuantityStockLocation>
<PictureURL>String</PictureURL>
<ProductAttributeID>String</ProductAttributeID>
<ProductID>String</ProductID>
<Reference>String</Reference>
<ReserveStockLocation>String</ReserveStockLocation>
<StockAdditionals>
<StockAdditional>
<Gtin>String</Gtin>
<PhysicalQuantityStockLocation>0</PhysicalQuantityStockLocation>
<StockID>0</StockID>
<StockLocation>String</StockLocation>
</StockAdditional>
</StockAdditionals>
<StockID>0</StockID>
<StockLocation>String</StockLocation>
<Weight>String</Weight>
</Stock>
<StockLocation>String</StockLocation>
<StockroomID>0</StockroomID>
<Substitutable>false</Substitutable>
<SubstitutionRef>String</SubstitutionRef>
<SupplierReference>String</SupplierReference>
<TraceabilityBatch>String</TraceabilityBatch>
<TraceabilityDetails>
<TraceabilityMissionDetail>
<Batch>String</Batch>
<ContainerID>0</ContainerID>
<ContainerName>String</ContainerName>
<ContainerSizeXCm>0</ContainerSizeXCm>
<ContainerSizeYCm>0</ContainerSizeYCm>
<ContainerSizeZCm>0</ContainerSizeZCm>
<ContainerWeight>0</ContainerWeight>
<IDMissionDetail>0</IDMissionDetail>
<Operator>String</Operator>
<PreparedQuantity>0</PreparedQuantity>
<StockroomID>0</StockroomID>
<StockroomName>String</StockroomName>
<VersionSelected>String</VersionSelected>
</TraceabilityMissionDetail>
</TraceabilityDetails>
<TraceabilityDetailsPacking>
<TraceabilityMissionDetailPacking>
<Batch>String</Batch>
<ContainerID>0</ContainerID>
<ContainerName>String</ContainerName>
<ContainerSizeXCm>0</ContainerSizeXCm>
<ContainerSizeYCm>0</ContainerSizeYCm>
<ContainerSizeZCm>0</ContainerSizeZCm>
<ContainerWeight>0</ContainerWeight>
<IDMissionDetail>0</IDMissionDetail>
<Operator>String</Operator>
<PreparedQuantity>0</PreparedQuantity>
<StockroomID>0</StockroomID>
<StockroomName>String</StockroomName>
<VersionSelected>String</VersionSelected>
</TraceabilityMissionDetailPacking>
</TraceabilityDetailsPacking>
<Tray>String</Tray>
<Versions xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>String</d6p1:string>
</Versions>
<VolumePerItemInM3>0</VolumePerItemInM3>
<WeightPerItemInKg>0</WeightPerItemInKg>
</MissionDetail>
</Details>
<DispatchAnomalyTempTray>String</DispatchAnomalyTempTray>
<FinderKey>String</FinderKey>
<GenericData1>String</GenericData1>
<GenericData2>String</GenericData2>
<GenericData3>String</GenericData3>
<ID>0</ID>
<Info>String</Info>
<Message>String</Message>
<MissionModification>String</MissionModification>
<Name>String</Name>
<OutputFileGenerated>false</OutputFileGenerated>
<Owner>String</Owner>
<Printer>String</Printer>
<RelatedContainersFromOtherMissions>
<Container>
<ContainerCode>String</ContainerCode>
<ContainerID>0</ContainerID>
<Deleted>false</Deleted>
<DimensionX />
<DimensionY />
<DimensionZ />
<Location>String</Location>
</Container>
</RelatedContainersFromOtherMissions>
<ShippingDetails>
<CarrierName>String</CarrierName>
<CarrierProductCode>String</CarrierProductCode>
<CarrierTrackingNumber>String</CarrierTrackingNumber>
<MissionID>0</MissionID>
<ShippingAddress1>String</ShippingAddress1>
<ShippingAddress2>String</ShippingAddress2>
<ShippingAddress3>String</ShippingAddress3>
<ShippingCity>String</ShippingCity>
<ShippingCompany>String</ShippingCompany>
<ShippingCountry>String</ShippingCountry>
<ShippingFirstname>String</ShippingFirstname>
<ShippingHeight>0</ShippingHeight>
<ShippingLastname>String</ShippingLastname>
<ShippingLenght>0</ShippingLenght>
<ShippingMail>String</ShippingMail>
<ShippingMobilePhone>String</ShippingMobilePhone>
<ShippingOther>String</ShippingOther>
<ShippingPhone>String</ShippingPhone>
<ShippingPostcode>String</ShippingPostcode>
<ShippingWeight>0</ShippingWeight>
<ShippingWidth>0</ShippingWidth>
</ShippingDetails>
<State>New</State>
<TotalQuantity>0</TotalQuantity>
<TotalQuantityDispatched>0</TotalQuantityDispatched>
<TotalQuantityPacked>0</TotalQuantityPacked>
<TotalQuantityPrepared>0</TotalQuantityPrepared>
<TransportLabelPrinted>false</TransportLabelPrinted>
<Trolley>String</Trolley>
<Type>String</Type>
<Works>
<Work>
<DateBegin>0001-01-01T00:00:00</DateBegin>
<DateEnd>0001-01-01T00:00:00</DateEnd>
<Duration>PT0S</Duration>
<MissionID>0</MissionID>
<Owner>String</Owner>
<WorkID>0</WorkID>
</Work>
</Works>
</Mission>
</Missions>
</MissionsPush>