| Name | Description | Type | Additional information |
|---|---|---|---|
| apiKey |
Please contact Caliq support to get your key |
string |
Required |
| LockID | integer |
Required |
|
| CustomerID |
Caliq internal unique customer identifier. Must be supplied if AccountNo is omitted |
integer |
None. |
| AccountNo |
User entered unique customer account number. Must be supplied if CustomerID is omitted |
string |
Required Max length: 10 |
| EventID |
Caliq internal id of event to be edited |
integer |
Required |
| CustomerPONumber |
Customer's purchase order number - send null to leave as is |
string |
Max length: 20 |
| OrderNotes |
User entered notes to be shown on despatch paperwork. Send null to leave as is' |
string |
None. |
| DeliveryRequirement |
(A)sap, on (D)ate, (W)eek commencing - send null to leave unchanged |
string |
Max length: 1 |
| DeliveryRequirementDate |
If DeliveryRequirement is D or W this is the date in YYYYMMDD format |
string |
None. |
| DespatchMethodID |
Must be a valid method id. Send as null to leave as is |
integer |
None. |
| Carriage |
Total carriage ex VAT. Send null to leave unchanged |
decimal number |
None. |
| CustomerHold |
Place on customer hold. If true will be placed on hold otherwise no change |
boolean |
None. |
| EditDeliveryAddress |
Only required if needing to edit address data |
EditDeliveryAddress |
None. |
| OrderEditLines |
List of order line changes |
OrderEditLines |
None. |