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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<CloseOrderArrival xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</ApiKey>
  <Latitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Latitude>
  <Longitude xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">0</Longitude>
  <OrderNumber>String</OrderNumber>
</CloseOrderArrival>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CloseOrderArrivalResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <Description xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</Heading>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">false</WasSuccessful>
  <CompanyName>String</CompanyName>
  <DestinationDepot>String</DestinationDepot>
  <DriverName>String</DriverName>
  <EstimatedSeals>0</EstimatedSeals>
  <LicensePlate>String</LicensePlate>
  <OperationSummary>
    <MissingSeals>
      <StockOperationSealItem>
        <CurrentWeight>0</CurrentWeight>
        <OperatorName>String</OperatorName>
        <OutletName>String</OutletName>
        <PausedAwaitingAuth>false</PausedAwaitingAuth>
        <PrincipalName>String</PrincipalName>
        <SealNumber>String</SealNumber>
        <UpliftDate>String</UpliftDate>
        <UpliftNumber>String</UpliftNumber>
        <UpliftPdfLink>String</UpliftPdfLink>
        <WeightDifference>0</WeightDifference>
      </StockOperationSealItem>
    </MissingSeals>
    <PausedSeals>
      <StockOperationSealItem>
        <CurrentWeight>0</CurrentWeight>
        <OperatorName>String</OperatorName>
        <OutletName>String</OutletName>
        <PausedAwaitingAuth>false</PausedAwaitingAuth>
        <PrincipalName>String</PrincipalName>
        <SealNumber>String</SealNumber>
        <UpliftDate>String</UpliftDate>
        <UpliftNumber>String</UpliftNumber>
        <UpliftPdfLink>String</UpliftPdfLink>
        <WeightDifference>0</WeightDifference>
      </StockOperationSealItem>
    </PausedSeals>
    <ScannedSeals>
      <StockOperationSealItem>
        <CurrentWeight>0</CurrentWeight>
        <OperatorName>String</OperatorName>
        <OutletName>String</OutletName>
        <PausedAwaitingAuth>false</PausedAwaitingAuth>
        <PrincipalName>String</PrincipalName>
        <SealNumber>String</SealNumber>
        <UpliftDate>String</UpliftDate>
        <UpliftNumber>String</UpliftNumber>
        <UpliftPdfLink>String</UpliftPdfLink>
        <WeightDifference>0</WeightDifference>
      </StockOperationSealItem>
    </ScannedSeals>
    <UnknownUpliftSeals>
      <StockOperationSealItem>
        <CurrentWeight>0</CurrentWeight>
        <OperatorName>String</OperatorName>
        <OutletName>String</OutletName>
        <PausedAwaitingAuth>false</PausedAwaitingAuth>
        <PrincipalName>String</PrincipalName>
        <SealNumber>String</SealNumber>
        <UpliftDate>String</UpliftDate>
        <UpliftNumber>String</UpliftNumber>
        <UpliftPdfLink>String</UpliftPdfLink>
        <WeightDifference>0</WeightDifference>
      </StockOperationSealItem>
    </UnknownUpliftSeals>
    <WeightDifferenceSeals>
      <StockOperationSealItem>
        <CurrentWeight>0</CurrentWeight>
        <OperatorName>String</OperatorName>
        <OutletName>String</OutletName>
        <PausedAwaitingAuth>false</PausedAwaitingAuth>
        <PrincipalName>String</PrincipalName>
        <SealNumber>String</SealNumber>
        <UpliftDate>String</UpliftDate>
        <UpliftNumber>String</UpliftNumber>
        <UpliftPdfLink>String</UpliftPdfLink>
        <WeightDifference>0</WeightDifference>
      </StockOperationSealItem>
    </WeightDifferenceSeals>
  </OperationSummary>
  <OperatorName>String</OperatorName>
  <OrderId>0</OrderId>
  <OrderNumber>String</OrderNumber>
  <RequestingOperatorName>String</RequestingOperatorName>
</CloseOrderArrivalResponse>