POST api/GetOrdersForBundling

Request Information

URI Parameters

None.

Body Parameters

OrderBundleReqModel
NameDescriptionTypeAdditional information
PickUpFromDate

date

None.

PickUpToDate

date

None.

FulfillmentTypeId

integer

None.

PersonIds

Collection of globally unique identifier

None.

Request Formats

application/json, text/json

Sample:
{
  "PickUpFromDate": "2025-12-06T03:48:58.7546147+00:00",
  "PickUpToDate": "2025-12-06T03:48:58.7546147+00:00",
  "FulfillmentTypeId": 1,
  "PersonIds": [
    "631c8b08-0b8c-425d-bef1-0a17b37451f3",
    "fa8a7a45-9052-44f4-92a5-0d44e083fe11"
  ]
}

application/xml, text/xml

Sample:
<OrderBundleReqModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.OnlineFRE.APIs.Models.Order">
  <FulfillmentTypeId>1</FulfillmentTypeId>
  <PersonIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>631c8b08-0b8c-425d-bef1-0a17b37451f3</d2p1:guid>
    <d2p1:guid>fa8a7a45-9052-44f4-92a5-0d44e083fe11</d2p1:guid>
  </PersonIds>
  <PickUpFromDate>2025-12-06T03:48:58.7546147+00:00</PickUpFromDate>
  <PickUpToDate>2025-12-06T03:48:58.7546147+00:00</PickUpToDate>
</OrderBundleReqModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'OrderBundleReqModel'.

Response Information

Resource Description

Collection of OnlineOrderModel
NameDescriptionTypeAdditional information
OrderId

integer

None.

ConfirmationNumber

string

None.

OrderedBy

integer

None.

OrderDate

date

None.

FulfillmentTypeName

string

None.

OrderMethodType

string

None.

OrderAmount

decimal number

None.

OrderTax

decimal number

None.

SpecialInstructions

string

None.

OrderStatus

string

None.

ServingZone

string

None.

ServingPeriod

string

None.

ServingZoneDescription

string

None.

MealTypeDescription

string

None.

MealTypeId

integer

None.

FirstName

string

None.

LastName

string

None.

ExternalPersonId

string

None.

BuyerId

globally unique identifier

None.

SchoolName

string

None.

OrderedByName

string

None.

ClassroomName

string

None.

ActualOrderAmount

decimal number

None.

PickUpDate

date

None.

ServingSchoolName

string

None.

OrderDetails

Collection of OrdItemDetailModel

None.

PickUpWindowName

string

None.

PickUpSpecialInstructions

string

None.

AvailabilityType

string

None.

ORDWeekDayName

string

None.

DayFromTime

string

None.

