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.

export class ApiServiceRequest implements IServiceRequest, IHasApiKey
{
    /** @description The API Key required for authentication */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    public ApiKey: string;

    public constructor(init?: Partial<ApiServiceRequest>) { (Object as any).assign(this, init); }
}

export class ApiServiceResponse implements IServiceResponse
{
    /** @description Information about the response. */
    // @ApiMember(Description="Information about the response.", IsRequired=true)
    public Description: string;

    /** @description Heading or summary of the response. */
    // @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
    public Heading: string;

    /** @description 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 WasSuccessful: boolean;

    public constructor(init?: Partial<ApiServiceResponse>) { (Object as any).assign(this, init); }
}

export class PlaceOrderFromQuoteResponse extends ApiServiceResponse
{
    /** @description The ID of the order. */
    // @ApiMember(Description="The ID of the order.")
    public OrderId: string;

    /** @description User friendly waybill number */
    // @ApiMember(Description="User friendly waybill number")
    public WayBill: string;

    public constructor(init?: Partial<PlaceOrderFromQuoteResponse>) { super(init); (Object as any).assign(this, init); }
}

export class PlaceOrderFromQuote extends ApiServiceRequest implements ILogRequest
{
    /** @description Optionally provide your own reference identifier */
    // @ApiMember(Description="Optionally provide your own reference identifier")
    public ClientReference: string;

    /** @description The quote the order is for */
    // @ApiMember(Description="The quote the order is for", IsRequired=true)
    public QuoteId: string;

    /** @description 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 Test: boolean;

    /** @description 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 IsUrgent: boolean;

    public constructor(init?: Partial<PlaceOrderFromQuote>) { super(init); (Object as any).assign(this, init); }
}

TypeScript PlaceOrderFromQuote DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
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/csv
Content-Length: length

{"OrderId":"00000000-0000-0000-0000-000000000000","WayBill":"String","Description":"String","Heading":"String","WasSuccessful":false}