Skip to content

Order.md

Latest commit

 

History

History
80 lines (57 loc) · 4.51 KB

Order.md

File metadata and controls

80 lines (57 loc) · 4.51 KB

UltraCartRestApiV2.Order

Properties

Name Type Description Notes
affiliates [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]
auto_order OrderAutoOrder [optional]
billing OrderBilling [optional]
buysafe OrderBuysafe [optional]
channel_partner OrderChannelPartner [optional]
checkout OrderCheckout [optional]
coupons [OrderCoupon] Coupons [optional]
creation_dts String Date/time that the order was created [optional]
currency_code String Currency code that the customer used if different than the merchant's base currency code [optional]
current_stage String Current stage that the order is in. [optional]
current_stage_histories [OrderCurrentStageHistory] History of the changes to the current_stage field [optional]
customer_profile Customer [optional]
digital_order OrderDigitalOrder [optional]
edi OrderEdi [optional]
exchange_rate Number Exchange rate at the time the order was placed if currency code is different than the base currency [optional]
fraud_score OrderFraudScore [optional]
gift OrderGift [optional]
gift_certificate OrderGiftCertificate [optional]
internal OrderInternal [optional]
items [OrderItem] Items [optional]
language_iso_code String Three letter ISO-639 language code used by the customer during the checkout if different than the default language [optional]
linked_shipment OrderLinkedShipment [optional]
marketing OrderMarketing [optional]
merchant_id String UltraCart merchant ID owning this order [optional]
order_id String Order ID [optional]
payment OrderPayment [optional]
point_of_sale OrderPointOfSale [optional]
properties [OrderProperty] Properties, available only through update, not through insert due to the nature of how properties are handled internally [optional]
quote OrderQuote [optional]
refund_dts String If the order was refunded, the date/time that the last refund occurred [optional]
refund_reason String Refund reason code. This can only be written during a refund operation otherwise this field is read only. [optional]
reject_dts String If the order was rejected, the date/time that the rejection occurred [optional]
reject_reason 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 [OrderTag] tags, available only through update, not through insert due to the nature of how tags are handled internally [optional]
taxes OrderTaxes [optional]
utms [OrderUtm] UTM clicks. The zero index is the most recent (last) UTM click [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")

  • Pre-ordered (value: "Pre-ordered")

  • Advanced Order Routing (value: "Advanced Order Routing")

  • Hold (value: "Hold")