SmartAcc DynaMod Web API v2024.4 Build 0000 - Local

<back to all web services

SubmitOrderRequest

Order

Submit Order Webhook

The following routes are available for this service:
POST/GrabFoodSubmitOrder
SubmitOrderRequest Parameters:
NameParameterData TypeRequiredDescription
orderIDbodystringNo
shortOrderNumberbodystringNo
merchantIDbodystringNo
partnerMerchantIDbodystringNo
paymentTypebodystringNo
cutlerybodyboolNo
orderTimebodystringNo
submitTimebodystringNo
completeTimebodystringNo
scheduledTimebodystringNo
orderStatebodystringNo
currencybodyCurrencyNo
featureFlagsbodyFeatureFlagsNo
itemsbodyList<OrderItem>No
campaignsbodyList<Campaign>No
promosbodyList<Promo>No
pricebodyPriceNo
dineInbodyDineInNo
receiverbodyReceiverNo
orderReadyEstimationbodyOrderReadyEstimationNo
membershipIDbodystringNo
Currency Parameters:
NameParameterData TypeRequiredDescription
codeformstringNo
symbolformstringNo
exponentformintNo
FeatureFlags Parameters:
NameParameterData TypeRequiredDescription
orderAcceptedTypeformstringNo
orderTypeformstringNo
isMexEditOrderformboolNo
OrderItem Parameters:
NameParameterData TypeRequiredDescription
idformstringNo
grabItemIDformstringNo
quantityformintNo
priceformdecimalNo
taxformdecimalNo
specificationsformstringNo
modifiersformList<Modifier>No
Modifier Parameters:
NameParameterData TypeRequiredDescription
idformstringNo
priceformdecimalNo
taxformdecimalNo
quantityformintNo
Campaign Parameters:
NameParameterData TypeRequiredDescription
idformstringNo
nameformstringNo
CampaignNameForMexformstringNo
levelformstringNo
typeformstringNo
usageCountformintNo
mexFundedRatioformdecimalNo
deductedAmountformdecimalNo
deductedPartformstringNo
appliedItemIDsformList<string>No
freeItemformOrderFreeItemNo
OrderFreeItem Parameters:
NameParameterData TypeRequiredDescription
idformstringNo
nameformstringNo
quantityformintNo
priceformdecimalNo
Promo Parameters:
NameParameterData TypeRequiredDescription
codeformstringNo
descriptionformstringNo
nameformstringNo
promoAmountformdecimalNo
Price Parameters:
NameParameterData TypeRequiredDescription
subtotalformdecimalNo
taxformdecimalNo
merchantChargeFeeformdecimalNo
grabFundPromoformdecimalNo
merchantFundPromoformdecimalNo
basketPromoformdecimalNo
deliveryFeeformdecimalNo
eaterPaymentformdecimalNo
DineIn Parameters:
NameParameterData TypeRequiredDescription
tableIDformstringNo
eaterCountformintNo
Receiver Parameters:
NameParameterData TypeRequiredDescription
nameformstringNo
phonesformlongNo
addressformReceiverAddressesNo
ReceiverAddresses Parameters:
NameParameterData TypeRequiredDescription
unitNumberformstringNo
deliveryInstructionformstringNo
addressformstringNo
postcodeformstringNo
poiSourceformstringNo
poiIDformstringNo
coordinatesformCoordinatesNo
Coordinates Parameters:
NameParameterData TypeRequiredDescription
latitudeformdoubleNo
longitudeformdoubleNo
OrderReadyEstimation Parameters:
NameParameterData TypeRequiredDescription
allowChangeformboolNo
estimatedOrderReadyTimeformstringNo
maxOrderReadyTimeformstringNo
newOrderReadyTimeformstringNo
SubmitOrderResponse Parameters:
NameParameterData TypeRequiredDescription
orderIDformstringNo
statusformstringNo
messageformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /GrabFoodSubmitOrder HTTP/1.1 
Host: snr2u.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SubmitOrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel">
  <campaigns>
    <SubmitOrderRequest.Campaign>
      <CampaignNameForMex>String</CampaignNameForMex>
      <appliedItemIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </appliedItemIDs>
      <deductedAmount>0</deductedAmount>
      <deductedPart>String</deductedPart>
      <freeItem>
        <id>String</id>
        <name>String</name>
        <price>0</price>
        <quantity>0</quantity>
      </freeItem>
      <id>String</id>
      <level>String</level>
      <mexFundedRatio>0</mexFundedRatio>
      <name>String</name>
      <type>String</type>
      <usageCount>0</usageCount>
    </SubmitOrderRequest.Campaign>
  </campaigns>
  <completeTime>String</completeTime>
  <currency>
    <code>String</code>
    <exponent>0</exponent>
    <symbol>String</symbol>
  </currency>
  <cutlery>false</cutlery>
  <dineIn>
    <eaterCount>0</eaterCount>
    <tableID>String</tableID>
  </dineIn>
  <featureFlags>
    <isMexEditOrder>false</isMexEditOrder>
    <orderAcceptedType>String</orderAcceptedType>
    <orderType>String</orderType>
  </featureFlags>
  <items>
    <SubmitOrderRequest.OrderItem>
      <grabItemID>String</grabItemID>
      <id>String</id>
      <modifiers>
        <SubmitOrderRequest.Modifier>
          <id>String</id>
          <price>0</price>
          <quantity>0</quantity>
          <tax>0</tax>
        </SubmitOrderRequest.Modifier>
      </modifiers>
      <price>0</price>
      <quantity>0</quantity>
      <specifications>String</specifications>
      <tax>0</tax>
    </SubmitOrderRequest.OrderItem>
  </items>
  <membershipID>String</membershipID>
  <merchantID>String</merchantID>
  <orderID>String</orderID>
  <orderReadyEstimation>
    <allowChange>false</allowChange>
    <estimatedOrderReadyTime>String</estimatedOrderReadyTime>
    <maxOrderReadyTime>String</maxOrderReadyTime>
    <newOrderReadyTime>String</newOrderReadyTime>
  </orderReadyEstimation>
  <orderState>String</orderState>
  <orderTime>String</orderTime>
  <partnerMerchantID>String</partnerMerchantID>
  <paymentType>String</paymentType>
  <price>
    <basketPromo>0</basketPromo>
    <deliveryFee>0</deliveryFee>
    <eaterPayment>0</eaterPayment>
    <grabFundPromo>0</grabFundPromo>
    <merchantChargeFee>0</merchantChargeFee>
    <merchantFundPromo>0</merchantFundPromo>
    <subtotal>0</subtotal>
    <tax>0</tax>
  </price>
  <promos>
    <SubmitOrderRequest.Promo>
      <code>String</code>
      <description>String</description>
      <name>String</name>
      <promoAmount>0</promoAmount>
    </SubmitOrderRequest.Promo>
  </promos>
  <receiver>
    <address>
      <address>String</address>
      <coordinates>
        <latitude>0</latitude>
        <longitude>0</longitude>
      </coordinates>
      <deliveryInstruction>String</deliveryInstruction>
      <poiID>String</poiID>
      <poiSource>String</poiSource>
      <postcode>String</postcode>
      <unitNumber>String</unitNumber>
    </address>
    <name>String</name>
    <phones>0</phones>
  </receiver>
  <scheduledTime>String</scheduledTime>
  <shortOrderNumber>String</shortOrderNumber>
  <submitTime>String</submitTime>
</SubmitOrderRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SubmitOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel">
  <message>String</message>
  <orderID>String</orderID>
  <status>String</status>
</SubmitOrderResponse>