WooCommerceShopOrder.md

WooCommerceShopOrder

Properties

Name	Type	Description	Notes
id	Integer	Unique identifier for the resource.	[optional]
parentId	Integer	Parent order ID.	[optional]
number	String	Order number.	[optional]
orderKey	String	Order key.	[optional]
createdVia	String	Shows where the order was created.	[optional]
version	String	Version of WooCommerce which last updated the order.	[optional]
status	StatusEnum	Order status.	[optional]
currency	CurrencyEnum	Currency the order was created with, in ISO format.	[optional]
dateCreated	OffsetDateTime	The date the order was created, in the site's timezone.	[optional]
dateCreatedGmt	OffsetDateTime	The date the order was created, as GMT.	[optional]
dateModified	OffsetDateTime	The date the order was last modified, in the site's timezone.	[optional]
dateModifiedGmt	OffsetDateTime	The date the order was last modified, as GMT.	[optional]
discountTotal	String	Total discount amount for the order.	[optional]
discountTax	String	Total discount tax amount for the order.	[optional]
shippingTotal	String	Total shipping amount for the order.	[optional]
shippingTax	String	Total shipping tax amount for the order.	[optional]
cartTax	String	Sum of line item taxes only.	[optional]
total	String	Grand total.	[optional]
totalTax	String	Sum of all taxes.	[optional]
pricesIncludeTax	Boolean	True the prices included tax during checkout.	[optional]
customerId	Integer	User ID who owns the order. 0 for guests.	[optional]
customerIpAddress	String	Customer's IP address.	[optional]
customerUserAgent	String	User agent of the customer.	[optional]
customerNote	String	Note left by customer during checkout.	[optional]
billing	WooCommerceWcV3OrdersPostRequestBilling		[optional]
shipping	WooCommerceWcV3OrdersPostRequestShipping		[optional]
paymentMethod	String	Payment method ID.	[optional]
paymentMethodTitle	String	Payment method title.	[optional]
transactionId	String	Unique transaction ID.	[optional]
datePaid	OffsetDateTime	The date the order was paid, in the site's timezone.	[optional]
datePaidGmt	OffsetDateTime	The date the order was paid, as GMT.	[optional]
dateCompleted	OffsetDateTime	The date the order was completed, in the site's timezone.	[optional]
dateCompletedGmt	OffsetDateTime	The date the order was completed, as GMT.	[optional]
cartHash	String	MD5 hash of cart items to ensure orders are not modified.	[optional]
metaData	List<WooCommerceShopCouponMetaDataInner>	Meta data.	[optional]
lineItems	List<WooCommerceShopOrderLineItemsInner>	Line items data.	[optional]
taxLines	List<WooCommerceShopOrderRefundTaxLinesInner>	Tax lines data.	[optional]
shippingLines	List<WooCommerceShopOrderRefundShippingLinesInner>	Shipping lines data.	[optional]
feeLines	List<WooCommerceShopOrderRefundFeeLinesInner>	Fee lines data.	[optional]
couponLines	List<WooCommerceShopOrderCouponLinesInner>	Coupons line data.	[optional]
refunds	List<WooCommerceShopOrderRefundsInner>	List of refunds.	[optional]
paymentUrl	String	Order payment URL.	[optional]
setPaid	Boolean	Define if the order is paid. It will set the status to processing and reduce stock items.	[optional]
isEditable	Boolean	Whether an order can be edited.	[optional]
needsPayment	Boolean	Whether an order needs payment, based on status and order total.	[optional]
needsProcessing	Boolean	Whether an order needs processing before it can be completed.	[optional]
manualUpdate	Boolean	Set the action as manual so that the order note registers as &quot;added by user&quot;.	[optional]

Enum: StatusEnum

Name	Value
AUTO_DRAFT	"auto-draft"
PENDING	"pending"
PROCESSING	"processing"
ON_HOLD	"on-hold"
COMPLETED	"completed"
CANCELLED	"cancelled"
REFUNDED	"refunded"
FAILED	"failed"
CHECKOUT_DRAFT	"checkout-draft"
UNKNOWN_DEFAULT_OPEN_API	"unknown_default_open_api"

Enum: CurrencyEnum

