| POST | /quote/order | Provide a quoteId to create an order. This will bill the order to your account. |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiServiceRequest(IServiceRequest, IHasApiKey):
# @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
api_key: Optional[str] = None
"""
The API Key required for authentication
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiServiceResponse(IServiceResponse):
# @ApiMember(Description="Information about the response.", IsRequired=true)
description: Optional[str] = None
"""
Information about the response.
"""
# @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
heading: Optional[str] = None
"""
Heading or summary of the response.
"""
# @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
was_successful: bool = False
"""
Did the intended operation for this response complete successfully?
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PlaceOrderFromQuoteResponse(ApiServiceResponse):
# @ApiMember(Description="The ID of the order.")
order_id: Optional[str] = None
"""
The ID of the order.
"""
# @ApiMember(Description="User friendly waybill number")
way_bill: Optional[str] = None
"""
User friendly waybill number
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PlaceOrderFromQuote(ApiServiceRequest, ILogRequest):
# @ApiMember(Description="Optionally provide your own reference identifier")
client_reference: Optional[str] = None
"""
Optionally provide your own reference identifier
"""
# @ApiMember(Description="The quote the order is for", IsRequired=true)
quote_id: Optional[str] = None
"""
The quote the order is for
"""
# @ApiMember(Description="Set this to true to prevent creating an order and billing for it", IsRequired=true)
test: bool = False
"""
Set this to true to prevent creating an order and billing for it
"""
# @ApiMember(Description="Is your account allows Urgent Orders, you can use this flag to indicate when an Order is urgent.")
is_urgent: bool = False
"""
Is your account allows Urgent Orders, you can use this flag to indicate when an Order is urgent.
"""
Python PlaceOrderFromQuote DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=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: api.1fetch.co.za
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}