Antel API

OrderDetail

The following routes are available for this service:
POST	/stock/orderDetail

"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 OrderDetailResponse extends ApiServiceResponse {
    /** @param {{orderId?:number,operatorName?:string,driverName?:string,companyName?:string,licensePlate?:string,orderNumber?:string,destinationDepot?:string,canClose?:boolean,canScan?:boolean,estimatedSeals?:number,scannedSeals?:number,status?:string,description?:string,heading?:string,wasSuccessful?:boolean,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    orderId;
    /** @type {string} */
    operatorName;
    /** @type {string} */
    driverName;
    /** @type {string} */
    companyName;
    /** @type {string} */
    licensePlate;
    /** @type {string} */
    orderNumber;
    /** @type {string} */
    destinationDepot;
    /** @type {boolean} */
    canClose;
    /** @type {boolean} */
    canScan;
    /** @type {number} */
    estimatedSeals;
    /** @type {number} */
    scannedSeals;
    /** @type {string} */
    status;
}
export class OrderDetail extends ApiServiceRequest {
    /** @param {{orderNumber?:string,forOperator?:boolean,apiKey?:string,latitude?:number,longitude?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    orderNumber;
    /** @type {boolean} */
    forOperator;
}

JavaScript OrderDetail DTOs

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

HTTP + CSV

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

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

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

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

{"orderId":0,"operatorName":"String","driverName":"String","companyName":"String","licensePlate":"String","orderNumber":"String","destinationDepot":"String","canClose":false,"canScan":false,"estimatedSeals":0,"scannedSeals":0,"status":"String","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"}}}