GET api/couriers/courier/{courierID}/boxOrders?orderDate={orderDate}&isPaid={isPaid}&canBook={canBook}

Request Information

URI Parameters

Name	Type	Additional information
courierID	integer	Required
orderDate	date	Required
isPaid	boolean	None.
canBook	boolean	None.

Body Parameters

None.

Response Information

Resource Description

Collection of BoxOrderSummary

Name	Type	Additional information
ID	integer	None.
OrderDate	date	None.
CustomerID	integer	None.
CustomerTitleName	string	None.
CustomerName	string	None.
RecipientTitleName	string	None.
RecipientName	string	None.
Address	string	None.
City	string	None.
Postcode	string	None.
SizeName	string	None.
SchemeID	integer	None.
UnitPriceFormatted	string	None.
DeliveryDayName	string	None.
IsGiftBox	boolean	None.
GiftboxID	integer	None.
FishboxOrderID	integer	None.
Adults	integer	None.
Children	integer	None.
IsPaid	boolean	None.
CourierStatusID	integer	None.
CourierStatusName	string	None.
IsPackComplete	boolean	None.
PackedByID	integer	None.
PackedByName	string	None.
CustomerNotes	string	None.
Notes	string	None.
UseCoupon	boolean	None.
CouponCode	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ID": 1,
    "OrderDate": "2025-05-11T10:26:01.4844865+00:00",
    "CustomerID": 3,
    "CustomerTitleName": "sample string 4",
    "CustomerName": "sample string 5",
    "RecipientTitleName": "sample string 6",
    "RecipientName": "sample string 7",
    "Address": "sample string 8",
    "City": "sample string 9",
    "Postcode": "sample string 10",
    "SizeName": "sample string 11",
    "SchemeID": 1,
    "UnitPriceFormatted": "sample string 12",
    "DeliveryDayName": "sample string 13",
    "IsGiftBox": true,
    "GiftboxID": 1,
    "FishboxOrderID": 1,
    "Adults": 15,
    "Children": 16,
    "IsPaid": true,
    "CourierStatusID": 1,
    "CourierStatusName": "sample string 18",
    "IsPackComplete": true,
    "PackedByID": 1,
    "PackedByName": "sample string 20",
    "CustomerNotes": "sample string 21",
    "Notes": "sample string 22",
    "UseCoupon": true,
    "CouponCode": "sample string 24"
  },
  {
    "ID": 1,
    "OrderDate": "2025-05-11T10:26:01.4844865+00:00",
    "CustomerID": 3,
    "CustomerTitleName": "sample string 4",
    "CustomerName": "sample string 5",
    "RecipientTitleName": "sample string 6",
    "RecipientName": "sample string 7",
    "Address": "sample string 8",
    "City": "sample string 9",
    "Postcode": "sample string 10",
    "SizeName": "sample string 11",
    "SchemeID": 1,
    "UnitPriceFormatted": "sample string 12",
    "DeliveryDayName": "sample string 13",
    "IsGiftBox": true,
    "GiftboxID": 1,
    "FishboxOrderID": 1,
    "Adults": 15,
    "Children": 16,
    "IsPaid": true,
    "CourierStatusID": 1,
    "CourierStatusName": "sample string 18",
    "IsPackComplete": true,
    "PackedByID": 1,
    "PackedByName": "sample string 20",
    "CustomerNotes": "sample string 21",
    "Notes": "sample string 22",
    "UseCoupon": true,
    "CouponCode": "sample string 24"
  }
]

application/xml, text/xml

Sample:

<ArrayOfBoxOrderSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/cag.Data.Box">
  <BoxOrderSummary>
    <Address>sample string 8</Address>
    <Adults>15</Adults>
    <Children>16</Children>
    <City>sample string 9</City>
    <CouponCode>sample string 24</CouponCode>
    <CourierStatusID>1</CourierStatusID>
    <CourierStatusName>sample string 18</CourierStatusName>
    <CustomerID>3</CustomerID>
    <CustomerName>sample string 5</CustomerName>
    <CustomerNotes>sample string 21</CustomerNotes>
    <CustomerTitleName>sample string 4</CustomerTitleName>
    <DeliveryDayName>sample string 13</DeliveryDayName>
    <FishboxOrderID>1</FishboxOrderID>
    <GiftboxID>1</GiftboxID>
    <ID>1</ID>
    <IsGiftBox>true</IsGiftBox>
    <IsPackComplete>true</IsPackComplete>
    <IsPaid>true</IsPaid>
    <Notes>sample string 22</Notes>
    <OrderDate>2025-05-11T10:26:01.4844865+00:00</OrderDate>
    <PackedByID>1</PackedByID>
    <PackedByName>sample string 20</PackedByName>
    <Postcode>sample string 10</Postcode>
    <RecipientName>sample string 7</RecipientName>
    <RecipientTitleName>sample string 6</RecipientTitleName>
    <SchemeID>1</SchemeID>
    <SizeName>sample string 11</SizeName>
    <UnitPriceFormatted>sample string 12</UnitPriceFormatted>
    <UseCoupon>true</UseCoupon>
  </BoxOrderSummary>
  <BoxOrderSummary>
    <Address>sample string 8</Address>
    <Adults>15</Adults>
    <Children>16</Children>
    <City>sample string 9</City>
    <CouponCode>sample string 24</CouponCode>
    <CourierStatusID>1</CourierStatusID>
    <CourierStatusName>sample string 18</CourierStatusName>
    <CustomerID>3</CustomerID>
    <CustomerName>sample string 5</CustomerName>
    <CustomerNotes>sample string 21</CustomerNotes>
    <CustomerTitleName>sample string 4</CustomerTitleName>
    <DeliveryDayName>sample string 13</DeliveryDayName>
    <FishboxOrderID>1</FishboxOrderID>
    <GiftboxID>1</GiftboxID>
    <ID>1</ID>
    <IsGiftBox>true</IsGiftBox>
    <IsPackComplete>true</IsPackComplete>
    <IsPaid>true</IsPaid>
    <Notes>sample string 22</Notes>
    <OrderDate>2025-05-11T10:26:01.4844865+00:00</OrderDate>
    <PackedByID>1</PackedByID>
    <PackedByName>sample string 20</PackedByName>
    <Postcode>sample string 10</Postcode>
    <RecipientName>sample string 7</RecipientName>
    <RecipientTitleName>sample string 6</RecipientTitleName>
    <SchemeID>1</SchemeID>
    <SizeName>sample string 11</SizeName>
    <UnitPriceFormatted>sample string 12</UnitPriceFormatted>
    <UseCoupon>true</UseCoupon>
  </BoxOrderSummary>
</ArrayOfBoxOrderSummary>