POST api/order

Request Information

URI Parameters

None.

Body Parameters

CreateOrderRequest
NameDescriptionTypeAdditional information
ExternalId

integer

None.

PreviousExternalID

integer

None.

Email

string

None.

MobilePhone

string

None.

UserID

string

None.

CurrencyCode

string

None.

CountryCode

string

None.

State

string

None.

ZipCode

string

None.

OrderType

string

None.

DealerCode

string

None.

PaymentMethod

Collection of string

None.

OrderReferenceNo

string

None.

isRecurring

boolean

None.

WalletId

integer

None.

WalletDebitAmount

decimal number

None.

PromoCode

string

None.

PromoName

string

None.

TransactionDate

integer

None.

TransactionId

integer

None.

ExchangeRate

decimal number

None.

TaxTotal

decimal number

None.

Total

decimal number

None.

OrderItems

Collection of OrderItem

None.

Custom

string

None.

ProcessCount

integer

None.

WebJobId

integer

None.

WebLogId

integer

None.

Route

string

None.

ApiUser

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ExternalId": 1,
  "PreviousExternalID": 2,
  "Email": "sample string 3",
  "MobilePhone": "sample string 4",
  "UserID": "sample string 5",
  "CurrencyCode": "sample string 6",
  "CountryCode": "sample string 7",
  "State": "sample string 8",
  "ZipCode": "sample string 9",
  "OrderType": "sample string 10",
  "DealerCode": "sample string 11",
  "PaymentMethod": [
    "sample string 1",
    "sample string 2"
  ],
  "OrderReferenceNo": "sample string 12",
  "isRecurring": true,
  "WalletId": 1,
  "WalletDebitAmount": 1.1,
  "PromoCode": "sample string 14",
  "PromoName": "sample string 15",
  "TransactionDate": 16,
  "TransactionId": 17,
  "ExchangeRate": 18.1,
  "TaxTotal": 1.1,
  "Total": 1.1,
  "OrderItems": [
    {
      "ItemName": "sample string 1",
      "SkuId": "sample string 2",
      "ContentId": "sample string 3",
      "Quantity": 4,
      "AmountBaseCurrency": 5.1,
      "AmountLocalCurrency": 6.1,
      "TaxAmount": 1.1,
      "TaxRate": 1.1,
      "NetAmount": 1.1,
      "PromoCode": "sample string 7",
      "DiscountAmount": 1.1,
      "DiscountTaxRate": 1.1,
      "DiscountTaxAmount": 1.1,
      "GrossAmount": 8.1,
      "OrderType": 9,
      "UpgradeFromItemId": "sample string 10",
      "IsRecurring": true,
      "StartDate": 11,
      "EndDate": 12,
      "StartDateStr": "sample string 13",
      "EndDateStr": "sample string 14",
      "StartDateTime": "sample string 15",
      "EndDateTime": "sample string 16"
    },
    {
      "ItemName": "sample string 1",
      "SkuId": "sample string 2",
      "ContentId": "sample string 3",
      "Quantity": 4,
      "AmountBaseCurrency": 5.1,
      "AmountLocalCurrency": 6.1,
      "TaxAmount": 1.1,
      "TaxRate": 1.1,
      "NetAmount": 1.1,
      "PromoCode": "sample string 7",
      "DiscountAmount": 1.1,
      "DiscountTaxRate": 1.1,
      "DiscountTaxAmount": 1.1,
      "GrossAmount": 8.1,
      "OrderType": 9,
      "UpgradeFromItemId": "sample string 10",
      "IsRecurring": true,
      "StartDate": 11,
      "EndDate": 12,
      "StartDateStr": "sample string 13",
      "EndDateStr": "sample string 14",
      "StartDateTime": "sample string 15",
      "EndDateTime": "sample string 16"
    }
  ],
  "Custom": "sample string 19",
  "ProcessCount": 1,
  "WebJobId": 20,
  "WebLogId": 21,
  "Route": "sample string 22",
  "ApiUser": "sample string 23"
}

application/xml, text/xml

