GET api/order/Order/GetOrderByOnlineOrderID?onlineOrderID={onlineOrderID}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| onlineOrderID | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
IOrder| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | integer |
None. |
|
| SubjectID | integer |
None. |
|
| SubjectTypeID | integer |
None. |
|
| SecondarySubjectID | integer |
None. |
|
| SecondarySubjectTypeID | integer |
None. |
|
| RankPriceTypeID | integer |
None. |
|
| MarketShowID | integer |
None. |
|
| StatusID | integer |
None. |
|
| TotalPrice | decimal number |
None. |
|
| TaxTotal | decimal number |
None. |
|
| ShippingTotal | decimal number |
None. |
|
| IsOverrideShipping | boolean |
None. |
|
| OrderDate | date |
None. |
|
| BonusDate | date |
None. |
|
| DatePosted | date |
None. |
|
| BillName1 | string |
None. |
|
| BillName2 | string |
None. |
|
| BillStreet1 | string |
None. |
|
| BillStreet2 | string |
None. |
|
| BillCity | string |
None. |
|
| BillState | string |
None. |
|
| BillPostalCode | string |
None. |
|
| BillCountry | string |
None. |
|
| BillPhone | string |
None. |
|
| ShipName1 | string |
None. |
|
| ShipName2 | string |
None. |
|
| ShipStreet1 | string |
None. |
|
| ShipStreet2 | string |
None. |
|
| ShipCity | string |
None. |
|
| ShipState | string |
None. |
|
| ShipPostalCode | string |
None. |
|
| ShipCountry | string |
None. |
|
| ShipPhone | string |
None. |
|
| InvoiceNotes | string |
None. |
|
| InvoiceNumber | string |
None. |
|
| MultiplierTypeID | integer |
None. |
|
| ShipMethodID | integer |
None. |
|
| TrackingID | string |
None. |
|
| DateShipped | date |
None. |
|
| AutoShipScheduleID | integer |
None. |
|
| BillEmail | string |
None. |
|
| ShipEmail | string |
None. |
|
| OrderLinkID | integer |
None. |
|
| BillCounty | string |
None. |
|
| ShipCounty | string |
None. |
|
| ShipGeoCode | string |
None. |
|
| Packslip_SupressFinancials | boolean |
None. |
|
| PartyID | integer |
None. |
|
| HandlingFee | decimal number |
None. |
|
| ShippingTax | decimal number |
None. |
|
| ShippingTaxCodeID | string |
None. |
|
| HandlingTax | decimal number |
None. |
|
| HandlingTaxCodeID | string |
None. |
|
| IsGiftOrder | boolean |
None. |
|
| IsOverrideHandlingFee | boolean |
None. |
|
| IsHostOrder | boolean |
None. |
|
| DataRepairNotes | string |
None. |
|
| DateVoided | date |
None. |
|
| DateLastUnofficial | date |
None. |
|
| AutoshipBatchID | integer |
None. |
|
| RetryAttempts | integer |
None. |
|
| DateLastRetry | date |
None. |
|
| RetryPaymentRuleID | integer |
None. |
|
| TaxExemptCodeID | string |
None. |
|
| IsTaxExempt | boolean |
None. |
|
| CurrencyTypeID | integer |
None. |
|
| PeriodID | integer |
None. |
|
| CompPeriodID | integer |
None. |
|
| DistributionTypeID | integer |
None. |
|
| PaymentProcessingLock | string |
None. |
Response Formats
application/xml, text/xml
Sample:
<Order> <ID>0</ID> <SubjectID>0</SubjectID> <SubjectTypeID>0</SubjectTypeID> <SecondarySubjectID>0</SecondarySubjectID> <SecondarySubjectTypeID>0</SecondarySubjectTypeID> <RankPriceTypeID>0</RankPriceTypeID> <MarketShowID>0</MarketShowID> <StatusID>0</StatusID> <TotalPrice>0</TotalPrice> <TaxTotal>0</TaxTotal> <ShippingTotal>0</ShippingTotal> <IsOverrideShipping>False</IsOverrideShipping> <OrderDate>01/01/0001 00:00:00</OrderDate> <BonusDate>01/01/0001 00:00:00</BonusDate> <DatePosted /> <BillName1 /> <BillName2 /> <BillStreet1 /> <BillStreet2 /> <BillCity /> <BillState /> <BillPostalCode /> <BillCountry /> <BillPhone /> <BillCounty /> <BillEmail /> <ShipName1 /> <ShipName2 /> <ShipStreet1 /> <ShipStreet2 /> <ShipCity /> <ShipState /> <ShipPostalCode /> <ShipCountry /> <ShipPhone /> <ShipCounty /> <ShipEmail /> <InvoiceNotes /> <InvoiceNumber /> <MultiplierTypeID>0</MultiplierTypeID> <ShipMethodID /> <TrackingID /> <DateShipped /> <AutoShipScheduleID /> <OrderLinkID /> <ShipGeoCode /> <Packslip_SupressFinancials>False</Packslip_SupressFinancials> <PartyID /> <HandlingFee>0</HandlingFee> <ShippingTax>0</ShippingTax> <ShippingTaxCodeID /> <HandlingTax>0</HandlingTax> <HandlingTaxCodeID /> <IsGiftOrder>False</IsGiftOrder> <IsOverrideHandlingFee>False</IsOverrideHandlingFee> <IsHostOrder>False</IsHostOrder> <DataRepairNotes /> <DateVoided /> <DateLastUnofficial /> <AutoshipBatchID /> <RetryAttempts /> <DateLastRetry /> <RetryPaymentRuleID>0</RetryPaymentRuleID> <TaxExemptCodeID /> <IsTaxExempt>False</IsTaxExempt> <CurrencyTypeID /> <PeriodID /> <CompPeriodID /> <DistributionTypeID /> <PaymentProcessingLock /> <CreatedBy /> <DateCreated>01/01/0001 00:00:00</DateCreated> <LastModifiedBy /> <DateLastModified /> </Order>
application/json, text/json
Sample:
{
"ID": 0,
"SubjectID": 0,
"SubjectTypeID": 0,
"SecondarySubjectID": 0,
"SecondarySubjectTypeID": 0,
"RankPriceTypeID": 0,
"MarketShowID": 0,
"StatusID": 0,
"TotalPrice": 0.0,
"TaxTotal": 0.0,
"ShippingTotal": 0.0,
"IsOverrideShipping": false,
"OrderDate": "0001-01-01T00:00:00",
"BonusDate": "0001-01-01T00:00:00",
"MultiplierTypeID": 0,
"Packslip_SupressFinancials": false,
"HandlingFee": 0.0,
"ShippingTax": 0.0,
"HandlingTax": 0.0,
"IsGiftOrder": false,
"IsOverrideHandlingFee": false,
"IsHostOrder": false,
"RetryPaymentRuleID": 0,
"IsTaxExempt": false,
"DateCreated": "0001-01-01T00:00:00"
}