Documentation for POST api/order/Order/Save

POST api/order/Order/Save

Save Freedom Order with ORder information and additional related information like Misc fields and Gift Messages.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
OrderID	Freedom OrderID	integer	None.
MarketShowID	Identifier of the market show to associate to this order.	integer	Required
BillingAddress	The billing Address.	AddressViewModel	None.
ShippingAddress	The shipping Address.	AddressViewModel	None.
InvoiceNotes	Invoice notes to the order. These notes are included in some shipping batch out files.	string	None.
ShipMethodID	Shipping method identifier associated to the order.	integer	None.
TaxExemptCodeID	Tax exempt code identifier associated to the order.	string	None.
IsTaxExempt	Flag that indicates whether the order is tax exempt or not.	boolean	None.
SendAutoresponders	Indicates whether or not to send the AR related to order creation. Optional. Default is true.	boolean	None.
ShippingTotal	Overrides the default shipping calculation with the amount passed in.	decimal number	None.
ShippingTax	Overrides the default shipping tax calculation with the amount passed in.	decimal number	None.
HandlingFee	Overrides the default handling calculation with the amount passed in.	decimal number	None.
HandlingTax	Overrides the default handling tax calculation with the amount passed in.	decimal number	None.
InvoiceNumber	This value overrides the use of Order# as Invoice#	string	None.
CustomerDID		string	None.
HostCustomerID		integer	None.
HostCustomerDID		string	None.
OrderMisc	For any customizations, this holds the extra fields associated to customizations.	Collection of MiscFieldViewModel	None.
OrderGiftMessage	For any customizations, this holds the extra fields associated to customizations.	OrdersGiftMessageViewModel	None.

Request Formats

application/xml, text/xml

Sample:

<OrderExtendedViewModel>
  <OrderID>1</OrderID>
  <MarketShowID>2</MarketShowID>
  <BillingAddress>
    <ID>1</ID>
    <Description>sample string 2</Description>
    <Street1>sample string 3</Street1>
    <Street2>sample string 4</Street2>
    <City>sample string 5</City>
    <Company>sample string 6</Company>
    <State>sample string 7</State>
    <PostalCode>sample string 8</PostalCode>
    <County>sample string 9</County>
    <Country>sample string 10</Country>
    <Phone>sample string 11</Phone>
    <Email>sample string 12</Email>
    <FirstName>sample string 13</FirstName>
    <LastName>sample string 14</LastName>
    <SpecialInstructions>sample string 15</SpecialInstructions>
    <SuggestedAddress>True</SuggestedAddress>
    <IsHiddenOnCart>True</IsHiddenOnCart>
    <IsOverrideAddress>True</IsOverrideAddress>
    <IsDefaultProfile>64</IsDefaultProfile>
  </BillingAddress>
  <ShippingAddress>
    <ID>1</ID>
    <Description>sample string 2</Description>
    <Street1>sample string 3</Street1>
    <Street2>sample string 4</Street2>
    <City>sample string 5</City>
    <Company>sample string 6</Company>
    <State>sample string 7</State>
    <PostalCode>sample string 8</PostalCode>
    <County>sample string 9</County>
    <Country>sample string 10</Country>
    <Phone>sample string 11</Phone>
    <Email>sample string 12</Email>
    <FirstName>sample string 13</FirstName>
    <LastName>sample string 14</LastName>
    <SpecialInstructions>sample string 15</SpecialInstructions>
    <SuggestedAddress>True</SuggestedAddress>
    <IsHiddenOnCart>True</IsHiddenOnCart>
    <IsOverrideAddress>True</IsOverrideAddress>
    <IsDefaultProfile>64</IsDefaultProfile>
  </ShippingAddress>
  <InvoiceNotes>sample string 3</InvoiceNotes>
  <ShipMethodID>1</ShipMethodID>
  <TaxExemptCodeID>sample string 4</TaxExemptCodeID>
  <IsTaxExempt>True</IsTaxExempt>
  <SendAutoresponders>True</SendAutoresponders>
  <ShippingTotal>1</ShippingTotal>
  <ShippingTax>1</ShippingTax>
  <HandlingFee>1</HandlingFee>
  <HandlingTax>1</HandlingTax>
  <InvoiceNumber>sample string 7</InvoiceNumber>
  <CustomerDID>sample string 8</CustomerDID>
  <HostCustomerID>1</HostCustomerID>
  <HostCustomerDID>sample string 9</HostCustomerDID>
  <OrderMisc>
    <MiscFieldViewModel>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </MiscFieldViewModel>
    <MiscFieldViewModel>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </MiscFieldViewModel>
  </OrderMisc>
  <OrderGiftMessage>
    <Message>sample string 1</Message>
    <ID>2</ID>
    <OrderID>1</OrderID>
    <OnlineOrderID>1</OnlineOrderID>
    <Sequence>3</Sequence>
  </OrderGiftMessage>
</OrderExtendedViewModel>

application/json, text/json

Sample:

{
  "OrderID": 1,
  "MarketShowID": 2,
  "BillingAddress": {
    "ID": 1,
    "Description": "sample string 2",
    "Street1": "sample string 3",
    "Street2": "sample string 4",
    "City": "sample string 5",
    "Company": "sample string 6",
    "State": "sample string 7",
    "PostalCode": "sample string 8",
    "County": "sample string 9",
    "Country": "sample string 10",
    "Phone": "sample string 11",
    "Email": "sample string 12",
    "FirstName": "sample string 13",
    "LastName": "sample string 14",
    "SpecialInstructions": "sample string 15",
    "SuggestedAddress": true,
    "IsHiddenOnCart": true,
    "IsOverrideAddress": true,
    "IsDefaultProfile": 64
  },
  "ShippingAddress": {
    "ID": 1,
    "Description": "sample string 2",
    "Street1": "sample string 3",
    "Street2": "sample string 4",
    "City": "sample string 5",
    "Company": "sample string 6",
    "State": "sample string 7",
    "PostalCode": "sample string 8",
    "County": "sample string 9",
    "Country": "sample string 10",
    "Phone": "sample string 11",
    "Email": "sample string 12",
    "FirstName": "sample string 13",
    "LastName": "sample string 14",
    "SpecialInstructions": "sample string 15",
    "SuggestedAddress": true,
    "IsHiddenOnCart": true,
    "IsOverrideAddress": true,
    "IsDefaultProfile": 64
  },
  "InvoiceNotes": "sample string 3",
  "ShipMethodID": 1,
  "TaxExemptCodeID": "sample string 4",
  "IsTaxExempt": true,
  "SendAutoresponders": true,
  "ShippingTotal": 1.0,
  "ShippingTax": 1.0,
  "HandlingFee": 1.0,
  "HandlingTax": 1.0,
  "InvoiceNumber": "sample string 7",
  "CustomerDID": "sample string 8",
  "HostCustomerID": 1,
  "HostCustomerDID": "sample string 9",
  "OrderMisc": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "OrderGiftMessage": {
    "Message": "sample string 1",
    "ID": 2,
    "OrderID": 1,
    "OnlineOrderID": 1,
    "Sequence": 3
  }
}

application/x-www-form-urlencoded

Sample:

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

Response Information

Resource Description

ApiResultOfOrderSummaryViewModel

Name	Type	Additional information
Result	OrderSummaryViewModel	None.
IsSuccessful	boolean	None.
MessageTranslationKey	string	None.
Message	string	None.
Messages	Collection of ApiResultMessage	None.

Response Formats

application/xml, text/xml, application/json, text/json

Sample:

Sample not available.