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.

import java.math.*
import java.util.*
import net.servicestack.client.*


open class PlaceOrderFromQuote : ApiServiceRequest(), ILogRequest
{
    /**
    * Optionally provide your own reference identifier
    */
    @ApiMember(Description="Optionally provide your own reference identifier")
    var ClientReference:String? = null

    /**
    * The quote the order is for
    */
    @ApiMember(Description="The quote the order is for", IsRequired=true)
    var QuoteId:UUID? = null

    /**
    * Set this to true to prevent creating an order and billing for it
    */
    @ApiMember(Description="Set this to true to prevent creating an order and billing for it", IsRequired=true)
    var Test:Boolean? = null

    /**
    * Is your account allows Urgent Orders, you can use this flag to indicate when an Order is urgent.
    */
    @ApiMember(Description="Is your account allows Urgent Orders, you can use this flag to indicate when an Order is urgent.")
    var IsUrgent:Boolean? = null
}

open class ApiServiceRequest : IServiceRequest, IHasApiKey
{
    /**
    * The API Key required for authentication
    */
    @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    var ApiKey:String? = null
}

open class PlaceOrderFromQuoteResponse : ApiServiceResponse()
{
    /**
    * The ID of the order.
    */
    @ApiMember(Description="The ID of the order.")
    var OrderId:UUID? = null

    /**
    * User friendly waybill number
    */
    @ApiMember(Description="User friendly waybill number")
    var WayBill:String? = null
}

open class ApiServiceResponse : IServiceResponse
{
    /**
    * Information about the response.
    */
    @ApiMember(Description="Information about the response.", IsRequired=true)
    var Description:String? = null

    /**
    * Heading or summary of the response.
    */
    @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
    var Heading:String? = null

    /**
    * Did the intended operation for this response complete successfully?
    */
    @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
    var WasSuccessful:Boolean? = null
}

Kotlin 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>