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.*;

public class dtos
{

    public static class PlaceOrderFromQuote extends ApiServiceRequest implements ILogRequest
    {
        /**
        * Optionally provide your own reference identifier
        */
        @ApiMember(Description="Optionally provide your own reference identifier")
        public String ClientReference = null;

        /**
        * The quote the order is for
        */
        @ApiMember(Description="The quote the order is for", IsRequired=true)
        public UUID QuoteId = 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)
        public Boolean Test = 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.")
        public Boolean IsUrgent = null;
        
        public String getClientReference() { return ClientReference; }
        public PlaceOrderFromQuote setClientReference(String value) { this.ClientReference = value; return this; }
        public UUID getQuoteId() { return QuoteId; }
        public PlaceOrderFromQuote setQuoteId(UUID value) { this.QuoteId = value; return this; }
        public Boolean isTest() { return Test; }
        public PlaceOrderFromQuote setTest(Boolean value) { this.Test = value; return this; }
        public Boolean getIsUrgent() { return IsUrgent; }
        public PlaceOrderFromQuote setIsUrgent(Boolean value) { this.IsUrgent = value; return this; }
    }

    public static class ApiServiceRequest implements IServiceRequest, IHasApiKey
    {
        /**
        * The API Key required for authentication
        */
        @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
        public String ApiKey = null;
        
        public String getApiKey() { return ApiKey; }
        public ApiServiceRequest setApiKey(String value) { this.ApiKey = value; return this; }
    }

    public static class PlaceOrderFromQuoteResponse extends ApiServiceResponse
    {
        /**
        * The ID of the order.
        */
        @ApiMember(Description="The ID of the order.")
        public UUID OrderId = null;

        /**
        * User friendly waybill number
        */
        @ApiMember(Description="User friendly waybill number")
        public String WayBill = null;
        
        public UUID getOrderId() { return OrderId; }
        public PlaceOrderFromQuoteResponse setOrderId(UUID value) { this.OrderId = value; return this; }
        public String getWayBill() { return WayBill; }
        public PlaceOrderFromQuoteResponse setWayBill(String value) { this.WayBill = value; return this; }
    }

    public static class ApiServiceResponse implements IServiceResponse
    {
        /**
        * Information about the response.
        */
        @ApiMember(Description="Information about the response.", IsRequired=true)
        public String Description = null;

        /**
        * Heading or summary of the response.
        */
        @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
        public String Heading = 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)
        public Boolean WasSuccessful = null;
        
        public String getDescription() { return Description; }
        public ApiServiceResponse setDescription(String value) { this.Description = value; return this; }
        public String getHeading() { return Heading; }
        public ApiServiceResponse setHeading(String value) { this.Heading = value; return this; }
        public Boolean isWasSuccessful() { return WasSuccessful; }
        public ApiServiceResponse setWasSuccessful(Boolean value) { this.WasSuccessful = value; return this; }
    }

}

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