Authentication |
ApiAuthenticationType |
|
Authentication.DealerId |
Int |
Your Dealer ID |
Authentication.SubAccountId |
Int |
(optional) Your SubAccount ID |
Authentication.ApiKey |
String |
Your API Key |
Order |
OrderType |
|
Order.Channel |
String |
Sales channel |
Order.DateOrdered |
String |
Date order was placed |
Order.Reference |
String |
Order number |
Order.Customer |
CustomerType |
|
Order.Customer.Id |
String |
Customer unique identifier |
Order.Customer.City |
String |
City of customer's address |
Order.Customer.StateOrProvince |
String |
State of customer's address |
Order.Customer.PostalCode |
String |
Postal code (or ZIP code) of customer's address |
Order.Customer.CountryCode |
String |
Country code of customer's address |
Order.Customer.Email |
String |
Email address of customer |
Order.Item |
ItemType |
|
Order.Item.Id |
String |
Unique identifier for item |
Order.Item.Category |
String |
Top level category placement of item |
Order.Item.Category2 |
String |
2nd level category placement of item |
Order.Item.Category3 |
String |
3rd level category placement of item |
Order.Item.Manufacturer |
String |
Manufacturer of item to be returned |
Order.Item.Model |
String |
Model of item to be returned |
Order.Item.Price |
String |
Price of item to be returned |
Order.Item.UPC |
String |
UPC code of item to be returned |
Order.Item.Condition |
String |
Condition of item to be returned |
Order.Item.QuantityOrdered |
String |
Total quantity ordered of item to be returned |
ShippingInformation |
ShippingInformationType |
|
ShippingInformation.DateShipped |
date |
Date that item shipped |
ShippingInformation.Carrier |
String |
Carrier used to deliver item |
ShippingInformation.ServiceType |
String |
Carrier's service type selected to deliver item |
ShippingInformation.WarehouseLocation |
WarehouseInformationType |
Location of warehouse that fulfilled order |
ShippingInformation.WarehouseLocation.Id |
String |
Unique identifier of warehouse location |
ShippingInformation.WarehouseLocation.City |
String |
City of warehouse's address |
ShippingInformation.WarehouseLocation.StateOrProvince |
String |
State/Province of warehouse's address |
ShippingInformation.WarehouseLocation.PostalCode |
String |
Postal code (ZIP code) of warehouse's address |
ShippingInformation.WarehouseLocation.CountryCode |
String |
Country code of warehouse's address |
ShippingInformation.PackageDetails |
PackageDetailsType |
|
ShippingInformation.PackageDetails.DoubleBoxed |
String |
Was item double boxed? Valid options are: NotAvailable, Yes or No |
ShippingInformation.PackageDetails.ItemCount |
Int |
Count of items in package (1 if shipped by itself) |
ShippingInformation.PackageDetails.Depth |
String |
Depth of package |
ShippingInformation.PackageDetails.Length |
String |
Length of package |
ShippingInformation.PackageDetails.Width |
String |
Width of package |
ShippingInformation.PackageDetails.Weight |
String |
Weight of package |
Vendor |
VendorType |
Vendor information |
Vendor.Id |
String |
Unique identifier of vendor |
Vendor.Name |
String |
Name of vendor |
ReturnInformation |
ReturnType |
|
ReturnInformation.QuantityToReturn |
Int |
Quantity to be returned |
ReturnInformation.ReasonType |
String |
Reason type |
ReturnInformation.ReasonDescription |
String |
Description of reason type |