Antel API

<back to all web services

CloseOrderArrival

Requires Authentication
The following routes are available for this service:
POST/stock/closeArrival/order
"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 StockOperationSealItem {
    /** @param {{upliftNumber?:string,sealNumber?:string,principalName?:string,currentWeight?:number,weightDifference?:number,operatorName?:string,outletName?:string,upliftDate?:string,pausedAwaitingAuth?:boolean,upliftPdfLink?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    upliftNumber;
    /** @type {string} */
    sealNumber;
    /** @type {string} */
    principalName;
    /** @type {number} */
    currentWeight;
    /** @type {number} */
    weightDifference;
    /** @type {string} */
    operatorName;
    /** @type {string} */
    outletName;
    /** @type {string} */
    upliftDate;
    /** @type {boolean} */
    pausedAwaitingAuth;
    /** @type {string} */
    upliftPdfLink;
}
export class StockOperationSummary {
    /** @param {{scannedSeals?:StockOperationSealItem[],missingSeals?:StockOperationSealItem[],unknownUpliftSeals?:StockOperationSealItem[],pausedSeals?:StockOperationSealItem[],weightDifferenceSeals?:StockOperationSealItem[],hasScannedSeals?:boolean,hasMissingSeals?:boolean,hasWeightDifferenceSeals?:boolean,hasUnknownUpliftSeals?:boolean,hasPausedSeals?:boolean,hasException?:boolean,totalSealsCount?:number,totalSealsWeight?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {StockOperationSealItem[]} */
    scannedSeals;
    /** @type {StockOperationSealItem[]} */
    missingSeals;
    /** @type {StockOperationSealItem[]} */
    unknownUpliftSeals;
    /** @type {StockOperationSealItem[]} */
    pausedSeals;
    /** @type {StockOperationSealItem[]} */
    weightDifferenceSeals;
    /** @type {boolean} */
    hasScannedSeals;
    /** @type {boolean} */
    hasMissingSeals;
    /** @type {boolean} */
    hasWeightDifferenceSeals;
    /** @type {boolean} */
    hasUnknownUpliftSeals;
    /** @type {boolean} */
    hasPausedSeals;
    /** @type {boolean} */
    hasException;
    /** @type {number} */
    totalSealsCount;
    /** @type {number} */
    totalSealsWeight;
}
export class CloseOrderArrivalResponse extends ApiServiceResponse {
    /** @param {{orderNumber?:string,requestingOperatorName?:string,operatorName?:string,destinationDepot?:string,driverName?:string,companyName?:string,licensePlate?:string,orderId?:number,estimatedSeals?:number,operationSummary?:StockOperationSummary,description?:string,heading?:string,wasSuccessful?:boolean,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    orderNumber;
    /** @type {string} */
    requestingOperatorName;
    /** @type {string} */
    operatorName;
    /** @type {string} */
    destinationDepot;
    /** @type {string} */
    driverName;
    /** @type {string} */
    companyName;
    /** @type {string} */
    licensePlate;
    /** @type {number} */
    orderId;
    /** @type {number} */
    estimatedSeals;
    /** @type {StockOperationSummary} */
    operationSummary;
}
export class CloseOrderArrival extends ApiServiceRequest {
    /** @param {{orderNumber?:string,apiKey?:string,latitude?:number,longitude?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    orderNumber;
}

JavaScript CloseOrderArrival DTOs

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

HTTP + OTHER

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

POST /stock/closeArrival/order HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"orderNumber":"String","apiKey":"String","latitude":0,"longitude":0}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"orderNumber":"String","requestingOperatorName":"String","operatorName":"String","destinationDepot":"String","driverName":"String","companyName":"String","licensePlate":"String","orderId":0,"estimatedSeals":0,"operationSummary":{"scannedSeals":[{"upliftNumber":"String","sealNumber":"String","principalName":"String","currentWeight":0,"weightDifference":0,"operatorName":"String","outletName":"String","upliftDate":"String","pausedAwaitingAuth":false,"upliftPdfLink":"String"}],"missingSeals":[{"upliftNumber":"String","sealNumber":"String","principalName":"String","currentWeight":0,"weightDifference":0,"operatorName":"String","outletName":"String","upliftDate":"String","pausedAwaitingAuth":false,"upliftPdfLink":"String"}],"unknownUpliftSeals":[{"upliftNumber":"String","sealNumber":"String","principalName":"String","currentWeight":0,"weightDifference":0,"operatorName":"String","outletName":"String","upliftDate":"String","pausedAwaitingAuth":false,"upliftPdfLink":"String"}],"pausedSeals":[{"upliftNumber":"String","sealNumber":"String","principalName":"String","currentWeight":0,"weightDifference":0,"operatorName":"String","outletName":"String","upliftDate":"String","pausedAwaitingAuth":false,"upliftPdfLink":"String"}],"weightDifferenceSeals":[{"upliftNumber":"String","sealNumber":"String","principalName":"String","currentWeight":0,"weightDifference":0,"operatorName":"String","outletName":"String","upliftDate":"String","pausedAwaitingAuth":false,"upliftPdfLink":"String"}],"hasScannedSeals":true,"hasMissingSeals":true,"hasWeightDifferenceSeals":true,"hasUnknownUpliftSeals":true,"hasPausedSeals":true,"hasException":true,"totalSealsCount":4,"totalSealsWeight":0},"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"}}}