POST api/orders/order

Request Information

URI Parameters

None.

Body Parameters

CustomerOrder
NameDescriptionTypeAdditional information
CustId

string

Required

ContactName

string

Required

ShipCustAddrId

string

None.

ShipMethodId

string

Required

ShipToAddressName

string

None.

ShipToAddressLine1

string

None.

ShipToAddressLine2

string

None.

ShipToCity

string

None.

ShipToState

string

None.

ShipToPostalCode

string

None.

BillCustAddrId

string

Required

Subtotal

decimal number

Range: inclusive between 0.25 and 2147483647

FreightCharge

decimal number

None.

OrderTotal

decimal number

None.

PromoCode

string

None.

PromoAmount

decimal number

None.

CreditCardGuid

string

None.

DeaNumber

string

None.

DeaNumberState

string

None.

PaymentTermsId

string

None.

CartItems

Collection of CartModelItem

None.

Request Formats

application/json, text/json

Sample:
{
  "CustId": "sample string 1",
  "ContactName": "sample string 2",
  "ShipCustAddrId": "sample string 3",
  "ShipMethodId": "sample string 4",
  "ShipToAddressName": "sample string 5",
  "ShipToAddressLine1": "sample string 6",
  "ShipToAddressLine2": "sample string 7",
  "ShipToCity": "sample string 8",
  "ShipToState": "sample string 9",
  "ShipToPostalCode": "sample string 10",
  "BillCustAddrId": "sample string 11",
  "Subtotal": 12.0,
  "FreightCharge": 13.0,
  "OrderTotal": 14.0,
  "PromoCode": "sample string 15",
  "PromoAmount": 16.0,
  "CreditCardGuid": "sample string 17",
  "DeaNumber": "sample string 18",
  "DeaNumberState": "sample string 19",
  "PaymentTermsId": "sample string 20",
  "CartItems": [
    {
      "LineNumber": 1,
      "ItemKey": 2,
      "ItemId": "sample string 3",
      "Strength": "sample string 4",
      "Quantity": 5,
      "LinePrice": 6.0,
      "MarketingName": "sample string 7",
      "BackOrderFlag": true,
      "CommonEffFlag": true,
      "DosageDescription": "sample string 10",
      "FlavorDesc": "sample string 11",
      "FlavorKey": 12,
      "PatientsQty": 1,
      "QtyPrescribed": 1,
      "Legal": true
    },
    {
      "LineNumber": 1,
      "ItemKey": 2,
      "ItemId": "sample string 3",
      "Strength": "sample string 4",
      "Quantity": 5,
      "LinePrice": 6.0,
      "MarketingName": "sample string 7",
      "BackOrderFlag": true,
      "CommonEffFlag": true,
      "DosageDescription": "sample string 10",
      "FlavorDesc": "sample string 11",
      "FlavorKey": 12,
      "PatientsQty": 1,
      "QtyPrescribed": 1,
      "Legal": true
    }
  ]
}

application/xml, text/xml

Sample:
<CustomerOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WedgewoodAPI.Models">
  <BillCustAddrId>sample string 11</BillCustAddrId>
  <CartItems>
    <CartModelItem>
      <BackOrderFlag>true</BackOrderFlag>
      <CommonEffFlag>true</CommonEffFlag>
      <DosageDescription>sample string 10</DosageDescription>
      <FlavorDesc>sample string 11</FlavorDesc>
      <FlavorKey>12</FlavorKey>
      <ItemId>sample string 3</ItemId>
      <ItemKey>2</ItemKey>
      <Legal>true</Legal>
      <LineNumber>1</LineNumber>
      <LinePrice>6</LinePrice>
      <MarketingName>sample string 7</MarketingName>
      <PatientsQty>1</PatientsQty>
      <QtyPrescribed>1</QtyPrescribed>
      <Quantity>5</Quantity>
      <Strength>sample string 4</Strength>
    </CartModelItem>
    <CartModelItem>
      <BackOrderFlag>true</BackOrderFlag>
      <CommonEffFlag>true</CommonEffFlag>
      <DosageDescription>sample string 10</DosageDescription>
      <FlavorDesc>sample string 11</FlavorDesc>
      <FlavorKey>12</FlavorKey>
      <ItemId>sample string 3</ItemId>
      <ItemKey>2</ItemKey>
      <Legal>true</Legal>
      <LineNumber>1</LineNumber>
      <LinePrice>6</LinePrice>
      <MarketingName>sample string 7</MarketingName>
      <PatientsQty>1</PatientsQty>
      <QtyPrescribed>1</QtyPrescribed>
      <Quantity>5</Quantity>
      <Strength>sample string 4</Strength>
    </CartModelItem>
  </CartItems>
  <ContactName>sample string 2</ContactName>
  <CreditCardGuid>sample string 17</CreditCardGuid>
  <CustId>sample string 1</CustId>
  <DeaNumber>sample string 18</DeaNumber>
  <DeaNumberState>sample string 19</DeaNumberState>
  <FreightCharge>13</FreightCharge>
  <OrderTotal>14</OrderTotal>
  <PaymentTermsId>sample string 20</PaymentTermsId>
  <PromoAmount>16</PromoAmount>
  <PromoCode>sample string 15</PromoCode>
  <ShipCustAddrId>sample string 3</ShipCustAddrId>
  <ShipMethodId>sample string 4</ShipMethodId>
  <ShipToAddressLine1>sample string 6</ShipToAddressLine1>
  <ShipToAddressLine2>sample string 7</ShipToAddressLine2>
  <ShipToAddressName>sample string 5</ShipToAddressName>
  <ShipToCity>sample string 8</ShipToCity>
  <ShipToPostalCode>sample string 10</ShipToPostalCode>
  <ShipToState>sample string 9</ShipToState>
  <Subtotal>12</Subtotal>
</CustomerOrder>

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.