| POST | /quote/order | Provide a quoteId to create an order. This will bill the order to your account. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientReference | body | string | No | Optionally provide your own reference identifier |
| QuoteId | body | Guid | Yes | The quote the order is for |
| Test | body | bool | Yes | Set this to true to prevent creating an order and billing for it |
| IsUrgent | body | bool | No | Is your account allows Urgent Orders, you can use this flag to indicate when an Order is urgent. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | form | string | Yes | The API Key required for authentication |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OrderId | form | Guid | No | The ID of the order. |
| WayBill | form | string | No | User friendly waybill number |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Description | form | string | Yes | Information about the response. |
| Heading | form | string | Yes | Heading or summary of the response. |
| WasSuccessful | form | boolean | Yes | Did the intended operation for this response complete successfully? |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
Content-Type: text/jsonl
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/jsonl
Content-Length: length
{"OrderId":"00000000-0000-0000-0000-000000000000","WayBill":"String","Description":"String","Heading":"String","WasSuccessful":false}