GET api/orders/search/{branchId}/{fromDate}/{toDate}

Gets orders by branch id {branchId} where orderdate is equal or later than {fromDate}<br/> and if {toDate} is specified orderdate is between {fromDate} and {toDate}.<br/>

Request Information

URI Parameters

Name	Description	Type	Additional information
branchId	The branchId to fetch orders for	integer	Required
fromDate	Fetch all orders with order date greater than [fromDate]	date	Required
toDate	Specifies an end date for the query	date	Default value is Null

Body Parameters

None.

Remarks

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

Example

//Gets the orders on branchId 1 where orderdate is between fromDate and toDate
http://localhost/api/search/orders/1/2016-01-01/2018-01-01

Response Information

Resource Description

Returns orders for the specified branch ID {branchId}.

Collection of OrderHeadResponse

Name	Type	Additional information
Id	integer	Required
CurrencyName	string	Required Max length: 50
IsWebOrder	boolean	None.
AgreementName	string	Max length: 80
RetailPriceListName	string	Max length: 100
OrderStatusId	integer	Required
OrderStatusName	string	Required Max length: 40
WMSStatusId	integer	None.
WMSStatusName	string	None.
IsWMSExpress	boolean	Required
CloseOrderTypeId	integer	None.
CloseOrderTypeName	string	Max length: 100
WMSId	integer	None.
CarrierId	integer	None.
CarrierName	string	Max length: 100
Waybill	Collection of string	Max length: 200
PaymentTransactionProviderId	string	Max length: 56
AgreementNo	integer	None.
RetailPriceListId	globally unique identifier	None.
TimebookReservationId	globally unique identifier	None.
CalendarEventId	integer	None.
SplitId	globally unique identifier	None.
OrderLines	Collection of OrderLineResponse	None.
OrderType	OrderType	None.
SellerBranchId	integer	Required
CustomerNumber	integer	None.
OrderDate	date	Required
LicensePlate	string	Max length: 15
Odometer	integer	None.
WorkOrderNumber	string	Max length: 40
SalesPerson	string	Required Max length: 50
CurrencyId	integer	Required
CurrencyRate	decimal number	Required
DeliveryDate	date	None.
RequisitionOrderNumber	string	Max length: 40
TotalAmountIncludingVat	decimal number	None.
TotalAmountExcludingVat	decimal number	None.
RoundingAmount	decimal number	None.
CustomerReference	string	Max length: 40
ContactId	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": "1b060381-dda4-4110-b7de-aa13e952db2f",
    "TimebookReservationId": "fa909b79-a9a5-46d1-8d95-930509d5c875",
    "CalendarEventId": 1,
    "SplitId": "9b70fb2a-4159-4686-bd75-aa6d3cd04c24",
    "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": "2026-01-21 22:53:30",
    "LicensePlate": "sample string 15",
    "Odometer": 1,
    "WorkOrderNumber": "sample string 16",
    "SalesPerson": "sample string 17",
    "CurrencyId": 18,
    "CurrencyRate": 19.0,
    "DeliveryDate": "2026-01-21 22:53:30",
    "RequisitionOrderNumber": "sample string 20",
    "TotalAmountIncludingVat": 1.0,
    "TotalAmountExcludingVat": 1.0,
    "RoundingAmount": 1.0,
    "CustomerReference": "sample string 21",
    "ContactId": "7518a787-7177-48b0-b567-5a6095a2ed94"
  },
  {
    "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": "1b060381-dda4-4110-b7de-aa13e952db2f",
    "TimebookReservationId": "fa909b79-a9a5-46d1-8d95-930509d5c875",
    "CalendarEventId": 1,
    "SplitId": "9b70fb2a-4159-4686-bd75-aa6d3cd04c24",
    "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": "2026-01-21 22:53:30",
    "LicensePlate": "sample string 15",
    "Odometer": 1,
    "WorkOrderNumber": "sample string 16",
    "SalesPerson": "sample string 17",
    "CurrencyId": 18,
    "CurrencyRate": 19.0,
    "DeliveryDate": "2026-01-21 22:53:30",
    "RequisitionOrderNumber": "sample string 20",
    "TotalAmountIncludingVat": 1.0,
    "TotalAmountExcludingVat": 1.0,
    "RoundingAmount": 1.0,
    "CustomerReference": "sample string 21",
    "ContactId": "7518a787-7177-48b0-b567-5a6095a2ed94"
  }
]

application/xml, text/xml