DayToTime

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "OrderId": 1,
    "ConfirmationNumber": "sample string 2",
    "OrderedBy": 3,
    "OrderDate": "2025-12-06T03:48:58.7575934+00:00",
    "FulfillmentTypeName": "sample string 5",
    "OrderMethodType": "sample string 6",
    "OrderAmount": 7.0,
    "OrderTax": 1.0,
    "SpecialInstructions": "sample string 8",
    "OrderStatus": "sample string 9",
    "ServingZone": "sample string 10",
    "ServingPeriod": "sample string 11",
    "ServingZoneDescription": "sample string 12",
    "MealTypeDescription": "sample string 13",
    "MealTypeId": 14,
    "FirstName": "sample string 15",
    "LastName": "sample string 16",
    "ExternalPersonId": "sample string 17",
    "BuyerId": "cf9432a6-b3e5-43cc-949c-b320a7ae4c38",
    "SchoolName": "sample string 19",
    "OrderedByName": "sample string 20",
    "ClassroomName": "sample string 21",
    "ActualOrderAmount": 1.0,
    "PickUpDate": "2025-12-06T03:48:58.7575934+00:00",
    "ServingSchoolName": "sample string 23",
    "OrderDetails": [
      {
        "MenuItemId": 1,
        "Quantity": 2,
        "Price": 3.0,
        "ActualPrice": 1.0,
        "AddedAtEpoch": 4,
        "MenuItemDescription": "sample string 5",
        "SpanishDescription": "sample string 6",
        "Allergens": [
          {
            "AllergenId": 1,
            "Description": "sample string 2",
            "MenuItemId": 3
          },
          {
            "AllergenId": 1,
            "Description": "sample string 2",
            "MenuItemId": 3
          }
        ]
      },
      {
        "MenuItemId": 1,
        "Quantity": 2,
        "Price": 3.0,
        "ActualPrice": 1.0,
        "AddedAtEpoch": 4,
        "MenuItemDescription": "sample string 5",
        "SpanishDescription": "sample string 6",
        "Allergens": [
          {
            "AllergenId": 1,
            "Description": "sample string 2",
            "MenuItemId": 3
          },
          {
            "AllergenId": 1,
            "Description": "sample string 2",
            "MenuItemId": 3
          }
        ]
      }
    ],
    "PickUpWindowName": "sample string 24",
    "PickUpSpecialInstructions": "sample string 25",
    "AvailabilityType": "sample string 26",
    "ORDWeekDayName": "sample string 27",
    "DayFromTime": "sample string 28",
    "DayToTime": "sample string 29"
  },
  {
    "OrderId": 1,
    "ConfirmationNumber": "sample string 2",
    "OrderedBy": 3,
    "OrderDate": "2025-12-06T03:48:58.7575934+00:00",
    "FulfillmentTypeName": "sample string 5",
    "OrderMethodType": "sample string 6",
    "OrderAmount": 7.0,
    "OrderTax": 1.0,
    "SpecialInstructions": "sample string 8",
    "OrderStatus": "sample string 9",
    "ServingZone": "sample string 10",
    "ServingPeriod": "sample string 11",
    "ServingZoneDescription": "sample string 12",
    "MealTypeDescription": "sample string 13",
    "MealTypeId": 14,
    "FirstName": "sample string 15",
    "LastName": "sample string 16",
    "ExternalPersonId": "sample string 17",
    "BuyerId": "cf9432a6-b3e5-43cc-949c-b320a7ae4c38",
    "SchoolName": "sample string 19",
    "OrderedByName": "sample string 20",
    "ClassroomName": "sample string 21",
    "ActualOrderAmount": 1.0,
    "PickUpDate": "2025-12-06T03:48:58.7575934+00:00",
    "ServingSchoolName": "sample string 23",
    "OrderDetails": [
      {
        "MenuItemId": 1,
        "Quantity": 2,
        "Price": 3.0,
        "ActualPrice": 1.0,
        "AddedAtEpoch": 4,
        "MenuItemDescription": "sample string 5",
        "SpanishDescription": "sample string 6",
        "Allergens": [
          {
            "AllergenId": 1,
            "Description": "sample string 2",
            "MenuItemId": 3
          },
          {
            "AllergenId": 1,
            "Description": "sample string 2",
            "MenuItemId": 3
          }
        ]
      },
      {
        "MenuItemId": 1,
        "Quantity": 2,
        "Price": 3.0,
        "ActualPrice": 1.0,
        "AddedAtEpoch": 4,
        "MenuItemDescription": "sample string 5",
        "SpanishDescription": "sample string 6",
        "Allergens": [
          {
            "AllergenId": 1,
            "Description": "sample string 2",
            "MenuItemId": 3
          },
          {
            "AllergenId": 1,
            "Description": "sample string 2",
            "MenuItemId": 3
          }
        ]
      }
    ],
    "PickUpWindowName": "sample string 24",
    "PickUpSpecialInstructions": "sample string 25",
    "AvailabilityType": "sample string 26",
    "ORDWeekDayName": "sample string 27",
    "DayFromTime": "sample string 28",
    "DayToTime": "sample string 29"
  }
]

application/xml, text/xml

