| Name | Description | Type | Additional information |
|---|---|---|---|
| ID |
Caliq internal order/credit/return id |
integer |
None. |
| Kind |
Type of order (Order,Credit,Return) |
string |
Max length: 15 |
| Created |
Date created in YYYYMMDD format |
string |
Max length: 10 |
| Number |
User facing reference for the 'order'. NOTE: It is possible to have an order,credit and return all with the same order number. It is only unique within the Kind |
integer |
None. |
| Description | string |
Max length: 50 |
|
| ChannelID |
Channel ID for this order/credit/return |
integer |
None. |
| AccountNo |
Caliq customer account number |
string |
None. |
| AccountID |
Caliq internal cusomer identifier |
integer |
None. |
| Status |
'In Progress' , 'Cancelled' , 'Complete' |
string |
Max length: 20 |
| Editable |
Is this order editable via the OrderEdit API call |
boolean |
None. |
| Currency | string |
Max length: 3 |
|
| Active |
Is this considered active or not? |
boolean |
None. |
| Value |
Monetary value of order in above currency, excluding VAT |
decimal number |
None. |
| ValueVAT |
VAT value of order in above currency |
decimal number |
None. |
| Carriage |
Monetary value of carriage in above currency, excluding VAT |
decimal number |
None. |
| CarriageVAT |
VAT value of carriage in above currency |
decimal number |
None. |
| WebOrderRef |
Order reference captured from website |
string |
Max length: 50 |
| CustomerPONo |
Customer purchase order number |
string |
Max length: 20 |
| Bill_Line1 |
Order billing address |
string |
Max length: 50 |
| Bill_Line2 | string |
Max length: 50 |
|
| Bill_Line3 | string |
Max length: 50 |
|
| Bill_Town | string |
Max length: 50 |
|
| Bill_County | string |
Max length: 25 |
|
| Bill_Country |
Country code, derived from country table |
string |
Max length: 3 |
| Bill_Postcode | string |
Max length: 15 |
|
| Bill_AddressID |
Internal Caliq ID of this address |
integer |
None. |
| Del_Line1 |
Order delivery address |
string |
Max length: 40 |
| Del_Company | string |
Max length: 50 |
|
| Del_Line2 | string |
Max length: 50 |
|
| Del_Line3 | string |
Max length: 50 |
|
| Del_Town | string |
Max length: 50 |
|
| Del_County | string |
Max length: 25 |
|
| Del_Country |
Country code, derived from country table |
string |
Max length: 3 |
| Del_Postcode | string |
Max length: 15 |
|
| Del_AddressID |
Internal Caliq ID of this address |
integer |
None. |
| ContactIDOrder |
Caliq internal ID of the ordering contact |
integer |
None. |
| ContactIDDeliver |
Caliq internal ID of the delivery contact |
integer |
None. |
| ContactIDInvoice |
Caliq internal ID of the invoice contact |
integer |
None. |
| RequiredDelivery |
Required delivery date for the order in YYYYMMDD format |
string |
None. |
| SalesRep |
Name of the sales representative for this order |
string |
Max length: 100 |
| SalesRepID |
ID of the sales representative for this order |
string |
Max length: 10 |
| AccountMgr |
Name of the account manager for this order |
string |
Max length: 100 |
| AccountMgrID |
ID of the account manager for this order |
string |
Max length: 10 |
| OfficeRep |
Name of the office representative for this order |
string |
Max length: 100 |
| OfficeRepID |
ID of the office representative for this order |
string |
Max length: 10 |
| WHActions |
Warehouse events made against this order |
WHActions |
None. |
| Despatches |
Despatches made against this order |
Despatches |
None. |
| EventInvoices |
Invoices and credits raised against this order |
EventInvoices |
None. |
| EventPayments |
Payments against this order |
EventPayments |
None. |
| EventDocuments |
All PDF documents available for this order |
EventDocuments |
None. |
| OrderLines |
Order line details. Not returned unless asked for in parameters |
OrderLines |
None. |