| 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 .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ClientReference: String,
QuoteId: 00000000-0000-0000-0000-000000000000,
Test: False,
IsUrgent: False,
ApiKey: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
OrderId: 00000000-0000-0000-0000-000000000000,
WayBill: String,
Description: String,
Heading: String,
WasSuccessful: False
}