Documentation for POST api/order/Order/workflow

POST api/order/Order/workflow

Creates a customer (if needed), creates an order via workflow logic, validates and prevents duplicate InvoiceNumber requests for the same MarketShow, posts the order, add payment and returns the final order summary or error details.

Request Information

URI Parameters

None.

Body Parameters

Workflow data including customer search/info and order info.

CreateOrderWorkFlowViewModel

Name	Description	Type	Additional information
customerinfo	Customer information.	CustomerCreationViewModel	None.
orderinfo	Order information. Include payment	CreateOrderViewModel	None.

Request Formats

application/xml, text/xml

Sample:

<CreateOrderWorkFlowViewModel>
  <customerinfo>
    <FirstName>sample string 1</FirstName>
    <LastName>sample string 2</LastName>
    <Email>sample string 3</Email>
    <Password>sample string 4</Password>
    <RepDID>sample string 5</RepDID>
    <Company>sample string 6</Company>
    <Phone1>sample string 7</Phone1>
    <Phone2>sample string 8</Phone2>
    <Phone3>sample string 9</Phone3>
    <Phone4>sample string 10</Phone4>
    <ShippingStreet1>sample string 11</ShippingStreet1>
    <ShippingStreet2>sample string 12</ShippingStreet2>
    <ShippingCountry>sample string 13</ShippingCountry>
    <ShippingPostalCode>sample string 14</ShippingPostalCode>
    <ShippingCity>sample string 15</ShippingCity>
    <ShippingState>sample string 16</ShippingState>
    <ShippingCounty>sample string 17</ShippingCounty>
    <BillingStreet1>sample string 18</BillingStreet1>
    <BillingStreet2>sample string 19</BillingStreet2>
    <BillingCountry>sample string 20</BillingCountry>
    <BillingPostalCode>sample string 21</BillingPostalCode>
    <BillingCity>sample string 22</BillingCity>
    <BillingState>sample string 23</BillingState>
    <BillingCounty>sample string 24</BillingCounty>
    <AgreedToTerms>True</AgreedToTerms>
    <ReferralMarketType>1</ReferralMarketType>
    <ReferralMarketTypeInput>sample string 26</ReferralMarketTypeInput>
    <ReferCustomerID>sample string 27</ReferCustomerID>
    <TaxID>sample string 28</TaxID>
    <TaxID2>sample string 29</TaxID2>
    <ReplicatedSiteUrl>sample string 30</ReplicatedSiteUrl>
    <CustomerType>31</CustomerType>
    <SendAutoresponders>True</SendAutoresponders>
    <DateOfBirth>04/28/2026 15:53:49</DateOfBirth>
    <ReciprocalRepDID>sample string 33</ReciprocalRepDID>
    <PreferredCulture>34</PreferredCulture>
    <LinkToRepDID>sample string 35</LinkToRepDID>
  </customerinfo>
  <orderinfo>
    <RepDID>sample string 1</RepDID>
    <RepID>1</RepID>
    <CustomerDID>sample string 2</CustomerDID>
    <PartyID>1</PartyID>
    <OrderDate>04/28/2026 15:53:49</OrderDate>
    <BonusDate>04/28/2026 15:53:49</BonusDate>
    <MarketShowID>4</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>
    <ShipGeoCode>sample string 5</ShipGeoCode>
    <InvoiceNotes>sample string 6</InvoiceNotes>
    <ShipMethodID>1</ShipMethodID>
    <TaxExemptCodeID>1</TaxExemptCodeID>
    <IsTaxExempt>True</IsTaxExempt>
    <CurrencyTypeID>1</CurrencyTypeID>
    <SendAutoresponders>True</SendAutoresponders>
    <ShippingTotal>1</ShippingTotal>
    <ShippingTax>1</ShippingTax>
    <HandlingFee>1</HandlingFee>
    <HandlingTax>1</HandlingTax>
    <InvoiceNumber>sample string 9</InvoiceNumber>
    <DistributionTypeID>1</DistributionTypeID>
    <OrderDetails>
      <OrderDetailWithOverridesViewModel>
        <Quantity>1</Quantity>
        <ProductID>sample string 2</ProductID>
        <PriceTaxFields>
          <Price>1</Price>
          <TaxableAmount>2</TaxableAmount>
          <Tax>1</Tax>
        </PriceTaxFields>
        <VolumeFields>
          <Volume>1</Volume>
          <Volume2>2</Volume2>
          <Volume3>3</Volume3>
          <Volume4>4</Volume4>
        </VolumeFields>
        <OtherPriceFields>
          <OtherPrice>1</OtherPrice>
          <OtherPrice2>2</OtherPrice2>
          <OtherPrice3>3</OtherPrice3>
          <OtherPrice4>4</OtherPrice4>
        </OtherPriceFields>
        <Misc>
          <MiscFieldViewModel>
            <Name>sample string 1</Name>
            <Value>sample string 2</Value>
          </MiscFieldViewModel>
          <MiscFieldViewModel>
            <Name>sample string 1</Name>
            <Value>sample string 2</Value>
          </MiscFieldViewModel>
        </Misc>
      </OrderDetailWithOverridesViewModel>
      <OrderDetailWithOverridesViewModel>
        <Quantity>1</Quantity>
        <ProductID>sample string 2</ProductID>
        <PriceTaxFields>
          <Price>1</Price>
          <TaxableAmount>2</TaxableAmount>
          <Tax>1</Tax>
        </PriceTaxFields>
        <VolumeFields>
          <Volume>1</Volume>
          <Volume2>2</Volume2>
          <Volume3>3</Volume3>
          <Volume4>4</Volume4>
        </VolumeFields>
        <OtherPriceFields>
          <OtherPrice>1</OtherPrice>
          <OtherPrice2>2</OtherPrice2>
          <OtherPrice3>3</OtherPrice3>
          <OtherPrice4>4</OtherPrice4>
        </OtherPriceFields>
        <Misc>
          <MiscFieldViewModel>
            <Name>sample string 1</Name>
            <Value>sample string 2</Value>
          </MiscFieldViewModel>
          <MiscFieldViewModel>
            <Name>sample string 1</Name>
            <Value>sample string 2</Value>
          </MiscFieldViewModel>
        </Misc>
      </OrderDetailWithOverridesViewModel>
    </OrderDetails>
    <PaymentInfo>
      <ID>1</ID>
      <PaymentTypeID>2</PaymentTypeID>
      <PaymentTypeDescription>sample string 3</PaymentTypeDescription>
      <PaymentDate>04/28/2026 15:53:49</PaymentDate>
      <OrderID>1</OrderID>
      <Amount>5</Amount>
      <Detail1>sample string 6</Detail1>
      <Detail2>sample string 7</Detail2>
      <Detail3>sample string 8</Detail3>
      <Detail4>sample string 9</Detail4>
      <Detail5>sample string 10</Detail5>
      <Detail6>sample string 11</Detail6>
      <StatusTypeID>12</StatusTypeID>
      <MarketShowID>1</MarketShowID>
      <Detail7>sample string 13</Detail7>
      <Detail8>sample string 14</Detail8>
      <Detail9>sample string 15</Detail9>
      <Detail10>sample string 16</Detail10>
      <Detail11>sample string 17</Detail11>
      <Detail12>sample string 18</Detail12>
      <CCAccount>sample string 19</CCAccount>
      <CCAccountID>1</CCAccountID>
      <PartyPaymentID>1</PartyPaymentID>
      <PartyRewardID>1</PartyRewardID>
      <IsDoNotRecall>True</IsDoNotRecall>
      <ImportBatchID>21</ImportBatchID>
      <DataRepairNotes>sample string 22</DataRepairNotes>
      <DebitCardAccountID>1</DebitCardAccountID>
      <DebitCardProcessor_ProgrammingKey>sample string 23</DebitCardProcessor_ProgrammingKey>
      <GiftCardAccountID>1</GiftCardAccountID>
      <ECheckAccountID>1</ECheckAccountID>
      <CurrencyTypeID>1</CurrencyTypeID>
      <Detail13>sample string 24</Detail13>
      <Detail14>sample string 25</Detail14>
      <Detail15>sample string 26</Detail15>
      <Detail16>sample string 27</Detail16>
      <Detail17>sample string 28</Detail17>
      <Detail18>sample string 29</Detail18>
      <DisconnectedAccountID>1</DisconnectedAccountID>
      <PartyID>1</PartyID>
      <IsBypass>True</IsBypass>
      <TokenizedPaymentAccountID>1</TokenizedPaymentAccountID>
      <Detail19>sample string 30</Detail19>
      <PromissoryAmount>31</PromissoryAmount>
      <PromissoryPaymentID>1</PromissoryPaymentID>
      <CreatedBy>sample string 32</CreatedBy>
      <DateCreated>04/28/2026 15:53:49</DateCreated>
      <LastModifiedBy>sample string 34</LastModifiedBy>
      <DateLastModified>04/28/2026 15:53:49</DateLastModified>
      <Detail20>sample string 35</Detail20>
      <Detail21>sample string 36</Detail21>
      <Detail22>sample string 37</Detail22>
      <Detail23>sample string 38</Detail23>
      <Detail24>sample string 39</Detail24>
      <Detail25>sample string 40</Detail25>
      <IsDeletable>True</IsDeletable>
    </PaymentInfo>
    <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>
  </orderinfo>
