| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Order id. This id is set when placing an order in DäckData. |
integer |
Required |
| CurrencyName |
Name of currency used in the order. |
string |
Required Max length: 50 |
| IsWebOrder |
Specifies if the order origin is through the DDAPI. |
boolean |
None. |
| AgreementName |
Name of the agreement used in order for calculating prices. |
string |
Max length: 80 |
| RetailPriceListName |
Name of the pricelist used in the order. |
string |
Max length: 100 |
| OrderStatusId |
Order status id. Can be 1 = Open, 2 = Closed and 3 = Deleted. |
integer |
Required |
| OrderStatusName |
Order status name. Any of 1 = Open, 2 = Closed and 3 = Deleted. |
string |
Required Max length: 40 |
| WMSStatusId |
WMS status id. Any of 1 = Not sent, 2 = Sent, 3 = Confirmed, 4 = Processed, 5 = SendFailed, 6 = Fail, 7 = Locked. |
integer |
None. |
| WMSStatusName |
WMS status name. Any of 1 = Not sent, 2 = Sent, 3 = Confirmed, 4 = Processed, 5 = SendFailed, 6 = Fail, 7 = Locked. |
string |
None. |
| IsWMSExpress |
Specifies if the order is sent to WMS as express order. |
boolean |
Required |
| CloseOrderTypeId |
Close order type. Any of 1 = Delivery note, 2 = Reservation, 3 = Cash order. |
integer |
None. |
| CloseOrderTypeName |
Close order type name. Any of 1 = Delivery note, 2 = Reservation, 3 = Cash order. |
string |
Max length: 100 |
| WMSId |
Order reference number for order sent to WMS. |
integer |
None. |
| CarrierId |
Id of the carrier used for transportation for WMS orders. |
integer |
None. |
| CarrierName |
Name of the carrier used for transportation of WMS orders. |
string |
Max length: 100 |
| Waybill |
Collection of waybill numbers. |
Collection of string |
Max length: 200 |
| PaymentTransactionProviderId |
Collection of order lines. |
string |
Max length: 56 |
| AgreementNo |
The agreement used for calculating prices in the order. |
integer |
None. |
| RetailPriceListId |
The pricelist used for the order. |
globally unique identifier |
None. |
| TimebookReservationId |
Id for timebook reservation. This field is used if using the Compilator Timebook API and the order is to be processed in DD2010. |
globally unique identifier |
None. |
| CalendarEventId |
Id for a calendar event. |
integer |
None. |
| SplitId |
Indicates that order has been split. Other part of the split order shares the same Id. |
globally unique identifier |
None. |
| OrderLines | Collection of OrderLineResponse |
None. |
|
| OrderType |
This construct is made in order to introduce order type without breaking the exposed interface |
OrderType |
None. |
| SellerBranchId |
Branch id of the branch owning the order. |
integer |
Required |
| CustomerNumber |
Customer number for the customer placing the order. Use api/customers/{id} to get customer details. |
integer |
None. |
| OrderDate |
Date when ther order is placed. |
date |
Required |
| LicensePlate |
License plate number. |
string |
Max length: 15 |
| Odometer |
Odometer. |
integer |
None. |
| WorkOrderNumber | string |
Max length: 40 |
|
| SalesPerson |
Name of the person responsible for the order. |
string |
Required Max length: 50 |
| CurrencyId |
Currecy id. A list of suppoerted currencies can be fetched through the API with /api/currencies |
integer |
Required |
| CurrencyRate |
Actual currency rate used on order. |
decimal number |
Required |
| DeliveryDate |
Requested delivery date for the order. |
date |
None. |
| RequisitionOrderNumber | string |
Max length: 40 |
|
| TotalAmountIncludingVat |
Total order amount including discount and VAT. |
decimal number |
None. |
| TotalAmountExcludingVat |
Total order amount including discount but without VAT. |
decimal number |
None. |
| RoundingAmount |
Optional rounding amount. |
decimal number |
None. |
| CustomerReference |
Customers order reference. |
string |
Max length: 40 |
| ContactId |
Customer contact id. Use api/contacts/{id} to get contact details. |
globally unique identifier |
None. |