1Fetch Client API

PlaceOrderFromQuote

The following routes are available for this service:
POST	/quote/order	Provide a quoteId to create an order. This will bill the order to your account.

"use strict";
export class ApiServiceRequest {
    /** @param {{ApiKey?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The API Key required for authentication */
    ApiKey;
}
export class ApiServiceResponse {
    /** @param {{Description?:string,Heading?:string,WasSuccessful?:boolean}} [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;
}
export class PlaceOrderFromQuoteResponse extends ApiServiceResponse {
    /** @param {{OrderId?:string,WayBill?:string,Description?:string,Heading?:string,WasSuccessful?:boolean}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {string}
     * @description The ID of the order. */
    OrderId;
    /**
     * @type {string}
     * @description User friendly waybill number */
    WayBill;
}
export class PlaceOrderFromQuote extends ApiServiceRequest {
    /** @param {{ClientReference?:string,QuoteId?:string,Test?:boolean,IsUrgent?:boolean,ApiKey?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {string}
     * @description Optionally provide your own reference identifier */
    ClientReference;
    /**
     * @type {string}
     * @description The quote the order is for */
    QuoteId;
    /**
     * @type {boolean}
     * @description Set this to true to prevent creating an order and billing for it */
    Test;
    /**
     * @type {boolean}
     * @description Is your account allows Urgent Orders, you can use this flag to indicate when an Order is urgent. */
    IsUrgent;
}

JavaScript PlaceOrderFromQuote 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 /quote/order HTTP/1.1 
Host: api.1fetch.co.za 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PlaceOrderFromQuote xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">String</ApiKey>
  <ClientReference>String</ClientReference>
  <IsUrgent>false</IsUrgent>
  <QuoteId>00000000-0000-0000-0000-000000000000</QuoteId>
  <Test>false</Test>
</PlaceOrderFromQuote>

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

<PlaceOrderFromQuoteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel">
  <Description xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">String</Heading>
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">false</WasSuccessful>
  <OrderId>00000000-0000-0000-0000-000000000000</OrderId>
  <WayBill>String</WayBill>
</PlaceOrderFromQuoteResponse>