| POST | /uplift/finalise |
|---|
"use strict";
export class ApiServiceRequest {
/** @param {{apiKey?:string,latitude?:number,longitude?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The API Key required for authentication */
apiKey;
/**
* @type {number}
* @description Latitude of the user making this request */
latitude;
/**
* @type {number}
* @description Longitude of the user making this request */
longitude;
}
export class ApiServiceResponse {
/** @param {{description?:string,heading?:string,wasSuccessful?:boolean,responseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Information about the response. */
description;
/**
* @type {string}
* @description Heading or summary of the response. */
heading;
/**
* @type {boolean}
* @description Did the intended operation for this response complete successfully? */
wasSuccessful;
/** @type {ResponseStatus} */
responseStatus;
}
export class UpliftProductData {
/** @param {{upliftProductId?:number,upliftId?:number,productId?:number,unitPrice?:number,name?:string,category?:string,unitBarcode?:string,unitSize?:string,unitWeight?:number,code?:string,upliftImages?:Object[],quantity?:number,value?:number,priceOverMax?:boolean,quantityOverMax?:boolean,quantityOverRequirement?:boolean,serialNumber?:string,batchCode?:string,stockStatusId?:number,lotNumber?:string,expiryDate?:string,manufactureDate?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
upliftProductId;
/** @type {number} */
upliftId;
/** @type {number} */
productId;
/** @type {number} */
unitPrice;
/** @type {string} */
name;
/** @type {string} */
category;
/** @type {string} */
unitBarcode;
/** @type {string} */
unitSize;
/** @type {number} */
unitWeight;
/** @type {string} */
code;
/** @type {Object[]} */
upliftImages;
/** @type {number} */
quantity;
/** @type {number} */
value;
/** @type {boolean} */
priceOverMax;
/** @type {boolean} */
quantityOverMax;
/** @type {boolean} */
quantityOverRequirement;
/** @type {string} */
serialNumber;
/** @type {string} */
batchCode;
/** @type {number} */
stockStatusId;
/** @type {string} */
lotNumber;
/** @type {string} */
expiryDate;
/** @type {string} */
manufactureDate;
}
export class UpliftSealData {
/** @param {{unbagged?:boolean,sealNumber?:string,antelSealNumber?:string,products?:UpliftProductData[],totalPrice?:number,totalQuantity?:number,netWeight?:number,grossWeight?:number,billableSeal?:boolean,invalidAntelSealNumber?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {boolean} */
unbagged;
/** @type {string} */
sealNumber;
/** @type {string} */
antelSealNumber;
/** @type {UpliftProductData[]} */
products;
/** @type {number} */
totalPrice;
/** @type {number} */
totalQuantity;
/** @type {number} */
netWeight;
/** @type {number} */
grossWeight;
/** @type {boolean} */
billableSeal;
/** @type {boolean} */
invalidAntelSealNumber;
}
export class UpliftClaimData {
/** @param {{upliftClaimId?:number,claimUnits?:number,claimNumber?:string,claimValue?:number,claimDocumentImages?:Object[],returnOrderNumber?:string,lineCount?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
upliftClaimId;
/** @type {number} */
claimUnits;
/** @type {string} */
claimNumber;
/** @type {number} */
claimValue;
/** @type {Object[]} */
claimDocumentImages;
/** @type {string} */
returnOrderNumber;
/** @type {number} */
lineCount;
}
export class SaveUpliftResponse extends ApiServiceResponse {
/** @param {{upliftId?:number,upliftAuthRequestId?:string,seals?:UpliftSealData[],unbaggedItems?:UpliftSealData,claims?:UpliftClaimData[],deleteFromDevice?:boolean,imageIds?:string[],invalidAntelSeal?:boolean,description?:string,heading?:string,wasSuccessful?:boolean,responseStatus?:ResponseStatus}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {number} */
upliftId;
/** @type {string} */
upliftAuthRequestId;
/** @type {UpliftSealData[]} */
seals;
/** @type {UpliftSealData} */
unbaggedItems;
/** @type {UpliftClaimData[]} */
claims;
/** @type {boolean} */
deleteFromDevice;
/** @type {string[]} */
imageIds;
/** @type {boolean} */
invalidAntelSeal;
}
export class FinaliseUplift extends ApiServiceRequest {
/** @param {{upliftId?:number,incompleteUpliftId?:string,apiKey?:string,latitude?:number,longitude?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {number} */
upliftId;
/** @type {string} */
incompleteUpliftId;
}
JavaScript FinaliseUplift DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /uplift/finalise HTTP/1.1
Host: antel.api.dev.86degrees.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
upliftId: 0,
apiKey: String,
latitude: 0,
longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
upliftId: 0,
seals:
[
{
unbagged: False,
sealNumber: String,
antelSealNumber: String,
products:
[
{
upliftProductId: 0,
upliftId: 0,
productId: 0,
unitPrice: 0,
name: String,
category: String,
unitBarcode: String,
unitSize: String,
unitWeight: 0,
code: String,
upliftImages:
[
{
}
],
quantity: 0,
value: 0,
priceOverMax: False,
quantityOverMax: False,
quantityOverRequirement: False,
serialNumber: String,
batchCode: String,
stockStatusId: 0,
lotNumber: String,
expiryDate: String,
manufactureDate: String
}
],
totalPrice: 0,
totalQuantity: 0,
netWeight: 0,
grossWeight: 0,
billableSeal: False,
invalidAntelSealNumber: False
}
],
unbaggedItems:
{
unbagged: False,
sealNumber: String,
antelSealNumber: String,
products:
[
{
upliftProductId: 0,
upliftId: 0,
productId: 0,
unitPrice: 0,
name: String,
category: String,
unitBarcode: String,
unitSize: String,
unitWeight: 0,
code: String,
upliftImages:
[
{
}
],
quantity: 0,
value: 0,
priceOverMax: False,
quantityOverMax: False,
quantityOverRequirement: False,
serialNumber: String,
batchCode: String,
stockStatusId: 0,
lotNumber: String,
expiryDate: String,
manufactureDate: String
}
],
totalPrice: 0,
totalQuantity: 0,
netWeight: 0,
grossWeight: 0,
billableSeal: False,
invalidAntelSealNumber: False
},
claims:
[
{
upliftClaimId: 0,
claimUnits: 0,
claimNumber: String,
claimValue: 0,
claimDocumentImages:
[
{
}
],
returnOrderNumber: String,
lineCount: 0
}
],
deleteFromDevice: False,
imageIds:
[
String
],
invalidAntelSeal: False,
description: String,
heading: String,
wasSuccessful: False,
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}