Exigo Web Service

GetOrders
Returns one or more orders.

CSV Support
No
Transactional Support
No

GetOrdersRequest
CustomerID
Int32?
No
The unique identifier of the customer
OrderID
Int32?
No
The unique identifier for the order
OrderIDs
Int32[]
No
OrderDateStart
DateTime?
No
OrderDateEnd
DateTime?
No
OrderStatus
OrderStatusType?
No
The status of the order
WarehouseID
Int32?
No
The unique identifier for the warehouse
CurrencyCode
String
No
The standard ISO 4217 3-letter currency code
ReturnCustomer
Boolean?
No
ReturnKitDetails
Boolean?
No
GreaterThanOrderID
Int32?
No
GreaterThanModifiedDate
DateTime?
No
If specified, the records returned will have a ModifiedDate greater than the specified value.
BatchSize
Int32?
No
The number of records to return. Defaults to 500.
Other11
String
No
A company-defined custom value.
Other12
String
No
A company-defined custom value.
Other13
String
No
A company-defined custom value.
Other14
String
No
A company-defined custom value.
Other15
String
No
A company-defined custom value.
Other16
String
No
A company-defined custom value.
Other17
String
No
A company-defined custom value.
Other18
String
No
A company-defined custom value.
Other19
String
No
A company-defined custom value.
Other20
String
No
A company-defined custom value.
GetOrdersResponse
Orders
OrderResponse[]
RecordCount
Int32
The number of records returned
Result
ApiResult
The status of your web service call response. This property tells you if the call was executed successfully, any errors that occurred and other miscellanous, method-specific information.
OrderResponse
OrderID
Int32
The unique identifier for the order
CustomerID
Int32
The unique identifier of the customer
OrderStatus
OrderStatusType
The status of the order
OrderDate
DateTime
The date the order will process
CurrencyCode
String
The standard ISO 4217 3-letter currency code
WarehouseID
Int32
The unique identifier for the warehouse
ShipMethodID
Int32
The unique identifier for the ship method
PriceType
Int32
The type of price
FirstName
String
The customer's first name
LastName
String
The customer's last name
Company
String
The customer's company name
Address1
String
Address2
String
City
String
State
String
Zip
String
Country
String
County
String
Email
String
The customer's email address
Phone
String
The customer's primary phone number
Notes
String
Any additional notes or information about this record
Total
Decimal
The total of the order
SubTotal
Decimal
The subtotal of the order
TaxTotal
Decimal
The total taxes of the order
ShippingTotal
Decimal
The total shipping fees of the order
DiscountTotal
Decimal
The total discounts applied to the order
DiscountPercent
Decimal
WeightTotal
Decimal
The total weight of the item
BusinessVolumeTotal
Decimal
The total business volume of the order
CommissionableVolumeTotal
Decimal
The total commissionable volume of the order
TrackingNumber1
String
TrackingNumber2
String
TrackingNumber3
String
TrackingNumber4
String
TrackingNumber5
String
Other1Total
Decimal
The total value of the Other1 price of the order
Other2Total
Decimal
The total value of the Other2 price of the order
Other3Total
Decimal
The total value of the Other3 price of the order
Other4Total
Decimal
The total value of the Other4 price of the order
Other5Total
Decimal
The total value of the Other5 price of the order
Other6Total
Decimal
The total value of the Other6 price of the order
Other7Total
Decimal
The total value of the Other7 price of the order
Other8Total
Decimal
The total value of the Other8 price of the order
Other9Total
Decimal
The total value of the Other9 price of the order
Other10Total
Decimal
The total value of the Other10 price of the order
ShippingTax
Decimal
The total tax from shipping of the order
OrderTax
Decimal
FedTaxTotal
Decimal
StateTaxTotal
Decimal
FedShippingTax
Decimal
StateShippingTax
Decimal
CityShippingTax
Decimal
CityLocalShippingTax
Decimal
CountyShippingTax
Decimal
CountyLocalShippingTax
Decimal
Other11
String
A company-defined custom value.
Other12
String
A company-defined custom value.
Other13
String
A company-defined custom value.
Other14
String
A company-defined custom value.
Other15
String
A company-defined custom value.
Other16
String
A company-defined custom value.
Other17
String
A company-defined custom value.
Other18
String
A company-defined custom value.
Other19
String
A company-defined custom value.
Other20
String
A company-defined custom value.
ModifiedDate
DateTime
The date the record was last modified
OrderType
OrderType
The type of the order
ShippedDate
DateTime?
CreatedDate
DateTime
The date the record was created
CreatedBy
String
The user or entity that created the record
ModifiedBy
String
The user or entity that last modified the record
TaxFedRate
Decimal
TaxStateRate
Decimal
TaxCityRate
Decimal
TaxCityLocalRate
Decimal
TaxCountyRate
Decimal
TaxCountyLocalRate
Decimal
TaxManualRate
Decimal
TaxCity
String
TaxCounty
String
TaxState
String
TaxZip
String
TaxCountry
String
TaxIsExempt
Boolean
TaxIsOverRide
Boolean
Details
OrderDetailResponse[]
Payments
PaymentResponse[]
ExpectedPayments
ExpectedPaymentResponse[]
Customer
CustomerResponse
MiddleName
String
The customer's middle name
NameSuffix
String
The customer's name suffix
ApiResult
Status
ResultStatus
Specifies whether the web service call was successfully executed.
Errors
String[]
An array of error messages that were returned from Exigo. If the web service call was successful, this colleciton will be empty.
TransactionKey
String
The unique GUID identifier assigned to this web service call for logging purposes.
OrderDetailResponse
ItemCode
String
The alphanumeric unique identifier for the item
Description
String
Quantity
Decimal
The quantity of the item
PriceEach
Decimal
The price of each item
PriceTotal
Decimal
The total amount for this item, based on the price of the item and the quantity selected
Tax
Decimal
The tax charged for the item
WeightEach
Decimal
The weight of each item
Weight
Decimal
The weight of the items, based on the quantity selected
BusinessVolumeEach
Decimal
The BV earned for each item
BusinesVolume
Decimal
The BV earned for the item, based on the quantity selected
CommissionableVolumeEach
Decimal
The CV earned for each item
CommissionableVolume
Decimal
The CV earned for the item, based on the quantity selected
Other1Each
Decimal
A company-defined custom price amount per item.
Other1
Decimal
A company-defined custom price total.
Other2Each
Decimal
A company-defined custom price amount per item.
Other2
Decimal
A company-defined custom price total.
Other3Each
Decimal
A company-defined custom price amount per item.
Other3
Decimal
A company-defined custom price total.
Other4Each
Decimal
A company-defined custom price amount per item.
Other4
Decimal
A company-defined custom price total.
Other5Each
Decimal
A company-defined custom price amount per item.
Other5
Decimal
A company-defined custom price total.
Other6Each
Decimal
A company-defined custom price amount per item.
Other6
Decimal
A company-defined custom price total.
Other7Each
Decimal
A company-defined custom price amount per item.
Other7
Decimal
A company-defined custom price total.
Other8Each
Decimal
A company-defined custom price amount per item.
Other8
Decimal
A company-defined custom price total.
Other9Each
Decimal
A company-defined custom price amount per item.
Other9
Decimal
A company-defined custom price total.
Other10Each
Decimal
A company-defined custom price amount per item.
Other10
Decimal
A company-defined custom price total.
ParentItemCode
String
The kit's master item code. If this is defined, this item will be considered a part of a kit and it's price will not be used when calculating it into the order.
Taxable
Decimal
Specifies whether the item is taxable
FedTax
Decimal
The federal tax charged for the item
StateTax
Decimal
The state tax charged for the item
CityTax
Decimal
The city tax charged for the item
CityLocalTax
Decimal
The cities' local tax charged for the item
CountyTax
Decimal
The county tax charged for the item
CountyLocalTax
Decimal
The counties' local tax charged for the item
ManualTax
Decimal
The manually-added tax charged for the item
IsStateTaxOverride
Boolean
Specifies whether the state tax was overridden for the item
OrderLine
Int32
The 0-based index position of the item in the order's detail collection
PaymentResponse
PaymentID
Int32
The unique identifier for the payment record.
CustomerID
Int32
The unique identifier of the customer
PaymentType
PaymentType
The type of payment method the auto order will use
PaymentDate
DateTime
The date of the payment
Amount
Decimal
OrderID
Int32?
The unique identifier for the order
CurrencyCode
String
The standard ISO 4217 3-letter currency code
BillingName
String
The name on file with this payment method
BankName
String
The name on file with this payment method
Memo
String
Any extra data associated with the payment method
CreditCardNumberDisplay
String
The masked credit card number
AuthorizationCode
String
The authorization code issued by the merchant for the processed payment.
CreditCardType
Int32
The type of credit card (ie. Visa, Mastercard, etc)
CreditCardTypeDescription
String
The description of the credit card's type
ExpectedPaymentResponse
ExpectedPaymentID
Int32
The unique identifier for the expected payment record
CustomerID
Int32
The unique identifier of the customer
PaymentType
PaymentType
The type of payment method the auto order will use
PaymentDate
DateTime
The date of the payment
Amount
Decimal
OrderID
Int32
The unique identifier for the order
CurrencyCode
String
The standard ISO 4217 3-letter currency code
BillingName
String
The name on file with this payment method
AuthorizationCode
String
The authorization code issued by the merchant for the processed payment.
CustomerResponse
CustomerID
Int32
The unique identifier of the customer
FirstName
String
The customer's first name
LastName
String
The customer's last name
Company
String
The customer's company name
CustomerType
Int32
The customer's type ID. This identifier represents the customer's relationship with the company (ex. retail customer, distributor, etc.)
CustomerStatus
Int32
The customer's status ID. This identifier represents the customer's status with the company (ex. active, deleted, etc.)
Email
String
The customer's email address
Phone
String
The customer's primary phone number
Phone2
String
The customer's secondary phone number
MobilePhone
String
The customer's mobile phone number
Fax
String
The customer's fax number
MainAddress1
String
The customer's primary address' street address
MainAddress2
String
The customer's primary address' apartment, suite or box number. This field is not used when validating the address with the Exigo address validation service.
MainCity
String
The customer's primary address' city
MainState
String
The customer's primary address' state or region code (ie. TX, CA, etc.)
MainZip
String
The customer's primary address' zip code
MainCountry
String
The customer's primary address' country code (ie. US, CA, etc.)
MainCounty
String
The customer's primary address' county
MailAddress1
String
The customer's secondary address' street address
MailAddress2
String
The customer's secondary address' apartment, suite or box number. This field is not used when validating the address with the Exigo address validation service.
MailCity
String
The customer's secondary address' city
MailState
String
The customer's secondary address' state or region code (ie. TX, CA, etc.)
MailZip
String
The customer's secondary address' zip code
MailCountry
String
The customer's secondary address' country code (ie. US, CA, etc.)
MailCounty
String
The customer's secondary address' county
OtherAddress1
String
The customer's additional address' street address
OtherAddress2
String
The customer's additional address' apartment, suite or box number. This field is not used when validating the address with the Exigo address validation service.
OtherCity
String
The customer's additional address' city
OtherState
String
The customer's additional address' state or region code (ie. TX, CA, etc.)
OtherZip
String
The customer's additional address' zip code
OtherCountry
String
The customer's additional address' country code (ie. US, CA, etc.)
OtherCounty
String
The customer's additional address' county
LoginName
String
The customer's login name
EnrollerID
Int32
The customer's enroller's ID
SponsorID
Int32
The customer's Unilevel sponsor's ID
RankID
Int32
BirthDate
DateTime
The customer's birth date
Field1
String
Field2
String
Field3
String
Field4
String
Field5
String
Field6
String
Field7
String
Field8
String
Field9
String
Field10
String
Field11
String
Field12
String
Field13
String
Field14
String
Field15
String
Date1
DateTime?
A company-defined custom date
Date2
DateTime?
A company-defined custom date
Date3
DateTime?
A company-defined custom date
Date4
DateTime?
A company-defined custom date
Date5
DateTime?
A company-defined custom date
CurrencyCode
String
The standard ISO 4217 3-letter currency code
PayableToName
String
The customer's preferred name used in commisson payouts
DefaultWarehouseID
Int32
The customer's default warehouse ID
PayableType
PayableType
The customer's commission payout preference
CheckThreshold
Decimal
The customer's preferred minimum amount for each paid commission. For example, if the CheckThreshold is 50.00, the customer will not be paid a commission until their commissions meet or exceed 50.00.
PriceType
Int32
The type of price
LanguageID
Int32
The customer's preferred language ID (ex. 0 (English), 1 (Spanish), etc.)
Gender
Gender
The customer's gender (ie. 'M' (Male), 'F' (Female), 'U' (Undecided))
SalesTaxID
String
The customer's sales tax ID
VatRegistration
String
The customer's VAT registration number
IsSalesTaxExempt
Boolean
Specifies whether the customer is exempt from sales tax.
IsSubscribedToBroadcasts
Boolean
Specifies if the customer is opted in to receive email broadcasts.
CreatedDate
DateTime
The date the record was created
ModifiedDate
DateTime
The date the record was last modified
MiddleName
String
The customer's middle name
NameSuffix
String
The customer's name suffix