SalesDataOrderInterface.md

SalesDataOrderInterface

Properties

Name	Type	Description	Notes
adjustment_negative	float	Negative adjustment value.	[optional]
adjustment_positive	float	Positive adjustment value.	[optional]
applied_rule_ids	str	Applied rule IDs.	[optional]
base_adjustment_negative	float	Base negative adjustment value.	[optional]
base_adjustment_positive	float	Base positive adjustment value.	[optional]
base_currency_code	str	Base currency code.	[optional]
base_discount_amount	float	Base discount amount.	[optional]
base_discount_canceled	float	Base discount canceled.	[optional]
base_discount_invoiced	float	Base discount invoiced.	[optional]
base_discount_refunded	float	Base discount refunded.	[optional]
base_grand_total	float	Base grand total.
base_discount_tax_compensation_amount	float	Base discount tax compensation amount.	[optional]
base_discount_tax_compensation_invoiced	float	Base discount tax compensation invoiced.	[optional]
base_discount_tax_compensation_refunded	float	Base discount tax compensation refunded.	[optional]
base_shipping_amount	float	Base shipping amount.	[optional]
base_shipping_canceled	float	Base shipping canceled.	[optional]
base_shipping_discount_amount	float	Base shipping discount amount.	[optional]
base_shipping_discount_tax_compensation_amnt	float	Base shipping discount tax compensation amount.	[optional]
base_shipping_incl_tax	float	Base shipping including tax.	[optional]
base_shipping_invoiced	float	Base shipping invoiced.	[optional]
base_shipping_refunded	float	Base shipping refunded.	[optional]
base_shipping_tax_amount	float	Base shipping tax amount.	[optional]
base_shipping_tax_refunded	float	Base shipping tax refunded.	[optional]
base_subtotal	float	Base subtotal.	[optional]
base_subtotal_canceled	float	Base subtotal canceled.	[optional]
base_subtotal_incl_tax	float	Base subtotal including tax.	[optional]
base_subtotal_invoiced	float	Base subtotal invoiced.	[optional]
base_subtotal_refunded	float	Base subtotal refunded.	[optional]
base_tax_amount	float	Base tax amount.	[optional]
base_tax_canceled	float	Base tax canceled.	[optional]
base_tax_invoiced	float	Base tax invoiced.	[optional]
base_tax_refunded	float	Base tax refunded.	[optional]
base_total_canceled	float	Base total canceled.	[optional]
base_total_due	float	Base total due.	[optional]
base_total_invoiced	float	Base total invoiced.	[optional]
base_total_invoiced_cost	float	Base total invoiced cost.	[optional]
base_total_offline_refunded	float	Base total offline refunded.	[optional]
base_total_online_refunded	float	Base total online refunded.	[optional]
base_total_paid	float	Base total paid.	[optional]
base_total_qty_ordered	float	Base total quantity ordered.	[optional]
base_total_refunded	float	Base total refunded.	[optional]
base_to_global_rate	float	Base-to-global rate.	[optional]
base_to_order_rate	float	Base-to-order rate.	[optional]
billing_address_id	int	Billing address ID.	[optional]
can_ship_partially	int	Can-ship-partially flag value.	[optional]
can_ship_partially_item	int	Can-ship-partially-item flag value.	[optional]
coupon_code	str	Coupon code.	[optional]
created_at	str	Created-at timestamp.	[optional]
customer_dob	str	Customer date-of-birth (DOB).	[optional]
customer_email	str	Customer email address.
customer_firstname	str	Customer first name.	[optional]
customer_gender	int	Customer gender.	[optional]
customer_group_id	int	Customer group ID.	[optional]
customer_id	int	Customer ID.	[optional]
customer_is_guest	int	Customer-is-guest flag value.	[optional]
customer_lastname	str	Customer last name.	[optional]
customer_middlename	str	Customer middle name.	[optional]
customer_note	str	Customer note.	[optional]
customer_note_notify	int	Customer-note-notify flag value.	[optional]
customer_prefix	str	Customer prefix.	[optional]
customer_suffix	str	Customer suffix.	[optional]
customer_taxvat	str	Customer value-added tax (VAT).	[optional]
discount_amount	float	Discount amount.	[optional]
discount_canceled	float	Discount canceled.	[optional]
discount_description	str	Discount description.	[optional]
discount_invoiced	float	Discount invoiced.	[optional]
discount_refunded	float	Discount refunded amount.	[optional]
edit_increment	int	Edit increment value.	[optional]
email_sent	int	Email-sent flag value.	[optional]
entity_id	int	Order ID.	[optional]
ext_customer_id	str	External customer ID.	[optional]
ext_order_id	str	External order ID.	[optional]
forced_shipment_with_invoice	int	Forced-shipment-with-invoice flag value.	[optional]
global_currency_code	str	Global currency code.	[optional]
grand_total	float	Grand total.
discount_tax_compensation_amount	float	Discount tax compensation amount.	[optional]
discount_tax_compensation_invoiced	float	Discount tax compensation invoiced amount.	[optional]
discount_tax_compensation_refunded	float	Discount tax compensation refunded amount.	[optional]
hold_before_state	str	Hold before state.	[optional]
hold_before_status	str	Hold before status.	[optional]
increment_id	str	Increment ID.	[optional]
is_virtual	int	Is-virtual flag value.	[optional]
order_currency_code	str	Order currency code.	[optional]
original_increment_id	str	Original increment ID.	[optional]
payment_authorization_amount	float	Payment authorization amount.	[optional]
payment_auth_expiration	int	Payment authorization expiration date.	[optional]
protect_code	str	Protect code.	[optional]
quote_address_id	int	Quote address ID.	[optional]
quote_id	int	Quote ID.	[optional]
relation_child_id	str	Relation child ID.	[optional]
relation_child_real_id	str	Relation child real ID.	[optional]
relation_parent_id	str	Relation parent ID.	[optional]
relation_parent_real_id	str	Relation parent real ID.	[optional]
remote_ip	str	Remote IP address.	[optional]
shipping_amount	float	Shipping amount.	[optional]
shipping_canceled	float	Shipping canceled amount.	[optional]
shipping_description	str	Shipping description.	[optional]
shipping_discount_amount	float	Shipping discount amount.	[optional]
shipping_discount_tax_compensation_amount	float	Shipping discount tax compensation amount.	[optional]
shipping_incl_tax	float	Shipping including tax amount.	[optional]
shipping_invoiced	float	Shipping invoiced amount.	[optional]
shipping_refunded	float	Shipping refunded amount.	[optional]
shipping_tax_amount	float	Shipping tax amount.	[optional]
shipping_tax_refunded	float	Shipping tax refunded amount.	[optional]
state	str	State.	[optional]
status	str	Status.	[optional]
store_currency_code	str	Store currency code.	[optional]
store_id	int	Store ID.	[optional]
store_name	str	Store name.	[optional]
store_to_base_rate	float	Store-to-base rate.	[optional]
store_to_order_rate	float	Store-to-order rate.	[optional]
subtotal	float	Subtotal.	[optional]
subtotal_canceled	float	Subtotal canceled amount.	[optional]
subtotal_incl_tax	float	Subtotal including tax amount.	[optional]
subtotal_invoiced	float	Subtotal invoiced amount.	[optional]
subtotal_refunded	float	Subtotal refunded amount.	[optional]
tax_amount	float	Tax amount.	[optional]
tax_canceled	float	Tax canceled amount.	[optional]
tax_invoiced	float	Tax invoiced amount.	[optional]
tax_refunded	float	Tax refunded amount.	[optional]
total_canceled	float	Total canceled.	[optional]
total_due	float	Total due.	[optional]
total_invoiced	float	Total invoiced amount.	[optional]
total_item_count	int	Total item count.	[optional]
total_offline_refunded	float	Total offline refunded amount.	[optional]
total_online_refunded	float	Total online refunded amount.	[optional]
total_paid	float	Total paid.	[optional]
total_qty_ordered	float	Total quantity ordered.	[optional]
total_refunded	float	Total amount refunded.	[optional]
updated_at	str	Updated-at timestamp.	[optional]
weight	float	Weight.	[optional]
x_forwarded_for	str	X-Forwarded-For field value.	[optional]
items	list[SalesDataOrderItemInterface]	Array of items.
billing_address	SalesDataOrderAddressInterface		[optional]
payment	SalesDataOrderPaymentInterface		[optional]
status_histories	list[SalesDataOrderStatusHistoryInterface]	Array of status histories.	[optional]
extension_attributes	SalesDataOrderExtensionInterface		[optional]

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