Skip to content

Latest commit

 

History

History
54 lines (51 loc) · 4.26 KB

File metadata and controls

54 lines (51 loc) · 4.26 KB

# OrderQuery

Properties

Name Type Description Notes
card_bin string First six digits (BIN) of the credit card number. Must be specified together with card_last4 and a payment_date_begin/payment_date_end range. Requires query_target=cache. [optional]
card_last4 string Last four digits of the credit card number. Must be specified together with card_bin and a payment_date_begin/payment_date_end range. Always supply four digits, including for American Express. Requires query_target=cache. [optional]
cc_email string CC Email [optional]
channel_partner_code string The code of the channel partner [optional]
channel_partner_order_id string The order ID assigned by the channel partner for this order [optional]
city string City [optional]
company string Company [optional]
country_code string ISO-3166 two letter country code [optional]
creation_date_begin string Date/time that the order was created [optional]
creation_date_end string Date/time that the order was created [optional]
current_stage string Current stage that the order is in. [optional]
custom_field_1 string Custom field 1 [optional]
custom_field_10 string Custom field 10 [optional]
custom_field_2 string Custom field 2 [optional]
custom_field_3 string Custom field 3 [optional]
custom_field_4 string Custom field 4 [optional]
custom_field_5 string Custom field 5 [optional]
custom_field_6 string Custom field 6 [optional]
custom_field_7 string Custom field 7 [optional]
custom_field_8 string Custom field 8 [optional]
custom_field_9 string Custom field 9 [optional]
customer_profile_oid int The customer profile to find associated orders for [optional]
email string Email [optional]
first_name string First name [optional]
item_id string Item ID [optional]
last_name string Last name [optional]
order_id string Order ID [optional]
payment_date_begin string Date/time that the order was successfully processed [optional]
payment_date_end string Date/time that the order was successfully processed [optional]
payment_method string Payment method [optional]
payment_transaction_filters \ultracart\v2\models\OrderQueryPaymentTransactionFilter[] Exact-match filters on the detail name/value pairs of a single payment transaction, AND-ed against the same transaction. Requires query_target=cache. The origin or database path cannot search transaction details. The rotating gateway is just another pair, name equals rotatingTransactionGatewayCode or rotatingTransactionGatewayName. [optional]
phone string Phone [optional]
postal_code string Postal code [optional]
purchase_order_number string Purchase order number [optional]
query_target string Query Target [optional]
refund_date_begin string Date/time that the order was refunded [optional]
refund_date_end string Date/time that the order was refunded [optional]
rma string RMA number [optional]
screen_branding_theme_code string Screen branding theme code associated with the order (legacy checkout) [optional]
shipment_date_begin string Date/time that the order was shipped [optional]
shipment_date_end string Date/time that the order was shipped [optional]
shipped_on_date_begin string Date/time that the order should ship on [optional]
shipped_on_date_end string Date/time that the order should ship on [optional]
state_region string State for United States otherwise region or province for other countries [optional]
storefront_host_name string StoreFront host name associated with the order [optional]
total float Total [optional]

[Back to Model list] [Back to API list] [Back to README]