Sample:
<CreateOrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EvergentInterface.Core.ApiClasses">
  <ApiUser>sample string 23</ApiUser>
  <CountryCode>sample string 7</CountryCode>
  <CurrencyCode>sample string 6</CurrencyCode>
  <Custom>sample string 19</Custom>
  <DealerCode>sample string 11</DealerCode>
  <Email>sample string 3</Email>
  <ExchangeRate>18.1</ExchangeRate>
  <ExternalId>1</ExternalId>
  <MobilePhone>sample string 4</MobilePhone>
  <OrderItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/EvergentInterface.Core.DomainClasses">
    <d2p1:OrderItem>
      <d2p1:AmountBaseCurrency>5.1</d2p1:AmountBaseCurrency>
      <d2p1:AmountLocalCurrency>6.1</d2p1:AmountLocalCurrency>
      <d2p1:ContentId>sample string 3</d2p1:ContentId>
      <d2p1:DiscountAmount>1.1</d2p1:DiscountAmount>
      <d2p1:DiscountTaxAmount>1.1</d2p1:DiscountTaxAmount>
      <d2p1:DiscountTaxRate>1.1</d2p1:DiscountTaxRate>
      <d2p1:EndDate>12</d2p1:EndDate>
      <d2p1:EndDateStr>sample string 14</d2p1:EndDateStr>
      <d2p1:EndDateTime>sample string 16</d2p1:EndDateTime>
      <d2p1:GrossAmount>8.1</d2p1:GrossAmount>
      <d2p1:IsRecurring>true</d2p1:IsRecurring>
      <d2p1:ItemName>sample string 1</d2p1:ItemName>
      <d2p1:NetAmount>1.1</d2p1:NetAmount>
      <d2p1:OrderType>9</d2p1:OrderType>
      <d2p1:PromoCode>sample string 7</d2p1:PromoCode>
      <d2p1:Quantity>4</d2p1:Quantity>
      <d2p1:SkuId>sample string 2</d2p1:SkuId>
      <d2p1:StartDate>11</d2p1:StartDate>
      <d2p1:StartDateStr>sample string 13</d2p1:StartDateStr>
      <d2p1:StartDateTime>sample string 15</d2p1:StartDateTime>
      <d2p1:TaxAmount>1.1</d2p1:TaxAmount>
      <d2p1:TaxRate>1.1</d2p1:TaxRate>
      <d2p1:UpgradeFromItemId>sample string 10</d2p1:UpgradeFromItemId>
    </d2p1:OrderItem>
    <d2p1:OrderItem>
      <d2p1:AmountBaseCurrency>5.1</d2p1:AmountBaseCurrency>
      <d2p1:AmountLocalCurrency>6.1</d2p1:AmountLocalCurrency>
      <d2p1:ContentId>sample string 3</d2p1:ContentId>
      <d2p1:DiscountAmount>1.1</d2p1:DiscountAmount>
      <d2p1:DiscountTaxAmount>1.1</d2p1:DiscountTaxAmount>
      <d2p1:DiscountTaxRate>1.1</d2p1:DiscountTaxRate>
      <d2p1:EndDate>12</d2p1:EndDate>
      <d2p1:EndDateStr>sample string 14</d2p1:EndDateStr>
      <d2p1:EndDateTime>sample string 16</d2p1:EndDateTime>
      <d2p1:GrossAmount>8.1</d2p1:GrossAmount>
      <d2p1:IsRecurring>true</d2p1:IsRecurring>
      <d2p1:ItemName>sample string 1</d2p1:ItemName>
      <d2p1:NetAmount>1.1</d2p1:NetAmount>
      <d2p1:OrderType>9</d2p1:OrderType>
      <d2p1:PromoCode>sample string 7</d2p1:PromoCode>
      <d2p1:Quantity>4</d2p1:Quantity>
      <d2p1:SkuId>sample string 2</d2p1:SkuId>
      <d2p1:StartDate>11</d2p1:StartDate>
      <d2p1:StartDateStr>sample string 13</d2p1:StartDateStr>
      <d2p1:StartDateTime>sample string 15</d2p1:StartDateTime>
      <d2p1:TaxAmount>1.1</d2p1:TaxAmount>
      <d2p1:TaxRate>1.1</d2p1:TaxRate>
      <d2p1:UpgradeFromItemId>sample string 10</d2p1:UpgradeFromItemId>
    </d2p1:OrderItem>
  </OrderItems>
  <OrderReferenceNo>sample string 12</OrderReferenceNo>
  <OrderType>sample string 10</OrderType>
  <PaymentMethod xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </PaymentMethod>
  <PreviousExternalID>2</PreviousExternalID>
  <ProcessCount>1</ProcessCount>
  <PromoCode>sample string 14</PromoCode>
  <PromoName>sample string 15</PromoName>
  <Route>sample string 22</Route>
  <State>sample string 8</State>
  <TaxTotal>1.1</TaxTotal>
  <Total>1.1</Total>
  <TransactionDate>16</TransactionDate>
  <TransactionId>17</TransactionId>
  <UserID>sample string 5</UserID>
  <WalletDebitAmount>1.1</WalletDebitAmount>
  <WalletId>1</WalletId>
  <WebJobId>20</WebJobId>
  <WebLogId>21</WebLogId>
  <ZipCode>sample string 9</ZipCode>
  <isRecurring>true</isRecurring>
</CreateOrderRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.