API Data Provider - Online Help

Orders

Retrieves a list of all orders.

Columns

Name Type ReadOnly References Description
Id [KEY] Integer True

Status String True

Title String False

Total Decimal True

TotalDue Decimal True

TotalPaid Decimal True

ContactId Integer False

Contacts.Id

ContactEmail String True

ContactFirstName String True

ContactLastName String True

ContactJobTitle String True

ContactCompanyName String True

IsPaymentAllowed Boolean True

IsPaypalAllowed Boolean True

InvoiceNumber Integer True

OrderDate Datetime False

OrderType String False

The allowed values are Online, Offline.

CreationDate Datetime True

ModificationDate Datetime True

LeadAffiliateId Integer False

Notes String True

OrderItems String False

IsPaymentPlanAutoCharge Boolean True

PaymentPlanCreditCardId Integer True

PaymentPlanDaysBetweenPayments Integer True

PaymentPlanDaysBetweenRetries Integer True

PaymentPlanInitialPaymentAmount Decimal True

PaymentPlanInitialPaymentDate Datetime True

PaymentPlanInitialPaymentPercent Double True

PaymentPlanMaxChargeAttempts Integer True

PaymentPlanNumberOfPayments Integer True

PaymentPlanPaymentGatewayMerchantAccountId Integer True

PaymentPlanPaymentGatewayMerchantAccountName String True

IsPaymentPlanGatewayDefaultUsed Boolean True

PaymentPlanPaymentMethodId Integer True

PaymentPlanPlanStartDate Date True

IsRecurring Boolean True

RefundTotal Decimal True

SalesAffiliateId Integer False

ShippingInformationCompany String True

ShippingInformationCity String True

ShippingInformationCountry String True

ShippingInformationId String True

ShippingInformationFirstName String True

ShippingInformationLastName String True

ShippingInformationStreet1 String True

ShippingInformationStreet2 String True

ShippingInformationState String True

IsShippingInformationInvoiceToCompany Boolean True

ShippingInformationMiddleName String True

ShippingInformationPhone String True

ShippingInformationZip String True

SourceType String True

Terms String True

ProductId Integer True

Pseudocolumns

Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name Type Description
Paid Boolean

Sets paid status of items to return

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770.0