API Data Provider - Online Help

Orders

Retrieve all Orders.

Columns

Name Type References
Id Int
CreatedAt String
Status String

The allowed values are Abandoned, Canceled, PendingPayment, Paid.

Currency String
Subtotal Double
Tax Double
ShippingTax Double
Shipping Double
Total Double
Discount Double
ShippingDiscount Double
PaymentMethodName String
ShippingMethodId Int
ShippingMethodName String
PaymentInformation String
AdditionalInformation String
Coupons String
CustomerId Int
Email String
Phone String
CustomerStatus String

The allowed values are approved, pending, disabled.

CustomerShippingAddressName String
CustomerShippingAddressSurname String
CustomerShippingAddressAddress String
CustomerShippingAddressCity String
CustomerShippingAddressPostal String
CustomerShippingAddressMunicipality String
CustomerShippingAddressRegion Int
CustomerShippingAddressCountry String
CustomerBillingAddressName String
CustomerBillingAddressSurname String
CustomerBillingAddressTaxid String
CustomerBillingAddressAddress String
CustomerBillingAddressCity String
CustomerBillingAddressPostal String
CustomerBillingAddressMunicipality String
CustomerBillingAddressRegion Int
CustomerBillingAddressCountry String
CustomerCategory String
CustomerAdditionalFields String
ShippingAddressName String
ShippingAddressSurname String
ShippingAddressAddress String
ShippingAddressCity String
ShippingAddressPostal String
ShippingAddressMunicipality String
ShippingAddressRegion Int
ShippingAddressCountry String
BillingAddressName String
BillingAddressSurname String
Taxid String
BillingAddressAddress String
BillingAddressCity String
BillingAddressPostal String
BillingAddressMunicipality String
BillingAddressRegion Int
BillingAddressCountry String
Products String
TrackingNumber String
TrackingCompany String
TrackingUrl String
ShipmentStatus String

The allowed values are delivered, requested, in_transit, failed.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839.0