GET api/orders/{customerNumber}

Gets open orders by customer number {customerNumber}.

Request Information

URI Parameters

Name	Description	Type	Additional information
customerNumber	The customer number to fetch orders for	integer	Required

Body Parameters

None.

Remarks

Use api/orders/id/branchId to get detailed information about the order.

Example

//Gets the open orders for customernumber 1
http://localhost/api/orders/1

Response Information

Resource Description

Returns open orders for the specified customernumber{customerNumber}.

Collection of OrderHeadResponse

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. This field is used if using the Compilator Calendar API and the order is to be processed in DDWeb.	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.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "CurrencyName": "sample string 2",
    "IsWebOrder": true,
    "AgreementName": "sample string 4",
    "RetailPriceListName": "sample string 5",
    "OrderStatusId": 6,
    "OrderStatusName": "sample string 7",
    "WMSStatusId": 1,
    "WMSStatusName": "sample string 8",
    "IsWMSExpress": true,
    "CloseOrderTypeId": 1,
    "CloseOrderTypeName": "sample string 10",
    "WMSId": 1,
    "CarrierId": 1,
    "CarrierName": "sample string 11",
    "Waybill": [
      "sample string 1",
      "sample string 2"
    ],
    "PaymentTransactionProviderId": "sample string 12",
    "AgreementNo": 1,
    "RetailPriceListId": "9b96efda-e7a2-4184-972f-504600d29baa",
    "TimebookReservationId": "8fd18b9a-64fd-4298-8f5a-a5262f8a4036",
    "CalendarEventId": 1,
    "SplitId": "eda3caa4-2038-4575-acdc-095cd72ffe07",
    "OrderLines": [
      {
        "OrderLineArticle": {
          "OrderLineTypeId": 1,
          "OrderLineTypeName": "sample string 2",
          "MainGroupName": "sample string 3",
          "SubGroupName": "sample string 4",
          "MainGroupId": 5,
          "SubGroupId": 6,
          "IsService": true,
          "WMSConfirmedQuantity": 1.0,
          "OrderLineStatistics": {
            "Brand": "sample string 1",
            "SectionWidth": 1.0,
            "AspectRatio": 1.0,
            "RimDiameter": 1.0,
            "TreadPattern": "sample string 2",
            "SpeedRating": "sample string 3",
            "ExtraLoad": true,
            "RunFlatTyre": true,
            "Wet": "sample string 4",
            "Fuel": "sample string 5",
            "Noise": 1,
            "NoiseClass": 1,
            "Weight": 1.0
          },
          "ArticleNumber": 8,
          "Quantity": 9.0,
          "Description": "sample string 10",
          "Price": 11.0,
          "DiscountFactor": 12.0,
          "Amount": 13.0,
          "VatPercent": 14.0,
          "VatAmount": 15.0,
          "HasVat": true,
          "IsExport": true
        },
        "OrderLineText": {
          "Text": "sample string 1"
        },
        "LineNumber": 1,
        "ParentLineNumber": 1,
        "IsArticlePackageLine": true,
        "HasFixedQuantity": true
      },
      {
        "OrderLineArticle": {
          "OrderLineTypeId": 1,
          "OrderLineTypeName": "sample string 2",
          "MainGroupName": "sample string 3",
          "SubGroupName": "sample string 4",
          "MainGroupId": 5,
          "SubGroupId": 6,
          "IsService": true,
          "WMSConfirmedQuantity": 1.0,
          "OrderLineStatistics": {
            "Brand": "sample string 1",
            "SectionWidth": 1.0,
            "AspectRatio": 1.0,
            "RimDiameter": 1.0,
            "TreadPattern": "sample string 2",
            "SpeedRating": "sample string 3",
            "ExtraLoad": true,
            "RunFlatTyre": true,
            "Wet": "sample string 4",
            "Fuel": "sample string 5",
            "Noise": 1,
            "NoiseClass": 1,
            "Weight": 1.0
          },
          "ArticleNumber": 8,
          "Quantity": 9.0,
          "Description": "sample string 10",
          "Price": 11.0,
          "DiscountFactor": 12.0,
          "Amount": 13.0,
          "VatPercent": 14.0,
          "VatAmount": 15.0,
          "HasVat": true,
          "IsExport": true
        },
        "OrderLineText": {
          "Text": "sample string 1"
        },
        "LineNumber": 1,
        "ParentLineNumber": 1,
        "IsArticlePackageLine": true,
        "HasFixedQuantity": true
      }
    ],
    "OrderType": 1,
    "SellerBranchId": 13,
    "CustomerNumber": 1,
    "OrderDate": "12/21/2025 1:01:54 PM",
    "LicensePlate": "sample string 15",
    "Odometer": 1,
    "WorkOrderNumber": "sample string 16",
    "SalesPerson": "sample string 17",
    "CurrencyId": 18,
    "CurrencyRate": 19.0,
    "DeliveryDate": "12/21/2025 1:01:54 PM",
    "RequisitionOrderNumber": "sample string 20",
    "TotalAmountIncludingVat": 1.0,
    "TotalAmountExcludingVat": 1.0,
    "RoundingAmount": 1.0,
    "CustomerReference": "sample string 21",
    "ContactId": "9bf00fa2-61ea-45eb-882d-bcc0bb7ee4ff"
  },
  {
    "Id": 1,
    "CurrencyName": "sample string 2",
    "IsWebOrder": true,
    "AgreementName": "sample string 4",
    "RetailPriceListName": "sample string 5",
    "OrderStatusId": 6,
    "OrderStatusName": "sample string 7",
    "WMSStatusId": 1,
    "WMSStatusName": "sample string 8",
    "IsWMSExpress": true,
    "CloseOrderTypeId": 1,
    "CloseOrderTypeName": "sample string 10",
    "WMSId": 1,
    "CarrierId": 1,
    "CarrierName": "sample string 11",
    "Waybill": [
      "sample string 1",
      "sample string 2"
    ],
    "PaymentTransactionProviderId": "sample string 12",
    "AgreementNo": 1,
    "RetailPriceListId": "9b96efda-e7a2-4184-972f-504600d29baa",
    "TimebookReservationId": "8fd18b9a-64fd-4298-8f5a-a5262f8a4036",
    "CalendarEventId": 1,
    "SplitId": "eda3caa4-2038-4575-acdc-095cd72ffe07",
    "OrderLines": [
      {
        "OrderLineArticle": {
          "OrderLineTypeId": 1,
          "OrderLineTypeName": "sample string 2",
          "MainGroupName": "sample string 3",
          "SubGroupName": "sample string 4",
          "MainGroupId": 5,
          "SubGroupId": 6,
          "IsService": true,
          "WMSConfirmedQuantity": 1.0,
          "OrderLineStatistics": {
            "Brand": "sample string 1",
            "SectionWidth": 1.0,
            "AspectRatio": 1.0,
            "RimDiameter": 1.0,
            "TreadPattern": "sample string 2",
            "SpeedRating": "sample string 3",
            "ExtraLoad": true,
            "RunFlatTyre": true,
            "Wet": "sample string 4",
            "Fuel": "sample string 5",
            "Noise": 1,
            "NoiseClass": 1,
            "Weight": 1.0
          },
          "ArticleNumber": 8,
          "Quantity": 9.0,
          "Description": "sample string 10",
          "Price": 11.0,
          "DiscountFactor": 12.0,
          "Amount": 13.0,
          "VatPercent": 14.0,
          "VatAmount": 15.0,
          "HasVat": true,
          "IsExport": true
        },
        "OrderLineText": {
          "Text": "sample string 1"
        },
        "LineNumber": 1,
        "ParentLineNumber": 1,
        "IsArticlePackageLine": true,
        "HasFixedQuantity": true
      },
      {
        "OrderLineArticle": {
          "OrderLineTypeId": 1,
          "OrderLineTypeName": "sample string 2",
          "MainGroupName": "sample string 3",
          "SubGroupName": "sample string 4",
          "MainGroupId": 5,
          "SubGroupId": 6,
          "IsService": true,
          "WMSConfirmedQuantity": 1.0,
          "OrderLineStatistics": {
            "Brand": "sample string 1",
            "SectionWidth": 1.0,
            "AspectRatio": 1.0,
            "RimDiameter": 1.0,
            "TreadPattern": "sample string 2",
            "SpeedRating": "sample string 3",
            "ExtraLoad": true,
            "RunFlatTyre": true,
            "Wet": "sample string 4",
            "Fuel": "sample string 5",
            "Noise": 1,
            "NoiseClass": 1,
            "Weight": 1.0
          },
          "ArticleNumber": 8,
          "Quantity": 9.0,
          "Description": "sample string 10",
          "Price": 11.0,
          "DiscountFactor": 12.0,
          "Amount": 13.0,
          "VatPercent": 14.0,
          "VatAmount": 15.0,
          "HasVat": true,
          "IsExport": true
        },
        "OrderLineText": {
          "Text": "sample string 1"
        },
        "LineNumber": 1,
        "ParentLineNumber": 1,
        "IsArticlePackageLine": true,
        "HasFixedQuantity": true
      }
    ],
    "OrderType": 1,
    "SellerBranchId": 13,
    "CustomerNumber": 1,
    "OrderDate": "12/21/2025 1:01:54 PM",
    "LicensePlate": "sample string 15",
    "Odometer": 1,
    "WorkOrderNumber": "sample string 16",
    "SalesPerson": "sample string 17",
    "CurrencyId": 18,
    "CurrencyRate": 19.0,
    "DeliveryDate": "12/21/2025 1:01:54 PM",
    "RequisitionOrderNumber": "sample string 20",
    "TotalAmountIncludingVat": 1.0,
    "TotalAmountExcludingVat": 1.0,
    "RoundingAmount": 1.0,
    "CustomerReference": "sample string 21",
    "ContactId": "9bf00fa2-61ea-45eb-882d-bcc0bb7ee4ff"
  }
]

application/xml, text/xml