POST api/SaveOnlineOrder

Request Information

URI Parameters

None.

Body Parameters

OnlineOrderRequestModel
NameDescriptionTypeAdditional information
OrderedBy

integer

None.
SchoolId

globally unique identifier

None.
BuyerId

globally unique identifier

None.
MealTypeId

integer

None.
OrderDate

date

None.
FulfillmentTypeId

integer

None.
ServingZoneId

integer

None.
ServingPeriodId

integer

None.
OrderGroupId

integer

None.
OrderMethodTypeId

integer

None.
ClassroomName

string

None.
OrderAmount

decimal number

None.
OrderTax

decimal number

None.
SpecialInstructions

string

None.
OrderDetails

Collection of OrdItemDetailModel

None.
OrderedByName

string

None.
ReimbursableTotal

decimal number

None.
AlaCarteTotal

decimal number

None.
ServingSchoolId

globally unique identifier

None.
PickupDate

date

None.

Request Formats

application/json, text/json

Sample: 
{
  "OrderedBy": 1,
  "SchoolId": "85f197c2-f265-4a56-88c2-43e6d5993d20",
  "BuyerId": "107b0fe6-1815-4fb7-a89f-30fdfb57b067",
  "MealTypeId": 4,
  "OrderDate": "2025-12-06T03:49:58.8462335+00:00",
  "FulfillmentTypeId": 6,
  "ServingZoneId": 1,
  "ServingPeriodId": 1,
  "OrderGroupId": 7,
  "OrderMethodTypeId": 8,
  "ClassroomName": "sample string 9",
  "OrderAmount": 10.0,
  "OrderTax": 1.0,
  "SpecialInstructions": "sample string 11",
  "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
        }
      ]
    }
  ],
  "OrderedByName": "sample string 12",
  "ReimbursableTotal": 1.0,
  "AlaCarteTotal": 1.0,
  "ServingSchoolId": "c55c2e22-4dfe-4a39-b153-8d637115d699",
  "PickupDate": "2025-12-06T03:49:58.8462335+00:00"
}

application/xml, text/xml

Sample: 
<OnlineOrderRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.OnlineFRE.APIs.Models.Order">
  <AlaCarteTotal>1</AlaCarteTotal>
  <BuyerId>107b0fe6-1815-4fb7-a89f-30fdfb57b067</BuyerId>
  <ClassroomName>sample string 9</ClassroomName>
  <FulfillmentTypeId>6</FulfillmentTypeId>
  <MealTypeId>4</MealTypeId>
  <OrderAmount>10</OrderAmount>
  <OrderDate>2025-12-06T03:49:58.8462335+00:00</OrderDate>
  <OrderDetails>
    <OrdItemDetailModel>
      <ActualPrice>1</ActualPrice>
      <AddedAtEpoch>4</AddedAtEpoch>
      <Allergens xmlns:d4p1="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.OnlineFRE.APIs.Models.MenuItems">
        <d4p1:AllergiesMenuItemModel>
          <d4p1:AllergenId>1</d4p1:AllergenId>
          <d4p1:Description>sample string 2</d4p1:Description>
          <d4p1:MenuItemId>3</d4p1:MenuItemId>
        </d4p1:AllergiesMenuItemModel>
        <d4p1:AllergiesMenuItemModel>
          <d4p1:AllergenId>1</d4p1:AllergenId>
          <d4p1:Description>sample string 2</d4p1:Description>
          <d4p1:MenuItemId>3</d4p1:MenuItemId>
        </d4p1: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:d4p1="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.OnlineFRE.APIs.Models.MenuItems">
        <d4p1:AllergiesMenuItemModel>
          <d4p1:AllergenId>1</d4p1:AllergenId>
          <d4p1:Description>sample string 2</d4p1:Description>
          <d4p1:MenuItemId>3</d4p1:MenuItemId>
        </d4p1:AllergiesMenuItemModel>
        <d4p1:AllergiesMenuItemModel>
          <d4p1:AllergenId>1</d4p1:AllergenId>
          <d4p1:Description>sample string 2</d4p1:Description>
          <d4p1:MenuItemId>3</d4p1:MenuItemId>
        </d4p1:AllergiesMenuItemModel>
      </Allergens>
      <MenuItemDescription>sample string 5</MenuItemDescription>
      <MenuItemId>1</MenuItemId>
      <Price>3</Price>
      <Quantity>2</Quantity>
      <SpanishDescription>sample string 6</SpanishDescription>
    </OrdItemDetailModel>
  </OrderDetails>
  <OrderGroupId>7</OrderGroupId>
  <OrderMethodTypeId>8</OrderMethodTypeId>
  <OrderTax>1</OrderTax>
  <OrderedBy>1</OrderedBy>
  <OrderedByName>sample string 12</OrderedByName>
  <PickupDate>2025-12-06T03:49:58.8462335+00:00</PickupDate>
  <ReimbursableTotal>1</ReimbursableTotal>
  <SchoolId>85f197c2-f265-4a56-88c2-43e6d5993d20</SchoolId>
  <ServingPeriodId>1</ServingPeriodId>
  <ServingSchoolId>c55c2e22-4dfe-4a39-b153-8d637115d699</ServingSchoolId>
  <ServingZoneId>1</ServingZoneId>
  <SpecialInstructions>sample string 11</SpecialInstructions>
</OnlineOrderRequestModel>

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 'OnlineOrderRequestModel'.

Response Information

Resource Description

Object

None.

Response Formats

application/json, text/json

Sample: 
{}

application/xml, text/xml

Sample: 
<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />