Skip to content

OrderQuery.md

Latest commit

 

History

History
134 lines (81 loc) · 4.54 KB

OrderQuery.md

File metadata and controls

134 lines (81 loc) · 4.54 KB

UltraCartRestApiV2.OrderQuery

Properties

Name Type Description Notes
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 Number 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]
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 Number Total [optional]

Enum: CurrentStageEnum

  • Accounts Receivable (value: "Accounts Receivable")

  • Pending Clearance (value: "Pending Clearance")

  • Fraud Review (value: "Fraud Review")

  • Rejected (value: "Rejected")

  • Shipping Department (value: "Shipping Department")

  • Completed Order (value: "Completed Order")

  • Quote Request (value: "Quote Request")

  • Quote Sent (value: "Quote Sent")

  • Least Cost Routing (value: "Least Cost Routing")

  • Unknown (value: "Unknown")

Enum: PaymentMethodEnum

  • Affirm (value: "Affirm")

  • Amazon (value: "Amazon")

  • Amazon SC (value: "Amazon SC")

  • Cash (value: "Cash")

  • Check (value: "Check")

  • COD (value: "COD")

  • Credit Card (value: "Credit Card")

  • eCheck (value: "eCheck")

  • LoanHero (value: "LoanHero")

  • Money Order (value: "Money Order")

  • PayPal (value: "PayPal")

  • Purchase Order (value: "Purchase Order")

  • Quote Request (value: "Quote Request")

  • Unknown (value: "Unknown")

  • Wire Transfer (value: "Wire Transfer")

  • Venmo (value: "Venmo")

  • Apple Pay (value: "Apple Pay")

  • Google Pay (value: " Google Pay")

  • PayPal Fastlane (value: "PayPal Fastlane")

Enum: QueryTargetEnum

  • origin (value: "origin")

  • cache (value: "cache")