Skip to content

Latest commit

 

History

History
107 lines (87 loc) · 4.78 KB

File metadata and controls

107 lines (87 loc) · 4.78 KB

OrderQuery

Properties

Name Type Description Notes
ccEmail String CC Email [optional]
channelPartnerCode String The code of the channel partner [optional]
channelPartnerOrderId String The order ID assigned by the channel partner for this order [optional]
city String City [optional]
company String Company [optional]
countryCode String ISO-3166 two letter country code [optional]
creationDateBegin String Date/time that the order was created [optional]
creationDateEnd String Date/time that the order was created [optional]
currentStage CurrentStageEnum Current stage that the order is in. [optional]
customField1 String Custom field 1 [optional]
customField10 String Custom field 10 [optional]
customField2 String Custom field 2 [optional]
customField3 String Custom field 3 [optional]
customField4 String Custom field 4 [optional]
customField5 String Custom field 5 [optional]
customField6 String Custom field 6 [optional]
customField7 String Custom field 7 [optional]
customField8 String Custom field 8 [optional]
customField9 String Custom field 9 [optional]
customerProfileOid Integer The customer profile to find associated orders for [optional]
email String Email [optional]
firstName String First name [optional]
itemId String Item ID [optional]
lastName String Last name [optional]
orderId String Order ID [optional]
paymentDateBegin String Date/time that the order was successfully processed [optional]
paymentDateEnd String Date/time that the order was successfully processed [optional]
paymentMethod PaymentMethodEnum Payment method [optional]
phone String Phone [optional]
postalCode String Postal code [optional]
purchaseOrderNumber String Purchase order number [optional]
queryTarget QueryTargetEnum Query Target [optional]
refundDateBegin String Date/time that the order was refunded [optional]
refundDateEnd String Date/time that the order was refunded [optional]
rma String RMA number [optional]
screenBrandingThemeCode String Screen branding theme code associated with the order (legacy checkout) [optional]
shipmentDateBegin String Date/time that the order was shipped [optional]
shipmentDateEnd String Date/time that the order was shipped [optional]
shippedOnDateBegin String Date/time that the order should ship on [optional]
shippedOnDateEnd String Date/time that the order should ship on [optional]
stateRegion String State for United States otherwise region or province for other countries [optional]
storefrontHostName String StoreFront host name associated with the order [optional]
total BigDecimal Total [optional]

Enum: CurrentStageEnum

Name Value
ACCOUNTS_RECEIVABLE "Accounts Receivable"
PENDING_CLEARANCE "Pending Clearance"
FRAUD_REVIEW "Fraud Review"
REJECTED "Rejected"
SHIPPING_DEPARTMENT "Shipping Department"
COMPLETED_ORDER "Completed Order"
QUOTE_REQUEST "Quote Request"
QUOTE_SENT "Quote Sent"
LEAST_COST_ROUTING "Least Cost Routing"
UNKNOWN "Unknown"

Enum: PaymentMethodEnum

Name Value
AFFIRM "Affirm"
AMAZON "Amazon"
AMAZON_SC "Amazon SC"
CASH "Cash"
CHECK "Check"
COD "COD"
CREDIT_CARD "Credit Card"
ECHECK "eCheck"
LOANHERO "LoanHero"
MONEY_ORDER "Money Order"
PAYPAL "PayPal"
PURCHASE_ORDER "Purchase Order"
QUOTE_REQUEST "Quote Request"
UNKNOWN "Unknown"
WIRE_TRANSFER "Wire Transfer"
VENMO "Venmo"
APPLE_PAY "Apple Pay"
_GOOGLE_PAY " Google Pay"
PAYPAL_FASTLANE "PayPal Fastlane"

Enum: QueryTargetEnum

Name Value
ORIGIN "origin"
CACHE "cache"