CData JDBC Driver for Magento 2019 - Online Help
Questions / Feedback?

Orders

CData JDBC Driver for Magento 2019 - Build 19.0.7354

Query the available orders in Magento.

Select

The Orders view supports server-side processing for all columns in the WHERE clause. However, some columns have restrictions on the operators that can be used.

The driver will use the Magento API to filter the results with these operators while the rest of the filter is executed client side within the driver.

  • String columns support the following operators: >, >=, <, <=, =, IN, NOT IN, LIKE, or NOT LIKE.
  • CreatedAt can be used twice to specify a range and supports the following operators: >, >=, <, <=, and =.
  • Other columns support the following operators: >, >=, <, <=, =, IN, or NOT IN.

For example, the following query is processed server side:

SELECT * FROM Orders WHERE DiscountAmount > 0.05 AND Status = 'pending' AND StoreName NOT LIKE '%main%' ORDER BY CreatedAt
You can turn off client-side execution by setting SupportEnhancedSQL to false, in which case any search criteria that refers to any other columns or operators will cause an error.

Columns

Name Type Description
EntityId [KEY] Integer The Id of the order.
Status String Order status.
CouponCode String Order coupon code.
ShippingDescription String Order shipping address.
CustomerId Integer Order customer Id.
BaseDiscountAmount Double Order base discount amount.
BaseGrandTotal Double Order base grand total.
BaseShippingAmount Double Order base shipping amount.
BaseShippingTaxAmount Double Order base shipping tax amount.
BaseSubtotal Double Order base subtotal.
BaseTaxAmount Double Order base tax amount.
BaseTotalPaid Double Total amount paid for the order.
BaseTotalRefunded Double Total base amount refunded for the order.
DiscountAmount Double Order total discount.
GrandTotal Double Order grand total.
ShippingAmount Double Order shipping amount.
ShippingTaxAmount Double Order shipping tax amount.
StoreToOrderRate Double Store-to-order rate.
Subtotal Double Order subtotal.
TaxAmount Double Order tax amount.
TotalPaid Double Total paid for the order.
TotalRefunded Double Total refunded for the order.
BaseShippingDiscountAmount Double Base shipping discount amount of the order.
BaseSubtotalInclTax Double Order base subtotal including tax.
BaseTotalDue Double Base due total of the order.
ShippingDiscountAmount Double Shipping discount amount for the order.
SubtotalInclTax Double Order subtotal including tax.
TotalDue Double Order due total.
IncrementId String Order increment Id.
BaseCurrencyCode String Order base currency code.
DiscountDescription String Order discount description.
RemoteIp String Order remote IP.
StoreCurrencyCode String Order currency code.
StoreName String Order store name.
CreatedAt Datetime Order creation date.
ShippingInclTax Double Total amount of the shipping including tax.
BaseCustomerBalanceAmount Double Base customer balance amount.
CustomerBalanceAmount Double Cutomer balance amount.
PaymentMethod String Order payment method.
GiftMessageFrom String Order gift message from.
GiftMessageTo String Order gift message to.
GiftMessageBody String Order gift message body.
TaxName String Order tax name.
TaxRate Double Order tax rate.

 
 
Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 19.0.7354.0