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.

namespace WebService.ClientServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ApiServiceResponse() = 
        ///<summary>
        ///Information about the response.
        ///</summary>
        [<ApiMember(Description="Information about the response.", IsRequired=true)>]
        member val Description:String = null with get,set

        ///<summary>
        ///Heading or summary of the response.
        ///</summary>
        [<ApiMember(Description="Heading or summary of the response.", IsRequired=true)>]
        member val Heading:String = null with get,set

        ///<summary>
        ///Did the intended operation for this response complete successfully?
        ///</summary>
        [<ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)>]
        member val WasSuccessful:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type PlaceOrderFromQuoteResponse() = 
        inherit ApiServiceResponse()
        ///<summary>
        ///The ID of the order.
        ///</summary>
        [<ApiMember(Description="The ID of the order.")>]
        member val OrderId:Guid = new Guid() with get,set

        ///<summary>
        ///User friendly waybill number
        ///</summary>
        [<ApiMember(Description="User friendly waybill number")>]
        member val WayBill:String = null with get,set

    [<AllowNullLiteral>]
    type ApiServiceRequest() = 
        ///<summary>
        ///The API Key required for authentication
        ///</summary>
        [<ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)>]
        member val ApiKey:String = null with get,set

    [<AllowNullLiteral>]
    type PlaceOrderFromQuote() = 
        inherit ApiServiceRequest()
        ///<summary>
        ///Optionally provide your own reference identifier
        ///</summary>
        [<ApiMember(Description="Optionally provide your own reference identifier")>]
        member val ClientReference:String = null with get,set

        ///<summary>
        ///The quote the order is for
        ///</summary>
        [<ApiMember(Description="The quote the order is for", IsRequired=true)>]
        member val QuoteId:Guid = new Guid() with get,set

        ///<summary>
        ///Set this to true to prevent creating an order and billing for it
        ///</summary>
        [<ApiMember(Description="Set this to true to prevent creating an order and billing for it", IsRequired=true)>]
        member val Test:Boolean = new Boolean() with get,set

        ///<summary>
        ///Is your account allows Urgent Orders, you can use this flag to indicate when an Order is urgent.
        ///</summary>
        [<ApiMember(Description="Is your account allows Urgent Orders, you can use this flag to indicate when an Order is urgent.")>]
        member val IsUrgent:Boolean = new Boolean() with get,set

F# 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>