GET api/order/OnlineOrder/{id}

Allows you to get a specific Online Order based on the ID.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The ID of the you want to get

integer

Required

Body Parameters

None.

Response Information

Resource Description

OnlineOrderFullViewModel
NameDescriptionTypeAdditional information
ID

The ID of the online order.

integer

None.

SubjectID

The Subject ID of the online order. This is an internal identifier as to the user who will "own" the order.

integer

None.

SubjectTypeID

This defines what kind of user ID to expect for the Subject ID

integer

None.

SecondarySubjectID

Should their be a secondary person associated to the order. This is the ID of that user.

integer

None.

SecondarySubjectTypeID

This defines what kind of user ID to expect for the Secondary Subject ID

integer

None.

ShipMethodID

The shipping method associated with the order. Be aware, sometimes, various products purchased may use a different ship method. Like a very large item shipping freight when the rest of the order uses 3 day shipping.

integer

None.

MarketShowID

This is the Market Show related to the online order. The Market Show is used to dictate which market type the order originated from. This could denote coming from a replicated site, being at an actual show or conference, and more.

integer

None.

BillFirstName

The first name associated to the billing address.

string

None.

BillLastName

The last name associated to the billing address.

string

None.

BillCompany

The company title associated to the billing address.

string

None.

BillPhone

The phone number associated to the billing address.

string

None.

BillStreet1

The first line of street/address information associated to the billing address.

string

None.

BillStreet2

The second line of street/address information associated to the billing address.

string

None.

BillCity

The city associated to the billing address.

string

None.

BillState

The state associated to the billing address.

string

None.

BillCounty

The county name associated to the billing address.

string

None.

BillPostalCode

The postal code associated to the billing address.

string

None.

BillCountry

The country associated to the billing address.

string

None.

ShipFirstName

The first name associated to the shipping address.

string

None.

ShipLastName

The last name associated to the shipping address.

string

None.

ShipCompany

The company title associated to the shipping address.

string

None.

ShipPhone

The phone number associated to the shipping address.

string

None.

ShipStreet1

The first line of street/address information associated to the shipping address.

string

None.

ShipStreet2

The second line of street/address information associated to the shipping address.

string

None.

ShipCity

The city associated to the shipping address.

string

None.

ShipState

The state associated to the shipping address.

string

None.

ShipCounty

The county name associated to the shipping address.

string

None.

ShipPostalCode

The postal code associated to the shipping address.

string

None.

ShipCountry

The country associated to the shipping address.

string

None.

IPAddress

Usually once finalized, an IP Address is stored to denote where the online order originated. This is not always filled out dependent upon the context of order creation.

string

None.

Total

The order total including shipping, handling, and tax.

decimal number

None.

IsComplete

Defines whether or not the order has been finalized. Finalized orders cannot be modified.

boolean

None.

OrderID

Once an order is finalized. This is the permanent Order ID assigned to it.

integer

None.

Email

The email associated to the order.

string

None.

PaymentType

The payment type that was used to finalize the order.

string

None.

PaymentDate

The date the payment was made used to finalize the order.

date

None.

PaymentAmount

The total payment made to finalize the order. With gift certificates, credits, and promotions, this amount does not always match the order total.

decimal number

None.

ShippingTotal

The cost of shipping associated to the order.

decimal number

None.

RankPriceTypeID

This defines the rank price associated to the online order. See the API for Rank Price Types for more details.

integer

None.

CreditAmount

If any credit was used towards finalizing the order, that amount is given here.

decimal number

None.

ShipGeocode

The geocode location associated to the shipping address.

string

None.

HandlingFee

The handling fee (cost associated to shipping)

decimal number

None.

ShippingTax

The shipping tax

decimal number

None.

ShippingTaxCodeID

Defines which tax method was used to calculate the shipping tax.

string

None.

HandlingTax

The handling tax (cost associated to shipping)

decimal number

None.

HandlingTaxCodeID

Defines which tax method was used to calcualte the handlign tax.

string

None.

PaymentStatusTypeID

The status of the payment used to finalize the order.

integer

None.

IsGiftOrder

Defines whether or not the order contains a gift message and is considered a gift order.

boolean

None.

IsOrderDraft

Defines whether or not the order is a draft

boolean

None.

IsOverrideShipping

For certain orders, the shipping value can be overridden to a certain amount. If that happens, this will be set to true.

boolean

None.

OrigShipStreet1

In the event the shipping address is set to a warehouse (for will call shipping), this gives us the original shipping address for tax/reporting purposes.

string

None.

OrigShipStreet2

In the event the shipping address is set to a warehouse (for will call shipping), this gives us the original shipping address for tax/reporting purposes.

string

None.

OrigShipCity

In the event the shipping address is set to a warehouse (for will call shipping), this gives us the original shipping address city for tax/reporting purposes.

string

None.

OrigShipState

In the event the shipping address is set to a warehouse (for will call shipping), this gives us the original shipping address state for tax/reporting purposes.

string

None.

OrigShipPostalCode

In the event the shipping address is set to a warehouse (for will call shipping), this gives us the original shipping address postal code for tax/reporting purposes.

string

None.

OrigShipCounty

In the event the shipping address is set to a warehouse (for will call shipping), this gives us the original shipping address county for tax/reporting purposes.

string

None.

OrigShipCountry

In the event the shipping address is set to a warehouse (for will call shipping), this gives us the original shipping address country for tax/reporting purposes.

string

None.

IsExtCheckoutAdjustShipForOverride

Should the order have had the shipment cost adjusted to allow for overrides, this will be set to true.

boolean

None.

CurrencyTypeID

Defines the currency associated to this order. See the Currency Types API for details.

integer

None.

OriginalRankPriceTypeID

Should the Rank Price have been overwritten, this gives the original rank price type

integer

None.

DateCreated

The date the order was created

date

None.

PartyID

The party associated to this order (if any)

integer

None.

CartConfigurationID

integer

None.

CartConfigurationName

string

None.

IsLockedForPaymentProcessing

boolean

None.

PaymentDeclineID

integer

None.

OnBehalfBCKey

integer

None.

OnBehalfRepID

integer

None.

OnBehalfRepDID

string

None.

OnBehalfRepDisplayName

string

None.

Response Formats

application/json, text/json

Sample:

Sample not available.