1Fetch Client API

<back to all web services

PlaceOrderFromQuote

The following routes are available for this service:
POST/quote/orderProvide a quoteId to create an order. This will bill the order to your account.
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports WebService.ClientServiceModel
Imports WebService.ClientServiceModel.Base

Namespace Global

    Namespace WebService.ClientServiceModel

        Public Partial Class PlaceOrderFromQuote
            Inherits ApiServiceRequest
            Implements ILogRequest
            '''<Summary>
            '''Optionally provide your own reference identifier
            '''</Summary>
            <ApiMember(Description:="Optionally provide your own reference identifier")>
            Public Overridable Property ClientReference As String

            '''<Summary>
            '''The quote the order is for
            '''</Summary>
            <ApiMember(Description:="The quote the order is for", IsRequired:=true)>
            Public Overridable Property QuoteId As Guid

            '''<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)>
            Public Overridable Property Test As Boolean

            '''<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.")>
            Public Overridable Property IsUrgent As Boolean
        End Class

        Public Partial Class PlaceOrderFromQuoteResponse
            Inherits ApiServiceResponse
            '''<Summary>
            '''The ID of the order.
            '''</Summary>
            <ApiMember(Description:="The ID of the order.")>
            Public Overridable Property OrderId As Guid

            '''<Summary>
            '''User friendly waybill number
            '''</Summary>
            <ApiMember(Description:="User friendly waybill number")>
            Public Overridable Property WayBill As String
        End Class
    End Namespace

    Namespace WebService.ClientServiceModel.Base

        Public Partial Class ApiServiceRequest
            Implements IServiceRequest
            Implements IHasApiKey
            '''<Summary>
            '''The API Key required for authentication
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The API Key required for authentication", IsRequired:=true)>
            Public Overridable Property ApiKey As String
        End Class

        Public Partial Class ApiServiceResponse
            Implements IServiceResponse
            '''<Summary>
            '''Information about the response.
            '''</Summary>
            <ApiMember(Description:="Information about the response.", IsRequired:=true)>
            Public Overridable Property Description As String

            '''<Summary>
            '''Heading or summary of the response.
            '''</Summary>
            <ApiMember(Description:="Heading or summary of the response.", IsRequired:=true)>
            Public Overridable Property Heading As String

            '''<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)>
            Public Overridable Property WasSuccessful As Boolean
        End Class
    End Namespace
End Namespace

VB.NET PlaceOrderFromQuote DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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: 1fetch.api.client.prod.86degrees.com 
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
}