Name	Value
AED	"AED"
AFN	"AFN"
ALL	"ALL"
AMD	"AMD"
ANG	"ANG"
AOA	"AOA"
ARS	"ARS"
AUD	"AUD"
AWG	"AWG"
AZN	"AZN"
BAM	"BAM"
BBD	"BBD"
BDT	"BDT"
BGN	"BGN"
BHD	"BHD"
BIF	"BIF"
BMD	"BMD"
BND	"BND"
BOB	"BOB"
BRL	"BRL"
BSD	"BSD"
BTC	"BTC"
BTN	"BTN"
BWP	"BWP"
BYR	"BYR"
BYN	"BYN"
BZD	"BZD"
CAD	"CAD"
CDF	"CDF"
CHF	"CHF"
CLP	"CLP"
CNY	"CNY"
COP	"COP"
CRC	"CRC"
CUC	"CUC"
CUP	"CUP"
CVE	"CVE"
CZK	"CZK"
DJF	"DJF"
DKK	"DKK"
DOP	"DOP"
DZD	"DZD"
EGP	"EGP"
ERN	"ERN"
ETB	"ETB"
EUR	"EUR"
FJD	"FJD"
FKP	"FKP"
GBP	"GBP"
GEL	"GEL"
GGP	"GGP"
GHS	"GHS"
GIP	"GIP"
GMD	"GMD"
GNF	"GNF"
GTQ	"GTQ"
GYD	"GYD"
HKD	"HKD"
HNL	"HNL"
HRK	"HRK"
HTG	"HTG"
HUF	"HUF"
IDR	"IDR"
ILS	"ILS"
IMP	"IMP"
INR	"INR"
IQD	"IQD"
IRR	"IRR"
IRT	"IRT"
ISK	"ISK"
JEP	"JEP"
JMD	"JMD"
JOD	"JOD"
JPY	"JPY"
KES	"KES"
KGS	"KGS"
KHR	"KHR"
KMF	"KMF"
KPW	"KPW"
KRW	"KRW"
KWD	"KWD"
KYD	"KYD"
KZT	"KZT"
LAK	"LAK"
LBP	"LBP"
LKR	"LKR"
LRD	"LRD"
LSL	"LSL"
LYD	"LYD"
MAD	"MAD"
MDL	"MDL"
MGA	"MGA"
MKD	"MKD"
MMK	"MMK"
MNT	"MNT"
MOP	"MOP"
MRU	"MRU"
MUR	"MUR"
MVR	"MVR"
MWK	"MWK"
MXN	"MXN"
MYR	"MYR"
MZN	"MZN"
NAD	"NAD"
NGN	"NGN"
NIO	"NIO"
NOK	"NOK"
NPR	"NPR"
NZD	"NZD"
OMR	"OMR"
PAB	"PAB"
PEN	"PEN"
PGK	"PGK"
PHP	"PHP"
PKR	"PKR"
PLN	"PLN"
PRB	"PRB"
PYG	"PYG"
QAR	"QAR"
RON	"RON"
RSD	"RSD"
RUB	"RUB"
RWF	"RWF"
SAR	"SAR"
SBD	"SBD"
SCR	"SCR"
SDG	"SDG"
SEK	"SEK"
SGD	"SGD"
SHP	"SHP"
SLL	"SLL"
SOS	"SOS"
SRD	"SRD"
SSP	"SSP"
STN	"STN"
SYP	"SYP"
SZL	"SZL"
THB	"THB"
TJS	"TJS"
TMT	"TMT"
TND	"TND"
TOP	"TOP"
TRY	"TRY"
TTD	"TTD"
TWD	"TWD"
TZS	"TZS"
UAH	"UAH"
UGX	"UGX"
USD	"USD"
UYU	"UYU"
UZS	"UZS"
VEF	"VEF"
VES	"VES"
VND	"VND"
VUV	"VUV"
WST	"WST"
XAF	"XAF"
XCD	"XCD"
XOF	"XOF"
XPF	"XPF"
YER	"YER"
ZAR	"ZAR"
ZMW	"ZMW"
UNKNOWN_DEFAULT_OPEN_API	"unknown_default_open_api"