Sample:
<ArrayOfOnlineOrderModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.OnlineFRE.APIs.Models.Order">
  <OnlineOrderModel>
    <ActualOrderAmount>1</ActualOrderAmount>
    <AvailabilityType>sample string 26</AvailabilityType>
    <BuyerId>cf9432a6-b3e5-43cc-949c-b320a7ae4c38</BuyerId>
    <ClassroomName>sample string 21</ClassroomName>
    <ConfirmationNumber>sample string 2</ConfirmationNumber>
    <DayFromTime>sample string 28</DayFromTime>
    <DayToTime>sample string 29</DayToTime>
    <ExternalPersonId>sample string 17</ExternalPersonId>
    <FirstName>sample string 15</FirstName>
    <FulfillmentTypeName>sample string 5</FulfillmentTypeName>
    <LastName>sample string 16</LastName>
    <MealTypeDescription>sample string 13</MealTypeDescription>
    <MealTypeId>14</MealTypeId>
    <ORDWeekDayName>sample string 27</ORDWeekDayName>
    <OrderAmount>7</OrderAmount>
    <OrderDate>2025-12-06T03:48:58.7575934+00:00</OrderDate>
    <OrderDetails>
      <OrdItemDetailModel>
        <ActualPrice>1</ActualPrice>
        <AddedAtEpoch>4</AddedAtEpoch>
        <Allergens xmlns:d5p1="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.OnlineFRE.APIs.Models.MenuItems">
          <d5p1:AllergiesMenuItemModel>
            <d5p1:AllergenId>1</d5p1:AllergenId>
            <d5p1:Description>sample string 2</d5p1:Description>
            <d5p1:MenuItemId>3</d5p1:MenuItemId>
          </d5p1:AllergiesMenuItemModel>
          <d5p1:AllergiesMenuItemModel>
            <d5p1:AllergenId>1</d5p1:AllergenId>
            <d5p1:Description>sample string 2</d5p1:Description>
            <d5p1:MenuItemId>3</d5p1:MenuItemId>
          </d5p1:AllergiesMenuItemModel>
        </Allergens>
        <MenuItemDescription>sample string 5</MenuItemDescription>
        <MenuItemId>1</MenuItemId>
        <Price>3</Price>
        <Quantity>2</Quantity>
        <SpanishDescription>sample string 6</SpanishDescription>
      </OrdItemDetailModel>
      <OrdItemDetailModel>
        <ActualPrice>1</ActualPrice>
        <AddedAtEpoch>4</AddedAtEpoch>
        <Allergens xmlns:d5p1="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.OnlineFRE.APIs.Models.MenuItems">
          <d5p1:AllergiesMenuItemModel>
            <d5p1:AllergenId>1</d5p1:AllergenId>
            <d5p1:Description>sample string 2</d5p1:Description>
            <d5p1:MenuItemId>3</d5p1:MenuItemId>
          </d5p1:AllergiesMenuItemModel>
          <d5p1:AllergiesMenuItemModel>
            <d5p1:AllergenId>1</d5p1:AllergenId>
            <d5p1:Description>sample string 2</d5p1:Description>
            <d5p1:MenuItemId>3</d5p1:MenuItemId>
          </d5p1:AllergiesMenuItemModel>
        </Allergens>
        <MenuItemDescription>sample string 5</MenuItemDescription>
        <MenuItemId>1</MenuItemId>
        <Price>3</Price>
        <Quantity>2</Quantity>
        <SpanishDescription>sample string 6</SpanishDescription>
      </OrdItemDetailModel>
    </OrderDetails>
    <OrderId>1</OrderId>
    <OrderMethodType>sample string 6</OrderMethodType>
    <OrderStatus>sample string 9</OrderStatus>
    <OrderTax>1</OrderTax>
    <OrderedBy>3</OrderedBy>
    <OrderedByName>sample string 20</OrderedByName>
    <PickUpDate>2025-12-06T03:48:58.7575934+00:00</PickUpDate>
    <PickUpSpecialInstructions>sample string 25</PickUpSpecialInstructions>
    <PickUpWindowName>sample string 24</PickUpWindowName>
    <SchoolName>sample string 19</SchoolName>
    <ServingPeriod>sample string 11</ServingPeriod>
    <ServingSchoolName>sample string 23</ServingSchoolName>
    <ServingZone>sample string 10</ServingZone>
    <ServingZoneDescription>sample string 12</ServingZoneDescription>
    <SpecialInstructions>sample string 8</SpecialInstructions>
  </OnlineOrderModel>
  <OnlineOrderModel>
    <ActualOrderAmount>1</ActualOrderAmount>
    <AvailabilityType>sample string 26</AvailabilityType>
    <BuyerId>cf9432a6-b3e5-43cc-949c-b320a7ae4c38</BuyerId>
    <ClassroomName>sample string 21</ClassroomName>
    <ConfirmationNumber>sample string 2</ConfirmationNumber>
    <DayFromTime>sample string 28</DayFromTime>
    <DayToTime>sample string 29</DayToTime>
    <ExternalPersonId>sample string 17</ExternalPersonId>
    <FirstName>sample string 15</FirstName>
    <FulfillmentTypeName>sample string 5</FulfillmentTypeName>
    <LastName>sample string 16</LastName>
    <MealTypeDescription>sample string 13</MealTypeDescription>
    <MealTypeId>14</MealTypeId>
    <ORDWeekDayName>sample string 27</ORDWeekDayName>
    <OrderAmount>7</OrderAmount>
    <OrderDate>2025-12-06T03:48:58.7575934+00:00</OrderDate>
    <OrderDetails>
      <OrdItemDetailModel>
        <ActualPrice>1</ActualPrice>
        <AddedAtEpoch>4</AddedAtEpoch>
        <Allergens xmlns:d5p1="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.OnlineFRE.APIs.Models.MenuItems">
          <d5p1:AllergiesMenuItemModel>
            <d5p1:AllergenId>1</d5p1:AllergenId>
            <d5p1:Description>sample string 2</d5p1:Description>
            <d5p1:MenuItemId>3</d5p1:MenuItemId>
          </d5p1:AllergiesMenuItemModel>
          <d5p1:AllergiesMenuItemModel>
            <d5p1:AllergenId>1</d5p1:AllergenId>
            <d5p1:Description>sample string 2</d5p1:Description>
            <d5p1:MenuItemId>3</d5p1:MenuItemId>
          </d5p1:AllergiesMenuItemModel>
        </Allergens>
        <MenuItemDescription>sample string 5</MenuItemDescription>
        <MenuItemId>1</MenuItemId>
        <Price>3</Price>
        <Quantity>2</Quantity>
        <SpanishDescription>sample string 6</SpanishDescription>
      </OrdItemDetailModel>
      <OrdItemDetailModel>
        <ActualPrice>1</ActualPrice>
        <AddedAtEpoch>4</AddedAtEpoch>
        <Allergens xmlns:d5p1="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.OnlineFRE.APIs.Models.MenuItems">
          <d5p1:AllergiesMenuItemModel>
            <d5p1:AllergenId>1</d5p1:AllergenId>
            <d5p1:Description>sample string 2</d5p1:Description>
            <d5p1:MenuItemId>3</d5p1:MenuItemId>
          </d5p1:AllergiesMenuItemModel>
          <d5p1:AllergiesMenuItemModel>
            <d5p1:AllergenId>1</d5p1:AllergenId>
            <d5p1:Description>sample string 2</d5p1:Description>
            <d5p1:MenuItemId>3</d5p1:MenuItemId>
          </d5p1:AllergiesMenuItemModel>
        </Allergens>
        <MenuItemDescription>sample string 5</MenuItemDescription>
        <MenuItemId>1</MenuItemId>
        <Price>3</Price>
        <Quantity>2</Quantity>
        <SpanishDescription>sample string 6</SpanishDescription>
      </OrdItemDetailModel>
    </OrderDetails>
    <OrderId>1</OrderId>
    <OrderMethodType>sample string 6</OrderMethodType>
    <OrderStatus>sample string 9</OrderStatus>
    <OrderTax>1</OrderTax>
    <OrderedBy>3</OrderedBy>
    <OrderedByName>sample string 20</OrderedByName>
    <PickUpDate>2025-12-06T03:48:58.7575934+00:00</PickUpDate>
    <PickUpSpecialInstructions>sample string 25</PickUpSpecialInstructions>
    <PickUpWindowName>sample string 24</PickUpWindowName>
    <SchoolName>sample string 19</SchoolName>
    <ServingPeriod>sample string 11</ServingPeriod>
    <ServingSchoolName>sample string 23</ServingSchoolName>
    <ServingZone>sample string 10</ServingZone>
    <ServingZoneDescription>sample string 12</ServingZoneDescription>
    <SpecialInstructions>sample string 8</SpecialInstructions>
  </OnlineOrderModel>
</ArrayOfOnlineOrderModel>