API Data Provider - Online Help

Orders

List all order objects or single order.

Columns

Name Type References
ObjectId [KEY] String
OrderNumber String
OrderStatus String

The allowed values are UNKNOWN, AWAITPAY, PAID, REFUNDED, CANCELLED, PARTIALLY_FULFILLED, SHIPPED.

PlacedAt Datetime
ObjectOwner String

Batches.ObjectOwner

ToAddressValidationResults String
ToAddressCity String
ToAddressCompany String
ToAddressCountry String
ToAddressEmail String
ToAddressIsComplete Boolean
ToAddressIsResidential String
ToAddressLatitude String
ToAddressLongitude String
ToAddressMetadata String
ToAddressName String
ToAddressObjectCreated Datetime
ToAddressObjectId String
ToAddressObjectOwner String
ToAddressPhone String
ToAddressState String
ToAddressStreetNo String
ToAddressStreet1 String
ToAddressStreet2 String
ToAddressStreet3 String
ToAddressTest Boolean
ToAddressZip String
FromAddress String
ShopApp String

The allowed values are Amazon, Etsy, Spreecommerce, Shippo, Bigcommerce, GoDaddy, StripeRelay, ePages, CSV_Import, Magento, Magento, eBay, Shopify, WooCommerce.

Weight String
WeightUnit String
Transactions String
TotalTax String
TotalPrice String
SubtotalPrice String
Currency String
ShippingMethod String
ShippingCost String
ShippingCostCurrency String
LineItems String
Notes String
Test Boolean

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