</CreateOrderWorkFlowViewModel>

application/json, text/json

Sample:

{
  "customerinfo": {
    "FirstName": "sample string 1",
    "LastName": "sample string 2",
    "Email": "sample string 3",
    "Password": "sample string 4",
    "RepDID": "sample string 5",
    "Company": "sample string 6",
    "Phone1": "sample string 7",
    "Phone2": "sample string 8",
    "Phone3": "sample string 9",
    "Phone4": "sample string 10",
    "ShippingStreet1": "sample string 11",
    "ShippingStreet2": "sample string 12",
    "ShippingCountry": "sample string 13",
    "ShippingPostalCode": "sample string 14",
    "ShippingCity": "sample string 15",
    "ShippingState": "sample string 16",
    "ShippingCounty": "sample string 17",
    "BillingStreet1": "sample string 18",
    "BillingStreet2": "sample string 19",
    "BillingCountry": "sample string 20",
    "BillingPostalCode": "sample string 21",
    "BillingCity": "sample string 22",
    "BillingState": "sample string 23",
    "BillingCounty": "sample string 24",
    "AgreedToTerms": true,
    "ReferralMarketType": 1,
    "ReferralMarketTypeInput": "sample string 26",
    "ReferCustomerID": "sample string 27",
    "TaxID": "sample string 28",
    "TaxID2": "sample string 29",
    "ReplicatedSiteUrl": "sample string 30",
    "CustomerType": 31,
    "SendAutoresponders": true,
    "DateOfBirth": "2026-04-28T15:53:49.6053041-04:00",
    "ReciprocalRepDID": "sample string 33",
    "PreferredCulture": 34,
    "LinkToRepDID": "sample string 35"
  },
  "orderinfo": {
    "RepDID": "sample string 1",
    "RepID": 1,
    "CustomerDID": "sample string 2",
    "PartyID": 1,
    "OrderDate": "2026-04-28T15:53:49.6063033-04:00",
    "BonusDate": "2026-04-28T15:53:49.6063033-04:00",
    "MarketShowID": 4,
    "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
    },
    "ShipGeoCode": "sample string 5",
    "InvoiceNotes": "sample string 6",
    "ShipMethodID": 1,
    "TaxExemptCodeID": 1,
    "IsTaxExempt": true,
    "CurrencyTypeID": 1,
    "SendAutoresponders": true,
    "ShippingTotal": 1.0,
    "ShippingTax": 1.0,
    "HandlingFee": 1.0,
    "HandlingTax": 1.0,
    "InvoiceNumber": "sample string 9",
    "DistributionTypeID": 1,
    "OrderDetails": [
      {
        "Quantity": 1,
        "ProductID": "sample string 2",
        "PriceTaxFields": {
          "Price": 1.0,
          "TaxableAmount": 2.0,
          "Tax": 1.0
        },
        "VolumeFields": {
          "Volume": 1.0,
          "Volume2": 2.0,
          "Volume3": 3.0,
          "Volume4": 4.0
        },
        "OtherPriceFields": {
          "OtherPrice": 1.0,
          "OtherPrice2": 2.0,
          "OtherPrice3": 3.0,
          "OtherPrice4": 4.0
        },
        "Misc": [
          {
            "Name": "sample string 1",
            "Value": "sample string 2"
          },
          {
            "Name": "sample string 1",
            "Value": "sample string 2"
          }
        ]
      },
      {
        "Quantity": 1,
        "ProductID": "sample string 2",
        "PriceTaxFields": {
          "Price": 1.0,
          "TaxableAmount": 2.0,
          "Tax": 1.0
        },
        "VolumeFields": {
          "Volume": 1.0,
          "Volume2": 2.0,
          "Volume3": 3.0,
          "Volume4": 4.0
        },
        "OtherPriceFields": {
          "OtherPrice": 1.0,
          "OtherPrice2": 2.0,
          "OtherPrice3": 3.0,
          "OtherPrice4": 4.0
        },
        "Misc": [
          {
            "Name": "sample string 1",
            "Value": "sample string 2"
          },
          {
            "Name": "sample string 1",
            "Value": "sample string 2"
          }
        ]
      }
    ],
    "PaymentInfo": {
      "id": 1,
      "paymentTypeId": 2,
      "paymentType": "sample string 3",
      "paymentDate": "2026-04-28T15:53:49.6083043-04:00",
      "orderId": 1,
      "amount": 5.0,
      "detail1": "sample string 6",
      "detail2": "sample string 7",
      "detail3": "sample string 8",
      "detail4": "sample string 9",
      "detail5": "sample string 10",
      "detail6": "sample string 11",
      "statusTypeId": 12,
      "marketShowId": 1,
      "detail7": "sample string 13",
      "detail8": "sample string 14",
      "detail9": "sample string 15",
      "detail10": "sample string 16",
      "detail11": "sample string 17",
      "detail12": "sample string 18",
      "ccAccount": "sample string 19",
      "ccAccountId": 1,
      "partyPaymentId": 1,
      "partyRewardId": 1,
      "isDoNotRecall": true,
      "importBatchId": 21,
      "dataRepairNotes": "sample string 22",
      "debitCardAccountId": 1,
      "DebitCardProcessor_ProgrammingKey": "sample string 23",
      "giftCardAccountId": 1,
      "eCheckAccountId": 1,
      "currencyTypeId": 1,
      "detail13": "sample string 24",
      "detail14": "sample string 25",
      "detail15": "sample string 26",
      "detail16": "sample string 27",
      "detail17": "sample string 28",
      "detail18": "sample string 29",
      "disconnectedAccountId": 1,
      "partyId": 1,
      "isBypass": true,
      "tokenizedPaymentAccountId": 1,
      "detail19": "sample string 30",
      "promissoryAmount": 31.0,
      "promissoryPaymentId": 1,
      "createdBy": "sample string 32",
      "dateCreated": "2026-04-28T15:53:49.6103057-04:00",
      "lastModifiedBy": "sample string 34",
      "dateLastModified": "2026-04-28T15:53:49.6103057-04:00",
      "detail20": "sample string 35",
      "detail21": "sample string 36",
      "detail22": "sample string 37",
      "detail23": "sample string 38",
      "detail24": "sample string 39",
      "detail25": "sample string 40",
      "isDeletable": true
    },
    "OrderMisc": [
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      }
    ]
  }
}

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

Response Information

Resource Description

ApiResult with OrderSummaryViewModel or error information.

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.