Skip to content

Latest commit

 

History

History
71 lines (59 loc) · 4.72 KB

File metadata and controls

71 lines (59 loc) · 4.72 KB

Order

Properties

Name Type Description Notes
affiliates List<OrderAffiliate> Affiliates if any were associated with the order. The first one in the array sent the order and each subsequent affiliate is the recruiter that earns a downline commission. [optional]
autoOrder OrderAutoOrder [optional]
billing OrderBilling [optional]
buysafe OrderBuysafe [optional]
channelPartner OrderChannelPartner [optional]
checkout OrderCheckout [optional]
coupons List<OrderCoupon> Coupons [optional]
creationDts String Date/time that the order was created [optional]
currencyCode String Currency code that the customer used if different than the merchant's base currency code [optional]
currentStage CurrentStageEnum Current stage that the order is in. [optional]
currentStageHistories List<OrderCurrentStageHistory> History of the changes to the current_stage field [optional]
customerProfile Customer [optional]
digitalOrder OrderDigitalOrder [optional]
edi OrderEdi [optional]
exchangeRate BigDecimal Exchange rate at the time the order was placed if currency code is different than the base currency [optional]
fraudScore OrderFraudScore [optional]
gift OrderGift [optional]
giftCertificate OrderGiftCertificate [optional]
internal OrderInternal [optional]
items List<OrderItem> Items [optional]
languageIsoCode String Three letter ISO-639 language code used by the customer during the checkout if different than the default language [optional]
linkedShipment OrderLinkedShipment [optional]
marketing OrderMarketing [optional]
merchantId String UltraCart merchant ID owning this order [optional]
orderId String Order ID [optional]
payment OrderPayment [optional]
pointOfSale OrderPointOfSale [optional]
properties List<OrderProperty> Properties, available only through update, not through insert due to the nature of how properties are handled internally [optional]
quote OrderQuote [optional]
refundDts String If the order was refunded, the date/time that the last refund occurred [optional]
refundReason String Refund reason code. This can only be written during a refund operation otherwise this field is read only. [optional]
rejectDts String If the order was rejected, the date/time that the rejection occurred [optional]
rejectReason String Reject reason code. This can only be written during a reject operation otherwise this field is read only. [optional]
salesforce OrderSalesforce [optional]
shipping OrderShipping [optional]
summary OrderSummary [optional]
tags List<OrderTag> tags, available only through update, not through insert due to the nature of how tags are handled internally [optional]
taxes OrderTaxes [optional]
utms List<OrderUtm> UTM clicks. The zero index is the most recent (last) UTM click [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"
PRE_ORDERED "Pre-ordered"
ADVANCED_ORDER_ROUTING "Advanced Order Routing"
HOLD "Hold"