WooCommerce Ontology
license: https://creativecommons.org/licenses/by/4.0/
publisher: inferal.com
preferred namespace prefix: woocommerce

Self Link
type: Class
comment: Self-referential link.
subclass of: URL

Collection Link
type: Class
comment: Collection link.
subclass of: URL

Links
type: Class
comment: HAL-style links object.

Metadata
type: Class
comment: Metadata key-value pair.
subclass of: PropertyValue

Image
type: Class
comment: Image object.
subclass of: ImageObject

Billing Address
type: Class
comment: Billing address.
subclass of: PostalAddress

Shipping Address
type: Class
comment: Shipping address.
subclass of: PostalAddress

Woo Commerce Error
type: Class
comment: WooCommerce API error response.
subclass of: Thing

Product Category Ref
type: Class
comment: Product category reference.
subclass of: CategoryCode

Product Tag Ref
type: Class
comment: Product tag reference.
subclass of: DefinedTerm

Product Image
type: Class
comment: Product image.
subclass of: ImageObject

Product Attribute
type: Class
comment: Product attribute.
subclass of: PropertyValue

Default Attribute
type: Class
comment: Default product attribute.
subclass of: PropertyValue

Product Download
type: Class
comment: Product download file.
subclass of: DigitalDocument

Product Dimensions
type: Class
comment: Product dimensions.
subclass of: QuantitativeValue

Product Metadata
type: Class
comment: Product metadata.
subclass of: PropertyValue

Category Image
type: Class
comment: Product category image. Similar to ProductImage but used specifically for category images.
subclass of: ImageObject

Product Category
type: Class
comment: Product category.
subclass of: CategoryCode

Product Category Input
type: Class
comment: Input for creating/updating a product category.

Product Tag
type: Class
comment: Product tag.
subclass of: DefinedTerm

Product Tag Input
type: Class
comment: Input for creating/updating a tag.

Product Brand
type: Class
comment: Product brand taxonomy. Structurally identical to categories (display, image, parent hierarchy).

Product Brand Input
type: Class
comment: Input for creating/updating a product brand.

Product
type: Class
comment: WooCommerce product.
subclass of: Product
subclass of: ProductOrService

Product Shipping Class
type: Class
comment: Product shipping class.
subclass of: DefinedTerm

Product Variation
type: Class
comment: Product variation.
subclass of: ProductModel

Product Input
type: Class
comment: Input for creating/updating a product.

Product Variation Input
type: Class
comment: Input for creating/updating a variation.

Product Attribute Taxonomy
type: Class
comment: Global product attribute (taxonomy).
subclass of: PropertyValueSpecification

Product Attribute Term
type: Class
comment: Attribute term.
subclass of: DefinedTerm

Order Line Item
type: Class
comment: Order line item (product in order).
subclass of: OrderItem

Order Item Tax
type: Class
comment: Tax line for order items.
subclass of: PriceSpecification

Order Line Item Input
type: Class
comment: Line item input for creating/updating orders.

Shipping Line
type: Class
comment: Shipping line.
subclass of: ParcelDelivery

Shipping Line Input
type: Class
comment: Shipping line input.

Tax Line
type: Class
comment: Tax line. All fields are read-only per WooCommerce API docs.
subclass of: PriceSpecification

Tax Rate
type: Class
comment: WooCommerce tax rate.
subclass of: PriceSpecification

Fee Line
type: Class
comment: Fee line.
subclass of: PriceSpecification

Fee Line Input
type: Class
comment: Fee line input.

Coupon Line
type: Class
comment: Coupon line.
subclass of: Offer

Coupon Line Input
type: Class
comment: Coupon line input.

Order Refund Line
type: Class
comment: Inline refund line in Order response. This is a simplified representation of refunds returned in the Order object. All fields are read-only per WooCommerce API docs.
subclass of: MonetaryAmount

Refund
type: Class
comment: Order refund.
subclass of: Order

Order
type: Class
comment: WooCommerce order.
subclass of: Order

Customer
type: Class
comment: WooCommerce customer.
subclass of: Person

Refund Input
type: Class
comment: Refund input.

Refund Line Item Input
type: Class
comment: Refund line item input.

Refund Tax Input
type: Class
comment: Refund tax input.

Order Note
type: Class
comment: Order note.
subclass of: Comment

Order Note Input
type: Class
comment: Order note input.

Order Input
type: Class
comment: Order input for creating/updating.

Customer Input
type: Class
comment: Customer input for creating/updating.

Customer Download
type: Class
comment: Customer download. All fields are read-only as this is a read-only resource.
subclass of: DownloadAction

Customer Download File
type: Class
comment: Customer download file.
subclass of: MediaObject

Product Review
type: Class
comment: Product review.
subclass of: Review

Product Review Input
type: Class
comment: Product review input for creating/updating.
subclass of: Review

Product Shipping Class Input
type: Class
comment: Product shipping class input for creating/updating.
subclass of: DefinedTerm

Report
type: Class
comment: Report list item.
subclass of: Report

Sales Report
type: Class
comment: Sales report.
subclass of: Report

Sales Report Period
type: Class
comment: Sales report period breakdown.
subclass of: QuantitativeValue

Top Sellers Report Item
type: Class
comment: Top sellers report item.
subclass of: ListItem

Report Totals Item
type: Class
comment: Report totals item (for coupons, customers, orders, products, reviews, categories, tags, attributes).
subclass of: QuantitativeValue

Coupon
type: Class
comment: WooCommerce coupon.
subclass of: Offer

Coupon Input
type: Class
comment: Input for creating/updating a coupon.

Tax Rate Input
type: Class
comment: Input for creating/updating a tax rate.

Tax Class
type: Class
comment: WooCommerce tax class.
subclass of: DefinedTerm

Tax Class Input
type: Class
comment: Input for creating a tax class.

Shipping Method
type: Class
comment: WooCommerce shipping method. This represents a global shipping method type (e.g., flat_rate, free_shipping, local_pickup). These are the available shipping methods that can be added to shipping zones.
subclass of: DeliveryMethod

Shipping Zone
type: Class
comment: WooCommerce shipping zone.
subclass of: DeliveryChargeSpecification

Shipping Zone Input
type: Class
comment: Input for creating/updating a shipping zone.

Shipping Zone Location
type: Class
comment: WooCommerce shipping zone location.
subclass of: GeoShape

Shipping Zone Location Input
type: Class
comment: Input for creating/updating a shipping zone location.

Shipping Zone Method Setting
type: Class
comment: Shipping method setting. Settings are dynamically keyed by setting ID in the response.
subclass of: PropertyValue

Shipping Zone Method
type: Class
comment: WooCommerce shipping zone method.
subclass of: DeliveryMethod

Shipping Zone Method Create Input
type: Class
comment: Input for creating a shipping zone method. Only method_id is required to add a shipping method to a zone.

Shipping Zone Method Update Input
type: Class
comment: Input for updating a shipping zone method.

Setting Options Link
type: Class
comment: Link to setting options.
subclass of: URL

Setting Group Links
type: Class
comment: HAL-style links for setting groups. Setting groups have a different link structure with 'options' instead of 'self'.

Setting Group
type: Class
comment: WooCommerce setting group. Setting groups are categories that contain related settings. Examples: general, products, tax, shipping, checkout, account, email, integration, api
subclass of: Thing

Setting Option
type: Class
comment: WooCommerce setting option. Individual configurable setting within a setting group.
subclass of: PropertyValue

Setting Option Input
type: Class
comment: Input for updating a setting option.

Setting Option Batch Input
type: Class
comment: Input for batch updating setting options.

Setting Option Batch Request
type: Class
comment: Batch update request for setting options.

Setting Option Batch Response
type: Class
comment: Batch update response for setting options.

Payment Gateway Setting
type: Class
comment: Payment gateway setting. Individual configurable setting within a payment gateway. Reuses SettingOptionType enum from settings.tsp since same types apply.
subclass of: PropertyValue

Payment Gateway
type: Class
comment: WooCommerce payment gateway. Payment gateways handle payment processing at checkout. Results are not paginated - all gateways will be returned.
subclass of: PaymentMethod

Payment Gateway Input
type: Class
comment: Input for updating a payment gateway.

Webhook
type: Class
comment: WooCommerce webhook configuration. Webhooks allow external services to be notified when events occur in WooCommerce. After 5 consecutive failed deliveries, the webhook is automatically disabled.
subclass of: Thing

Webhook Create Input
type: Class
comment: Input for creating a webhook.
subclass of: Webhook

Webhook Update Input
type: Class
comment: Input for updating a webhook.
subclass of: Webhook

System Status Environment
type: Class
comment: System status environment properties.
subclass of: SoftwareApplication

System Status Database
type: Class
comment: System status database properties.
subclass of: DataCatalog

System Status Active Plugin
type: Class
comment: Active plugin information.
subclass of: SoftwareApplication

System Status Theme Override
type: Class
comment: Template override information.
subclass of: DigitalDocument

System Status Theme
type: Class
comment: System status theme properties.
subclass of: SoftwareApplication

System Status Settings
type: Class
comment: System status settings properties.

System Status Security
type: Class
comment: System status security properties.

System Status Page
type: Class
comment: WooCommerce page information.
subclass of: WebPage

System Status
type: Class
comment: WooCommerce system status. The system status API allows you to view all system status items.
subclass of: SoftwareApplication

System Status Tool
type: Class
comment: System status tool. The system status tools API allows you to view and run tools from system status.
subclass of: Action

System Status Tool Run Input
type: Class
comment: Input model for running a system status tool.

Data Endpoint
type: Class
comment: Data endpoint information. Represents an available data resource in the WooCommerce data API.
subclass of: EntryPoint

State
type: Class
comment: State/Province information. Used within Country and ContinentCountry models.
subclass of: State

Continent Country
type: Class
comment: Country information within a continent. Contains additional currency and formatting properties compared to the standalone Country model.
subclass of: Country

Continent
type: Class
comment: Continent information. Contains continent code, name, and list of countries with their details.
subclass of: Continent

Country
type: Class
comment: Country information. Contains country code, name, and list of states.
subclass of: Country

Currency
type: Class
comment: Currency information. Contains currency code, name, and symbol.
subclass of: Thing

Order Receipt Request
type: Class
comment: Request to create or refresh an order receipt URL.
added in version: v8 4 0

Send Order Details Request
type: Class
comment: Request to send order details email to customer.
added in version: v9 5 0

Send Email Request
type: Class
comment: Request to send a templated order notification email.
added in version: v9 8 0

Action Message Response
type: Class
comment: Response from order action endpoints.

Email Template
type: Class
comment: Available email template for an order.
added in version: v9 8 0

Product Created Event
type: Class
comment: Product created webhook payload.

Product Updated Event
type: Class
comment: Product updated webhook payload.

Product Deleted Event
type: Class
comment: Product deleted webhook payload. Note: Contains only the deleted product ID.

Product Restored Event
type: Class
comment: Product restored from trash webhook payload.

Order Created Event
type: Class
comment: Order created webhook payload.

Order Updated Event
type: Class
comment: Order updated webhook payload.

Order Deleted Event
type: Class
comment: Order deleted webhook payload.

Order Restored Event
type: Class
comment: Order restored from trash webhook payload.

Customer Created Event
type: Class
comment: Customer created webhook payload.

Customer Updated Event
type: Class
comment: Customer updated webhook payload.

Customer Deleted Event
type: Class
comment: Customer deleted webhook payload.

Coupon Created Event
type: Class
comment: Coupon created webhook payload.

Coupon Updated Event
type: Class
comment: Coupon updated webhook payload.

Coupon Deleted Event
type: Class
comment: Coupon deleted webhook payload.

Data
type: Class

Settings Record
type: Class

Settings Entry
type: Class

Settings Record
type: Class

Settings Entry
type: Class

Options Record
type: Class

Options Entry
type: Class

Reviewer Avatar Urls Record
type: Class

Reviewer Avatar Urls Entry
type: Class

Totals Record
type: Class

Totals Entry
type: Class

Options Record
type: Class

Options Entry
type: Class

Settings Record
type: Class

Settings Entry
type: Class

Options Record
type: Class

Options Entry
type: Class

Settings Record
type: Class

Settings Entry
type: Class

Database Tables Record
type: Class

Database Tables Entry
type: Class

Taxonomies Record
type: Class

Taxonomies Entry
type: Class

AttributeOrderBy
type: ConceptScheme
comment: Sort order options for product attributes.
has top concept: Menu Order
has top concept: Name
has top concept: Name Num
has top concept: Id

Menu Order
type: Concept
in scheme: AttributeOrderBy
top concept of: AttributeOrderBy
alternative label: menuOrder
definition: Sort by menu order (default)
notation: menu_order

Name
type: Concept
in scheme: AttributeOrderBy
top concept of: AttributeOrderBy
alternative label: name
definition: Sort by name alphabetically
notation: name

Name Num
type: Concept
in scheme: AttributeOrderBy
top concept of: AttributeOrderBy
alternative label: nameNum
definition: Sort by name numerically
notation: name_num

Id
type: Concept
in scheme: AttributeOrderBy
top concept of: AttributeOrderBy
alternative label: id
definition: Sort by ID
notation: id

BackorderStatus
type: ConceptScheme
comment: Backorder status.
has top concept: No
has top concept: Notify
has top concept: Yes

No
type: Concept
in scheme: BackorderStatus
top concept of: BackorderStatus
alternative label: no
definition: Do not allow backorders
notation: no

Notify
type: Concept
in scheme: BackorderStatus
top concept of: BackorderStatus
alternative label: notify
definition: Allow backorders but notify customer
notation: notify

Yes
type: Concept
in scheme: BackorderStatus
top concept of: BackorderStatus
alternative label: yes
definition: Allow backorders
notation: yes

CatalogVisibility
type: ConceptScheme
comment: Catalog visibility.
has top concept: Visible
has top concept: Catalog
has top concept: Search
has top concept: Hidden

Visible
type: Concept
in scheme: CatalogVisibility
top concept of: CatalogVisibility
alternative label: visible
definition: Visible everywhere
notation: visible

Catalog
type: Concept
in scheme: CatalogVisibility
top concept of: CatalogVisibility
alternative label: catalog
definition: Only in catalog (not search)
notation: catalog

Search
type: Concept
in scheme: CatalogVisibility
top concept of: CatalogVisibility
alternative label: search
definition: Only in search (not catalog)
notation: search

Hidden
type: Concept
in scheme: CatalogVisibility
top concept of: CatalogVisibility
alternative label: hidden
definition: Hidden from both catalog and search
notation: hidden

CategoryDisplay
type: ConceptScheme
comment: Category archive display type.
has top concept: Default
has top concept: Products
has top concept: Subcategories
has top concept: Both

Default
type: Concept
in scheme: CategoryDisplay
top concept of: CategoryDisplay
alternative label: default
definition: Default display type
notation: default

Products
type: Concept
in scheme: CategoryDisplay
top concept of: CategoryDisplay
alternative label: products
definition: Display products only
notation: products

Subcategories
type: Concept
in scheme: CategoryDisplay
top concept of: CategoryDisplay
alternative label: subcategories
definition: Display subcategories only
notation: subcategories

Both
type: Concept
in scheme: CategoryDisplay
top concept of: CategoryDisplay
alternative label: both
definition: Display both products and subcategories
notation: both

DiscountType
type: ConceptScheme
comment: Coupon discount type.
has top concept: Percent
has top concept: Fixed Cart
has top concept: Fixed Product

Percent
type: Concept
in scheme: DiscountType
top concept of: DiscountType
alternative label: percent
definition: Percentage discount
notation: percent

Fixed Cart
type: Concept
in scheme: DiscountType
top concept of: DiscountType
alternative label: fixedCart
definition: Fixed cart discount
notation: fixed_cart

Fixed Product
type: Concept
in scheme: DiscountType
top concept of: DiscountType
alternative label: fixedProduct
definition: Fixed product discount
notation: fixed_product

OrderStatus
type: ConceptScheme
comment: Order status.
has top concept: Pending
has top concept: Processing
has top concept: On Hold
has top concept: Completed
has top concept: Cancelled
has top concept: Refunded
has top concept: Failed
has top concept: Trash
has top concept: Auto Draft
has top concept: Checkout Draft

Pending
type: Concept
in scheme: OrderStatus
top concept of: OrderStatus
alternative label: pending
definition: Payment pending
notation: pending

Processing
type: Concept
in scheme: OrderStatus
top concept of: OrderStatus
alternative label: processing
definition: Payment received, order processing
notation: processing

On Hold
type: Concept
in scheme: OrderStatus
top concept of: OrderStatus
alternative label: onHold
definition: Awaiting action (payment, stock, etc.)
notation: on-hold

Completed
type: Concept
in scheme: OrderStatus
top concept of: OrderStatus
alternative label: completed
definition: Order fulfilled and complete
notation: completed

Cancelled
type: Concept
in scheme: OrderStatus
top concept of: OrderStatus
alternative label: cancelled
definition: Order cancelled by admin or customer
notation: cancelled

Refunded
type: Concept
in scheme: OrderStatus
top concept of: OrderStatus
alternative label: refunded
definition: Order refunded
notation: refunded

Failed
type: Concept
in scheme: OrderStatus
top concept of: OrderStatus
alternative label: failed
definition: Payment failed or declined
notation: failed

Trash
type: Concept
in scheme: OrderStatus
top concept of: OrderStatus
alternative label: trash
definition: Order trashed
notation: trash

Auto Draft
type: Concept
in scheme: OrderStatus
top concept of: OrderStatus
alternative label: autoDraft
definition: Auto-draft status for WordPress auto-save functionality
added in version: v6 3 1
notation: auto-draft

Checkout Draft
type: Concept
in scheme: OrderStatus
top concept of: OrderStatus
alternative label: checkoutDraft
definition: Checkout draft (block checkout). Version history: Added in v4.3.0, removed in v4.3.1, re-added in v6.6.1. TypeSpec limitation: Only one
added in version: v6 6 1
notation: checkout-draft

ProductStatus
type: ConceptScheme
comment: Product status.
has top concept: Publish
has top concept: Draft
has top concept: Pending
has top concept: Private
has top concept: Auto Draft
has top concept: Trash

Publish
type: Concept
in scheme: ProductStatus
top concept of: ProductStatus
alternative label: publish
definition: Published and visible
notation: publish

Draft
type: Concept
in scheme: ProductStatus
top concept of: ProductStatus
alternative label: draft
definition: Draft, not visible
notation: draft

Pending
type: Concept
in scheme: ProductStatus
top concept of: ProductStatus
alternative label: pending
definition: Pending review
notation: pending

Private
type: Concept
in scheme: ProductStatus
top concept of: ProductStatus
alternative label: private
definition: Private, only visible to admins
notation: private

Auto Draft
type: Concept
in scheme: ProductStatus
top concept of: ProductStatus
alternative label: autoDraft
definition: Auto-draft, enables WordPress autosave functionality
added in version: v7 4 1
notation: auto-draft

Trash
type: Concept
in scheme: ProductStatus
top concept of: ProductStatus
alternative label: trash
definition: Trashed, moved to trash. Version history: Query param filter accepted "trash" since v4.2.0, but ProductStatus enum value for write operations added in v7.4.1.
added in version: v7 4 1
notation: trash

ProductType
type: ConceptScheme
comment: Product type.
has top concept: Simple
has top concept: Grouped
has top concept: External
has top concept: Variable

Simple
type: Concept
in scheme: ProductType
top concept of: ProductType
alternative label: simple
definition: Simple product
notation: simple

Grouped
type: Concept
in scheme: ProductType
top concept of: ProductType
alternative label: grouped
definition: Grouped product
notation: grouped

External
type: Concept
in scheme: ProductType
top concept of: ProductType
alternative label: external
definition: External/Affiliate product
notation: external

Variable
type: Concept
in scheme: ProductType
top concept of: ProductType
alternative label: variable
definition: Variable product
notation: variable

ReviewStatus
type: ConceptScheme
comment: Review status.
has top concept: Approved
has top concept: Hold
has top concept: Spam
has top concept: Trash
has top concept: Unspam
has top concept: Untrash

Approved
type: Concept
in scheme: ReviewStatus
top concept of: ReviewStatus
alternative label: approved
definition: Approved review
notation: approved

Hold
type: Concept
in scheme: ReviewStatus
top concept of: ReviewStatus
alternative label: hold
definition: Held for moderation
notation: hold

Spam
type: Concept
in scheme: ReviewStatus
top concept of: ReviewStatus
alternative label: spam
definition: Marked as spam
notation: spam

Trash
type: Concept
in scheme: ReviewStatus
top concept of: ReviewStatus
alternative label: trash
definition: Moved to trash
notation: trash

Unspam
type: Concept
in scheme: ReviewStatus
top concept of: ReviewStatus
alternative label: unspam
definition: Unspam (restore from spam)
notation: unspam

Untrash
type: Concept
in scheme: ReviewStatus
top concept of: ReviewStatus
alternative label: untrash
definition: Untrash (restore from trash)
notation: untrash

SettingOptionType
type: ConceptScheme
comment: Type of setting control. Determines how the setting is displayed and edited in the UI.
has top concept: Text
has top concept: Email
has top concept: Number
has top concept: Color
has top concept: Password
has top concept: Textarea
has top concept: Select
has top concept: Multiselect
has top concept: Radio
has top concept: Image Width
has top concept: Checkbox

Text
type: Concept
in scheme: SettingOptionType
top concept of: SettingOptionType
alternative label: text
definition: Text input field
notation: text

Email
type: Concept
in scheme: SettingOptionType
top concept of: SettingOptionType
alternative label: email
definition: Email input field
notation: email

Number
type: Concept
in scheme: SettingOptionType
top concept of: SettingOptionType
alternative label: number
definition: Number input field
notation: number

Color
type: Concept
in scheme: SettingOptionType
top concept of: SettingOptionType
alternative label: color
definition: Color picker
notation: color

Password
type: Concept
in scheme: SettingOptionType
top concept of: SettingOptionType
alternative label: password
definition: Password input field
notation: password

Textarea
type: Concept
in scheme: SettingOptionType
top concept of: SettingOptionType
alternative label: textarea
definition: Multi-line text area
notation: textarea

Select
type: Concept
in scheme: SettingOptionType
top concept of: SettingOptionType
alternative label: select
definition: Dropdown select
notation: select

Multiselect
type: Concept
in scheme: SettingOptionType
top concept of: SettingOptionType
alternative label: multiselect
definition: Multi-select dropdown
notation: multiselect

Radio
type: Concept
in scheme: SettingOptionType
top concept of: SettingOptionType
alternative label: radio
definition: Radio button group
notation: radio

Image Width
type: Concept
in scheme: SettingOptionType
top concept of: SettingOptionType
alternative label: imageWidth
definition: Image width input
notation: image_width

Checkbox
type: Concept
in scheme: SettingOptionType
top concept of: SettingOptionType
alternative label: checkbox
definition: Checkbox toggle
notation: checkbox

ShippingZoneLocationType
type: ConceptScheme
comment: Shipping zone location type.
has top concept: Postcode
has top concept: State
has top concept: Country
has top concept: Continent

Postcode
type: Concept
in scheme: ShippingZoneLocationType
top concept of: ShippingZoneLocationType
alternative label: postcode
definition: Postcode or ZIP code
notation: postcode

State
type: Concept
in scheme: ShippingZoneLocationType
top concept of: ShippingZoneLocationType
alternative label: state
definition: State or province
notation: state

Country
type: Concept
in scheme: ShippingZoneLocationType
top concept of: ShippingZoneLocationType
alternative label: country
definition: Country
notation: country

Continent
type: Concept
in scheme: ShippingZoneLocationType
top concept of: ShippingZoneLocationType
alternative label: continent
definition: Continent
notation: continent

ShippingZoneMethodSettingType
type: ConceptScheme
comment: Type of shipping method setting.
has top concept: Text
has top concept: Email
has top concept: Number
has top concept: Color
has top concept: Password
has top concept: Textarea
has top concept: Select
has top concept: Multiselect
has top concept: Radio
has top concept: Image Width
has top concept: Checkbox
has top concept: Title
has top concept: Price

Text
type: Concept
in scheme: ShippingZoneMethodSettingType
top concept of: ShippingZoneMethodSettingType
alternative label: text
definition: Text input
notation: text

Email
type: Concept
in scheme: ShippingZoneMethodSettingType
top concept of: ShippingZoneMethodSettingType
alternative label: email
definition: Email input
notation: email

Number
type: Concept
in scheme: ShippingZoneMethodSettingType
top concept of: ShippingZoneMethodSettingType
alternative label: number
definition: Number input
notation: number

Color
type: Concept
in scheme: ShippingZoneMethodSettingType
top concept of: ShippingZoneMethodSettingType
alternative label: color
definition: Color picker
notation: color

Password
type: Concept
in scheme: ShippingZoneMethodSettingType
top concept of: ShippingZoneMethodSettingType
alternative label: password
definition: Password input
notation: password

Textarea
type: Concept
in scheme: ShippingZoneMethodSettingType
top concept of: ShippingZoneMethodSettingType
alternative label: textarea
definition: Textarea input
notation: textarea

Select
type: Concept
in scheme: ShippingZoneMethodSettingType
top concept of: ShippingZoneMethodSettingType
alternative label: select
definition: Select dropdown
notation: select

Multiselect
type: Concept
in scheme: ShippingZoneMethodSettingType
top concept of: ShippingZoneMethodSettingType
alternative label: multiselect
definition: Multi-select dropdown
notation: multiselect

Radio
type: Concept
in scheme: ShippingZoneMethodSettingType
top concept of: ShippingZoneMethodSettingType
alternative label: radio
definition: Radio buttons
notation: radio

Image Width
type: Concept
in scheme: ShippingZoneMethodSettingType
top concept of: ShippingZoneMethodSettingType
alternative label: imageWidth
definition: Image width input
notation: image_width

Checkbox
type: Concept
in scheme: ShippingZoneMethodSettingType
top concept of: ShippingZoneMethodSettingType
alternative label: checkbox
definition: Checkbox
notation: checkbox

Title
type: Concept
in scheme: ShippingZoneMethodSettingType
top concept of: ShippingZoneMethodSettingType
alternative label: title
definition: Title/heading (non-editable)
notation: title

Price
type: Concept
in scheme: ShippingZoneMethodSettingType
top concept of: ShippingZoneMethodSettingType
alternative label: price
definition: Price input
notation: price

StockStatus
type: ConceptScheme
comment: Stock status.
has top concept: Instock
has top concept: Outofstock
has top concept: Onbackorder

Instock
type: Concept
in scheme: StockStatus
top concept of: StockStatus
alternative label: instock
definition: In stock
notation: instock

Outofstock
type: Concept
in scheme: StockStatus
top concept of: StockStatus
alternative label: outofstock
definition: Out of stock
notation: outofstock

Onbackorder
type: Concept
in scheme: StockStatus
top concept of: StockStatus
alternative label: onbackorder
definition: On backorder
notation: onbackorder

TaxStatus
type: ConceptScheme
comment: Tax status.
has top concept: Taxable
has top concept: Shipping
has top concept: None

Taxable
type: Concept
in scheme: TaxStatus
top concept of: TaxStatus
alternative label: taxable
definition: Taxable
notation: taxable

Shipping
type: Concept
in scheme: TaxStatus
top concept of: TaxStatus
alternative label: shipping
definition: Shipping only taxable
notation: shipping

None
type: Concept
in scheme: TaxStatus
top concept of: TaxStatus
alternative label: none
definition: Not taxable
notation: none

WebhookStatus
type: ConceptScheme
comment: Webhook status.
has top concept: Active
has top concept: Paused
has top concept: Disabled

Active
type: Concept
in scheme: WebhookStatus
top concept of: WebhookStatus
alternative label: active
definition: Active - delivers payload
notation: active

Paused
type: Concept
in scheme: WebhookStatus
top concept of: WebhookStatus
alternative label: paused
definition: Paused - delivery paused by admin
notation: paused

Disabled
type: Concept
in scheme: WebhookStatus
top concept of: WebhookStatus
alternative label: disabled
definition: Disabled - delivery paused by failure
notation: disabled

manageStock
type: ConceptScheme
has top concept: True
has top concept: False
has top concept: Parent

True
type: Concept
in scheme: manageStock
top concept of: manageStock
alternative label: true
notation: true

False
type: Concept
in scheme: manageStock
top concept of: manageStock
alternative label: false
notation: false

Parent
type: Concept
in scheme: manageStock
top concept of: manageStock
alternative label: parent
notation: parent

manageStock
type: ConceptScheme
has top concept: True
has top concept: False
has top concept: Parent

True
type: Concept
in scheme: manageStock
top concept of: manageStock
alternative label: true
notation: true

False
type: Concept
in scheme: manageStock
top concept of: manageStock
alternative label: false
notation: false

Parent
type: Concept
in scheme: manageStock
top concept of: manageStock
alternative label: parent
notation: parent

currency position
type: Property

currency symbol
type: Property

decimal separator
type: Property

file path
type: Property

location type
type: Property

number of decimals
type: Property

options link
type: Property

order id
type: Property

parent order
type: Property

product count
type: Property

product id
type: Property

access expires
type: Property
comment: Query alias: 1 model declares accessExpires.

access expires gmt
type: Property
comment: Query alias: 1 model declares accessExpiresGmt.

action
type: Property
comment: Query alias: 1 model declares action.

active plugins
type: Property
comment: Query alias: 1 model declares activePlugins.

added by user
type: Property
comment: Query alias: 2 models declare addedByUser.

address1
type: Property
comment: Query alias: 2 models declare address1.

address2
type: Property
comment: Query alias: 2 models declare address2.

alt
type: Property
comment: Query alias: 3 models declare alt.

amount
type: Property
comment: Query alias: 7 models declare amount.

api enabled
type: Property
comment: Query alias: 1 model declares apiEnabled.

api refund
type: Property
comment: Query alias: 1 model declares apiRefund.

api restock
type: Property
comment: Query alias: 1 model declares apiRestock.

attribute identifier
type: Property
comment: Query alias: 2 models declare attributeIdentifier.

author
type: Property
comment: Query alias: 1 model declares author.

author name
type: Property
comment: Query alias: 1 model declares authorName.

author url
type: Property
comment: Query alias: 2 models declare authorUrl.

avatar url
type: Property
comment: Query alias: 3 models declare avatarUrl.

average rating
type: Property
comment: Query alias: 4 models declare averageRating.

average sales
type: Property
comment: Query alias: 1 model declares averageSales.

backordered
type: Property
comment: Query alias: 5 models declare backordered.

backorders
type: Property
comment: Query alias: 7 models declare backorders.

backorders allowed
type: Property
comment: Query alias: 5 models declare backordersAllowed.

billing
type: Property
comment: Query alias: 9 models declare billing.

button text
type: Property
comment: Query alias: 5 models declare buttonText.

cart hash
type: Property
comment: Query alias: 4 models declare cartHash.

cart tax
type: Property
comment: Query alias: 4 models declare cartTax.

catalog visibility
type: Property
comment: Query alias: 5 models declare catalogVisibility.

categories
type: Property
comment: Query alias: 5 models declare categories.

cities
type: Property
comment: Query alias: 2 models declare cities.

city
type: Property
comment: Query alias: 4 models declare city.

code
type: Property
comment: Query alias: 14 models declare code.

collection
type: Property
comment: Query alias: 1 model declares collection.

company
type: Property
comment: Query alias: 2 models declare company.

compound
type: Property
comment: Query alias: 3 models declare compound.

confirm
type: Property
comment: Query alias: 1 model declares confirm.

core version
type: Property
comment: Query alias: 1 model declares coreVersion.

count
type: Property
comment: Query alias: 5 models declare count.

countries
type: Property
comment: Query alias: 1 model declares countries.

country
type: Property
comment: Query alias: 4 models declare country.

created via
type: Property
comment: Query alias: 4 models declare createdVia.

cross sell products
type: Property
comment: Query alias: 5 models declare crossSellProducts.

curl version
type: Property
comment: Query alias: 1 model declares curlVersion.

currency
type: Property
comment: Query alias: 6 models declare currency.

currency code
type: Property
comment: Query alias: 1 model declares currencyCode.

currency pos
type: Property
comment: Query alias: 1 model declares currencyPos.

currency position
type: Property
comment: Query alias: 1 model declares currencyPosition.

currency symbol
type: Property
comment: Query alias: 5 models declare currencySymbol.

customer
type: Property
comment: Query alias: 5 models declare customer.

customer ip address
type: Property
comment: Query alias: 4 models declare customerIpAddress.

customers
type: Property
comment: Query alias: 1 model declares customers.

customer user agent
type: Property
comment: Query alias: 4 models declare customerUserAgent.

data
type: Property
comment: Query alias: 1 model declares data.

database
type: Property
comment: Query alias: 1 model declares database.

database prefix
type: Property
comment: Query alias: 1 model declares databasePrefix.

database tables
type: Property
comment: Query alias: 1 model declares databaseTables.

date completed
type: Property
comment: Query alias: 4 models declare dateCompleted.

date completed gmt
type: Property
comment: Query alias: 4 models declare dateCompletedGmt.

date created
type: Property
comment: Query alias: 20 models declare dateCreated.

date created gmt
type: Property
comment: Query alias: 19 models declare dateCreatedGmt.

date expires
type: Property
comment: Query alias: 4 models declare dateExpires.

date expires gmt
type: Property
comment: Query alias: 2 models declare dateExpiresGmt.

date modified
type: Property
comment: Query alias: 17 models declare dateModified.

date modified gmt
type: Property
comment: Query alias: 16 models declare dateModifiedGmt.

date on sale from
type: Property
comment: Query alias: 7 models declare dateOnSaleFrom.

date on sale from gmt
type: Property
comment: Query alias: 7 models declare dateOnSaleFromGmt.

date on sale to
type: Property
comment: Query alias: 7 models declare dateOnSaleTo.

date on sale to gmt
type: Property
comment: Query alias: 7 models declare dateOnSaleToGmt.

date paid
type: Property
comment: Query alias: 4 models declare datePaid.

date paid gmt
type: Property
comment: Query alias: 4 models declare datePaidGmt.

decimal sep
type: Property
comment: Query alias: 1 model declares decimalSep.

decimal separator
type: Property
comment: Query alias: 1 model declares decimalSeparator.

default
type: Property
comment: Query alias: 3 models declare default.

default attributes
type: Property
comment: Query alias: 5 models declare defaultAttributes.

default timezone
type: Property
comment: Query alias: 1 model declares defaultTimezone.

delivery url
type: Property
comment: Query alias: 2 models declare deliveryUrl.

description
type: Property
comment: Query alias: 31 models declare description.

dimensions
type: Property
comment: Query alias: 7 models declare dimensions.

dimension unit
type: Property
comment: Query alias: 1 model declares dimensionUnit.

discount
type: Property
comment: Query alias: 2 models declare discount.

discount tax
type: Property
comment: Query alias: 5 models declare discountTax.

discount total
type: Property
comment: Query alias: 4 models declare discountTotal.

discount type
type: Property
comment: Query alias: 5 models declare discountType.

display
type: Property
comment: Query alias: 4 models declare display.

display key
type: Property
comment: Query alias: 1 model declares displayKey.

display value
type: Property
comment: Query alias: 1 model declares displayValue.

domdocument enabled
type: Property
comment: Query alias: 1 model declares domdocumentEnabled.

downloadable
type: Property
comment: Query alias: 7 models declare downloadable.

download expiry
type: Property
comment: Query alias: 7 models declare downloadExpiry.

download id
type: Property
comment: Query alias: 1 model declares downloadId.

download identifier
type: Property
comment: Query alias: 1 model declares downloadIdentifier.

download limit
type: Property
comment: Query alias: 7 models declare downloadLimit.

download name
type: Property
comment: Query alias: 1 model declares downloadName.

downloads
type: Property
comment: Query alias: 7 models declare downloads.

downloads remaining
type: Property
comment: Query alias: 1 model declares downloadsRemaining.

download url
type: Property
comment: Query alias: 1 model declares downloadUrl.

email
type: Property
comment: Query alias: 7 models declare email.

email restrictions
type: Property
comment: Query alias: 2 models declare emailRestrictions.

enabled
type: Property
comment: Query alias: 5 models declare enabled.

environment
type: Property
comment: Query alias: 1 model declares environment.

event
type: Property
comment: Query alias: 1 model declares event.

excluded product categories
type: Property
comment: Query alias: 2 models declare excludedProductCategories.

excluded products
type: Property
comment: Query alias: 2 models declare excludedProducts.

exclude sale items
type: Property
comment: Query alias: 2 models declare excludeSaleItems.

expiration date
type: Property
comment: Query alias: 1 model declares expirationDate.

expiration days
type: Property
comment: Query alias: 1 model declares expirationDays.

external url
type: Property
comment: Query alias: 5 models declare externalUrl.

featured
type: Property
comment: Query alias: 5 models declare featured.

first name
type: Property
comment: Query alias: 6 models declare firstName.

force email update
type: Property
comment: Query alias: 2 models declare forceEmailUpdate.

force new
type: Property
comment: Query alias: 1 model declares forceNew.

force ssl
type: Property
comment: Query alias: 1 model declares forceSsl.

free shipping
type: Property
comment: Query alias: 5 models declare freeShipping.

fsockopen or curl enabled
type: Property
comment: Query alias: 1 model declares fsockopenOrCurlEnabled.

geolocation enabled
type: Property
comment: Query alias: 1 model declares geolocationEnabled.

global unique id
type: Property
comment: Query alias: 8 models declare globalUniqueId.

grouped products
type: Property
comment: Query alias: 5 models declare groupedProducts.

group id
type: Property
comment: Query alias: 1 model declares groupId.

gzip enabled
type: Property
comment: Query alias: 1 model declares gzipEnabled.

has archives
type: Property
comment: Query alias: 1 model declares hasArchives.

has outdated templates
type: Property
comment: Query alias: 1 model declares hasOutdatedTemplates.

has woocommerce file
type: Property
comment: Query alias: 1 model declares hasWoocommerceFile.

has woocommerce support
type: Property
comment: Query alias: 1 model declares hasWoocommerceSupport.

height
type: Property
comment: Query alias: 1 model declares height.

hide errors
type: Property
comment: Query alias: 1 model declares hideErrors.

home url
type: Property
comment: Query alias: 1 model declares homeUrl.

hooks
type: Property
comment: Query alias: 1 model declares hooks.

href
type: Property
comment: Query alias: 3 models declare href.

image identifier
type: Property
comment: Query alias: 3 models declare imageIdentifier.

images
type: Property
comment: Query alias: 5 models declare images.

individual use
type: Property
comment: Query alias: 2 models declare individualUse.

instance
type: Property
comment: Query alias: 1 model declares instance.

instance id
type: Property
comment: Query alias: 1 model declares instanceId.

is child theme
type: Property
comment: Query alias: 1 model declares isChildTheme.

is editable
type: Property
comment: Query alias: 4 models declare isEditable.

is paying customer
type: Property
comment: Query alias: 3 models declare isPayingCustomer.

item identifier
type: Property
comment: Query alias: 4 models declare itemIdentifier.

items
type: Property
comment: Query alias: 1 model declares items.

key
type: Property
comment: Query alias: 2 models declare key.

label
type: Property
comment: Query alias: 5 models declare label.

language
type: Property
comment: Query alias: 1 model declares language.

last name
type: Property
comment: Query alias: 6 models declare lastName.

length
type: Property
comment: Query alias: 1 model declares length.

limit usage to xitems
type: Property
comment: Query alias: 2 models declare limitUsageToXItems.

line item identifier
type: Property
comment: Query alias: 1 model declares lineItemIdentifier.

log directory
type: Property
comment: Query alias: 1 model declares logDirectory.

log directory writable
type: Property
comment: Query alias: 1 model declares logDirectoryWritable.

manage stock
type: Property
comment: Query alias: 7 models declare manageStock.

maximum amount
type: Property
comment: Query alias: 2 models declare maximumAmount.

maxmind geoip database
type: Property
comment: Query alias: 1 model declares maxmindGeoipDatabase.

max upload size
type: Property
comment: Query alias: 1 model declares maxUploadSize.

mbstring enabled
type: Property
comment: Query alias: 1 model declares mbstringEnabled.

menu order
type: Property
comment: Query alias: 11 models declare menuOrder.

message
type: Property
comment: Query alias: 3 models declare message.

metadata
type: Property
comment: Query alias: 24 models declare metadata.

meta data
type: Property
comment: Query alias: 7 models declare metaData.

meta identifier
type: Property
comment: Query alias: 2 models declare metaIdentifier.

method description
type: Property
comment: Query alias: 2 models declare methodDescription.

method id
type: Property
comment: Query alias: 4 models declare methodId.

method supports
type: Property
comment: Query alias: 1 model declares methodSupports.

method title
type: Property
comment: Query alias: 4 models declare methodTitle.

minimum amount
type: Property
comment: Query alias: 2 models declare minimumAmount.

mysql version
type: Property
comment: Query alias: 1 model declares mysqlVersion.

name
type: Property
comment: Query alias: 45 models declare name.

needs payment
type: Property
comment: Query alias: 4 models declare needsPayment.

needs processing
type: Property
comment: Query alias: 4 models declare needsProcessing.

net sales
type: Property
comment: Query alias: 1 model declares netSales.

network activated
type: Property
comment: Query alias: 1 model declares networkActivated.

nominal amount
type: Property
comment: Query alias: 1 model declares nominalAmount.

note
type: Property
comment: Query alias: 2 models declare note.

number
type: Property
comment: Query alias: 4 models declare number.

number of decimals
type: Property
comment: Query alias: 1 model declares numberOfDecimals.

num decimals
type: Property
comment: Query alias: 1 model declares numDecimals.

on sale
type: Property
comment: Query alias: 5 models declare onSale.

option
type: Property
comment: Query alias: 1 model declares option.

order by
type: Property
comment: Query alias: 1 model declares orderBy.

order key
type: Property
comment: Query alias: 5 models declare orderKey.

orders
type: Property
comment: Query alias: 1 model declares orders.

overrides
type: Property
comment: Query alias: 1 model declares overrides.

page exists
type: Property
comment: Query alias: 1 model declares pageExists.

page id
type: Property
comment: Query alias: 1 model declares pageId.

page name
type: Property
comment: Query alias: 1 model declares pageName.

pages
type: Property
comment: Query alias: 1 model declares pages.

page set
type: Property
comment: Query alias: 1 model declares pageSet.

page visible
type: Property
comment: Query alias: 1 model declares pageVisible.

parent author url
type: Property
comment: Query alias: 1 model declares parentAuthorUrl.

parent id
type: Property
comment: Query alias: 1 model declares parentId.

parent name
type: Property
comment: Query alias: 2 models declare parentName.

parent version
type: Property
comment: Query alias: 1 model declares parentVersion.

parent version latest
type: Property
comment: Query alias: 1 model declares parentVersionLatest.

password
type: Property
comment: Query alias: 1 model declares password.

payment method
type: Property
comment: Query alias: 5 models declare paymentMethod.

payment method title
type: Property
comment: Query alias: 5 models declare paymentMethodTitle.

payment url
type: Property
comment: Query alias: 4 models declare paymentUrl.

phone
type: Property
comment: Query alias: 2 models declare phone.

php max execution time
type: Property
comment: Query alias: 1 model declares phpMaxExecutionTime.

php max input vars
type: Property
comment: Query alias: 1 model declares phpMaxInputVars.

php post max size
type: Property
comment: Query alias: 1 model declares phpPostMaxSize.

php version
type: Property
comment: Query alias: 1 model declares phpVersion.

placeholder
type: Property
comment: Query alias: 3 models declare placeholder.

plugin
type: Property
comment: Query alias: 1 model declares plugin.

position
type: Property
comment: Query alias: 1 model declares position.

postcode
type: Property
comment: Query alias: 4 models declare postcode.

postcodes
type: Property
comment: Query alias: 2 models declare postcodes.

price
type: Property
comment: Query alias: 6 models declare price.

price html
type: Property
comment: Query alias: 4 models declare priceHtml.

prices include tax
type: Property
comment: Query alias: 4 models declare pricesIncludeTax.

priority
type: Property
comment: Query alias: 2 models declare priority.

product
type: Property
comment: Query alias: 6 models declare product.

product categories
type: Property
comment: Query alias: 2 models declare productCategories.

product name
type: Property
comment: Query alias: 1 model declares productName.

products
type: Property
comment: Query alias: 2 models declare products.

purchasable
type: Property
comment: Query alias: 5 models declare purchasable.

purchase note
type: Property
comment: Query alias: 5 models declare purchaseNote.

quantity
type: Property
comment: Query alias: 4 models declare quantity.

rate code
type: Property
comment: Query alias: 1 model declares rateCode.

rate percent
type: Property
comment: Query alias: 1 model declares ratePercent.

rating
type: Property
comment: Query alias: 2 models declare rating.

rating count
type: Property
comment: Query alias: 4 models declare ratingCount.

reason
type: Property
comment: Query alias: 3 models declare reason.

refunded by
type: Property
comment: Query alias: 2 models declare refundedBy.

refunded payment
type: Property
comment: Query alias: 1 model declares refundedPayment.

refunds
type: Property
comment: Query alias: 4 models declare refunds.

refund tax
type: Property
comment: Query alias: 1 model declares refundTax.

refund total
type: Property
comment: Query alias: 2 models declare refundTotal.

regular price
type: Property
comment: Query alias: 7 models declare regularPrice.

related products
type: Property
comment: Query alias: 4 models declare relatedProducts.

remote get response
type: Property
comment: Query alias: 1 model declares remoteGetResponse.

remote get successful
type: Property
comment: Query alias: 1 model declares remoteGetSuccessful.

remote post response
type: Property
comment: Query alias: 1 model declares remotePostResponse.

remote post successful
type: Property
comment: Query alias: 1 model declares remotePostSuccessful.

resource
type: Property
comment: Query alias: 1 model declares resource.

review
type: Property
comment: Query alias: 2 models declare review.

reviewer
type: Property
comment: Query alias: 2 models declare reviewer.

reviewer avatar urls
type: Property
comment: Query alias: 1 model declares reviewerAvatarUrls.

reviewer email
type: Property
comment: Query alias: 2 models declare reviewerEmail.

reviews allowed
type: Property
comment: Query alias: 5 models declare reviewsAllowed.

role
type: Property
comment: Query alias: 3 models declare role.

sale price
type: Property
comment: Query alias: 7 models declare salePrice.

sales
type: Property
comment: Query alias: 1 model declares sales.

secret
type: Property
comment: Query alias: 3 models declare secret.

secure connection
type: Property
comment: Query alias: 1 model declares secureConnection.

security
type: Property
comment: Query alias: 1 model declares security.

self
type: Property
comment: Query alias: 1 model declares self.

server info
type: Property
comment: Query alias: 1 model declares serverInfo.

set paid
type: Property
comment: Query alias: 1 model declares setPaid.

setting identifier
type: Property
comment: Query alias: 3 models declare settingIdentifier.

shipping class
type: Property
comment: Query alias: 7 models declare shippingClass.

shipping class id
type: Property
comment: Query alias: 5 models declare shippingClassId.

shipping required
type: Property
comment: Query alias: 4 models declare shippingRequired.

shipping tax
type: Property
comment: Query alias: 4 models declare shippingTax.

shipping taxable
type: Property
comment: Query alias: 4 models declare shippingTaxable.

shipping tax total
type: Property
comment: Query alias: 1 model declares shippingTaxTotal.

shipping total
type: Property
comment: Query alias: 4 models declare shippingTotal.

shortcode
type: Property
comment: Query alias: 1 model declares shortcode.

shortcode present
type: Property
comment: Query alias: 1 model declares shortcodePresent.

shortcode required
type: Property
comment: Query alias: 1 model declares shortcodeRequired.

short description
type: Property
comment: Query alias: 5 models declare shortDescription.

site url
type: Property
comment: Query alias: 1 model declares siteUrl.

sku
type: Property
comment: Query alias: 8 models declare sku.

slug
type: Property
comment: Query alias: 21 models declare slug.

soapclient enabled
type: Property
comment: Query alias: 1 model declares soapclientEnabled.

sold individually
type: Property
comment: Query alias: 5 models declare soldIndividually.

src
type: Property
comment: Query alias: 3 models declare src.

state
type: Property
comment: Query alias: 4 models declare state.

states
type: Property
comment: Query alias: 2 models declare states.

stock quantity
type: Property
comment: Query alias: 7 models declare stockQuantity.

stock status
type: Property
comment: Query alias: 7 models declare stockStatus.

sub groups
type: Property
comment: Query alias: 1 model declares subGroups.

subtotal
type: Property
comment: Query alias: 3 models declare subtotal.

subtotal tax
type: Property
comment: Query alias: 1 model declares subtotalTax.

success
type: Property
comment: Query alias: 1 model declares success.

suhosin installed
type: Property
comment: Query alias: 1 model declares suhosinInstalled.

symbol
type: Property
comment: Query alias: 1 model declares symbol.

tags
type: Property
comment: Query alias: 5 models declare tags.

tax
type: Property
comment: Query alias: 1 model declares tax.

tax class
type: Property
comment: Query alias: 13 models declare taxClass.

taxes
type: Property
comment: Query alias: 3 models declare taxes.

tax lines
type: Property
comment: Query alias: 5 models declare taxLines.

taxonomies
type: Property
comment: Query alias: 1 model declares taxonomies.

tax rate identifier
type: Property
comment: Query alias: 2 models declare taxRateIdentifier.

tax status
type: Property
comment: Query alias: 9 models declare taxStatus.

tax total
type: Property
comment: Query alias: 1 model declares taxTotal.

template id
type: Property
comment: Query alias: 1 model declares templateId.

template identifier
type: Property
comment: Query alias: 1 model declares templateIdentifier.

theme
type: Property
comment: Query alias: 1 model declares theme.

thousand sep
type: Property
comment: Query alias: 1 model declares thousandSep.

thousand separator
type: Property
comment: Query alias: 1 model declares thousandSeparator.

tip
type: Property
comment: Query alias: 3 models declare tip.

title
type: Property
comment: Query alias: 6 models declare title.

topic
type: Property
comment: Query alias: 3 models declare topic.

total
type: Property
comment: Query alias: 13 models declare total.

total customers
type: Property
comment: Query alias: 1 model declares totalCustomers.

total discount
type: Property
comment: Query alias: 1 model declares totalDiscount.

total items
type: Property
comment: Query alias: 1 model declares totalItems.

total orders
type: Property
comment: Query alias: 1 model declares totalOrders.

total refunds
type: Property
comment: Query alias: 1 model declares totalRefunds.

totals
type: Property
comment: Query alias: 1 model declares totals.

totals grouped by
type: Property
comment: Query alias: 1 model declares totalsGroupedBy.

total shipping
type: Property
comment: Query alias: 1 model declares totalShipping.

total tax
type: Property
comment: Query alias: 8 models declare totalTax.

transaction id
type: Property
comment: Query alias: 5 models declare transactionId.

type
type: Property
comment: Query alias: 11 models declare type.

upsell products
type: Property
comment: Query alias: 5 models declare upsellProducts.

url
type: Property
comment: Query alias: 1 model declares url.

usage count
type: Property
comment: Query alias: 3 models declare usageCount.

usage limit
type: Property
comment: Query alias: 4 models declare usageLimit.

usage limit per user
type: Property
comment: Query alias: 2 models declare usageLimitPerUser.

used by
type: Property
comment: Query alias: 1 model declares usedBy.

username
type: Property
comment: Query alias: 4 models declare username.

value
type: Property
comment: Query alias: 7 models declare value.

variations
type: Property
comment: Query alias: 4 models declare variations.

verified
type: Property
comment: Query alias: 1 model declares verified.

version
type: Property
comment: Query alias: 8 models declare version.

version latest
type: Property
comment: Query alias: 2 models declare versionLatest.

virtual
type: Property
comment: Query alias: 7 models declare virtual.

visible
type: Property
comment: Query alias: 1 model declares visible.

wc database version
type: Property
comment: Query alias: 1 model declares wcDatabaseVersion.

weight
type: Property
comment: Query alias: 7 models declare weight.

weight unit
type: Property
comment: Query alias: 1 model declares weightUnit.

width
type: Property
comment: Query alias: 1 model declares width.

wp cron
type: Property
comment: Query alias: 1 model declares wpCron.

wp debug mode
type: Property
comment: Query alias: 1 model declares wpDebugMode.

wp environment type
type: Property
comment: Query alias: 1 model declares wpEnvironmentType.

wp memory limit
type: Property
comment: Query alias: 1 model declares wpMemoryLimit.

wp multisite
type: Property
comment: Query alias: 1 model declares wpMultisite.

wp version
type: Property
comment: Query alias: 1 model declares wpVersion.

review status
type: Property

select options
type: Property

setting type
type: Property

thousand separator
type: Property

updated items
type: Property

webhook status
type: Property

href
type: Property
comment: URL to the resource
alternate name: href
sub property of: href
sub property of: url
domain: Self Link
range: anyURI

href
type: Property
comment: URL to the collection
alternate name: href
sub property of: href
sub property of: url
domain: Collection Link
range: anyURI

self
type: Property
comment: Link to this resource
alternate name: self
sub property of: self
domain: Links
range: Self Link

collection
type: Property
comment: Link to the collection
alternate name: collection
sub property of: collection
domain: Links
range: Collection Link

meta identifier
type: Property
comment: Metadata ID
alternate name: id
sub property of: meta identifier
domain: Metadata
range: long

key
type: Property
comment: Metadata key
alternate name: key
sub property of: key
sub property of: propertyID
domain: Metadata
range: string

value
type: Property
comment: Metadata value
alternate name: value
sub property of: value
domain: Metadata
range: string

display key
type: Property
comment: Meta key for UI display
alternate name: display_key
sub property of: display key
domain: Metadata
range: string
added in version: v4 7 4

display value
type: Property
comment: Meta value for UI display
alternate name: display_value
sub property of: display value
domain: Metadata
range: string
added in version: v4 7 4

image identifier
type: Property
comment: Image ID
alternate name: id
sub property of: image identifier
domain: Image
range: long

src
type: Property
comment: Image URL
alternate name: src
sub property of: src
sub property of: contentUrl
domain: Image
range: anyURI

name
type: Property
comment: Image name
alternate name: name
sub property of: name
domain: Image
range: string

alt
type: Property
comment: Image alt text
alternate name: alt
sub property of: alt
sub property of: alternateName
domain: Image
range: string

date created
type: Property
comment: The date the image was created (in the site's timezone)
alternate name: date_created
sub property of: date created
sub property of: dateCreated
domain: Image
range: dateTime

date modified
type: Property
comment: The date the image was last modified (in the site's timezone)
alternate name: date_modified
sub property of: date modified
sub property of: dateModified
domain: Image
range: dateTime

first name
type: Property
comment: First name
alternate name: first_name
sub property of: first name
sub property of: givenName
domain: Billing Address
range: string

last name
type: Property
comment: Last name
alternate name: last_name
sub property of: last name
sub property of: familyName
domain: Billing Address
range: string

company
type: Property
comment: Company name
alternate name: company
sub property of: company
domain: Billing Address
range: string

address1
type: Property
comment: Address line 1
alternate name: address_1
sub property of: address1
sub property of: streetAddress
domain: Billing Address
range: string

address2
type: Property
comment: Address line 2
alternate name: address_2
sub property of: address2
sub property of: streetAddress
domain: Billing Address
range: string

city
type: Property
comment: City
alternate name: city
sub property of: city
sub property of: addressLocality
domain: Billing Address
range: string

state
type: Property
comment: State/Province code
alternate name: state
sub property of: state
sub property of: addressRegion
domain: Billing Address
range: string

postcode
type: Property
comment: Postal/ZIP code
alternate name: postcode
sub property of: postcode
sub property of: postalCode
domain: Billing Address
range: string

country
type: Property
comment: Country code (ISO 3166-1 alpha-2)
alternate name: country
sub property of: country
sub property of: addressCountry
domain: Billing Address
range: string

email
type: Property
comment: Email address
alternate name: email
sub property of: email
domain: Billing Address
range: string

phone
type: Property
comment: Phone number
alternate name: phone
sub property of: phone
sub property of: telephone
domain: Billing Address
range: string

first name
type: Property
comment: First name
alternate name: first_name
sub property of: first name
sub property of: givenName
domain: Shipping Address
range: string

last name
type: Property
comment: Last name
alternate name: last_name
sub property of: last name
sub property of: familyName
domain: Shipping Address
range: string

company
type: Property
comment: Company name
alternate name: company
sub property of: company
domain: Shipping Address
range: string

address1
type: Property
comment: Address line 1
alternate name: address_1
sub property of: address1
sub property of: streetAddress
domain: Shipping Address
range: string

address2
type: Property
comment: Address line 2
alternate name: address_2
sub property of: address2
sub property of: streetAddress
domain: Shipping Address
range: string

city
type: Property
comment: City
alternate name: city
sub property of: city
sub property of: addressLocality
domain: Shipping Address
range: string

state
type: Property
comment: State/Province code
alternate name: state
sub property of: state
sub property of: addressRegion
domain: Shipping Address
range: string

postcode
type: Property
comment: Postal/ZIP code
alternate name: postcode
sub property of: postcode
sub property of: postalCode
domain: Shipping Address
range: string

country
type: Property
comment: Country code (ISO 3166-1 alpha-2)
alternate name: country
sub property of: country
sub property of: addressCountry
domain: Shipping Address
range: string

phone
type: Property
comment: Phone number
alternate name: phone
sub property of: phone
sub property of: telephone
domain: Shipping Address
range: string
added in version: v5 6 2

code
type: Property
comment: Error code
alternate name: code
sub property of: code
sub property of: identifier
domain: Woo Commerce Error
range: string

message
type: Property
comment: Human-readable error message
alternate name: message
sub property of: message
sub property of: description
domain: Woo Commerce Error
range: string

data
type: Property
comment: Additional error data
alternate name: data
sub property of: data
domain: Woo Commerce Error
range: Data

id
type: Property
comment: Category ID
alternate name: id
domain: Product Category Ref
range: long

name
type: Property
comment: Category name
alternate name: name
sub property of: name
domain: Product Category Ref
range: string

slug
type: Property
comment: Category slug
alternate name: slug
sub property of: slug
sub property of: identifier
domain: Product Category Ref
range: string

id
type: Property
comment: Tag ID
alternate name: id
domain: Product Tag Ref
range: long

name
type: Property
comment: Tag name
alternate name: name
sub property of: name
domain: Product Tag Ref
range: string

slug
type: Property
comment: Tag slug
alternate name: slug
sub property of: slug
sub property of: identifier
domain: Product Tag Ref
range: string

image identifier
type: Property
comment: Image ID (attachment ID from Media Library)
alternate name: id
sub property of: image identifier
domain: Product Image
range: long

date created
type: Property
comment: The date the image was created, in the site's timezone
alternate name: date_created
sub property of: date created
domain: Product Image
range: dateTime

date created gmt
type: Property
comment: The date the image was created, as GMT
alternate name: date_created_gmt
sub property of: date created gmt
domain: Product Image
range: dateTime

date modified
type: Property
comment: The date the image was last modified, in the site's timezone
alternate name: date_modified
sub property of: date modified
domain: Product Image
range: dateTime

date modified gmt
type: Property
comment: The date the image was last modified, as GMT
alternate name: date_modified_gmt
sub property of: date modified gmt
domain: Product Image
range: dateTime

src
type: Property
comment: Image URL
alternate name: src
sub property of: src
sub property of: contentUrl
domain: Product Image
range: anyURI

name
type: Property
comment: Image name
alternate name: name
sub property of: name
domain: Product Image
range: string

alt
type: Property
comment: Image alternative text
alternate name: alt
sub property of: alt
sub property of: caption
domain: Product Image
range: string

attribute identifier
type: Property
comment: Attribute ID (0 for custom product attribute)
alternate name: id
sub property of: attribute identifier
domain: Product Attribute
range: long

name
type: Property
comment: Attribute name
alternate name: name
sub property of: name
domain: Product Attribute
range: string

position
type: Property
comment: Attribute position in list
alternate name: position
sub property of: position
domain: Product Attribute
range: int

visible
type: Property
comment: Whether visible on product page
alternate name: visible
sub property of: visible
domain: Product Attribute
range: boolean

variation
type: Property
comment: Whether used for variations
alternate name: variation
domain: Product Attribute
range: boolean

options
type: Property
comment: List of attribute term values
alternate name: options
sub property of: value
domain: Product Attribute
range: string

attribute identifier
type: Property
comment: Attribute ID (0 for custom product attribute)
alternate name: id
sub property of: attribute identifier
domain: Default Attribute
range: long

name
type: Property
comment: Attribute name
alternate name: name
sub property of: name
domain: Default Attribute
range: string

option
type: Property
comment: Selected attribute term
alternate name: option
sub property of: option
sub property of: value
domain: Default Attribute
range: string

download identifier
type: Property
comment: Download ID (MD5 hash)
alternate name: id
sub property of: download identifier
domain: Product Download
range: string

name
type: Property
comment: Download file name
alternate name: name
sub property of: name
domain: Product Download
range: string

file
type: Property
comment: Download file URL
alternate name: file
sub property of: contentUrl
domain: Product Download
range: anyURI

length
type: Property
comment: Length
alternate name: length
sub property of: length
domain: Product Dimensions
range: string

width
type: Property
comment: Width
alternate name: width
sub property of: width
domain: Product Dimensions
range: string

height
type: Property
comment: Height
alternate name: height
sub property of: height
domain: Product Dimensions
range: string

meta identifier
type: Property
comment: Meta ID
alternate name: id
sub property of: meta identifier
domain: Product Metadata
range: long

key
type: Property
comment: Meta key
alternate name: key
sub property of: key
sub property of: name
domain: Product Metadata
range: string

value
type: Property
comment: Meta value
alternate name: value
sub property of: value
domain: Product Metadata
range: string

image identifier
type: Property
comment: Image ID
alternate name: id
sub property of: image identifier
domain: Category Image
range: long

date created
type: Property
comment: The date the image was created, in the site's timezone
alternate name: date_created
sub property of: date created
sub property of: dateCreated
domain: Category Image
range: dateTime

date created gmt
type: Property
comment: The date the image was created, as GMT
alternate name: date_created_gmt
sub property of: date created gmt
domain: Category Image
range: dateTime

date modified
type: Property
comment: The date the image was last modified, in the site's timezone
alternate name: date_modified
sub property of: date modified
sub property of: dateModified
domain: Category Image
range: dateTime

date modified gmt
type: Property
comment: The date the image was last modified, as GMT
alternate name: date_modified_gmt
sub property of: date modified gmt
domain: Category Image
range: dateTime

src
type: Property
comment: Image URL
alternate name: src
sub property of: src
sub property of: contentUrl
domain: Category Image
range: anyURI

name
type: Property
comment: Image name
alternate name: name
sub property of: name
domain: Category Image
range: string

alt
type: Property
comment: Image alternative text
alternate name: alt
sub property of: alt
sub property of: caption
domain: Category Image
range: string

id
type: Property
comment: Unique identifier for the resource
alternate name: id
domain: Product Category
range: long

name
type: Property
comment: Category name
alternate name: name
sub property of: name
domain: Product Category
range: string

slug
type: Property
comment: An alphanumeric identifier for the resource unique to its type
alternate name: slug
sub property of: slug
sub property of: identifier
domain: Product Category
range: string

parent
type: Property
comment: The ID for the parent of the resource
alternate name: parent
domain: Product Category
range: Product Category

description
type: Property
comment: HTML description of the resource
alternate name: description
sub property of: description
domain: Product Category
range: string

display
type: Property
comment: Category archive display type
alternate name: display
sub property of: display
domain: Product Category
range: string
code list: CategoryDisplay

image
type: Property
comment: Image data
alternate name: image
domain: Product Category
range: Category Image

menu order
type: Property
comment: Menu order, used to custom sort the resource
alternate name: menu_order
sub property of: menu order
domain: Product Category
range: int

count
type: Property
comment: Number of published products for the resource
alternate name: count
sub property of: count
domain: Product Category
range: int

links
type: Property
comment: HAL links
alternate name: _links
domain: Product Category
range: Links

name
type: Property
comment: Category name
alternate name: name
sub property of: name
domain: Product Category Input
range: string

slug
type: Property
comment: An alphanumeric identifier for the resource unique to its type
alternate name: slug
sub property of: slug
domain: Product Category Input
range: string

parent
type: Property
comment: The ID for the parent of the resource
alternate name: parent
domain: Product Category Input
range: Product Category

description
type: Property
comment: HTML description of the resource
alternate name: description
sub property of: description
domain: Product Category Input
range: string

display
type: Property
comment: Category archive display type
alternate name: display
sub property of: display
domain: Product Category Input
range: string
code list: CategoryDisplay

image
type: Property
comment: Image data
alternate name: image
domain: Product Category Input
range: Category Image

id
type: Property
comment: Unique identifier
alternate name: id
domain: Product Tag
range: long

name
type: Property
comment: Tag name
alternate name: name
sub property of: name
domain: Product Tag
range: string

slug
type: Property
comment: URL-friendly slug
alternate name: slug
sub property of: slug
sub property of: identifier
domain: Product Tag
range: string

description
type: Property
comment: Description
alternate name: description
sub property of: description
domain: Product Tag
range: string

count
type: Property
comment: Number of products with this tag
alternate name: count
sub property of: count
domain: Product Tag
range: int

links
type: Property
comment: HAL links
alternate name: _links
domain: Product Tag
range: Links

name
type: Property
comment: Tag name
alternate name: name
sub property of: name
domain: Product Tag Input
range: string

slug
type: Property
comment: URL-friendly slug
alternate name: slug
sub property of: slug
domain: Product Tag Input
range: string

description
type: Property
comment: Description
alternate name: description
sub property of: description
domain: Product Tag Input
range: string

id
type: Property
comment: Unique identifier for the resource
alternate name: id
domain: Product Brand
range: long

name
type: Property
comment: Brand name
alternate name: name
sub property of: name
domain: Product Brand
range: string

slug
type: Property
comment: An alphanumeric identifier for the resource unique to its type
alternate name: slug
sub property of: slug
domain: Product Brand
range: string

parent
type: Property
comment: The ID for the parent of the resource
alternate name: parent
domain: Product Brand
range: Product Brand

description
type: Property
comment: HTML description of the resource
alternate name: description
sub property of: description
domain: Product Brand
range: string

display
type: Property
comment: Brand archive display type
alternate name: display
sub property of: display
domain: Product Brand
range: string
code list: CategoryDisplay

image
type: Property
comment: Image data
alternate name: image
domain: Product Brand
range: Category Image

menu order
type: Property
comment: Menu order, used to custom sort the resource
alternate name: menu_order
sub property of: menu order
domain: Product Brand
range: int

count
type: Property
comment: Number of published products for the resource
alternate name: count
sub property of: count
domain: Product Brand
range: int

links
type: Property
comment: HAL links
alternate name: _links
domain: Product Brand
range: Links

name
type: Property
comment: Brand name
alternate name: name
sub property of: name
domain: Product Brand Input
range: string

slug
type: Property
comment: An alphanumeric identifier for the resource unique to its type
alternate name: slug
sub property of: slug
domain: Product Brand Input
range: string

parent
type: Property
comment: The ID for the parent of the resource
alternate name: parent
domain: Product Brand Input
range: Product Brand

description
type: Property
comment: HTML description of the resource
alternate name: description
sub property of: description
domain: Product Brand Input
range: string

display
type: Property
comment: Brand archive display type
alternate name: display
sub property of: display
domain: Product Brand Input
range: string
code list: CategoryDisplay

image
type: Property
comment: Image data
alternate name: image
domain: Product Brand Input
range: Category Image

menu order
type: Property
comment: Menu order, used to custom sort the resource
alternate name: menu_order
sub property of: menu order
domain: Product Brand Input
range: int

id
type: Property
comment: Unique identifier for the resource
alternate name: id
domain: Product
range: long

name
type: Property
comment: Product name
alternate name: name
sub property of: name
domain: Product
range: string

slug
type: Property
comment: URL-friendly slug
alternate name: slug
sub property of: slug
sub property of: identifier
domain: Product
range: string

permalink
type: Property
comment: Product URL
alternate name: permalink
sub property of: url
domain: Product
range: anyURI

date created
type: Property
comment: The date the product was created, in the site's timezone
alternate name: date_created
sub property of: date created
sub property of: dateCreated
domain: Product
range: dateTime

date created gmt
type: Property
comment: The date the product was created, as GMT
alternate name: date_created_gmt
sub property of: date created gmt
domain: Product
range: dateTime

date modified
type: Property
comment: The date the product was last modified, in the site's timezone
alternate name: date_modified
sub property of: date modified
sub property of: dateModified
domain: Product
range: dateTime

date modified gmt
type: Property
comment: The date the product was last modified, as GMT
alternate name: date_modified_gmt
sub property of: date modified gmt
domain: Product
range: dateTime

type
type: Property
comment: Product type
alternate name: type
sub property of: type
domain: Product
range: string
code list: ProductType

status
type: Property
comment: Product status (post status)
alternate name: status
domain: Product
range: string
code list: ProductStatus

featured
type: Property
comment: Featured product
alternate name: featured
sub property of: featured
domain: Product
range: boolean

catalog visibility
type: Property
comment: Catalog visibility
alternate name: catalog_visibility
sub property of: catalog visibility
domain: Product
range: string
code list: CatalogVisibility

description
type: Property
comment: Product description
alternate name: description
sub property of: description
domain: Product
range: string

short description
type: Property
comment: Product short description
alternate name: short_description
sub property of: short description
sub property of: abstract
domain: Product
range: string

sku
type: Property
comment: Unique identifier (Stock Keeping Unit)
alternate name: sku
sub property of: sku
domain: Product
range: string

global unique id
type: Property
comment: Global product identifier
alternate name: global_unique_id
sub property of: global unique id
sub property of: gtin
domain: Product
range: string
added in version: v9 2 4

price
type: Property
comment: Current product price
alternate name: price
sub property of: price
domain: Product
range: string

regular price
type: Property
comment: Product regular price
alternate name: regular_price
sub property of: regular price
sub property of: price
domain: Product
range: string

sale price
type: Property
comment: Product sale price
alternate name: sale_price
sub property of: sale price
sub property of: lowPrice
domain: Product
range: string

date on sale from
type: Property
comment: Start date of sale price, in the site's timezone
alternate name: date_on_sale_from
sub property of: date on sale from
domain: Product
range: dateTime

date on sale from gmt
type: Property
comment: Start date of sale price, as GMT
alternate name: date_on_sale_from_gmt
sub property of: date on sale from gmt
domain: Product
range: dateTime

date on sale to
type: Property
comment: End date of sale price, in the site's timezone
alternate name: date_on_sale_to
sub property of: date on sale to
domain: Product
range: dateTime

date on sale to gmt
type: Property
comment: End date of sale price, as GMT
alternate name: date_on_sale_to_gmt
sub property of: date on sale to gmt
domain: Product
range: dateTime

price html
type: Property
comment: Price formatted in HTML
alternate name: price_html
sub property of: price html
domain: Product
range: string

on sale
type: Property
comment: Shows if the product is on sale
alternate name: on_sale
sub property of: on sale
domain: Product
range: boolean

purchasable
type: Property
comment: Shows if the product can be bought
alternate name: purchasable
sub property of: purchasable
domain: Product
range: boolean

total sales
type: Property
comment: Amount of sales
alternate name: total_sales
domain: Product
range: long

virtual
type: Property
comment: If the product is virtual (no shipping)
alternate name: virtual
sub property of: virtual
domain: Product
range: boolean

downloadable
type: Property
comment: If the product is downloadable
alternate name: downloadable
sub property of: downloadable
domain: Product
range: boolean

downloads
type: Property
comment: List of downloadable files
alternate name: downloads
sub property of: downloads
domain: Product
range: Product Download

download limit
type: Property
comment: Number of times downloadable files can be downloaded after purchase. Default is -1.
alternate name: download_limit
sub property of: download limit
domain: Product
range: int

download expiry
type: Property
comment: Number of days until access to downloadable files expires. Default is -1.
alternate name: download_expiry
sub property of: download expiry
domain: Product
range: int

external url
type: Property
comment: Product external URL. Only for external products.
alternate name: external_url
sub property of: external url
domain: Product
range: string

button text
type: Property
comment: Product external button text. Only for external products.
alternate name: button_text
sub property of: button text
domain: Product
range: string

tax status
type: Property
comment: Tax status
alternate name: tax_status
sub property of: tax status
domain: Product
range: string
code list: TaxStatus

tax class
type: Property
comment: Tax class
alternate name: tax_class
sub property of: tax class
domain: Product
range: string

manage stock
type: Property
comment: Stock management at product level
alternate name: manage_stock
sub property of: manage stock
domain: Product
range: boolean

stock quantity
type: Property
comment: Stock quantity
alternate name: stock_quantity
sub property of: stock quantity
domain: Product
range: long

stock status
type: Property
comment: Controls the stock status of the product
alternate name: stock_status
sub property of: stock status
domain: Product
range: string
code list: StockStatus

backorders
type: Property
comment: If managing stock, this controls if backorders are allowed
alternate name: backorders
sub property of: backorders
domain: Product
range: string
code list: BackorderStatus

backorders allowed
type: Property
comment: Shows if backorders are allowed
alternate name: backorders_allowed
sub property of: backorders allowed
domain: Product
range: boolean

backordered
type: Property
comment: Shows if the product is on backordered
alternate name: backordered
sub property of: backordered
domain: Product
range: boolean

sold individually
type: Property
comment: Allow one item to be bought in a single order
alternate name: sold_individually
sub property of: sold individually
domain: Product
range: boolean

weight
type: Property
comment: Product weight
alternate name: weight
sub property of: weight
domain: Product
range: string

dimensions
type: Property
comment: Product dimensions
alternate name: dimensions
sub property of: dimensions
domain: Product
range: Product Dimensions

shipping required
type: Property
comment: Shows if the product need to be shipped
alternate name: shipping_required
sub property of: shipping required
domain: Product
range: boolean

shipping taxable
type: Property
comment: Shows whether or not the product shipping is taxable
alternate name: shipping_taxable
sub property of: shipping taxable
domain: Product
range: boolean

shipping class
type: Property
comment: Shipping class slug
alternate name: shipping_class
sub property of: shipping class
domain: Product
range: string

shipping class id
type: Property
comment: Shipping class ID
alternate name: shipping_class_id
sub property of: shipping class id
domain: Product
range: Product Shipping Class

reviews allowed
type: Property
comment: Allow reviews
alternate name: reviews_allowed
sub property of: reviews allowed
domain: Product
range: boolean

average rating
type: Property
comment: Reviews average rating
alternate name: average_rating
sub property of: average rating
domain: Product
range: string

rating count
type: Property
comment: Amount of reviews that the product have
alternate name: rating_count
sub property of: rating count
domain: Product
range: int

related products
type: Property
comment: List of related products
alternate name: related_ids
sub property of: related products
domain: Product
range: Product

upsell products
type: Property
comment: List of up-sell products
alternate name: upsell_ids
sub property of: upsell products
domain: Product
range: Product

cross sell products
type: Property
comment: List of cross-sell products
alternate name: cross_sell_ids
sub property of: cross sell products
domain: Product
range: Product

parent
type: Property
comment: Parent product
alternate name: parent_id
domain: Product
range: Product

purchase note
type: Property
comment: Optional note to send the customer after purchase
alternate name: purchase_note
sub property of: purchase note
domain: Product
range: string

categories
type: Property
comment: List of categories
alternate name: categories
sub property of: categories
sub property of: category
domain: Product
range: Product Category Ref

tags
type: Property
comment: List of tags
alternate name: tags
sub property of: tags
domain: Product
range: Product Tag Ref

images
type: Property
comment: List of images
alternate name: images
sub property of: images
sub property of: image
domain: Product
range: Product Image

attributes
type: Property
comment: List of attributes
alternate name: attributes
domain: Product
range: Product Attribute

default attributes
type: Property
comment: Defaults variation attributes
alternate name: default_attributes
sub property of: default attributes
domain: Product
range: Default Attribute

variations
type: Property
comment: List of variation IDs
alternate name: variations
sub property of: variations
domain: Product
range: Product Variation

grouped products
type: Property
comment: List of grouped product IDs
alternate name: grouped_products
sub property of: grouped products
domain: Product
range: Product

menu order
type: Property
comment: Menu order, used to custom sort products
alternate name: menu_order
sub property of: menu order
domain: Product
range: int

meta data
type: Property
comment: Meta data
alternate name: meta_data
sub property of: meta data
domain: Product
range: Product Metadata

links
type: Property
comment: HAL links
alternate name: _links
domain: Product
range: Links

id
type: Property
comment: Unique identifier for the resource
alternate name: id
domain: Product Shipping Class
range: long

name
type: Property
comment: Shipping class name
alternate name: name
sub property of: name
domain: Product Shipping Class
range: string

slug
type: Property
comment: An alphanumeric identifier for the resource unique to its type
alternate name: slug
sub property of: slug
domain: Product Shipping Class
range: string

description
type: Property
comment: HTML description of the resource
alternate name: description
sub property of: description
domain: Product Shipping Class
range: string

count
type: Property
comment: Number of published products for the resource
alternate name: count
sub property of: product count
sub property of: count
domain: Product Shipping Class
range: int

links
type: Property
comment: HAL links
alternate name: _links
domain: Product Shipping Class
range: Links

id
type: Property
comment: Unique identifier
alternate name: id
domain: Product Variation
range: long

date created
type: Property
comment: The date the variation was created, in the site's timezone
alternate name: date_created
sub property of: date created
domain: Product Variation
range: dateTime

date created gmt
type: Property
comment: The date the variation was created, as GMT
alternate name: date_created_gmt
sub property of: date created gmt
domain: Product Variation
range: dateTime

date modified
type: Property
comment: The date the variation was last modified, in the site's timezone
alternate name: date_modified
sub property of: date modified
domain: Product Variation
range: dateTime

date modified gmt
type: Property
comment: The date the variation was last modified, as GMT
alternate name: date_modified_gmt
sub property of: date modified gmt
domain: Product Variation
range: dateTime

description
type: Property
comment: Variation description
alternate name: description
sub property of: description
domain: Product Variation
range: string

permalink
type: Property
comment: Variation URL
alternate name: permalink
domain: Product Variation
range: string

sku
type: Property
comment: SKU
alternate name: sku
sub property of: sku
domain: Product Variation
range: string

global unique id
type: Property
comment: Global product identifier
alternate name: global_unique_id
sub property of: global unique id
sub property of: gtin
domain: Product Variation
range: string
added in version: v9 2 4

price
type: Property
comment: Current price
alternate name: price
sub property of: price
domain: Product Variation
range: string

regular price
type: Property
comment: Regular price
alternate name: regular_price
sub property of: regular price
sub property of: price
domain: Product Variation
range: string

sale price
type: Property
comment: Sale price
alternate name: sale_price
sub property of: sale price
sub property of: lowPrice
domain: Product Variation
range: string

date on sale from
type: Property
comment: Start date of sale price, in the site's timezone
alternate name: date_on_sale_from
sub property of: date on sale from
domain: Product Variation
range: dateTime

date on sale from gmt
type: Property
comment: Start date of sale price, as GMT
alternate name: date_on_sale_from_gmt
sub property of: date on sale from gmt
domain: Product Variation
range: dateTime

date on sale to
type: Property
comment: End date of sale price, in the site's timezone
alternate name: date_on_sale_to
sub property of: date on sale to
domain: Product Variation
range: dateTime

date on sale to gmt
type: Property
comment: End date of sale price, as GMT
alternate name: date_on_sale_to_gmt
sub property of: date on sale to gmt
domain: Product Variation
range: dateTime

on sale
type: Property
comment: Shows if the variation is on sale
alternate name: on_sale
sub property of: on sale
domain: Product Variation
range: boolean

status
type: Property
comment: Variation status
alternate name: status
domain: Product Variation
range: string
code list: ProductStatus

purchasable
type: Property
comment: Shows if the variation can be bought
alternate name: purchasable
sub property of: purchasable
domain: Product Variation
range: boolean

virtual
type: Property
comment: If the variation is virtual
alternate name: virtual
sub property of: virtual
domain: Product Variation
range: boolean

downloadable
type: Property
comment: If the variation is downloadable
alternate name: downloadable
sub property of: downloadable
domain: Product Variation
range: boolean

downloads
type: Property
comment: List of downloadable files
alternate name: downloads
sub property of: downloads
domain: Product Variation
range: Product Download

download limit
type: Property
comment: Number of times downloadable files can be downloaded after purchase
alternate name: download_limit
sub property of: download limit
domain: Product Variation
range: int

download expiry
type: Property
comment: Number of days until access to downloadable files expires
alternate name: download_expiry
sub property of: download expiry
domain: Product Variation
range: int

tax status
type: Property
comment: Tax status
alternate name: tax_status
sub property of: tax status
domain: Product Variation
range: string
code list: TaxStatus

tax class
type: Property
comment: Tax class
alternate name: tax_class
sub property of: tax class
domain: Product Variation
range: string

manage stock
type: Property
comment: Stock management at variation level
alternate name: manage_stock
sub property of: manage stock
domain: Product Variation
code list: manageStock
type changed from: boolean
type changed in version: v10 1 3

stock quantity
type: Property
comment: Stock quantity
alternate name: stock_quantity
sub property of: stock quantity
domain: Product Variation
range: long

stock status
type: Property
comment: Controls the stock status of the variation
alternate name: stock_status
sub property of: stock status
domain: Product Variation
range: string
code list: StockStatus

backorders
type: Property
comment: If managing stock, this controls if backorders are allowed
alternate name: backorders
sub property of: backorders
domain: Product Variation
range: string
code list: BackorderStatus

backorders allowed
type: Property
comment: Shows if backorders are allowed
alternate name: backorders_allowed
sub property of: backorders allowed
domain: Product Variation
range: boolean

backordered
type: Property
comment: Shows if the variation is on backordered
alternate name: backordered
sub property of: backordered
domain: Product Variation
range: boolean

weight
type: Property
comment: Variation weight
alternate name: weight
sub property of: weight
domain: Product Variation
range: string

dimensions
type: Property
comment: Variation dimensions
alternate name: dimensions
sub property of: dimensions
domain: Product Variation
range: Product Dimensions

shipping class
type: Property
comment: Shipping class slug
alternate name: shipping_class
sub property of: shipping class
domain: Product Variation
range: string

shipping class id
type: Property
comment: Shipping class ID
alternate name: shipping_class_id
sub property of: shipping class id
domain: Product Variation
range: Product Shipping Class

image
type: Property
comment: Variation image
alternate name: image
sub property of: image
domain: Product Variation
range: Product Image

attributes
type: Property
comment: List of variation attributes
alternate name: attributes
domain: Product Variation
range: Default Attribute

menu order
type: Property
comment: Menu order
alternate name: menu_order
sub property of: menu order
domain: Product Variation
range: int

meta data
type: Property
comment: Meta data
alternate name: meta_data
sub property of: meta data
domain: Product Variation
range: Product Metadata

links
type: Property
comment: HAL links
alternate name: _links
domain: Product Variation
range: Links

name
type: Property
comment: Product name
alternate name: name
sub property of: name
domain: Product Input
range: string

slug
type: Property
comment: URL-friendly slug
alternate name: slug
sub property of: slug
domain: Product Input
range: string

type
type: Property
comment: Product type
alternate name: type
sub property of: type
domain: Product Input
range: string
code list: ProductType

status
type: Property
comment: Product status
alternate name: status
domain: Product Input
range: string
code list: ProductStatus

featured
type: Property
comment: Featured product
alternate name: featured
sub property of: featured
domain: Product Input
range: boolean

catalog visibility
type: Property
comment: Catalog visibility
alternate name: catalog_visibility
sub property of: catalog visibility
domain: Product Input
range: string
code list: CatalogVisibility

description
type: Property
comment: Product description
alternate name: description
sub property of: description
domain: Product Input
range: string

short description
type: Property
comment: Product short description
alternate name: short_description
sub property of: short description
domain: Product Input
range: string

sku
type: Property
comment: SKU
alternate name: sku
sub property of: sku
domain: Product Input
range: string

global unique id
type: Property
comment: Global product identifier
alternate name: global_unique_id
sub property of: global unique id
domain: Product Input
range: string
added in version: v9 2 4

regular price
type: Property
comment: Product regular price
alternate name: regular_price
sub property of: regular price
domain: Product Input
range: string

sale price
type: Property
comment: Product sale price
alternate name: sale_price
sub property of: sale price
domain: Product Input
range: string

date on sale from
type: Property
comment: Start date of sale price, in the site's timezone
alternate name: date_on_sale_from
sub property of: date on sale from
domain: Product Input
range: dateTime

date on sale from gmt
type: Property
comment: Start date of sale price, as GMT
alternate name: date_on_sale_from_gmt
sub property of: date on sale from gmt
domain: Product Input
range: dateTime

date on sale to
type: Property
comment: End date of sale price, in the site's timezone
alternate name: date_on_sale_to
sub property of: date on sale to
domain: Product Input
range: dateTime

date on sale to gmt
type: Property
comment: End date of sale price, as GMT
alternate name: date_on_sale_to_gmt
sub property of: date on sale to gmt
domain: Product Input
range: dateTime

virtual
type: Property
comment: If the product is virtual
alternate name: virtual
sub property of: virtual
domain: Product Input
range: boolean

downloadable
type: Property
comment: If the product is downloadable
alternate name: downloadable
sub property of: downloadable
domain: Product Input
range: boolean

downloads
type: Property
comment: List of downloadable files
alternate name: downloads
sub property of: downloads
domain: Product Input
range: Product Download

download limit
type: Property
comment: Download limit
alternate name: download_limit
sub property of: download limit
domain: Product Input
range: int

download expiry
type: Property
comment: Download expiry in days
alternate name: download_expiry
sub property of: download expiry
domain: Product Input
range: int

external url
type: Property
comment: Product external URL
alternate name: external_url
sub property of: external url
domain: Product Input
range: string

button text
type: Property
comment: Product external button text
alternate name: button_text
sub property of: button text
domain: Product Input
range: string

tax status
type: Property
comment: Tax status
alternate name: tax_status
sub property of: tax status
domain: Product Input
range: string
code list: TaxStatus

tax class
type: Property
comment: Tax class
alternate name: tax_class
sub property of: tax class
domain: Product Input
range: string

manage stock
type: Property
comment: Whether to manage stock
alternate name: manage_stock
sub property of: manage stock
domain: Product Input
range: boolean

stock quantity
type: Property
comment: Stock quantity
alternate name: stock_quantity
sub property of: stock quantity
domain: Product Input
range: long

stock status
type: Property
comment: Stock status
alternate name: stock_status
sub property of: stock status
domain: Product Input
range: string
code list: StockStatus

backorders
type: Property
comment: Backorder status
alternate name: backorders
sub property of: backorders
domain: Product Input
range: string
code list: BackorderStatus

sold individually
type: Property
comment: Allow one item to be bought in a single order
alternate name: sold_individually
sub property of: sold individually
domain: Product Input
range: boolean

weight
type: Property
comment: Product weight
alternate name: weight
sub property of: weight
domain: Product Input
range: string

dimensions
type: Property
comment: Product dimensions
alternate name: dimensions
sub property of: dimensions
domain: Product Input
range: Product Dimensions

shipping class
type: Property
comment: Shipping class slug
alternate name: shipping_class
sub property of: shipping class
domain: Product Input
range: string

reviews allowed
type: Property
comment: Allow reviews
alternate name: reviews_allowed
sub property of: reviews allowed
domain: Product Input
range: boolean

upsell products
type: Property
comment: List of up-sell products
alternate name: upsell_ids
sub property of: upsell products
domain: Product Input
range: Product

cross sell products
type: Property
comment: List of cross-sell products
alternate name: cross_sell_ids
sub property of: cross sell products
domain: Product Input
range: Product

parent
type: Property
comment: Product parent
alternate name: parent_id
domain: Product Input
range: Product

purchase note
type: Property
comment: Optional note to send the customer after purchase
alternate name: purchase_note
sub property of: purchase note
domain: Product Input
range: string

categories
type: Property
comment: List of categories
alternate name: categories
sub property of: categories
domain: Product Input
range: Product Category Ref

tags
type: Property
comment: List of tags
alternate name: tags
sub property of: tags
domain: Product Input
range: Product Tag Ref

images
type: Property
comment: List of images
alternate name: images
sub property of: images
domain: Product Input
range: Product Image

attributes
type: Property
comment: List of attributes
alternate name: attributes
domain: Product Input
range: Product Attribute

default attributes
type: Property
comment: Defaults variation attributes
alternate name: default_attributes
sub property of: default attributes
domain: Product Input
range: Default Attribute

grouped products
type: Property
comment: List of grouped product IDs
alternate name: grouped_products
sub property of: grouped products
domain: Product Input
range: Product

menu order
type: Property
comment: Menu order
alternate name: menu_order
sub property of: menu order
domain: Product Input
range: int

meta data
type: Property
comment: Meta data
alternate name: meta_data
sub property of: meta data
domain: Product Input
range: Product Metadata

description
type: Property
comment: Description
alternate name: description
sub property of: description
domain: Product Variation Input
range: string

sku
type: Property
comment: SKU
alternate name: sku
sub property of: sku
domain: Product Variation Input
range: string

global unique id
type: Property
comment: Global product identifier
alternate name: global_unique_id
sub property of: global unique id
domain: Product Variation Input
range: string
added in version: v9 2 4

regular price
type: Property
comment: Regular price
alternate name: regular_price
sub property of: regular price
domain: Product Variation Input
range: string

sale price
type: Property
comment: Sale price
alternate name: sale_price
sub property of: sale price
domain: Product Variation Input
range: string

date on sale from
type: Property
comment: Start date of sale price, in the site's timezone
alternate name: date_on_sale_from
sub property of: date on sale from
domain: Product Variation Input
range: dateTime

date on sale from gmt
type: Property
comment: Start date of sale price, as GMT
alternate name: date_on_sale_from_gmt
sub property of: date on sale from gmt
domain: Product Variation Input
range: dateTime

date on sale to
type: Property
comment: End date of sale price, in the site's timezone
alternate name: date_on_sale_to
sub property of: date on sale to
domain: Product Variation Input
range: dateTime

date on sale to gmt
type: Property
comment: End date of sale price, as GMT
alternate name: date_on_sale_to_gmt
sub property of: date on sale to gmt
domain: Product Variation Input
range: dateTime

status
type: Property
comment: Variation status
alternate name: status
domain: Product Variation Input
range: string
code list: ProductStatus

virtual
type: Property
comment: If the variation is virtual
alternate name: virtual
sub property of: virtual
domain: Product Variation Input
range: boolean

downloadable
type: Property
comment: If the variation is downloadable
alternate name: downloadable
sub property of: downloadable
domain: Product Variation Input
range: boolean

downloads
type: Property
comment: List of downloadable files
alternate name: downloads
sub property of: downloads
domain: Product Variation Input
range: Product Download

download limit
type: Property
comment: Download limit
alternate name: download_limit
sub property of: download limit
domain: Product Variation Input
range: int

download expiry
type: Property
comment: Download expiry in days
alternate name: download_expiry
sub property of: download expiry
domain: Product Variation Input
range: int

tax status
type: Property
comment: Tax status
alternate name: tax_status
sub property of: tax status
domain: Product Variation Input
range: string
code list: TaxStatus

tax class
type: Property
comment: Tax class
alternate name: tax_class
sub property of: tax class
domain: Product Variation Input
range: string

manage stock
type: Property
comment: Stock management setting
alternate name: manage_stock
sub property of: manage stock
domain: Product Variation Input
code list: manageStock
type changed from: boolean
type changed in version: v10 1 3

stock quantity
type: Property
comment: Stock quantity
alternate name: stock_quantity
sub property of: stock quantity
domain: Product Variation Input
range: long

stock status
type: Property
comment: Stock status
alternate name: stock_status
sub property of: stock status
domain: Product Variation Input
range: string
code list: StockStatus

backorders
type: Property
comment: Backorder status
alternate name: backorders
sub property of: backorders
domain: Product Variation Input
range: string
code list: BackorderStatus

weight
type: Property
comment: Variation weight
alternate name: weight
sub property of: weight
domain: Product Variation Input
range: string

dimensions
type: Property
comment: Variation dimensions
alternate name: dimensions
sub property of: dimensions
domain: Product Variation Input
range: Product Dimensions

shipping class
type: Property
comment: Shipping class slug
alternate name: shipping_class
sub property of: shipping class
domain: Product Variation Input
range: string

image
type: Property
comment: Variation image
alternate name: image
domain: Product Variation Input
range: Product Image

attributes
type: Property
comment: List of variation attributes
alternate name: attributes
domain: Product Variation Input
range: Default Attribute

menu order
type: Property
comment: Menu order
alternate name: menu_order
sub property of: menu order
domain: Product Variation Input
range: int

meta data
type: Property
comment: Meta data
alternate name: meta_data
sub property of: meta data
domain: Product Variation Input
range: Product Metadata

id
type: Property
comment: Unique identifier
alternate name: id
domain: Product Attribute Taxonomy
range: long

name
type: Property
comment: Attribute name
alternate name: name
sub property of: name
domain: Product Attribute Taxonomy
range: string

slug
type: Property
comment: Attribute slug
alternate name: slug
sub property of: slug
sub property of: identifier
domain: Product Attribute Taxonomy
range: string

type
type: Property
comment: Attribute type
alternate name: type
sub property of: type
domain: Product Attribute Taxonomy
range: string

order by
type: Property
comment: Default sort order. Options: menu_order, name, name_num and id. Default is menu_order.
alternate name: order_by
sub property of: order by
domain: Product Attribute Taxonomy
range: string
code list: AttributeOrderBy

has archives
type: Property
comment: Whether attribute has archives
alternate name: has_archives
sub property of: has archives
domain: Product Attribute Taxonomy
range: boolean

links
type: Property
comment: HAL links
alternate name: _links
domain: Product Attribute Taxonomy
range: Links

id
type: Property
comment: Unique identifier
alternate name: id
domain: Product Attribute Term
range: long

name
type: Property
comment: Term name
alternate name: name
sub property of: name
domain: Product Attribute Term
range: string

slug
type: Property
comment: Term slug
alternate name: slug
sub property of: slug
sub property of: identifier
domain: Product Attribute Term
range: string

description
type: Property
comment: Term description
alternate name: description
sub property of: description
domain: Product Attribute Term
range: string

menu order
type: Property
comment: Menu order
alternate name: menu_order
sub property of: menu order
domain: Product Attribute Term
range: int

count
type: Property
comment: Number of products with this term
alternate name: count
sub property of: count
domain: Product Attribute Term
range: int

links
type: Property
comment: HAL links
alternate name: _links
domain: Product Attribute Term
range: Links

id
type: Property
comment: Line item ID
alternate name: id
domain: Order Line Item
range: long

name
type: Property
comment: Product name
alternate name: name
sub property of: name
domain: Order Line Item
range: string

product
type: Property
comment: Product
alternate name: product_id
sub property of: product
domain: Order Line Item
range: Product

variation
type: Property
comment: Variation (0 if not a variation)
alternate name: variation_id
domain: Order Line Item
range: Product Variation

quantity
type: Property
comment: Quantity ordered
alternate name: quantity
sub property of: quantity
sub property of: orderQuantity
domain: Order Line Item
range: int

tax class
type: Property
comment: Tax class
alternate name: tax_class
sub property of: tax class
domain: Order Line Item
range: string

subtotal
type: Property
comment: Line subtotal (before discounts)
alternate name: subtotal
sub property of: subtotal
domain: Order Line Item
range: string

subtotal tax
type: Property
comment: Line subtotal tax
alternate name: subtotal_tax
sub property of: subtotal tax
domain: Order Line Item
range: string

total
type: Property
comment: Line total (after discounts)
alternate name: total
sub property of: total
sub property of: price
domain: Order Line Item
range: string

total tax
type: Property
comment: Line total tax
alternate name: total_tax
sub property of: total tax
domain: Order Line Item
range: string

taxes
type: Property
comment: Line taxes
alternate name: taxes
sub property of: taxes
domain: Order Line Item
range: Order Item Tax

metadata
type: Property
comment: Meta data
alternate name: meta_data
sub property of: metadata
domain: Order Line Item
range: Metadata

sku
type: Property
comment: Product SKU
alternate name: sku
sub property of: sku
domain: Order Line Item
range: string

price
type: Property
comment: Product price
alternate name: price
sub property of: price
domain: Order Line Item
range: string

image
type: Property
comment: Product image
alternate name: image
domain: Order Line Item
range: Image
added in version: v6 6 1

parent name
type: Property
comment: Parent product name if the product is a variation
alternate name: parent_name
sub property of: parent name
domain: Order Line Item
range: string
added in version: v4 7 4

global unique id
type: Property
comment: GTIN, UPC, EAN, or ISBN - global product identifier
alternate name: global_unique_id
sub property of: global unique id
domain: Order Line Item
range: string
added in version: v10 1 0

tax rate identifier
type: Property
comment: Tax rate ID
alternate name: id
sub property of: tax rate identifier
domain: Order Item Tax
range: long

total
type: Property
comment: Tax total
alternate name: total
sub property of: total
sub property of: price
domain: Order Item Tax
range: string

subtotal
type: Property
comment: Tax subtotal
alternate name: subtotal
sub property of: subtotal
domain: Order Item Tax
range: string

item identifier
type: Property
comment: Line item ID (for updates)
alternate name: id
sub property of: item identifier
domain: Order Line Item Input
range: long

product
type: Property
comment: Product
alternate name: product_id
sub property of: product
domain: Order Line Item Input
range: Product

variation
type: Property
comment: Variation
alternate name: variation_id
domain: Order Line Item Input
range: Product Variation

quantity
type: Property
comment: Quantity
alternate name: quantity
sub property of: quantity
domain: Order Line Item Input
range: int

tax class
type: Property
comment: Tax class
alternate name: tax_class
sub property of: tax class
domain: Order Line Item Input
range: string

subtotal
type: Property
comment: Line subtotal
alternate name: subtotal
sub property of: subtotal
domain: Order Line Item Input
range: string

total
type: Property
comment: Line total
alternate name: total
sub property of: total
domain: Order Line Item Input
range: string

metadata
type: Property
comment: Meta data
alternate name: meta_data
sub property of: metadata
domain: Order Line Item Input
range: Metadata

id
type: Property
comment: Shipping line ID
alternate name: id
domain: Shipping Line
range: long

method title
type: Property
comment: Shipping method title
alternate name: method_title
sub property of: method title
sub property of: name
domain: Shipping Line
range: string

method id
type: Property
comment: Shipping method ID
alternate name: method_id
sub property of: method id
domain: Shipping Line
range: string

instance id
type: Property
comment: Shipping instance ID
alternate name: instance_id
sub property of: instance id
domain: Shipping Line
range: string

total
type: Property
comment: Shipping total
alternate name: total
sub property of: total
sub property of: price
domain: Shipping Line
range: string

total tax
type: Property
comment: Shipping total tax
alternate name: total_tax
sub property of: total tax
domain: Shipping Line
range: string

taxes
type: Property
comment: Shipping taxes
alternate name: taxes
sub property of: taxes
domain: Shipping Line
range: Order Item Tax

metadata
type: Property
comment: Meta data
alternate name: meta_data
sub property of: metadata
domain: Shipping Line
range: Metadata

item identifier
type: Property
comment: Shipping line ID (for updates)
alternate name: id
sub property of: item identifier
domain: Shipping Line Input
range: long

method title
type: Property
comment: Shipping method title
alternate name: method_title
sub property of: method title
domain: Shipping Line Input
range: string

method id
type: Property
comment: Shipping method ID
alternate name: method_id
sub property of: method id
domain: Shipping Line Input
range: string

total
type: Property
comment: Shipping total
alternate name: total
sub property of: total
domain: Shipping Line Input
range: string

metadata
type: Property
comment: Meta data
alternate name: meta_data
sub property of: metadata
domain: Shipping Line Input
range: Metadata

id
type: Property
comment: Tax line ID
alternate name: id
domain: Tax Line
range: long

rate code
type: Property
comment: Tax rate code
alternate name: rate_code
sub property of: rate code
domain: Tax Line
range: string

rate
type: Property
comment: Tax rate
alternate name: rate_id
domain: Tax Line
range: Tax Rate

label
type: Property
comment: Tax rate label
alternate name: label
sub property of: label
sub property of: name
domain: Tax Line
range: string

compound
type: Property
comment: Whether compound tax
alternate name: compound
sub property of: compound
domain: Tax Line
range: boolean

tax total
type: Property
comment: Tax total
alternate name: tax_total
sub property of: tax total
sub property of: price
domain: Tax Line
range: string

shipping tax total
type: Property
comment: Shipping tax total
alternate name: shipping_tax_total
sub property of: shipping tax total
domain: Tax Line
range: string

rate percent
type: Property
comment: Tax rate percentage
alternate name: rate_percent
sub property of: rate percent
domain: Tax Line
range: double

metadata
type: Property
comment: Metadata
alternate name: meta_data
sub property of: metadata
domain: Tax Line
range: Metadata

id
type: Property
comment: Unique identifier for the resource
alternate name: id
domain: Tax Rate
range: long

country
type: Property
comment: Country ISO 3166 code
alternate name: country
sub property of: country
sub property of: addressCountry
domain: Tax Rate
range: string

state
type: Property
comment: State code
alternate name: state
sub property of: state
sub property of: addressRegion
domain: Tax Rate
range: string

postcode
type: Property
comment: Postcode/ZIP. Deprecated: use postcodes instead
alternate name: postcode
sub property of: postcode
sub property of: postalCode
domain: Tax Rate
range: string
deprecated: true

city
type: Property
comment: City name. Deprecated: use cities instead
alternate name: city
sub property of: city
sub property of: addressLocality
domain: Tax Rate
range: string
deprecated: true

postcodes
type: Property
comment: Postcodes/ZIPs
alternate name: postcodes
sub property of: postcodes
domain: Tax Rate
range: string
added in version: v5 3 3

cities
type: Property
comment: City names
alternate name: cities
sub property of: cities
domain: Tax Rate
range: string
added in version: v5 3 3

rate
type: Property
comment: Tax rate
alternate name: rate
domain: Tax Rate
range: string

name
type: Property
comment: Tax rate name
alternate name: name
sub property of: name
domain: Tax Rate
range: string

priority
type: Property
comment: Tax priority. Only 1 matching rate per priority will be used. Default is 1.
alternate name: priority
sub property of: priority
domain: Tax Rate
range: int

compound
type: Property
comment: Whether this is a compound tax rate. Compound rates are applied on top of other tax rates. Default is false.
alternate name: compound
sub property of: compound
domain: Tax Rate
range: boolean

shipping
type: Property
comment: Whether this tax rate also gets applied to shipping. Default is true.
alternate name: shipping
domain: Tax Rate
range: boolean

order
type: Property
comment: Indicates the order that will appear in queries
alternate name: order
sub property of: position
domain: Tax Rate
range: int

tax class
type: Property
comment: Tax class. Default is 'standard'.
alternate name: class
sub property of: tax class
domain: Tax Rate
range: string

links
type: Property
comment: HAL links
alternate name: _links
domain: Tax Rate
range: Links

id
type: Property
comment: Fee line ID
alternate name: id
domain: Fee Line
range: long

name
type: Property
comment: Fee name
alternate name: name
sub property of: name
domain: Fee Line
range: string

tax class
type: Property
comment: Tax class
alternate name: tax_class
sub property of: tax class
domain: Fee Line
range: string

tax status
type: Property
comment: Tax status
alternate name: tax_status
sub property of: tax status
domain: Fee Line
range: string
code list: TaxStatus

amount
type: Property
comment: Fee amount
alternate name: amount
sub property of: amount
domain: Fee Line
range: string

total
type: Property
comment: Fee total
alternate name: total
sub property of: total
sub property of: price
domain: Fee Line
range: string

total tax
type: Property
comment: Fee total tax
alternate name: total_tax
sub property of: total tax
domain: Fee Line
range: string

taxes
type: Property
comment: Fee taxes
alternate name: taxes
sub property of: taxes
domain: Fee Line
range: Order Item Tax

metadata
type: Property
comment: Meta data
alternate name: meta_data
sub property of: metadata
domain: Fee Line
range: Metadata

item identifier
type: Property
comment: Fee line ID (for updates)
alternate name: id
sub property of: item identifier
domain: Fee Line Input
range: long

name
type: Property
comment: Fee name
alternate name: name
sub property of: name
domain: Fee Line Input
range: string

tax class
type: Property
comment: Tax class
alternate name: tax_class
sub property of: tax class
domain: Fee Line Input
range: string

tax status
type: Property
comment: Tax status
alternate name: tax_status
sub property of: tax status
domain: Fee Line Input
range: string
code list: TaxStatus

total
type: Property
comment: Fee total
alternate name: total
sub property of: total
domain: Fee Line Input
range: string

metadata
type: Property
comment: Meta data
alternate name: meta_data
sub property of: metadata
domain: Fee Line Input
range: Metadata

id
type: Property
comment: Coupon line ID
alternate name: id
domain: Coupon Line
range: long

code
type: Property
comment: Coupon code
alternate name: code
sub property of: code
sub property of: name
domain: Coupon Line
range: string

discount
type: Property
comment: Discount amount
alternate name: discount
sub property of: discount
domain: Coupon Line
range: string

discount tax
type: Property
comment: Discount tax amount
alternate name: discount_tax
sub property of: discount tax
domain: Coupon Line
range: string

discount type
type: Property
comment: Type of discount (percent, fixed_cart, etc.)
alternate name: discount_type
sub property of: discount type
domain: Coupon Line
range: string
added in version: v8 7 2

free shipping
type: Property
comment: Whether coupon grants free shipping
alternate name: free_shipping
sub property of: free shipping
domain: Coupon Line
range: boolean
added in version: v8 7 2

nominal amount
type: Property
comment: Original coupon value before calculation (e.g., 10 for 10% off or $10 off)
alternate name: nominal_amount
sub property of: nominal amount
domain: Coupon Line
range: double
added in version: v8 7 2

metadata
type: Property
comment: Meta data
alternate name: meta_data
sub property of: metadata
domain: Coupon Line
range: Metadata

item identifier
type: Property
comment: Coupon line ID (for updates)
alternate name: id
sub property of: item identifier
domain: Coupon Line Input
range: long

code
type: Property
comment: Coupon code
alternate name: code
sub property of: code
domain: Coupon Line Input
range: string

metadata
type: Property
comment: Meta data
alternate name: meta_data
sub property of: metadata
domain: Coupon Line Input
range: Metadata

id
type: Property
comment: Refund ID
alternate name: id
domain: Order Refund Line
range: long

reason
type: Property
comment: Refund reason
alternate name: reason
sub property of: reason
sub property of: description
domain: Order Refund Line
range: string

total
type: Property
comment: Refund total
alternate name: total
sub property of: total
sub property of: value
domain: Order Refund Line
range: string

id
type: Property
comment: Refund ID
alternate name: id
domain: Refund
range: long

parent
type: Property
comment: The order the refund is associated with. Only present in standalone refunds endpoint.
alternate name: parent_id
sub property of: parent order
domain: Refund
range: Order

date created
type: Property
comment: The date the refund was created, in the site's timezone
alternate name: date_created
sub property of: date created
sub property of: orderDate
domain: Refund
range: dateTime

date created gmt
type: Property
comment: The date the refund was created, as GMT
alternate name: date_created_gmt
sub property of: date created gmt
domain: Refund
range: dateTime

amount
type: Property
comment: Total refund amount. If provided, takes precedence over line item totals.
alternate name: amount
sub property of: amount
sub property of: totalPrice
domain: Refund
range: string

reason
type: Property
comment: Refund reason
alternate name: reason
sub property of: reason
sub property of: description
domain: Refund
range: string

refunded by
type: Property
comment: User ID who performed the refund
alternate name: refunded_by
sub property of: refunded by
sub property of: agent
domain: Refund
range: Customer

refunded payment
type: Property
comment: Whether the payment was refunded via the API. See api_refund.
alternate name: refunded_payment
sub property of: refunded payment
domain: Refund
range: boolean

metadata
type: Property
comment: Meta data
alternate name: meta_data
sub property of: metadata
domain: Refund
range: Metadata

line items
type: Property
comment: Refund line items
alternate name: line_items
domain: Refund
range: Order Line Item

tax lines
type: Property
comment: Tax lines data
alternate name: tax_lines
sub property of: tax lines
domain: Refund
range: Tax Line

shipping lines
type: Property
comment: Shipping lines data
alternate name: shipping_lines
domain: Refund
range: Shipping Line
added in version: v9 0 3

fee lines
type: Property
comment: Fee lines data
alternate name: fee_lines
domain: Refund
range: Fee Line
added in version: v9 0 3

links
type: Property
comment: HAL links
alternate name: _links
domain: Refund
range: Links

id
type: Property
comment: Unique identifier
alternate name: id
domain: Order
range: long

parent
type: Property
comment: Parent order (for order parts)
alternate name: parent_id
domain: Order
range: Order

number
type: Property
comment: Order number (may differ from ID)
alternate name: number
sub property of: number
sub property of: orderNumber
domain: Order
range: string

order key
type: Property
comment: Order key (for guest checkout links)
alternate name: order_key
sub property of: order key
domain: Order
range: string

created via
type: Property
comment: Shows where the order was created. Can only be set during creation.
alternate name: created_via
sub property of: created via
domain: Order
range: string

version
type: Property
comment: Version of WooCommerce which last updated the order
alternate name: version
sub property of: version
domain: Order
range: string

status
type: Property
comment: Order status
alternate name: status
domain: Order
range: string
code list: OrderStatus

currency
type: Property
comment: Currency code (ISO 4217)
alternate name: currency
sub property of: currency
sub property of: priceCurrency
domain: Order
range: string

currency symbol
type: Property
comment: Currency symbol
alternate name: currency_symbol
sub property of: currency symbol
domain: Order
range: string

date created
type: Property
comment: The date the order was created, in the site's timezone
alternate name: date_created
sub property of: date created
sub property of: orderDate
domain: Order
range: dateTime

date created gmt
type: Property
comment: The date the order was created, as GMT
alternate name: date_created_gmt
sub property of: date created gmt
domain: Order
range: dateTime

date modified
type: Property
comment: The date the order was last modified, in the site's timezone
alternate name: date_modified
sub property of: date modified
sub property of: dateModified
domain: Order
range: dateTime

date modified gmt
type: Property
comment: The date the order was last modified, as GMT
alternate name: date_modified_gmt
sub property of: date modified gmt
domain: Order
range: dateTime

discount total
type: Property
comment: Total discount amount
alternate name: discount_total
sub property of: discount total
domain: Order
range: string

discount tax
type: Property
comment: Total discount tax
alternate name: discount_tax
sub property of: discount tax
domain: Order
range: string

shipping total
type: Property
comment: Total shipping amount
alternate name: shipping_total
sub property of: shipping total
domain: Order
range: string

shipping tax
type: Property
comment: Total shipping tax
alternate name: shipping_tax
sub property of: shipping tax
domain: Order
range: string

cart tax
type: Property
comment: Sum of line item taxes only
alternate name: cart_tax
sub property of: cart tax
domain: Order
range: string

total
type: Property
comment: Grand total
alternate name: total
sub property of: total
sub property of: totalPrice
domain: Order
range: string

total tax
type: Property
comment: Sum of all taxes
alternate name: total_tax
sub property of: total tax
domain: Order
range: string

prices include tax
type: Property
comment: True if prices included tax during checkout
alternate name: prices_include_tax
sub property of: prices include tax
domain: Order
range: boolean

customer
type: Property
comment: Customer who owns the order. 0 for guests.
alternate name: customer_id
sub property of: customer
domain: Order
range: Customer

customer ip address
type: Property
comment: Customer's IP address
alternate name: customer_ip_address
sub property of: customer ip address
domain: Order
range: string

customer user agent
type: Property
comment: User agent of the customer
alternate name: customer_user_agent
sub property of: customer user agent
domain: Order
range: string

customer note
type: Property
comment: Note left by customer during checkout
alternate name: customer_note
domain: Order
range: string

billing
type: Property
comment: Billing address
alternate name: billing
sub property of: billing
sub property of: billingAddress
domain: Order
range: Billing Address

shipping
type: Property
comment: Shipping address
alternate name: shipping
sub property of: deliveryAddress
domain: Order
range: Shipping Address

payment method
type: Property
comment: Payment method ID
alternate name: payment_method
sub property of: payment method
sub property of: paymentMethod
domain: Order
range: string

payment method title
type: Property
comment: Payment method title
alternate name: payment_method_title
sub property of: payment method title
domain: Order
range: string

transaction id
type: Property
comment: Unique transaction ID
alternate name: transaction_id
sub property of: transaction id
domain: Order
range: string

date paid
type: Property
comment: The date the order was paid, in the site's timezone
alternate name: date_paid
sub property of: date paid
domain: Order
range: dateTime

date paid gmt
type: Property
comment: The date the order was paid, as GMT
alternate name: date_paid_gmt
sub property of: date paid gmt
domain: Order
range: dateTime

date completed
type: Property
comment: The date the order was completed, in the site's timezone
alternate name: date_completed
sub property of: date completed
domain: Order
range: dateTime

date completed gmt
type: Property
comment: The date the order was completed, as GMT
alternate name: date_completed_gmt
sub property of: date completed gmt
domain: Order
range: dateTime

cart hash
type: Property
comment: MD5 hash of cart items to ensure orders are not modified
alternate name: cart_hash
sub property of: cart hash
domain: Order
range: string

line items
type: Property
comment: Line items
alternate name: line_items
sub property of: orderedItem
domain: Order
range: Order Line Item

tax lines
type: Property
comment: Tax lines
alternate name: tax_lines
sub property of: tax lines
domain: Order
range: Tax Line

shipping lines
type: Property
comment: Shipping lines
alternate name: shipping_lines
domain: Order
range: Shipping Line

fee lines
type: Property
comment: Fee lines
alternate name: fee_lines
domain: Order
range: Fee Line

coupon lines
type: Property
comment: Coupon lines
alternate name: coupon_lines
domain: Order
range: Coupon Line

refunds
type: Property
comment: List of refunds
alternate name: refunds
sub property of: refunds
domain: Order
range: Order Refund Line

needs payment
type: Property
comment: Whether order needs payment
alternate name: needs_payment
sub property of: needs payment
domain: Order
range: boolean

needs processing
type: Property
comment: Whether order needs processing
alternate name: needs_processing
sub property of: needs processing
domain: Order
range: boolean

payment url
type: Property
comment: Payment URL
alternate name: payment_url
sub property of: payment url
domain: Order
range: string

is editable
type: Property
comment: Whether order is editable
alternate name: is_editable
sub property of: is editable
domain: Order
range: boolean

metadata
type: Property
comment: Meta data
alternate name: meta_data
sub property of: metadata
domain: Order
range: Metadata

links
type: Property
comment: HAL links
alternate name: _links
domain: Order
range: Links

id
type: Property
comment: Unique identifier for the resource
alternate name: id
domain: Customer
range: long

date created
type: Property
comment: The date the customer was created, in the site's timezone
alternate name: date_created
sub property of: date created
sub property of: dateCreated
domain: Customer
range: dateTime

date created gmt
type: Property
comment: The date the customer was created, as GMT
alternate name: date_created_gmt
sub property of: date created gmt
domain: Customer
range: dateTime

date modified
type: Property
comment: The date the customer was last modified, in the site's timezone
alternate name: date_modified
sub property of: date modified
sub property of: dateModified
domain: Customer
range: dateTime

date modified gmt
type: Property
comment: The date the customer was last modified, as GMT
alternate name: date_modified_gmt
sub property of: date modified gmt
domain: Customer
range: dateTime

email
type: Property
comment: The email address for the customer
alternate name: email
sub property of: email
domain: Customer
range: string

first name
type: Property
comment: Customer first name
alternate name: first_name
sub property of: first name
sub property of: givenName
domain: Customer
range: string

last name
type: Property
comment: Customer last name
alternate name: last_name
sub property of: last name
sub property of: familyName
domain: Customer
range: string

role
type: Property
comment: Customer role
alternate name: role
sub property of: role
domain: Customer
range: string

username
type: Property
comment: Customer login name
alternate name: username
sub property of: username
domain: Customer
range: string

billing
type: Property
comment: List of billing address data
alternate name: billing
sub property of: billing
sub property of: billingAddress
domain: Customer
range: Billing Address

shipping
type: Property
comment: List of shipping address data
alternate name: shipping
sub property of: deliveryAddress
domain: Customer
range: Shipping Address

is paying customer
type: Property
comment: Is the customer a paying customer?
alternate name: is_paying_customer
sub property of: is paying customer
domain: Customer
range: boolean

avatar url
type: Property
comment: Avatar URL
alternate name: avatar_url
sub property of: avatar url
domain: Customer
range: string

metadata
type: Property
comment: Meta data
alternate name: meta_data
sub property of: metadata
domain: Customer
range: Metadata

links
type: Property
comment: HAL links
alternate name: _links
domain: Customer
range: Links

amount
type: Property
comment: Total refund amount. If provided, takes precedence over line item totals.
alternate name: amount
sub property of: amount
domain: Refund Input
range: string

reason
type: Property
comment: Refund reason
alternate name: reason
sub property of: reason
domain: Refund Input
range: string

refunded by
type: Property
comment: User ID who performed the refund
alternate name: refunded_by
sub property of: refunded by
domain: Refund Input
range: Customer

metadata
type: Property
comment: Meta data
alternate name: meta_data
sub property of: metadata
domain: Refund Input
range: Metadata

line items
type: Property
comment: Line items to refund
alternate name: line_items
domain: Refund Input
range: Refund Line Item Input

shipping lines
type: Property
comment: Shipping lines data
alternate name: shipping_lines
domain: Refund Input
range: Shipping Line Input
added in version: v9 0 3

fee lines
type: Property
comment: Fee lines data
alternate name: fee_lines
domain: Refund Input
range: Fee Line Input
added in version: v9 0 3

api refund
type: Property
comment: When true, the payment gateway API is used to generate the refund. Default is true.
alternate name: api_refund
sub property of: api refund
domain: Refund Input
range: boolean

api restock
type: Property
comment: When true, the selected line items are restocked. Default is true.
alternate name: api_restock
sub property of: api restock
domain: Refund Input
range: boolean
added in version: v5 6 2

line item identifier
type: Property
comment: Line item ID
alternate name: id
sub property of: line item identifier
domain: Refund Line Item Input
range: long

quantity
type: Property
comment: Quantity to refund
alternate name: quantity
sub property of: quantity
domain: Refund Line Item Input
range: int

refund total
type: Property
comment: Refund total for this item
alternate name: refund_total
sub property of: refund total
domain: Refund Line Item Input
range: string

refund tax
type: Property
comment: Refund tax totals
alternate name: refund_tax
sub property of: refund tax
domain: Refund Line Item Input
range: Refund Tax Input

tax rate identifier
type: Property
comment: Tax rate ID
alternate name: id
sub property of: tax rate identifier
domain: Refund Tax Input
range: long

refund total
type: Property
comment: Refund amount
alternate name: refund_total
sub property of: refund total
domain: Refund Tax Input
range: string

id
type: Property
comment: Note ID
alternate name: id
domain: Order Note
range: long

author
type: Property
comment: Note author
alternate name: author
sub property of: author
domain: Order Note
range: string

date created
type: Property
comment: The date the note was created, in the site's timezone
alternate name: date_created
sub property of: date created
sub property of: dateCreated
domain: Order Note
range: dateTime

date created gmt
type: Property
comment: The date the note was created, as GMT
alternate name: date_created_gmt
sub property of: date created gmt
domain: Order Note
range: dateTime

note
type: Property
comment: Note content
alternate name: note
sub property of: note
sub property of: text
domain: Order Note
range: string

customer note
type: Property
comment: Whether note is for customer (visible to customer). Default is false.
alternate name: customer_note
domain: Order Note
range: boolean

added by user
type: Property
comment: Whether added by user (not system). Default is false.
alternate name: added_by_user
sub property of: added by user
domain: Order Note
range: boolean

links
type: Property
comment: HAL links
alternate name: _links
domain: Order Note
range: Links

note
type: Property
comment: Note content
alternate name: note
sub property of: note
domain: Order Note Input
range: string

customer note
type: Property
comment: Whether note is for customer
alternate name: customer_note
domain: Order Note Input
range: boolean

added by user
type: Property
comment: Whether added by user (not system)
alternate name: added_by_user
sub property of: added by user
domain: Order Note Input
range: boolean

parent
type: Property
comment: Parent order ID
alternate name: parent_id
domain: Order Input
range: Order

status
type: Property
comment: Order status
alternate name: status
domain: Order Input
range: string
code list: OrderStatus

currency
type: Property
comment: Currency code
alternate name: currency
sub property of: currency
domain: Order Input
range: string

customer
type: Property
comment: Customer ID
alternate name: customer_id
sub property of: customer
domain: Order Input
range: Customer

customer note
type: Property
comment: Customer note
alternate name: customer_note
domain: Order Input
range: string

billing
type: Property
comment: Billing address
alternate name: billing
sub property of: billing
domain: Order Input
range: Billing Address

shipping
type: Property
comment: Shipping address
alternate name: shipping
domain: Order Input
range: Shipping Address

payment method
type: Property
comment: Payment method ID
alternate name: payment_method
sub property of: payment method
domain: Order Input
range: string

payment method title
type: Property
comment: Payment method title
alternate name: payment_method_title
sub property of: payment method title
domain: Order Input
range: string

transaction id
type: Property
comment: Transaction ID
alternate name: transaction_id
sub property of: transaction id
domain: Order Input
range: string

line items
type: Property
comment: Line items
alternate name: line_items
domain: Order Input
range: Order Line Item Input

shipping lines
type: Property
comment: Shipping lines
alternate name: shipping_lines
domain: Order Input
range: Shipping Line Input

fee lines
type: Property
comment: Fee lines
alternate name: fee_lines
domain: Order Input
range: Fee Line Input

coupon lines
type: Property
comment: Coupon lines
alternate name: coupon_lines
domain: Order Input
range: Coupon Line Input

set paid
type: Property
comment: Define if the order is paid. Will set status to processing and reduce stock.
alternate name: set_paid
sub property of: set paid
domain: Order Input
range: boolean

metadata
type: Property
comment: Meta data
alternate name: meta_data
sub property of: metadata
domain: Order Input
range: Metadata

email
type: Property
comment: The email address for the customer
alternate name: email
sub property of: email
domain: Customer Input
range: string

first name
type: Property
comment: Customer first name
alternate name: first_name
sub property of: first name
domain: Customer Input
range: string

last name
type: Property
comment: Customer last name
alternate name: last_name
sub property of: last name
domain: Customer Input
range: string

username
type: Property
comment: Customer login name
alternate name: username
sub property of: username
domain: Customer Input
range: string

password
type: Property
comment: Customer password
alternate name: password
sub property of: password
domain: Customer Input
range: string

billing
type: Property
comment: List of billing address data
alternate name: billing
sub property of: billing
domain: Customer Input
range: Billing Address

shipping
type: Property
comment: List of shipping address data
alternate name: shipping
domain: Customer Input
range: Shipping Address

metadata
type: Property
comment: Meta data
alternate name: meta_data
sub property of: metadata
domain: Customer Input
range: Metadata

download id
type: Property
comment: Download ID (MD5)
alternate name: download_id
sub property of: download id
sub property of: identifier
domain: Customer Download
range: string

download url
type: Property
comment: Download file URL
alternate name: download_url
sub property of: download url
sub property of: contentUrl
domain: Customer Download
range: anyURI

product
type: Property
comment: Downloadable product
alternate name: product_id
sub property of: product id
sub property of: product
domain: Customer Download
range: Product

product name
type: Property
comment: Product name
alternate name: product_name
sub property of: product name
domain: Customer Download
range: string

download name
type: Property
comment: Downloadable file name
alternate name: download_name
sub property of: download name
sub property of: name
domain: Customer Download
range: string

order
type: Property
comment: Order
alternate name: order_id
sub property of: order id
domain: Customer Download
range: Order

order key
type: Property
comment: Order key
alternate name: order_key
sub property of: order key
domain: Customer Download
range: string

downloads remaining
type: Property
comment: Number of downloads remaining
alternate name: downloads_remaining
sub property of: downloads remaining
domain: Customer Download
range: string

access expires
type: Property
comment: The date when download access expires, in the site's timezone. Can be 'never'.
alternate name: access_expires
sub property of: access expires
domain: Customer Download
range: string

access expires gmt
type: Property
comment: The date when download access expires, as GMT. Can be 'never'.
alternate name: access_expires_gmt
sub property of: access expires gmt
domain: Customer Download
range: string

file
type: Property
comment: File details
alternate name: file
sub property of: object
domain: Customer Download
range: Customer Download File

links
type: Property
comment: HAL links
alternate name: _links
domain: Customer Download
range: Links

name
type: Property
comment: File name
alternate name: name
sub property of: name
domain: Customer Download File
range: string

file
type: Property
comment: File URL
alternate name: file
sub property of: contentUrl
domain: Customer Download File
range: anyURI

id
type: Property
comment: Unique identifier
alternate name: id
domain: Product Review
range: long

date created
type: Property
comment: The date the review was created (in the site's timezone)
alternate name: date_created
sub property of: date created
sub property of: dateCreated
domain: Product Review
range: dateTime

date created gmt
type: Property
comment: The date the review was created (GMT)
alternate name: date_created_gmt
sub property of: date created gmt
sub property of: dateCreated
domain: Product Review
range: dateTime

product
type: Property
comment: Product the review belongs to
alternate name: product_id
sub property of: product
sub property of: itemReviewed
domain: Product Review
range: Product

status
type: Property
comment: Status of the review
alternate name: status
sub property of: review status
domain: Product Review
range: string
code list: ReviewStatus

reviewer
type: Property
comment: Reviewer name
alternate name: reviewer
sub property of: reviewer
domain: Product Review
range: string

reviewer email
type: Property
comment: Reviewer email
alternate name: reviewer_email
sub property of: reviewer email
sub property of: email
domain: Product Review
range: string

review
type: Property
comment: Review content
alternate name: review
sub property of: review
sub property of: reviewBody
domain: Product Review
range: string

rating
type: Property
comment: Review rating (0 to 5)
alternate name: rating
sub property of: rating
domain: Product Review
range: int

verified
type: Property
comment: Whether reviewer purchased the product
alternate name: verified
sub property of: verified
domain: Product Review
range: boolean

reviewer avatar urls
type: Property
comment: Avatar URLs for the reviewer
alternate name: reviewer_avatar_urls
sub property of: reviewer avatar urls
domain: Product Review
range: Reviewer Avatar Urls Record

links
type: Property
comment: HAL links
alternate name: _links
domain: Product Review
range: Links

product
type: Property
comment: Product the review belongs to
alternate name: product_id
sub property of: product
sub property of: itemReviewed
domain: Product Review Input
range: Product

status
type: Property
comment: Status of the review
alternate name: status
sub property of: review status
domain: Product Review Input
range: string
code list: ReviewStatus

reviewer
type: Property
comment: Reviewer name
alternate name: reviewer
sub property of: reviewer
domain: Product Review Input
range: string

reviewer email
type: Property
comment: Reviewer email
alternate name: reviewer_email
sub property of: reviewer email
sub property of: email
domain: Product Review Input
range: string

review
type: Property
comment: Review content
alternate name: review
sub property of: review
sub property of: reviewBody
domain: Product Review Input
range: string

rating
type: Property
comment: Review rating (0 to 5)
alternate name: rating
sub property of: rating
domain: Product Review Input
range: int

name
type: Property
comment: Shipping class name
alternate name: name
sub property of: name
domain: Product Shipping Class Input
range: string

slug
type: Property
comment: An alphanumeric identifier for the shipping class (slug)
alternate name: slug
sub property of: slug
domain: Product Shipping Class Input
range: string

description
type: Property
comment: Shipping class description
alternate name: description
sub property of: description
domain: Product Shipping Class Input
range: string

slug
type: Property
comment: Report slug/identifier
alternate name: slug
sub property of: slug
sub property of: identifier
domain: Report
range: string

description
type: Property
comment: Report description
alternate name: description
sub property of: description
domain: Report
range: string

links
type: Property
comment: HAL links
alternate name: _links
domain: Report
range: Links

total sales
type: Property
comment: Gross sales in the period
alternate name: total_sales
domain: Sales Report
range: string

net sales
type: Property
comment: Net sales in the period
alternate name: net_sales
sub property of: net sales
domain: Sales Report
range: string

average sales
type: Property
comment: Average net daily sales
alternate name: average_sales
sub property of: average sales
domain: Sales Report
range: string

total orders
type: Property
comment: Total number of orders placed
alternate name: total_orders
sub property of: total orders
domain: Sales Report
range: int

total items
type: Property
comment: Total number of items purchased
alternate name: total_items
sub property of: total items
domain: Sales Report
range: int

total tax
type: Property
comment: Total charged for taxes
alternate name: total_tax
sub property of: total tax
domain: Sales Report
range: string

total shipping
type: Property
comment: Total charged for shipping
alternate name: total_shipping
sub property of: total shipping
domain: Sales Report
range: string

total refunds
type: Property
comment: Total of refunded orders
alternate name: total_refunds
sub property of: total refunds
domain: Sales Report
range: int

total discount
type: Property
comment: Total of coupons used
alternate name: total_discount
sub property of: total discount
domain: Sales Report
range: int

totals grouped by
type: Property
comment: Group type (day, month, etc.)
alternate name: totals_grouped_by
sub property of: totals grouped by
domain: Sales Report
range: string

totals
type: Property
comment: Totals breakdown by date
alternate name: totals
sub property of: totals
domain: Sales Report
range: Totals Record

total customers
type: Property
comment: Total number of customers
alternate name: total_customers
sub property of: total customers
domain: Sales Report
range: int

links
type: Property
comment: HAL links
alternate name: _links
domain: Sales Report
range: Links

sales
type: Property
comment: Sales amount
alternate name: sales
sub property of: sales
domain: Sales Report Period
range: string

orders
type: Property
comment: Number of orders
alternate name: orders
sub property of: orders
domain: Sales Report Period
range: int

items
type: Property
comment: Number of items
alternate name: items
sub property of: items
domain: Sales Report Period
range: int

tax
type: Property
comment: Tax amount
alternate name: tax
sub property of: tax
domain: Sales Report Period
range: string

shipping
type: Property
comment: Shipping amount
alternate name: shipping
domain: Sales Report Period
range: string

discount
type: Property
comment: Discount amount
alternate name: discount
sub property of: discount
domain: Sales Report Period
range: string

customers
type: Property
comment: Number of customers
alternate name: customers
sub property of: customers
domain: Sales Report Period
range: int

title
type: Property
comment: Product title
alternate name: title
sub property of: title
sub property of: name
domain: Top Sellers Report Item
range: string

product
type: Property
comment: Product
alternate name: product_id
sub property of: product
domain: Top Sellers Report Item
range: Product

quantity
type: Property
comment: Total number of purchases
alternate name: quantity
sub property of: quantity
sub property of: orderQuantity
domain: Top Sellers Report Item
range: int

links
type: Property
comment: HAL links
alternate name: _links
domain: Top Sellers Report Item
range: Links

slug
type: Property
comment: An alphanumeric identifier for the resource
alternate name: slug
sub property of: slug
sub property of: identifier
domain: Report Totals Item
range: string

name
type: Property
comment: Item type name
alternate name: name
sub property of: name
domain: Report Totals Item
range: string

total
type: Property
comment: Total count
alternate name: total
sub property of: total
domain: Report Totals Item
range: string

id
type: Property
comment: Unique identifier for the object
alternate name: id
domain: Coupon
range: long

code
type: Property
comment: Coupon code
alternate name: code
sub property of: code
sub property of: identifier
domain: Coupon
range: string

amount
type: Property
comment: The amount of discount. Should always be numeric, even if setting a percentage.
alternate name: amount
sub property of: amount
sub property of: price
domain: Coupon
range: string

date created
type: Property
comment: The date the coupon was created, in the site's timezone
alternate name: date_created
sub property of: date created
sub property of: dateCreated
domain: Coupon
range: dateTime

date created gmt
type: Property
comment: The date the coupon was created, as GMT
alternate name: date_created_gmt
sub property of: date created gmt
domain: Coupon
range: dateTime

date modified
type: Property
comment: The date the coupon was last modified, in the site's timezone
alternate name: date_modified
sub property of: date modified
sub property of: dateModified
domain: Coupon
range: dateTime

date modified gmt
type: Property
comment: The date the coupon was last modified, as GMT
alternate name: date_modified_gmt
sub property of: date modified gmt
domain: Coupon
range: dateTime

discount type
type: Property
comment: Determines the type of discount that will be applied
alternate name: discount_type
sub property of: discount type
domain: Coupon
range: string
code list: DiscountType

description
type: Property
comment: Coupon description
alternate name: description
sub property of: description
domain: Coupon
range: string

status
type: Property
comment: Coupon publication status
alternate name: status
domain: Coupon
range: string
added in version: v6 2 0

date expires
type: Property
comment: The date the coupon expires, in the site's timezone
alternate name: date_expires
sub property of: date expires
sub property of: validThrough
domain: Coupon
range: dateTime

date expires gmt
type: Property
comment: The date the coupon expires, as GMT
alternate name: date_expires_gmt
sub property of: date expires gmt
domain: Coupon
range: dateTime

usage count
type: Property
comment: Number of times the coupon has been used already
alternate name: usage_count
sub property of: usage count
domain: Coupon
range: int

individual use
type: Property
comment: If true, the coupon can only be used individually. Other applied coupons will be removed from the cart.
alternate name: individual_use
sub property of: individual use
domain: Coupon
range: boolean

products
type: Property
comment: List of products the coupon can be used on
alternate name: product_ids
sub property of: products
domain: Coupon
range: Product

excluded products
type: Property
comment: List of products the coupon cannot be used on
alternate name: excluded_product_ids
sub property of: excluded products
domain: Coupon
range: Product

usage limit
type: Property
comment: How many times the coupon can be used in total
alternate name: usage_limit
sub property of: usage limit
domain: Coupon
range: int

usage limit per user
type: Property
comment: How many times the coupon can be used per customer
alternate name: usage_limit_per_user
sub property of: usage limit per user
domain: Coupon
range: int

limit usage to xitems
type: Property
comment: Max number of items in the cart the coupon can be applied to
alternate name: limit_usage_to_x_items
sub property of: limit usage to xitems
domain: Coupon
range: int

free shipping
type: Property
comment: If true and if the free shipping method requires a coupon, this coupon will enable free shipping
alternate name: free_shipping
sub property of: free shipping
domain: Coupon
range: boolean

product categories
type: Property
comment: List of category IDs the coupon applies to
alternate name: product_categories
sub property of: product categories
domain: Coupon
range: Product Category

excluded product categories
type: Property
comment: List of category IDs the coupon does not apply to
alternate name: excluded_product_categories
sub property of: excluded product categories
domain: Coupon
range: Product Category

exclude sale items
type: Property
comment: If true, this coupon will not be applied to items that have sale prices
alternate name: exclude_sale_items
sub property of: exclude sale items
domain: Coupon
range: boolean

minimum amount
type: Property
comment: Minimum order amount that needs to be in the cart before coupon applies
alternate name: minimum_amount
sub property of: minimum amount
domain: Coupon
range: string

maximum amount
type: Property
comment: Maximum order amount allowed when using the coupon
alternate name: maximum_amount
sub property of: maximum amount
domain: Coupon
range: string

email restrictions
type: Property
comment: List of email addresses that can use this coupon
alternate name: email_restrictions
sub property of: email restrictions
domain: Coupon
range: string

used by
type: Property
comment: List of user IDs (or guest email addresses) that have used the coupon
alternate name: used_by
sub property of: used by
domain: Coupon
range: string

metadata
type: Property
comment: Meta data
alternate name: meta_data
sub property of: metadata
domain: Coupon
range: Metadata

links
type: Property
comment: HAL links
alternate name: _links
domain: Coupon
range: Links

code
type: Property
comment: Coupon code
alternate name: code
sub property of: code
domain: Coupon Input
range: string

amount
type: Property
comment: The amount of discount. Should always be numeric, even if setting a percentage.
alternate name: amount
sub property of: amount
domain: Coupon Input
range: string

discount type
type: Property
comment: Determines the type of discount that will be applied
alternate name: discount_type
sub property of: discount type
domain: Coupon Input
range: string
code list: DiscountType

description
type: Property
comment: Coupon description
alternate name: description
sub property of: description
domain: Coupon Input
range: string

status
type: Property
comment: Coupon publication status
alternate name: status
domain: Coupon Input
range: string
added in version: v6 2 0

date expires
type: Property
comment: The date the coupon expires, in the site's timezone
alternate name: date_expires
sub property of: date expires
domain: Coupon Input
range: dateTime

date expires gmt
type: Property
comment: The date the coupon expires, as GMT
alternate name: date_expires_gmt
sub property of: date expires gmt
domain: Coupon Input
range: dateTime

individual use
type: Property
comment: If true, the coupon can only be used individually
alternate name: individual_use
sub property of: individual use
domain: Coupon Input
range: boolean

products
type: Property
comment: List of products the coupon can be used on
alternate name: product_ids
sub property of: products
domain: Coupon Input
range: Product

excluded products
type: Property
comment: List of products the coupon cannot be used on
alternate name: excluded_product_ids
sub property of: excluded products
domain: Coupon Input
range: Product

usage limit
type: Property
comment: How many times the coupon can be used in total
alternate name: usage_limit
sub property of: usage limit
domain: Coupon Input
range: int

usage limit per user
type: Property
comment: How many times the coupon can be used per customer
alternate name: usage_limit_per_user
sub property of: usage limit per user
domain: Coupon Input
range: int

limit usage to xitems
type: Property
comment: Max number of items in the cart the coupon can be applied to
alternate name: limit_usage_to_x_items
sub property of: limit usage to xitems
domain: Coupon Input
range: int

free shipping
type: Property
comment: If true, this coupon grants free shipping
alternate name: free_shipping
sub property of: free shipping
domain: Coupon Input
range: boolean

product categories
type: Property
comment: List of category IDs the coupon applies to
alternate name: product_categories
sub property of: product categories
domain: Coupon Input
range: Product Category

excluded product categories
type: Property
comment: List of category IDs the coupon does not apply to
alternate name: excluded_product_categories
sub property of: excluded product categories
domain: Coupon Input
range: Product Category

exclude sale items
type: Property
comment: If true, this coupon will not be applied to items that have sale prices
alternate name: exclude_sale_items
sub property of: exclude sale items
domain: Coupon Input
range: boolean

minimum amount
type: Property
comment: Minimum order amount that needs to be in the cart before coupon applies
alternate name: minimum_amount
sub property of: minimum amount
domain: Coupon Input
range: string

maximum amount
type: Property
comment: Maximum order amount allowed when using the coupon
alternate name: maximum_amount
sub property of: maximum amount
domain: Coupon Input
range: string

email restrictions
type: Property
comment: List of email addresses that can use this coupon
alternate name: email_restrictions
sub property of: email restrictions
domain: Coupon Input
range: string

metadata
type: Property
comment: Meta data
alternate name: meta_data
sub property of: metadata
domain: Coupon Input
range: Metadata

country
type: Property
comment: Country ISO 3166 code
alternate name: country
sub property of: country
sub property of: addressCountry
domain: Tax Rate Input
range: string

state
type: Property
comment: State code
alternate name: state
sub property of: state
sub property of: addressRegion
domain: Tax Rate Input
range: string

postcode
type: Property
comment: Postcode/ZIP. Deprecated: use postcodes instead
alternate name: postcode
sub property of: postcode
sub property of: postalCode
domain: Tax Rate Input
range: string
deprecated: true

city
type: Property
comment: City name. Deprecated: use cities instead
alternate name: city
sub property of: city
sub property of: addressLocality
domain: Tax Rate Input
range: string
deprecated: true

postcodes
type: Property
comment: Postcodes/ZIPs
alternate name: postcodes
sub property of: postcodes
domain: Tax Rate Input
range: string
added in version: v5 3 3

cities
type: Property
comment: City names
alternate name: cities
sub property of: cities
domain: Tax Rate Input
range: string
added in version: v5 3 3

rate
type: Property
comment: Tax rate
alternate name: rate
domain: Tax Rate Input
range: string

name
type: Property
comment: Tax rate name
alternate name: name
sub property of: name
domain: Tax Rate Input
range: string

priority
type: Property
comment: Tax priority. Only 1 matching rate per priority will be used. Default is 1.
alternate name: priority
sub property of: priority
domain: Tax Rate Input
range: int

compound
type: Property
comment: Whether this is a compound tax rate. Compound rates are applied on top of other tax rates. Default is false.
alternate name: compound
sub property of: compound
domain: Tax Rate Input
range: boolean

shipping
type: Property
comment: Whether this tax rate also gets applied to shipping. Default is true.
alternate name: shipping
domain: Tax Rate Input
range: boolean

order
type: Property
comment: Indicates the order that will appear in queries
alternate name: order
sub property of: position
domain: Tax Rate Input
range: int

tax class
type: Property
comment: Tax class. Default is 'standard'.
alternate name: class
sub property of: tax class
domain: Tax Rate Input
range: string

slug
type: Property
comment: Unique identifier for the resource
alternate name: slug
sub property of: slug
sub property of: identifier
domain: Tax Class
range: string

name
type: Property
comment: Tax class name
alternate name: name
sub property of: name
domain: Tax Class
range: string

links
type: Property
comment: HAL links
alternate name: _links
domain: Tax Class
range: Links

name
type: Property
comment: Tax class name
alternate name: name
sub property of: name
domain: Tax Class Input
range: string

id
type: Property
comment: Method ID
alternate name: id
sub property of: identifier
domain: Shipping Method
range: string

title
type: Property
comment: Shipping method title
alternate name: title
sub property of: title
sub property of: name
domain: Shipping Method
range: string

description
type: Property
comment: Shipping method description
alternate name: description
sub property of: description
domain: Shipping Method
range: string

links
type: Property
comment: HAL links
alternate name: _links
domain: Shipping Method
range: Links

id
type: Property
comment: Unique identifier for the resource
alternate name: id
domain: Shipping Zone
range: long

name
type: Property
comment: Shipping zone name
alternate name: name
sub property of: name
domain: Shipping Zone
range: string

order
type: Property
comment: Shipping zone order
alternate name: order
sub property of: position
domain: Shipping Zone
range: int

links
type: Property
comment: HAL links
alternate name: _links
domain: Shipping Zone
range: Links

name
type: Property
comment: Shipping zone name
alternate name: name
sub property of: name
domain: Shipping Zone Input
range: string

order
type: Property
comment: Shipping zone order
alternate name: order
domain: Shipping Zone Input
range: int

code
type: Property
comment: Shipping zone location code
alternate name: code
sub property of: code
sub property of: identifier
domain: Shipping Zone Location
range: string

type
type: Property
comment: Shipping zone location type
alternate name: type
sub property of: location type
sub property of: type
domain: Shipping Zone Location
range: string
code list: ShippingZoneLocationType

links
type: Property
comment: HAL links
alternate name: _links
domain: Shipping Zone Location
range: Links

code
type: Property
comment: Shipping zone location code
alternate name: code
sub property of: code
domain: Shipping Zone Location Input
range: string

type
type: Property
comment: Shipping zone location type
alternate name: type
sub property of: type
domain: Shipping Zone Location Input
range: string
code list: ShippingZoneLocationType

setting identifier
type: Property
comment: A unique identifier for the setting
alternate name: id
sub property of: setting identifier
sub property of: identifier
domain: Shipping Zone Method Setting
range: string

label
type: Property
comment: A human readable label for the setting used in interfaces
alternate name: label
sub property of: label
sub property of: name
domain: Shipping Zone Method Setting
range: string

description
type: Property
comment: A human readable description for the setting used in interfaces
alternate name: description
sub property of: description
domain: Shipping Zone Method Setting
range: string

type
type: Property
comment: Type of setting
alternate name: type
sub property of: type
sub property of: setting type
domain: Shipping Zone Method Setting
range: string
code list: ShippingZoneMethodSettingType

value
type: Property
comment: Setting value
alternate name: value
sub property of: value
domain: Shipping Zone Method Setting
range: string

default
type: Property
comment: Default value for the setting
alternate name: default
sub property of: default
sub property of: defaultValue
domain: Shipping Zone Method Setting
range: string

tip
type: Property
comment: Additional help text shown to the user about the setting
alternate name: tip
sub property of: tip
domain: Shipping Zone Method Setting
range: string

placeholder
type: Property
comment: Placeholder text to be displayed in text inputs
alternate name: placeholder
sub property of: placeholder
domain: Shipping Zone Method Setting
range: string

options
type: Property
comment: Options for select/multiselect types. Keys are option values, values are display labels.
alternate name: options
domain: Shipping Zone Method Setting
range: Options Record

instance
type: Property
comment: Shipping method instance ID
alternate name: instance_id
sub property of: instance
domain: Shipping Zone Method
range: int

title
type: Property
comment: Shipping method customer facing title
alternate name: title
sub property of: title
sub property of: name
domain: Shipping Zone Method
range: string

order
type: Property
comment: Shipping method sort order
alternate name: order
sub property of: position
domain: Shipping Zone Method
range: int

enabled
type: Property
comment: Shipping method enabled status
alternate name: enabled
sub property of: enabled
domain: Shipping Zone Method
range: boolean

method id
type: Property
comment: Shipping method ID
alternate name: method_id
sub property of: method id
domain: Shipping Zone Method
range: string

method title
type: Property
comment: Shipping method title
alternate name: method_title
sub property of: method title
domain: Shipping Zone Method
range: string

method description
type: Property
comment: Shipping method description
alternate name: method_description
sub property of: method description
sub property of: description
domain: Shipping Zone Method
range: string

settings
type: Property
comment: Shipping method settings. Keys are setting IDs.
alternate name: settings
domain: Shipping Zone Method
range: Settings Record

links
type: Property
comment: HAL links
alternate name: _links
domain: Shipping Zone Method
range: Links

method id
type: Property
comment: Shipping method ID (e.g., 'flat_rate', 'free_shipping', 'local_pickup')
alternate name: method_id
sub property of: method id
domain: Shipping Zone Method Create Input
range: string

order
type: Property
comment: Shipping method sort order
alternate name: order
domain: Shipping Zone Method Create Input
range: int

enabled
type: Property
comment: Shipping method enabled status
alternate name: enabled
sub property of: enabled
domain: Shipping Zone Method Create Input
range: boolean

order
type: Property
comment: Shipping method sort order
alternate name: order
domain: Shipping Zone Method Update Input
range: int

enabled
type: Property
comment: Shipping method enabled status
alternate name: enabled
sub property of: enabled
domain: Shipping Zone Method Update Input
range: boolean

settings
type: Property
comment: Settings to update. Keys are setting IDs, values are the new setting values.
alternate name: settings
domain: Shipping Zone Method Update Input
range: Settings Record

href
type: Property
comment: URL to the setting options
alternate name: href
sub property of: href
sub property of: url
domain: Setting Options Link
range: anyURI

options
type: Property
comment: Link to the setting options for this group
alternate name: options
sub property of: options link
domain: Setting Group Links
range: Setting Options Link

id
type: Property
comment: A unique identifier that can be used to link settings together
alternate name: id
sub property of: identifier
domain: Setting Group
range: string

label
type: Property
comment: A human readable label for the setting used in interfaces
alternate name: label
sub property of: label
sub property of: name
domain: Setting Group
range: string

description
type: Property
comment: A human readable description for the setting used in interfaces
alternate name: description
sub property of: description
domain: Setting Group
range: string

parent id
type: Property
comment: ID of parent grouping
alternate name: parent_id
sub property of: parent id
domain: Setting Group
range: string

sub groups
type: Property
comment: IDs for settings sub groups
alternate name: sub_groups
sub property of: sub groups
domain: Setting Group
range: string

links
type: Property
comment: HAL links
alternate name: _links
domain: Setting Group
range: Setting Group Links

id
type: Property
comment: A unique identifier for the setting
alternate name: id
sub property of: identifier
domain: Setting Option
range: string

label
type: Property
comment: A human readable label for the setting used in interfaces
alternate name: label
sub property of: label
sub property of: name
domain: Setting Option
range: string

description
type: Property
comment: A human readable description for the setting used in interfaces
alternate name: description
sub property of: description
domain: Setting Option
range: string

value
type: Property
comment: Setting value. String for most types, array of strings for multiselect.
alternate name: value
sub property of: value
domain: Setting Option
range: string

default
type: Property
comment: Default value for the setting. String for most types, array of strings for multiselect.
alternate name: default
sub property of: default
sub property of: defaultValue
domain: Setting Option
range: string

tip
type: Property
comment: Additional help text shown to the user about the setting
alternate name: tip
sub property of: tip
domain: Setting Option
range: string

placeholder
type: Property
comment: Placeholder text to be displayed in text inputs
alternate name: placeholder
sub property of: placeholder
domain: Setting Option
range: string

type
type: Property
comment: Type of setting control
alternate name: type
sub property of: type
sub property of: setting type
domain: Setting Option
range: string
code list: SettingOptionType

options
type: Property
comment: Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons
alternate name: options
sub property of: select options
domain: Setting Option
range: Options Record

group id
type: Property
comment: An identifier for the group this setting belongs to
alternate name: group_id
sub property of: group id
domain: Setting Option
range: string

links
type: Property
comment: HAL links
alternate name: _links
domain: Setting Option
range: Links

value
type: Property
comment: Setting value to update. String for most types, array of strings for multiselect.
alternate name: value
sub property of: value
domain: Setting Option Input
range: string

setting identifier
type: Property
comment: Setting ID
alternate name: id
sub property of: setting identifier
sub property of: identifier
domain: Setting Option Batch Input
range: string

value
type: Property
comment: Setting value to update. String for most types, array of strings for multiselect.
alternate name: value
sub property of: value
domain: Setting Option Batch Input
range: string

update
type: Property
comment: Settings to update
alternate name: update
domain: Setting Option Batch Request
range: Setting Option Batch Input

update
type: Property
comment: Updated settings
alternate name: update
sub property of: updated items
domain: Setting Option Batch Response
range: Setting Option

setting identifier
type: Property
comment: A unique identifier for the setting
alternate name: id
sub property of: setting identifier
sub property of: identifier
domain: Payment Gateway Setting
range: string

label
type: Property
comment: A human readable label for the setting used in interfaces
alternate name: label
sub property of: label
sub property of: name
domain: Payment Gateway Setting
range: string

description
type: Property
comment: A human readable description for the setting used in interfaces
alternate name: description
sub property of: description
domain: Payment Gateway Setting
range: string

type
type: Property
comment: Type of setting control
alternate name: type
sub property of: type
sub property of: setting type
domain: Payment Gateway Setting
range: string
code list: SettingOptionType

value
type: Property
comment: Setting value
alternate name: value
sub property of: value
domain: Payment Gateway Setting
range: string

default
type: Property
comment: Default value for the setting
alternate name: default
sub property of: default
sub property of: defaultValue
domain: Payment Gateway Setting
range: string

tip
type: Property
comment: Additional help text shown to the user about the setting
alternate name: tip
sub property of: tip
domain: Payment Gateway Setting
range: string

placeholder
type: Property
comment: Placeholder text to be displayed in text inputs
alternate name: placeholder
sub property of: placeholder
domain: Payment Gateway Setting
range: string

options
type: Property
comment: Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons
alternate name: options
domain: Payment Gateway Setting
range: Options Record

id
type: Property
comment: Payment gateway ID
alternate name: id
sub property of: identifier
domain: Payment Gateway
range: string

title
type: Property
comment: Payment gateway title on checkout
alternate name: title
sub property of: title
sub property of: name
domain: Payment Gateway
range: string

description
type: Property
comment: Payment gateway description on checkout
alternate name: description
sub property of: description
domain: Payment Gateway
range: string

order
type: Property
comment: Payment gateway sort order
alternate name: order
sub property of: position
domain: Payment Gateway
range: int

enabled
type: Property
comment: Payment gateway enabled status
alternate name: enabled
sub property of: enabled
domain: Payment Gateway
range: boolean

method title
type: Property
comment: Payment gateway method title
alternate name: method_title
sub property of: method title
domain: Payment Gateway
range: string

method description
type: Property
comment: Payment gateway method description
alternate name: method_description
sub property of: method description
domain: Payment Gateway
range: string

method supports
type: Property
comment: Supported features for this payment gateway
alternate name: method_supports
sub property of: method supports
domain: Payment Gateway
range: string

settings
type: Property
comment: Payment gateway settings, keyed by setting ID
alternate name: settings
domain: Payment Gateway
range: Settings Record

links
type: Property
comment: HAL links
alternate name: _links
domain: Payment Gateway
range: Links

title
type: Property
comment: Payment gateway title on checkout
alternate name: title
sub property of: title
sub property of: name
domain: Payment Gateway Input
range: string

description
type: Property
comment: Payment gateway description on checkout
alternate name: description
sub property of: description
domain: Payment Gateway Input
range: string

order
type: Property
comment: Payment gateway sort order
alternate name: order
sub property of: position
domain: Payment Gateway Input
range: int

enabled
type: Property
comment: Payment gateway enabled status
alternate name: enabled
sub property of: enabled
domain: Payment Gateway Input
range: boolean

settings
type: Property
comment: Settings values to update, keyed by setting ID
alternate name: settings
domain: Payment Gateway Input
range: Settings Record

id
type: Property
comment: Unique identifier for the resource
alternate name: id
domain: Webhook
range: long

name
type: Property
comment: A friendly name for the webhook
alternate name: name
sub property of: name
domain: Webhook
range: string

status
type: Property
comment: Webhook status
alternate name: status
sub property of: webhook status
domain: Webhook
range: string
code list: WebhookStatus

topic
type: Property
comment: Webhook topic (e.g., order.updated)
alternate name: topic
sub property of: topic
domain: Webhook
range: string

resource
type: Property
comment: Webhook resource (derived from topic)
alternate name: resource
sub property of: resource
domain: Webhook
range: string

event
type: Property
comment: Webhook event (derived from topic)
alternate name: event
sub property of: event
domain: Webhook
range: string

hooks
type: Property
comment: WooCommerce action names associated with the webhook
alternate name: hooks
sub property of: hooks
domain: Webhook
range: string

delivery url
type: Property
comment: The URL where the webhook payload is delivered
alternate name: delivery_url
sub property of: delivery url
domain: Webhook
range: string

secret
type: Property
comment: Secret key used to generate a hash of the delivered webhook (HMAC-SHA256)
alternate name: secret
sub property of: secret
domain: Webhook
range: string

date created
type: Property
comment: The date the webhook was created, in the site's timezone
alternate name: date_created
sub property of: date created
sub property of: dateCreated
domain: Webhook
range: dateTime

date created gmt
type: Property
comment: The date the webhook was created, as GMT
alternate name: date_created_gmt
sub property of: date created gmt
domain: Webhook
range: dateTime

date modified
type: Property
comment: The date the webhook was last modified, in the site's timezone
alternate name: date_modified
sub property of: date modified
sub property of: dateModified
domain: Webhook
range: dateTime

date modified gmt
type: Property
comment: The date the webhook was last modified, as GMT
alternate name: date_modified_gmt
sub property of: date modified gmt
domain: Webhook
range: dateTime

links
type: Property
comment: HAL links
alternate name: _links
domain: Webhook
range: Links

name
type: Property
comment: A friendly name for the webhook
alternate name: name
sub property of: name
domain: Webhook Create Input
range: string

status
type: Property
comment: Webhook status
alternate name: status
sub property of: webhook status
domain: Webhook Create Input
range: string
code list: WebhookStatus

topic
type: Property
comment: Webhook topic (e.g., order.updated)
alternate name: topic
sub property of: topic
domain: Webhook Create Input
range: string

delivery url
type: Property
comment: The URL where the webhook payload is delivered
alternate name: delivery_url
sub property of: delivery url
domain: Webhook Create Input
range: string

secret
type: Property
comment: Secret key used to generate a hash of the delivered webhook
alternate name: secret
sub property of: secret
domain: Webhook Create Input
range: string

name
type: Property
comment: A friendly name for the webhook
alternate name: name
sub property of: name
domain: Webhook Update Input
range: string

status
type: Property
comment: Webhook status
alternate name: status
sub property of: webhook status
domain: Webhook Update Input
range: string
code list: WebhookStatus

topic
type: Property
comment: Webhook topic (e.g., order.updated)
alternate name: topic
sub property of: topic
domain: Webhook Update Input
range: string

secret
type: Property
comment: Secret key used to generate a hash of the delivered webhook
alternate name: secret
sub property of: secret
domain: Webhook Update Input
range: string

home url
type: Property
comment: Home URL
alternate name: home_url
sub property of: home url
domain: System Status Environment
range: string

site url
type: Property
comment: Site URL
alternate name: site_url
sub property of: site url
domain: System Status Environment
range: string

version
type: Property
comment: WooCommerce version
alternate name: version
sub property of: version
sub property of: softwareVersion
domain: System Status Environment
range: string

log directory
type: Property
comment: Log directory
alternate name: log_directory
sub property of: log directory
domain: System Status Environment
range: string

log directory writable
type: Property
comment: Is log directory writable?
alternate name: log_directory_writable
sub property of: log directory writable
domain: System Status Environment
range: boolean

wp version
type: Property
comment: WordPress version
alternate name: wp_version
sub property of: wp version
domain: System Status Environment
range: string

wp multisite
type: Property
comment: Is WordPress multisite?
alternate name: wp_multisite
sub property of: wp multisite
domain: System Status Environment
range: boolean

wp memory limit
type: Property
comment: WordPress memory limit
alternate name: wp_memory_limit
sub property of: wp memory limit
domain: System Status Environment
range: long

wp debug mode
type: Property
comment: Is WordPress debug mode active?
alternate name: wp_debug_mode
sub property of: wp debug mode
domain: System Status Environment
range: boolean

wp cron
type: Property
comment: Are WordPress cron jobs enabled?
alternate name: wp_cron
sub property of: wp cron
domain: System Status Environment
range: boolean

wp environment type
type: Property
comment: WordPress environment type
alternate name: wp_environment_type
sub property of: wp environment type
domain: System Status Environment
range: string

language
type: Property
comment: WordPress language
alternate name: language
sub property of: language
sub property of: inLanguage
domain: System Status Environment
range: string

server info
type: Property
comment: Server info
alternate name: server_info
sub property of: server info
domain: System Status Environment
range: string

php version
type: Property
comment: PHP version
alternate name: php_version
sub property of: php version
domain: System Status Environment
range: string

php post max size
type: Property
comment: PHP post max size
alternate name: php_post_max_size
sub property of: php post max size
domain: System Status Environment
range: long

php max execution time
type: Property
comment: PHP max execution time
alternate name: php_max_execution_time
sub property of: php max execution time
domain: System Status Environment
range: int

php max input vars
type: Property
comment: PHP max input vars
alternate name: php_max_input_vars
sub property of: php max input vars
domain: System Status Environment
range: int

curl version
type: Property
comment: cURL version
alternate name: curl_version
sub property of: curl version
domain: System Status Environment
range: string

suhosin installed
type: Property
comment: Is SUHOSIN installed?
alternate name: suhosin_installed
sub property of: suhosin installed
domain: System Status Environment
range: boolean

max upload size
type: Property
comment: Max upload size
alternate name: max_upload_size
sub property of: max upload size
domain: System Status Environment
range: long

mysql version
type: Property
comment: MySQL version
alternate name: mysql_version
sub property of: mysql version
domain: System Status Environment
range: string

default timezone
type: Property
comment: Default timezone
alternate name: default_timezone
sub property of: default timezone
domain: System Status Environment
range: string

fsockopen or curl enabled
type: Property
comment: Is fsockopen/cURL enabled?
alternate name: fsockopen_or_curl_enabled
sub property of: fsockopen or curl enabled
domain: System Status Environment
range: boolean

soapclient enabled
type: Property
comment: Is SoapClient class enabled?
alternate name: soapclient_enabled
sub property of: soapclient enabled
domain: System Status Environment
range: boolean

domdocument enabled
type: Property
comment: Is DomDocument class enabled?
alternate name: domdocument_enabled
sub property of: domdocument enabled
domain: System Status Environment
range: boolean

gzip enabled
type: Property
comment: Is GZip enabled?
alternate name: gzip_enabled
sub property of: gzip enabled
domain: System Status Environment
range: boolean

mbstring enabled
type: Property
comment: Is mbstring enabled?
alternate name: mbstring_enabled
sub property of: mbstring enabled
domain: System Status Environment
range: boolean

remote post successful
type: Property
comment: Remote POST successful?
alternate name: remote_post_successful
sub property of: remote post successful
domain: System Status Environment
range: boolean

remote post response
type: Property
comment: Remote POST response
alternate name: remote_post_response
sub property of: remote post response
domain: System Status Environment
range: string

remote get successful
type: Property
comment: Remote GET successful?
alternate name: remote_get_successful
sub property of: remote get successful
domain: System Status Environment
range: boolean

remote get response
type: Property
comment: Remote GET response
alternate name: remote_get_response
sub property of: remote get response
domain: System Status Environment
range: string

wc database version
type: Property
comment: WooCommerce database version
alternate name: wc_database_version
sub property of: wc database version
sub property of: softwareVersion
domain: System Status Database
range: string

database prefix
type: Property
comment: Database prefix
alternate name: database_prefix
sub property of: database prefix
domain: System Status Database
range: string

maxmind geoip database
type: Property
comment: MaxMind GeoIP database
alternate name: maxmind_geoip_database
sub property of: maxmind geoip database
domain: System Status Database
range: string

database tables
type: Property
comment: Database tables (table name to existence status)
alternate name: database_tables
sub property of: database tables
domain: System Status Database
range: Database Tables Record

plugin
type: Property
comment: Plugin path
alternate name: plugin
sub property of: plugin
domain: System Status Active Plugin
range: string

name
type: Property
comment: Plugin name
alternate name: name
sub property of: name
domain: System Status Active Plugin
range: string

version
type: Property
comment: Plugin version
alternate name: version
sub property of: version
sub property of: softwareVersion
domain: System Status Active Plugin
range: string

version latest
type: Property
comment: Latest version of the plugin
alternate name: version_latest
sub property of: version latest
domain: System Status Active Plugin
range: string

url
type: Property
comment: Plugin URL
alternate name: url
sub property of: url
domain: System Status Active Plugin
range: anyURI

author name
type: Property
comment: Plugin author name
alternate name: author_name
sub property of: author name
domain: System Status Active Plugin
range: string

author url
type: Property
comment: Plugin author URL
alternate name: author_url
sub property of: author url
domain: System Status Active Plugin
range: string

network activated
type: Property
comment: Is the plugin network activated?
alternate name: network_activated
sub property of: network activated
domain: System Status Active Plugin
range: boolean

file
type: Property
comment: Template file path
alternate name: file
sub property of: file path
domain: System Status Theme Override
range: string

version
type: Property
comment: Version of the template
alternate name: version
sub property of: version
sub property of: softwareVersion
domain: System Status Theme Override
range: string

core version
type: Property
comment: Core version of the template
alternate name: core_version
sub property of: core version
domain: System Status Theme Override
range: string

name
type: Property
comment: Theme name
alternate name: name
sub property of: name
domain: System Status Theme
range: string

version
type: Property
comment: Theme version
alternate name: version
sub property of: version
sub property of: softwareVersion
domain: System Status Theme
range: string

version latest
type: Property
comment: Latest version of the theme
alternate name: version_latest
sub property of: version latest
domain: System Status Theme
range: string

author url
type: Property
comment: Theme author URL
alternate name: author_url
sub property of: author url
domain: System Status Theme
range: string

is child theme
type: Property
comment: Is this theme a child theme?
alternate name: is_child_theme
sub property of: is child theme
domain: System Status Theme
range: boolean

has woocommerce support
type: Property
comment: Does the theme declare WooCommerce support?
alternate name: has_woocommerce_support
sub property of: has woocommerce support
domain: System Status Theme
range: boolean

has woocommerce file
type: Property
comment: Does the theme have a woocommerce.php file?
alternate name: has_woocommerce_file
sub property of: has woocommerce file
domain: System Status Theme
range: boolean

has outdated templates
type: Property
comment: Does this theme have outdated templates?
alternate name: has_outdated_templates
sub property of: has outdated templates
domain: System Status Theme
range: boolean

overrides
type: Property
comment: Template overrides
alternate name: overrides
sub property of: overrides
domain: System Status Theme
range: System Status Theme Override

parent name
type: Property
comment: Parent theme name
alternate name: parent_name
sub property of: parent name
domain: System Status Theme
range: string

parent version
type: Property
comment: Parent theme version
alternate name: parent_version
sub property of: parent version
domain: System Status Theme
range: string

parent version latest
type: Property
comment: Latest version of the parent theme
alternate name: parent_version_latest
sub property of: parent version latest
domain: System Status Theme
range: string

parent author url
type: Property
comment: Parent theme author URL
alternate name: parent_author_url
sub property of: parent author url
domain: System Status Theme
range: string

api enabled
type: Property
comment: REST API enabled?
alternate name: api_enabled
sub property of: api enabled
domain: System Status Settings
range: boolean

force ssl
type: Property
comment: SSL forced?
alternate name: force_ssl
sub property of: force ssl
domain: System Status Settings
range: boolean

currency
type: Property
comment: Currency
alternate name: currency
sub property of: currency
domain: System Status Settings
range: string

currency symbol
type: Property
comment: Currency symbol
alternate name: currency_symbol
sub property of: currency symbol
domain: System Status Settings
range: string

currency position
type: Property
comment: Currency position
alternate name: currency_position
sub property of: currency position
domain: System Status Settings
range: string

thousand separator
type: Property
comment: Thousand separator
alternate name: thousand_separator
sub property of: thousand separator
domain: System Status Settings
range: string

decimal separator
type: Property
comment: Decimal separator
alternate name: decimal_separator
sub property of: decimal separator
domain: System Status Settings
range: string

number of decimals
type: Property
comment: Number of decimals
alternate name: number_of_decimals
sub property of: number of decimals
domain: System Status Settings
range: int

geolocation enabled
type: Property
comment: Geolocation enabled?
alternate name: geolocation_enabled
sub property of: geolocation enabled
domain: System Status Settings
range: boolean

taxonomies
type: Property
comment: Taxonomy terms for product/order statuses
alternate name: taxonomies
sub property of: taxonomies
domain: System Status Settings
range: Taxonomies Record

secure connection
type: Property
comment: Is the connection to your store secure?
alternate name: secure_connection
sub property of: secure connection
domain: System Status Security
range: boolean

hide errors
type: Property
comment: Hide errors from visitors?
alternate name: hide_errors
sub property of: hide errors
domain: System Status Security
range: boolean

page name
type: Property
comment: Page name
alternate name: page_name
sub property of: page name
sub property of: name
domain: System Status Page
range: string

page id
type: Property
comment: Page ID
alternate name: page_id
sub property of: page id
sub property of: identifier
domain: System Status Page
range: string

page set
type: Property
comment: Is the page set?
alternate name: page_set
sub property of: page set
domain: System Status Page
range: boolean

page exists
type: Property
comment: Does the page exist?
alternate name: page_exists
sub property of: page exists
domain: System Status Page
range: boolean

page visible
type: Property
comment: Is the page visible?
alternate name: page_visible
sub property of: page visible
domain: System Status Page
range: boolean

shortcode
type: Property
comment: Shortcode for the page
alternate name: shortcode
sub property of: shortcode
domain: System Status Page
range: string

shortcode required
type: Property
comment: Is the shortcode required?
alternate name: shortcode_required
sub property of: shortcode required
domain: System Status Page
range: boolean

shortcode present
type: Property
comment: Is the shortcode present?
alternate name: shortcode_present
sub property of: shortcode present
domain: System Status Page
range: boolean

environment
type: Property
comment: Environment properties
alternate name: environment
sub property of: environment
domain: System Status
range: System Status Environment

database
type: Property
comment: Database properties
alternate name: database
sub property of: database
domain: System Status
range: System Status Database

active plugins
type: Property
comment: Active plugins
alternate name: active_plugins
sub property of: active plugins
domain: System Status
range: System Status Active Plugin

theme
type: Property
comment: Theme properties
alternate name: theme
sub property of: theme
domain: System Status
range: System Status Theme

settings
type: Property
comment: Settings properties
alternate name: settings
domain: System Status
range: System Status Settings

security
type: Property
comment: Security properties
alternate name: security
sub property of: security
domain: System Status
range: System Status Security

pages
type: Property
comment: WooCommerce pages
alternate name: pages
sub property of: pages
domain: System Status
range: System Status Page

links
type: Property
comment: HAL links
alternate name: _links
domain: System Status
range: Links

id
type: Property
comment: A unique identifier for the tool
alternate name: id
sub property of: identifier
domain: System Status Tool
range: string

name
type: Property
comment: Tool name
alternate name: name
sub property of: name
domain: System Status Tool
range: string

action
type: Property
comment: What running the tool will do
alternate name: action
sub property of: action
domain: System Status Tool
range: string

description
type: Property
comment: Tool description
alternate name: description
sub property of: description
domain: System Status Tool
range: string

success
type: Property
comment: Did the tool run successfully?
alternate name: success
sub property of: success
domain: System Status Tool
range: boolean

message
type: Property
comment: Tool return message
alternate name: message
sub property of: message
domain: System Status Tool
range: string

links
type: Property
comment: HAL links
alternate name: _links
domain: System Status Tool
range: Links

confirm
type: Property
comment: Confirm execution of the tool
alternate name: confirm
sub property of: confirm
domain: System Status Tool Run Input
range: boolean

slug
type: Property
comment: Data resource ID
alternate name: slug
sub property of: slug
sub property of: identifier
domain: Data Endpoint
range: string

description
type: Property
comment: Data resource description
alternate name: description
sub property of: description
domain: Data Endpoint
range: string

links
type: Property
comment: HAL links
alternate name: _links
domain: Data Endpoint
range: Links

code
type: Property
comment: State code
alternate name: code
sub property of: code
sub property of: identifier
domain: State
range: string

name
type: Property
comment: Full name of state
alternate name: name
sub property of: name
domain: State
range: string

code
type: Property
comment: ISO3166 alpha-2 country code
alternate name: code
sub property of: code
sub property of: identifier
domain: Continent Country
range: string

name
type: Property
comment: Full name of country
alternate name: name
sub property of: name
domain: Continent Country
range: string

currency code
type: Property
comment: Default ISO4217 alpha-3 currency code for the country
alternate name: currency_code
sub property of: currency code
domain: Continent Country
range: string

currency pos
type: Property
comment: Currency symbol position for this country
alternate name: currency_pos
sub property of: currency position
sub property of: currency pos
domain: Continent Country
range: string

decimal sep
type: Property
comment: Decimal separator for displayed prices for this country
alternate name: decimal_sep
sub property of: decimal separator
sub property of: decimal sep
domain: Continent Country
range: string

dimension unit
type: Property
comment: The unit lengths are defined in for this country
alternate name: dimension_unit
sub property of: dimension unit
domain: Continent Country
range: string

num decimals
type: Property
comment: Number of decimal points shown in displayed prices for this country
alternate name: num_decimals
sub property of: number of decimals
sub property of: num decimals
domain: Continent Country
range: int

thousand sep
type: Property
comment: Thousands separator for displayed prices in this country
alternate name: thousand_sep
sub property of: thousand sep
sub property of: thousand separator
domain: Continent Country
range: string

weight unit
type: Property
comment: The unit weights are defined in for this country
alternate name: weight_unit
sub property of: weight unit
domain: Continent Country
range: string

states
type: Property
comment: List of states in this country
alternate name: states
sub property of: states
domain: Continent Country
range: State

code
type: Property
comment: 2 character continent code
alternate name: code
sub property of: code
sub property of: identifier
domain: Continent
range: string

name
type: Property
comment: Full name of continent
alternate name: name
sub property of: name
domain: Continent
range: string

countries
type: Property
comment: List of countries on this continent
alternate name: countries
sub property of: countries
domain: Continent
range: Continent Country

links
type: Property
comment: HAL links
alternate name: _links
domain: Continent
range: Links

code
type: Property
comment: ISO3166 alpha-2 country code
alternate name: code
sub property of: code
sub property of: identifier
domain: Country
range: string

name
type: Property
comment: Full name of country
alternate name: name
sub property of: name
domain: Country
range: string

states
type: Property
comment: List of states in this country
alternate name: states
sub property of: states
domain: Country
range: State

links
type: Property
comment: HAL links
alternate name: _links
domain: Country
range: Links

code
type: Property
comment: ISO4217 currency code
alternate name: code
sub property of: code
sub property of: identifier
domain: Currency
range: string

name
type: Property
comment: Full name of currency
alternate name: name
sub property of: name
domain: Currency
range: string

symbol
type: Property
comment: Currency symbol
alternate name: symbol
sub property of: currency symbol
sub property of: symbol
domain: Currency
range: string

links
type: Property
comment: HAL links
alternate name: _links
domain: Currency
range: Links

expiration date
type: Property
comment: Receipt expiration date in yyyy-mm-dd format
alternate name: expiration_date
sub property of: expiration date
domain: Order Receipt Request
range: string

expiration days
type: Property
comment: Number of days until receipt expires
alternate name: expiration_days
sub property of: expiration days
domain: Order Receipt Request
range: int

force new
type: Property
comment: Force generation of a new receipt URL even if one exists
alternate name: force_new
sub property of: force new
domain: Order Receipt Request
range: boolean

email
type: Property
comment: Email address to send to. Required if order has no billing email.
alternate name: email
sub property of: email
domain: Send Order Details Request
range: string

force email update
type: Property
comment: If true, update the order's billing email with the provided email address.
alternate name: force_email_update
sub property of: force email update
domain: Send Order Details Request
range: boolean
added in version: v9 8 0

template id
type: Property
comment: The email template to use. If omitted (10.7.0+), the best template is auto-selected based on order status.
alternate name: template_id
sub property of: template id
domain: Send Email Request
range: string
made optional in version: v10 7 0

email
type: Property
comment: Email address to send to. Required if order has no billing email.
alternate name: email
sub property of: email
domain: Send Email Request
range: string

force email update
type: Property
comment: If true, update the order's billing email with the provided email address.
alternate name: force_email_update
sub property of: force email update
domain: Send Email Request
range: boolean

message
type: Property
comment: Success message describing the action taken.
alternate name: message
sub property of: message
domain: Action Message Response
range: string

template identifier
type: Property
comment: Template identifier (e.g., 'customer_completed_order', 'customer_invoice').
alternate name: id
sub property of: template identifier
domain: Email Template
range: string

title
type: Property
comment: Display title of the template.
alternate name: title
sub property of: title
domain: Email Template
range: string

description
type: Property
comment: Description of when this template is used.
alternate name: description
sub property of: description
domain: Email Template
range: string

id
type: Property
comment: Unique identifier for the resource
alternate name: id
domain: Product Created Event
range: long

name
type: Property
comment: Product name
alternate name: name
sub property of: name
domain: Product Created Event
range: string

slug
type: Property
comment: URL-friendly slug
alternate name: slug
sub property of: slug
sub property of: identifier
domain: Product Created Event
range: string

permalink
type: Property
comment: Product URL
alternate name: permalink
sub property of: url
domain: Product Created Event
range: anyURI

date created
type: Property
comment: The date the product was created, in the site's timezone
alternate name: date_created
sub property of: date created
sub property of: dateCreated
domain: Product Created Event
range: dateTime

date created gmt
type: Property
comment: The date the product was created, as GMT
alternate name: date_created_gmt
sub property of: date created gmt
domain: Product Created Event
range: dateTime

date modified
type: Property
comment: The date the product was last modified, in the site's timezone
alternate name: date_modified
sub property of: date modified
sub property of: dateModified
domain: Product Created Event
range: dateTime

date modified gmt
type: Property
comment: The date the product was last modified, as GMT
alternate name: date_modified_gmt
sub property of: date modified gmt
domain: Product Created Event
range: dateTime

type
type: Property
comment: Product type
alternate name: type
sub property of: type
domain: Product Created Event
range: string
code list: ProductType

status
type: Property
comment: Product status (post status)
alternate name: status
domain: Product Created Event
range: string
code list: ProductStatus

featured
type: Property
comment: Featured product
alternate name: featured
sub property of: featured
domain: Product Created Event
range: boolean

catalog visibility
type: Property
comment: Catalog visibility
alternate name: catalog_visibility
sub property of: catalog visibility
domain: Product Created Event
range: string
code list: CatalogVisibility

description
type: Property
comment: Product description
alternate name: description
sub property of: description
domain: Product Created Event
range: string

short description
type: Property
comment: Product short description
alternate name: short_description
sub property of: short description
sub property of: abstract
domain: Product Created Event
range: string

sku
type: Property
comment: Unique identifier (Stock Keeping Unit)
alternate name: sku
sub property of: sku
domain: Product Created Event
range: string

global unique id
type: Property
comment: Global product identifier
alternate name: global_unique_id
sub property of: global unique id
sub property of: gtin
domain: Product Created Event
range: string
added in version: v9 2 4

price
type: Property
comment: Current product price
alternate name: price
sub property of: price
domain: Product Created Event
range: string

regular price
type: Property
comment: Product regular price
alternate name: regular_price
sub property of: regular price
sub property of: price
domain: Product Created Event
range: string

sale price
type: Property
comment: Product sale price
alternate name: sale_price
sub property of: sale price
sub property of: lowPrice
domain: Product Created Event
range: string

date on sale from
type: Property
comment: Start date of sale price, in the site's timezone
alternate name: date_on_sale_from
sub property of: date on sale from
domain: Product Created Event
range: dateTime

date on sale from gmt
type: Property
comment: Start date of sale price, as GMT
alternate name: date_on_sale_from_gmt
sub property of: date on sale from gmt
domain: Product Created Event
range: dateTime

date on sale to
type: Property
comment: End date of sale price, in the site's timezone
alternate name: date_on_sale_to
sub property of: date on sale to
domain: Product Created Event
range: dateTime

date on sale to gmt
type: Property
comment: End date of sale price, as GMT
alternate name: date_on_sale_to_gmt
sub property of: date on sale to gmt
domain: Product Created Event
range: dateTime

price html
type: Property
comment: Price formatted in HTML
alternate name: price_html
sub property of: price html
domain: Product Created Event
range: string

on sale
type: Property
comment: Shows if the product is on sale
alternate name: on_sale
sub property of: on sale
domain: Product Created Event
range: boolean

purchasable
type: Property
comment: Shows if the product can be bought
alternate name: purchasable
sub property of: purchasable
domain: Product Created Event
range: boolean

total sales
type: Property
comment: Amount of sales
alternate name: total_sales
domain: Product Created Event
range: long

virtual
type: Property
comment: If the product is virtual (no shipping)
alternate name: virtual
sub property of: virtual
domain: Product Created Event
range: boolean

downloadable
type: Property
comment: If the product is downloadable
alternate name: downloadable
sub property of: downloadable
domain: Product Created Event
range: boolean

downloads
type: Property
comment: List of downloadable files
alternate name: downloads
sub property of: downloads
domain: Product Created Event
range: Product Download

download limit
type: Property
comment: Number of times downloadable files can be downloaded after purchase. Default is -1.
alternate name: download_limit
sub property of: download limit
domain: Product Created Event
range: int

download expiry
type: Property
comment: Number of days until access to downloadable files expires. Default is -1.
alternate name: download_expiry
sub property of: download expiry
domain: Product Created Event
range: int

external url
type: Property
comment: Product external URL. Only for external products.
alternate name: external_url
sub property of: external url
domain: Product Created Event
range: string

button text
type: Property
comment: Product external button text. Only for external products.
alternate name: button_text
sub property of: button text
domain: Product Created Event
range: string

tax status
type: Property
comment: Tax status
alternate name: tax_status
sub property of: tax status
domain: Product Created Event
range: string
code list: TaxStatus

tax class
type: Property
comment: Tax class
alternate name: tax_class
sub property of: tax class
domain: Product Created Event
range: string

manage stock
type: Property
comment: Stock management at product level
alternate name: manage_stock
sub property of: manage stock
domain: Product Created Event
range: boolean

stock quantity
type: Property
comment: Stock quantity
alternate name: stock_quantity
sub property of: stock quantity
domain: Product Created Event
range: long

stock status
type: Property
comment: Controls the stock status of the product
alternate name: stock_status
sub property of: stock status
domain: Product Created Event
range: string
code list: StockStatus

backorders
type: Property
comment: If managing stock, this controls if backorders are allowed
alternate name: backorders
sub property of: backorders
domain: Product Created Event
range: string
code list: BackorderStatus

backorders allowed
type: Property
comment: Shows if backorders are allowed
alternate name: backorders_allowed
sub property of: backorders allowed
domain: Product Created Event
range: boolean

backordered
type: Property
comment: Shows if the product is on backordered
alternate name: backordered
sub property of: backordered
domain: Product Created Event
range: boolean

sold individually
type: Property
comment: Allow one item to be bought in a single order
alternate name: sold_individually
sub property of: sold individually
domain: Product Created Event
range: boolean

weight
type: Property
comment: Product weight
alternate name: weight
sub property of: weight
domain: Product Created Event
range: string

dimensions
type: Property
comment: Product dimensions
alternate name: dimensions
sub property of: dimensions
domain: Product Created Event
range: Product Dimensions

shipping required
type: Property
comment: Shows if the product need to be shipped
alternate name: shipping_required
sub property of: shipping required
domain: Product Created Event
range: boolean

shipping taxable
type: Property
comment: Shows whether or not the product shipping is taxable
alternate name: shipping_taxable
sub property of: shipping taxable
domain: Product Created Event
range: boolean

shipping class
type: Property
comment: Shipping class slug
alternate name: shipping_class
sub property of: shipping class
domain: Product Created Event
range: string

shipping class id
type: Property
comment: Shipping class ID
alternate name: shipping_class_id
sub property of: shipping class id
domain: Product Created Event
range: Product Shipping Class

reviews allowed
type: Property
comment: Allow reviews
alternate name: reviews_allowed
sub property of: reviews allowed
domain: Product Created Event
range: boolean

average rating
type: Property
comment: Reviews average rating
alternate name: average_rating
sub property of: average rating
domain: Product Created Event
range: string

rating count
type: Property
comment: Amount of reviews that the product have
alternate name: rating_count
sub property of: rating count
domain: Product Created Event
range: int

related products
type: Property
comment: List of related products
alternate name: related_ids
sub property of: related products
domain: Product Created Event
range: Product

upsell products
type: Property
comment: List of up-sell products
alternate name: upsell_ids
sub property of: upsell products
domain: Product Created Event
range: Product

cross sell products
type: Property
comment: List of cross-sell products
alternate name: cross_sell_ids
sub property of: cross sell products
domain: Product Created Event
range: Product

parent
type: Property
comment: Parent product
alternate name: parent_id
domain: Product Created Event
range: Product

purchase note
type: Property
comment: Optional note to send the customer after purchase
alternate name: purchase_note
sub property of: purchase note
domain: Product Created Event
range: string

categories
type: Property
comment: List of categories
alternate name: categories
sub property of: categories
sub property of: category
domain: Product Created Event
range: Product Category Ref

tags
type: Property
comment: List of tags
alternate name: tags
sub property of: tags
domain: Product Created Event
range: Product Tag Ref

images
type: Property
comment: List of images
alternate name: images
sub property of: images
sub property of: image
domain: Product Created Event
range: Product Image

attributes
type: Property
comment: List of attributes
alternate name: attributes
domain: Product Created Event
range: Product Attribute

default attributes
type: Property
comment: Defaults variation attributes
alternate name: default_attributes
sub property of: default attributes
domain: Product Created Event
range: Default Attribute

variations
type: Property
comment: List of variation IDs
alternate name: variations
sub property of: variations
domain: Product Created Event
range: Product Variation

grouped products
type: Property
comment: List of grouped product IDs
alternate name: grouped_products
sub property of: grouped products
domain: Product Created Event
range: Product

menu order
type: Property
comment: Menu order, used to custom sort products
alternate name: menu_order
sub property of: menu order
domain: Product Created Event
range: int

meta data
type: Property
comment: Meta data
alternate name: meta_data
sub property of: meta data
domain: Product Created Event
range: Product Metadata

links
type: Property
comment: HAL links
alternate name: _links
domain: Product Created Event
range: Links

id
type: Property
comment: Unique identifier for the resource
alternate name: id
domain: Product Updated Event
range: long

name
type: Property
comment: Product name
alternate name: name
sub property of: name
domain: Product Updated Event
range: string

slug
type: Property
comment: URL-friendly slug
alternate name: slug
sub property of: slug
sub property of: identifier
domain: Product Updated Event
range: string

permalink
type: Property
comment: Product URL
alternate name: permalink
sub property of: url
domain: Product Updated Event
range: anyURI

date created
type: Property
comment: The date the product was created, in the site's timezone
alternate name: date_created
sub property of: date created
sub property of: dateCreated
domain: Product Updated Event
range: dateTime

date created gmt
type: Property
comment: The date the product was created, as GMT
alternate name: date_created_gmt
sub property of: date created gmt
domain: Product Updated Event
range: dateTime

date modified
type: Property
comment: The date the product was last modified, in the site's timezone
alternate name: date_modified
sub property of: date modified
sub property of: dateModified
domain: Product Updated Event
range: dateTime

date modified gmt
type: Property
comment: The date the product was last modified, as GMT
alternate name: date_modified_gmt
sub property of: date modified gmt
domain: Product Updated Event
range: dateTime

type
type: Property
comment: Product type
alternate name: type
sub property of: type
domain: Product Updated Event
range: string
code list: ProductType

status
type: Property
comment: Product status (post status)
alternate name: status
domain: Product Updated Event
range: string
code list: ProductStatus

featured
type: Property
comment: Featured product
alternate name: featured
sub property of: featured
domain: Product Updated Event
range: boolean

catalog visibility
type: Property
comment: Catalog visibility
alternate name: catalog_visibility
sub property of: catalog visibility
domain: Product Updated Event
range: string
code list: CatalogVisibility

description
type: Property
comment: Product description
alternate name: description
sub property of: description
domain: Product Updated Event
range: string

short description
type: Property
comment: Product short description
alternate name: short_description
sub property of: short description
sub property of: abstract
domain: Product Updated Event
range: string

sku
type: Property
comment: Unique identifier (Stock Keeping Unit)
alternate name: sku
sub property of: sku
domain: Product Updated Event
range: string

global unique id
type: Property
comment: Global product identifier
alternate name: global_unique_id
sub property of: global unique id
sub property of: gtin
domain: Product Updated Event
range: string
added in version: v9 2 4

price
type: Property
comment: Current product price
alternate name: price
sub property of: price
domain: Product Updated Event
range: string

regular price
type: Property
comment: Product regular price
alternate name: regular_price
sub property of: regular price
sub property of: price
domain: Product Updated Event
range: string

sale price
type: Property
comment: Product sale price
alternate name: sale_price
sub property of: sale price
sub property of: lowPrice
domain: Product Updated Event
range: string

date on sale from
type: Property
comment: Start date of sale price, in the site's timezone
alternate name: date_on_sale_from
sub property of: date on sale from
domain: Product Updated Event
range: dateTime

date on sale from gmt
type: Property
comment: Start date of sale price, as GMT
alternate name: date_on_sale_from_gmt
sub property of: date on sale from gmt
domain: Product Updated Event
range: dateTime

date on sale to
type: Property
comment: End date of sale price, in the site's timezone
alternate name: date_on_sale_to
sub property of: date on sale to
domain: Product Updated Event
range: dateTime

date on sale to gmt
type: Property
comment: End date of sale price, as GMT
alternate name: date_on_sale_to_gmt
sub property of: date on sale to gmt
domain: Product Updated Event
range: dateTime

price html
type: Property
comment: Price formatted in HTML
alternate name: price_html
sub property of: price html
domain: Product Updated Event
range: string

on sale
type: Property
comment: Shows if the product is on sale
alternate name: on_sale
sub property of: on sale
domain: Product Updated Event
range: boolean

purchasable
type: Property
comment: Shows if the product can be bought
alternate name: purchasable
sub property of: purchasable
domain: Product Updated Event
range: boolean

total sales
type: Property
comment: Amount of sales
alternate name: total_sales
domain: Product Updated Event
range: long

virtual
type: Property
comment: If the product is virtual (no shipping)
alternate name: virtual
sub property of: virtual
domain: Product Updated Event
range: boolean

downloadable
type: Property
comment: If the product is downloadable
alternate name: downloadable
sub property of: downloadable
domain: Product Updated Event
range: boolean

downloads
type: Property
comment: List of downloadable files
alternate name: downloads
sub property of: downloads
domain: Product Updated Event
range: Product Download

download limit
type: Property
comment: Number of times downloadable files can be downloaded after purchase. Default is -1.
alternate name: download_limit
sub property of: download limit
domain: Product Updated Event
range: int

download expiry
type: Property
comment: Number of days until access to downloadable files expires. Default is -1.
alternate name: download_expiry
sub property of: download expiry
domain: Product Updated Event
range: int

external url
type: Property
comment: Product external URL. Only for external products.
alternate name: external_url
sub property of: external url
domain: Product Updated Event
range: string

button text
type: Property
comment: Product external button text. Only for external products.
alternate name: button_text
sub property of: button text
domain: Product Updated Event
range: string

tax status
type: Property
comment: Tax status
alternate name: tax_status
sub property of: tax status
domain: Product Updated Event
range: string
code list: TaxStatus

tax class
type: Property
comment: Tax class
alternate name: tax_class
sub property of: tax class
domain: Product Updated Event
range: string

manage stock
type: Property
comment: Stock management at product level
alternate name: manage_stock
sub property of: manage stock
domain: Product Updated Event
range: boolean

stock quantity
type: Property
comment: Stock quantity
alternate name: stock_quantity
sub property of: stock quantity
domain: Product Updated Event
range: long

stock status
type: Property
comment: Controls the stock status of the product
alternate name: stock_status
sub property of: stock status
domain: Product Updated Event
range: string
code list: StockStatus

backorders
type: Property
comment: If managing stock, this controls if backorders are allowed
alternate name: backorders
sub property of: backorders
domain: Product Updated Event
range: string
code list: BackorderStatus

backorders allowed
type: Property
comment: Shows if backorders are allowed
alternate name: backorders_allowed
sub property of: backorders allowed
domain: Product Updated Event
range: boolean

backordered
type: Property
comment: Shows if the product is on backordered
alternate name: backordered
sub property of: backordered
domain: Product Updated Event
range: boolean

sold individually
type: Property
comment: Allow one item to be bought in a single order
alternate name: sold_individually
sub property of: sold individually
domain: Product Updated Event
range: boolean

weight
type: Property
comment: Product weight
alternate name: weight
sub property of: weight
domain: Product Updated Event
range: string

dimensions
type: Property
comment: Product dimensions
alternate name: dimensions
sub property of: dimensions
domain: Product Updated Event
range: Product Dimensions

shipping required
type: Property
comment: Shows if the product need to be shipped
alternate name: shipping_required
sub property of: shipping required
domain: Product Updated Event
range: boolean

shipping taxable
type: Property
comment: Shows whether or not the product shipping is taxable
alternate name: shipping_taxable
sub property of: shipping taxable
domain: Product Updated Event
range: boolean

shipping class
type: Property
comment: Shipping class slug
alternate name: shipping_class
sub property of: shipping class
domain: Product Updated Event
range: string

shipping class id
type: Property
comment: Shipping class ID
alternate name: shipping_class_id
sub property of: shipping class id
domain: Product Updated Event
range: Product Shipping Class

reviews allowed
type: Property
comment: Allow reviews
alternate name: reviews_allowed
sub property of: reviews allowed
domain: Product Updated Event
range: boolean

average rating
type: Property
comment: Reviews average rating
alternate name: average_rating
sub property of: average rating
domain: Product Updated Event
range: string

rating count
type: Property
comment: Amount of reviews that the product have
alternate name: rating_count
sub property of: rating count
domain: Product Updated Event
range: int

related products
type: Property
comment: List of related products
alternate name: related_ids
sub property of: related products
domain: Product Updated Event
range: Product

upsell products
type: Property
comment: List of up-sell products
alternate name: upsell_ids
sub property of: upsell products
domain: Product Updated Event
range: Product

cross sell products
type: Property
comment: List of cross-sell products
alternate name: cross_sell_ids
sub property of: cross sell products
domain: Product Updated Event
range: Product

parent
type: Property
comment: Parent product
alternate name: parent_id
domain: Product Updated Event
range: Product

purchase note
type: Property
comment: Optional note to send the customer after purchase
alternate name: purchase_note
sub property of: purchase note
domain: Product Updated Event
range: string

categories
type: Property
comment: List of categories
alternate name: categories
sub property of: categories
sub property of: category
domain: Product Updated Event
range: Product Category Ref

tags
type: Property
comment: List of tags
alternate name: tags
sub property of: tags
domain: Product Updated Event
range: Product Tag Ref

images
type: Property
comment: List of images
alternate name: images
sub property of: images
sub property of: image
domain: Product Updated Event
range: Product Image

attributes
type: Property
comment: List of attributes
alternate name: attributes
domain: Product Updated Event
range: Product Attribute

default attributes
type: Property
comment: Defaults variation attributes
alternate name: default_attributes
sub property of: default attributes
domain: Product Updated Event
range: Default Attribute

variations
type: Property
comment: List of variation IDs
alternate name: variations
sub property of: variations
domain: Product Updated Event
range: Product Variation

grouped products
type: Property
comment: List of grouped product IDs
alternate name: grouped_products
sub property of: grouped products
domain: Product Updated Event
range: Product

menu order
type: Property
comment: Menu order, used to custom sort products
alternate name: menu_order
sub property of: menu order
domain: Product Updated Event
range: int

meta data
type: Property
comment: Meta data
alternate name: meta_data
sub property of: meta data
domain: Product Updated Event
range: Product Metadata

links
type: Property
comment: HAL links
alternate name: _links
domain: Product Updated Event
range: Links

id
type: Property
comment: Deleted product ID
alternate name: id
domain: Product Deleted Event
range: long

id
type: Property
comment: Unique identifier for the resource
alternate name: id
domain: Product Restored Event
range: long

name
type: Property
comment: Product name
alternate name: name
sub property of: name
domain: Product Restored Event
range: string

slug
type: Property
comment: URL-friendly slug
alternate name: slug
sub property of: slug
sub property of: identifier
domain: Product Restored Event
range: string

permalink
type: Property
comment: Product URL
alternate name: permalink
sub property of: url
domain: Product Restored Event
range: anyURI

date created
type: Property
comment: The date the product was created, in the site's timezone
alternate name: date_created
sub property of: date created
sub property of: dateCreated
domain: Product Restored Event
range: dateTime

date created gmt
type: Property
comment: The date the product was created, as GMT
alternate name: date_created_gmt
sub property of: date created gmt
domain: Product Restored Event
range: dateTime

date modified
type: Property
comment: The date the product was last modified, in the site's timezone
alternate name: date_modified
sub property of: date modified
sub property of: dateModified
domain: Product Restored Event
range: dateTime

date modified gmt
type: Property
comment: The date the product was last modified, as GMT
alternate name: date_modified_gmt
sub property of: date modified gmt
domain: Product Restored Event
range: dateTime

type
type: Property
comment: Product type
alternate name: type
sub property of: type
domain: Product Restored Event
range: string
code list: ProductType

status
type: Property
comment: Product status (post status)
alternate name: status
domain: Product Restored Event
range: string
code list: ProductStatus

featured
type: Property
comment: Featured product
alternate name: featured
sub property of: featured
domain: Product Restored Event
range: boolean

catalog visibility
type: Property
comment: Catalog visibility
alternate name: catalog_visibility
sub property of: catalog visibility
domain: Product Restored Event
range: string
code list: CatalogVisibility

description
type: Property
comment: Product description
alternate name: description
sub property of: description
domain: Product Restored Event
range: string

short description
type: Property
comment: Product short description
alternate name: short_description
sub property of: short description
sub property of: abstract
domain: Product Restored Event
range: string

sku
type: Property
comment: Unique identifier (Stock Keeping Unit)
alternate name: sku
sub property of: sku
domain: Product Restored Event
range: string

global unique id
type: Property
comment: Global product identifier
alternate name: global_unique_id
sub property of: global unique id
sub property of: gtin
domain: Product Restored Event
range: string
added in version: v9 2 4

price
type: Property
comment: Current product price
alternate name: price
sub property of: price
domain: Product Restored Event
range: string

regular price
type: Property
comment: Product regular price
alternate name: regular_price
sub property of: regular price
sub property of: price
domain: Product Restored Event
range: string

sale price
type: Property
comment: Product sale price
alternate name: sale_price
sub property of: sale price
sub property of: lowPrice
domain: Product Restored Event
range: string

date on sale from
type: Property
comment: Start date of sale price, in the site's timezone
alternate name: date_on_sale_from
sub property of: date on sale from
domain: Product Restored Event
range: dateTime

date on sale from gmt
type: Property
comment: Start date of sale price, as GMT
alternate name: date_on_sale_from_gmt
sub property of: date on sale from gmt
domain: Product Restored Event
range: dateTime

date on sale to
type: Property
comment: End date of sale price, in the site's timezone
alternate name: date_on_sale_to
sub property of: date on sale to
domain: Product Restored Event
range: dateTime

date on sale to gmt
type: Property
comment: End date of sale price, as GMT
alternate name: date_on_sale_to_gmt
sub property of: date on sale to gmt
domain: Product Restored Event
range: dateTime

price html
type: Property
comment: Price formatted in HTML
alternate name: price_html
sub property of: price html
domain: Product Restored Event
range: string

on sale
type: Property
comment: Shows if the product is on sale
alternate name: on_sale
sub property of: on sale
domain: Product Restored Event
range: boolean

purchasable
type: Property
comment: Shows if the product can be bought
alternate name: purchasable
sub property of: purchasable
domain: Product Restored Event
range: boolean

total sales
type: Property
comment: Amount of sales
alternate name: total_sales
domain: Product Restored Event
range: long

virtual
type: Property
comment: If the product is virtual (no shipping)
alternate name: virtual
sub property of: virtual
domain: Product Restored Event
range: boolean

downloadable
type: Property
comment: If the product is downloadable
alternate name: downloadable
sub property of: downloadable
domain: Product Restored Event
range: boolean

downloads
type: Property
comment: List of downloadable files
alternate name: downloads
sub property of: downloads
domain: Product Restored Event
range: Product Download

download limit
type: Property
comment: Number of times downloadable files can be downloaded after purchase. Default is -1.
alternate name: download_limit
sub property of: download limit
domain: Product Restored Event
range: int

download expiry
type: Property
comment: Number of days until access to downloadable files expires. Default is -1.
alternate name: download_expiry
sub property of: download expiry
domain: Product Restored Event
range: int

external url
type: Property
comment: Product external URL. Only for external products.
alternate name: external_url
sub property of: external url
domain: Product Restored Event
range: string

button text
type: Property
comment: Product external button text. Only for external products.
alternate name: button_text
sub property of: button text
domain: Product Restored Event
range: string

tax status
type: Property
comment: Tax status
alternate name: tax_status
sub property of: tax status
domain: Product Restored Event
range: string
code list: TaxStatus

tax class
type: Property
comment: Tax class
alternate name: tax_class
sub property of: tax class
domain: Product Restored Event
range: string

manage stock
type: Property
comment: Stock management at product level
alternate name: manage_stock
sub property of: manage stock
domain: Product Restored Event
range: boolean

stock quantity
type: Property
comment: Stock quantity
alternate name: stock_quantity
sub property of: stock quantity
domain: Product Restored Event
range: long

stock status
type: Property
comment: Controls the stock status of the product
alternate name: stock_status
sub property of: stock status
domain: Product Restored Event
range: string
code list: StockStatus

backorders
type: Property
comment: If managing stock, this controls if backorders are allowed
alternate name: backorders
sub property of: backorders
domain: Product Restored Event
range: string
code list: BackorderStatus

backorders allowed
type: Property
comment: Shows if backorders are allowed
alternate name: backorders_allowed
sub property of: backorders allowed
domain: Product Restored Event
range: boolean

backordered
type: Property
comment: Shows if the product is on backordered
alternate name: backordered
sub property of: backordered
domain: Product Restored Event
range: boolean

sold individually
type: Property
comment: Allow one item to be bought in a single order
alternate name: sold_individually
sub property of: sold individually
domain: Product Restored Event
range: boolean

weight
type: Property
comment: Product weight
alternate name: weight
sub property of: weight
domain: Product Restored Event
range: string

dimensions
type: Property
comment: Product dimensions
alternate name: dimensions
sub property of: dimensions
domain: Product Restored Event
range: Product Dimensions

shipping required
type: Property
comment: Shows if the product need to be shipped
alternate name: shipping_required
sub property of: shipping required
domain: Product Restored Event
range: boolean

shipping taxable
type: Property
comment: Shows whether or not the product shipping is taxable
alternate name: shipping_taxable
sub property of: shipping taxable
domain: Product Restored Event
range: boolean

shipping class
type: Property
comment: Shipping class slug
alternate name: shipping_class
sub property of: shipping class
domain: Product Restored Event
range: string

shipping class id
type: Property
comment: Shipping class ID
alternate name: shipping_class_id
sub property of: shipping class id
domain: Product Restored Event
range: Product Shipping Class

reviews allowed
type: Property
comment: Allow reviews
alternate name: reviews_allowed
sub property of: reviews allowed
domain: Product Restored Event
range: boolean

average rating
type: Property
comment: Reviews average rating
alternate name: average_rating
sub property of: average rating
domain: Product Restored Event
range: string

rating count
type: Property
comment: Amount of reviews that the product have
alternate name: rating_count
sub property of: rating count
domain: Product Restored Event
range: int

related products
type: Property
comment: List of related products
alternate name: related_ids
sub property of: related products
domain: Product Restored Event
range: Product

upsell products
type: Property
comment: List of up-sell products
alternate name: upsell_ids
sub property of: upsell products
domain: Product Restored Event
range: Product

cross sell products
type: Property
comment: List of cross-sell products
alternate name: cross_sell_ids
sub property of: cross sell products
domain: Product Restored Event
range: Product

parent
type: Property
comment: Parent product
alternate name: parent_id
domain: Product Restored Event
range: Product

purchase note
type: Property
comment: Optional note to send the customer after purchase
alternate name: purchase_note
sub property of: purchase note
domain: Product Restored Event
range: string

categories
type: Property
comment: List of categories
alternate name: categories
sub property of: categories
sub property of: category
domain: Product Restored Event
range: Product Category Ref

tags
type: Property
comment: List of tags
alternate name: tags
sub property of: tags
domain: Product Restored Event
range: Product Tag Ref

images
type: Property
comment: List of images
alternate name: images
sub property of: images
sub property of: image
domain: Product Restored Event
range: Product Image

attributes
type: Property
comment: List of attributes
alternate name: attributes
domain: Product Restored Event
range: Product Attribute

default attributes
type: Property
comment: Defaults variation attributes
alternate name: default_attributes
sub property of: default attributes
domain: Product Restored Event
range: Default Attribute

variations
type: Property
comment: List of variation IDs
alternate name: variations
sub property of: variations
domain: Product Restored Event
range: Product Variation

grouped products
type: Property
comment: List of grouped product IDs
alternate name: grouped_products
sub property of: grouped products
domain: Product Restored Event
range: Product

menu order
type: Property
comment: Menu order, used to custom sort products
alternate name: menu_order
sub property of: menu order
domain: Product Restored Event
range: int

meta data
type: Property
comment: Meta data
alternate name: meta_data
sub property of: meta data
domain: Product Restored Event
range: Product Metadata

links
type: Property
comment: HAL links
alternate name: _links
domain: Product Restored Event
range: Links

id
type: Property
comment: Unique identifier
alternate name: id
domain: Order Created Event
range: long

parent
type: Property
comment: Parent order (for order parts)
alternate name: parent_id
domain: Order Created Event
range: Order

number
type: Property
comment: Order number (may differ from ID)
alternate name: number
sub property of: number
sub property of: orderNumber
domain: Order Created Event
range: string

order key
type: Property
comment: Order key (for guest checkout links)
alternate name: order_key
sub property of: order key
domain: Order Created Event
range: string

created via
type: Property
comment: Shows where the order was created. Can only be set during creation.
alternate name: created_via
sub property of: created via
domain: Order Created Event
range: string

version
type: Property
comment: Version of WooCommerce which last updated the order
alternate name: version
sub property of: version
domain: Order Created Event
range: string

status
type: Property
comment: Order status
alternate name: status
domain: Order Created Event
range: string
code list: OrderStatus

currency
type: Property
comment: Currency code (ISO 4217)
alternate name: currency
sub property of: currency
sub property of: priceCurrency
domain: Order Created Event
range: string

currency symbol
type: Property
comment: Currency symbol
alternate name: currency_symbol
sub property of: currency symbol
domain: Order Created Event
range: string

date created
type: Property
comment: The date the order was created, in the site's timezone
alternate name: date_created
sub property of: date created
sub property of: orderDate
domain: Order Created Event
range: dateTime

date created gmt
type: Property
comment: The date the order was created, as GMT
alternate name: date_created_gmt
sub property of: date created gmt
domain: Order Created Event
range: dateTime

date modified
type: Property
comment: The date the order was last modified, in the site's timezone
alternate name: date_modified
sub property of: date modified
sub property of: dateModified
domain: Order Created Event
range: dateTime

date modified gmt
type: Property
comment: The date the order was last modified, as GMT
alternate name: date_modified_gmt
sub property of: date modified gmt
domain: Order Created Event
range: dateTime

discount total
type: Property
comment: Total discount amount
alternate name: discount_total
sub property of: discount total
domain: Order Created Event
range: string

discount tax
type: Property
comment: Total discount tax
alternate name: discount_tax
sub property of: discount tax
domain: Order Created Event
range: string

shipping total
type: Property
comment: Total shipping amount
alternate name: shipping_total
sub property of: shipping total
domain: Order Created Event
range: string

shipping tax
type: Property
comment: Total shipping tax
alternate name: shipping_tax
sub property of: shipping tax
domain: Order Created Event
range: string

cart tax
type: Property
comment: Sum of line item taxes only
alternate name: cart_tax
sub property of: cart tax
domain: Order Created Event
range: string

total
type: Property
comment: Grand total
alternate name: total
sub property of: total
sub property of: totalPrice
domain: Order Created Event
range: string

total tax
type: Property
comment: Sum of all taxes
alternate name: total_tax
sub property of: total tax
domain: Order Created Event
range: string

prices include tax
type: Property
comment: True if prices included tax during checkout
alternate name: prices_include_tax
sub property of: prices include tax
domain: Order Created Event
range: boolean

customer
type: Property
comment: Customer who owns the order. 0 for guests.
alternate name: customer_id
sub property of: customer
domain: Order Created Event
range: Customer

customer ip address
type: Property
comment: Customer's IP address
alternate name: customer_ip_address
sub property of: customer ip address
domain: Order Created Event
range: string

customer user agent
type: Property
comment: User agent of the customer
alternate name: customer_user_agent
sub property of: customer user agent
domain: Order Created Event
range: string

customer note
type: Property
comment: Note left by customer during checkout
alternate name: customer_note
domain: Order Created Event
range: string

billing
type: Property
comment: Billing address
alternate name: billing
sub property of: billing
sub property of: billingAddress
domain: Order Created Event
range: Billing Address

shipping
type: Property
comment: Shipping address
alternate name: shipping
sub property of: deliveryAddress
domain: Order Created Event
range: Shipping Address

payment method
type: Property
comment: Payment method ID
alternate name: payment_method
sub property of: payment method
sub property of: paymentMethod
domain: Order Created Event
range: string

payment method title
type: Property
comment: Payment method title
alternate name: payment_method_title
sub property of: payment method title
domain: Order Created Event
range: string

transaction id
type: Property
comment: Unique transaction ID
alternate name: transaction_id
sub property of: transaction id
domain: Order Created Event
range: string

date paid
type: Property
comment: The date the order was paid, in the site's timezone
alternate name: date_paid
sub property of: date paid
domain: Order Created Event
range: dateTime

date paid gmt
type: Property
comment: The date the order was paid, as GMT
alternate name: date_paid_gmt
sub property of: date paid gmt
domain: Order Created Event
range: dateTime

date completed
type: Property
comment: The date the order was completed, in the site's timezone
alternate name: date_completed
sub property of: date completed
domain: Order Created Event
range: dateTime

date completed gmt
type: Property
comment: The date the order was completed, as GMT
alternate name: date_completed_gmt
sub property of: date completed gmt
domain: Order Created Event
range: dateTime

cart hash
type: Property
comment: MD5 hash of cart items to ensure orders are not modified
alternate name: cart_hash
sub property of: cart hash
domain: Order Created Event
range: string

line items
type: Property
comment: Line items
alternate name: line_items
sub property of: orderedItem
domain: Order Created Event
range: Order Line Item

tax lines
type: Property
comment: Tax lines
alternate name: tax_lines
sub property of: tax lines
domain: Order Created Event
range: Tax Line

shipping lines
type: Property
comment: Shipping lines
alternate name: shipping_lines
domain: Order Created Event
range: Shipping Line

fee lines
type: Property
comment: Fee lines
alternate name: fee_lines
domain: Order Created Event
range: Fee Line

coupon lines
type: Property
comment: Coupon lines
alternate name: coupon_lines
domain: Order Created Event
range: Coupon Line

refunds
type: Property
comment: List of refunds
alternate name: refunds
sub property of: refunds
domain: Order Created Event
range: Order Refund Line

needs payment
type: Property
comment: Whether order needs payment
alternate name: needs_payment
sub property of: needs payment
domain: Order Created Event
range: boolean

needs processing
type: Property
comment: Whether order needs processing
alternate name: needs_processing
sub property of: needs processing
domain: Order Created Event
range: boolean

payment url
type: Property
comment: Payment URL
alternate name: payment_url
sub property of: payment url
domain: Order Created Event
range: string

is editable
type: Property
comment: Whether order is editable
alternate name: is_editable
sub property of: is editable
domain: Order Created Event
range: boolean

metadata
type: Property
comment: Meta data
alternate name: meta_data
sub property of: metadata
domain: Order Created Event
range: Metadata

links
type: Property
comment: HAL links
alternate name: _links
domain: Order Created Event
range: Links

id
type: Property
comment: Unique identifier
alternate name: id
domain: Order Updated Event
range: long

parent
type: Property
comment: Parent order (for order parts)
alternate name: parent_id
domain: Order Updated Event
range: Order

number
type: Property
comment: Order number (may differ from ID)
alternate name: number
sub property of: number
sub property of: orderNumber
domain: Order Updated Event
range: string

order key
type: Property
comment: Order key (for guest checkout links)
alternate name: order_key
sub property of: order key
domain: Order Updated Event
range: string

created via
type: Property
comment: Shows where the order was created. Can only be set during creation.
alternate name: created_via
sub property of: created via
domain: Order Updated Event
range: string

version
type: Property
comment: Version of WooCommerce which last updated the order
alternate name: version
sub property of: version
domain: Order Updated Event
range: string

status
type: Property
comment: Order status
alternate name: status
domain: Order Updated Event
range: string
code list: OrderStatus

currency
type: Property
comment: Currency code (ISO 4217)
alternate name: currency
sub property of: currency
sub property of: priceCurrency
domain: Order Updated Event
range: string

currency symbol
type: Property
comment: Currency symbol
alternate name: currency_symbol
sub property of: currency symbol
domain: Order Updated Event
range: string

date created
type: Property
comment: The date the order was created, in the site's timezone
alternate name: date_created
sub property of: date created
sub property of: orderDate
domain: Order Updated Event
range: dateTime

date created gmt
type: Property
comment: The date the order was created, as GMT
alternate name: date_created_gmt
sub property of: date created gmt
domain: Order Updated Event
range: dateTime

date modified
type: Property
comment: The date the order was last modified, in the site's timezone
alternate name: date_modified
sub property of: date modified
sub property of: dateModified
domain: Order Updated Event
range: dateTime

date modified gmt
type: Property
comment: The date the order was last modified, as GMT
alternate name: date_modified_gmt
sub property of: date modified gmt
domain: Order Updated Event
range: dateTime

discount total
type: Property
comment: Total discount amount
alternate name: discount_total
sub property of: discount total
domain: Order Updated Event
range: string

discount tax
type: Property
comment: Total discount tax
alternate name: discount_tax
sub property of: discount tax
domain: Order Updated Event
range: string

shipping total
type: Property
comment: Total shipping amount
alternate name: shipping_total
sub property of: shipping total
domain: Order Updated Event
range: string

shipping tax
type: Property
comment: Total shipping tax
alternate name: shipping_tax
sub property of: shipping tax
domain: Order Updated Event
range: string

cart tax
type: Property
comment: Sum of line item taxes only
alternate name: cart_tax
sub property of: cart tax
domain: Order Updated Event
range: string

total
type: Property
comment: Grand total
alternate name: total
sub property of: total
sub property of: totalPrice
domain: Order Updated Event
range: string

total tax
type: Property
comment: Sum of all taxes
alternate name: total_tax
sub property of: total tax
domain: Order Updated Event
range: string

prices include tax
type: Property
comment: True if prices included tax during checkout
alternate name: prices_include_tax
sub property of: prices include tax
domain: Order Updated Event
range: boolean

customer
type: Property
comment: Customer who owns the order. 0 for guests.
alternate name: customer_id
sub property of: customer
domain: Order Updated Event
range: Customer

customer ip address
type: Property
comment: Customer's IP address
alternate name: customer_ip_address
sub property of: customer ip address
domain: Order Updated Event
range: string

customer user agent
type: Property
comment: User agent of the customer
alternate name: customer_user_agent
sub property of: customer user agent
domain: Order Updated Event
range: string

customer note
type: Property
comment: Note left by customer during checkout
alternate name: customer_note
domain: Order Updated Event
range: string

billing
type: Property
comment: Billing address
alternate name: billing
sub property of: billing
sub property of: billingAddress
domain: Order Updated Event
range: Billing Address

shipping
type: Property
comment: Shipping address
alternate name: shipping
sub property of: deliveryAddress
domain: Order Updated Event
range: Shipping Address

payment method
type: Property
comment: Payment method ID
alternate name: payment_method
sub property of: payment method
sub property of: paymentMethod
domain: Order Updated Event
range: string

payment method title
type: Property
comment: Payment method title
alternate name: payment_method_title
sub property of: payment method title
domain: Order Updated Event
range: string

transaction id
type: Property
comment: Unique transaction ID
alternate name: transaction_id
sub property of: transaction id
domain: Order Updated Event
range: string

date paid
type: Property
comment: The date the order was paid, in the site's timezone
alternate name: date_paid
sub property of: date paid
domain: Order Updated Event
range: dateTime

date paid gmt
type: Property
comment: The date the order was paid, as GMT
alternate name: date_paid_gmt
sub property of: date paid gmt
domain: Order Updated Event
range: dateTime

date completed
type: Property
comment: The date the order was completed, in the site's timezone
alternate name: date_completed
sub property of: date completed
domain: Order Updated Event
range: dateTime

date completed gmt
type: Property
comment: The date the order was completed, as GMT
alternate name: date_completed_gmt
sub property of: date completed gmt
domain: Order Updated Event
range: dateTime

cart hash
type: Property
comment: MD5 hash of cart items to ensure orders are not modified
alternate name: cart_hash
sub property of: cart hash
domain: Order Updated Event
range: string

line items
type: Property
comment: Line items
alternate name: line_items
sub property of: orderedItem
domain: Order Updated Event
range: Order Line Item

tax lines
type: Property
comment: Tax lines
alternate name: tax_lines
sub property of: tax lines
domain: Order Updated Event
range: Tax Line

shipping lines
type: Property
comment: Shipping lines
alternate name: shipping_lines
domain: Order Updated Event
range: Shipping Line

fee lines
type: Property
comment: Fee lines
alternate name: fee_lines
domain: Order Updated Event
range: Fee Line

coupon lines
type: Property
comment: Coupon lines
alternate name: coupon_lines
domain: Order Updated Event
range: Coupon Line

refunds
type: Property
comment: List of refunds
alternate name: refunds
sub property of: refunds
domain: Order Updated Event
range: Order Refund Line

needs payment
type: Property
comment: Whether order needs payment
alternate name: needs_payment
sub property of: needs payment
domain: Order Updated Event
range: boolean

needs processing
type: Property
comment: Whether order needs processing
alternate name: needs_processing
sub property of: needs processing
domain: Order Updated Event
range: boolean

payment url
type: Property
comment: Payment URL
alternate name: payment_url
sub property of: payment url
domain: Order Updated Event
range: string

is editable
type: Property
comment: Whether order is editable
alternate name: is_editable
sub property of: is editable
domain: Order Updated Event
range: boolean

metadata
type: Property
comment: Meta data
alternate name: meta_data
sub property of: metadata
domain: Order Updated Event
range: Metadata

links
type: Property
comment: HAL links
alternate name: _links
domain: Order Updated Event
range: Links

id
type: Property
comment: Deleted order ID
alternate name: id
domain: Order Deleted Event
range: long

id
type: Property
comment: Unique identifier
alternate name: id
domain: Order Restored Event
range: long

parent
type: Property
comment: Parent order (for order parts)
alternate name: parent_id
domain: Order Restored Event
range: Order

number
type: Property
comment: Order number (may differ from ID)
alternate name: number
sub property of: number
sub property of: orderNumber
domain: Order Restored Event
range: string

order key
type: Property
comment: Order key (for guest checkout links)
alternate name: order_key
sub property of: order key
domain: Order Restored Event
range: string

created via
type: Property
comment: Shows where the order was created. Can only be set during creation.
alternate name: created_via
sub property of: created via
domain: Order Restored Event
range: string

version
type: Property
comment: Version of WooCommerce which last updated the order
alternate name: version
sub property of: version
domain: Order Restored Event
range: string

status
type: Property
comment: Order status
alternate name: status
domain: Order Restored Event
range: string
code list: OrderStatus

currency
type: Property
comment: Currency code (ISO 4217)
alternate name: currency
sub property of: currency
sub property of: priceCurrency
domain: Order Restored Event
range: string

currency symbol
type: Property
comment: Currency symbol
alternate name: currency_symbol
sub property of: currency symbol
domain: Order Restored Event
range: string

date created
type: Property
comment: The date the order was created, in the site's timezone
alternate name: date_created
sub property of: date created
sub property of: orderDate
domain: Order Restored Event
range: dateTime

date created gmt
type: Property
comment: The date the order was created, as GMT
alternate name: date_created_gmt
sub property of: date created gmt
domain: Order Restored Event
range: dateTime

date modified
type: Property
comment: The date the order was last modified, in the site's timezone
alternate name: date_modified
sub property of: date modified
sub property of: dateModified
domain: Order Restored Event
range: dateTime

date modified gmt
type: Property
comment: The date the order was last modified, as GMT
alternate name: date_modified_gmt
sub property of: date modified gmt
domain: Order Restored Event
range: dateTime

discount total
type: Property
comment: Total discount amount
alternate name: discount_total
sub property of: discount total
domain: Order Restored Event
range: string

discount tax
type: Property
comment: Total discount tax
alternate name: discount_tax
sub property of: discount tax
domain: Order Restored Event
range: string

shipping total
type: Property
comment: Total shipping amount
alternate name: shipping_total
sub property of: shipping total
domain: Order Restored Event
range: string

shipping tax
type: Property
comment: Total shipping tax
alternate name: shipping_tax
sub property of: shipping tax
domain: Order Restored Event
range: string

cart tax
type: Property
comment: Sum of line item taxes only
alternate name: cart_tax
sub property of: cart tax
domain: Order Restored Event
range: string

total
type: Property
comment: Grand total
alternate name: total
sub property of: total
sub property of: totalPrice
domain: Order Restored Event
range: string

total tax
type: Property
comment: Sum of all taxes
alternate name: total_tax
sub property of: total tax
domain: Order Restored Event
range: string

prices include tax
type: Property
comment: True if prices included tax during checkout
alternate name: prices_include_tax
sub property of: prices include tax
domain: Order Restored Event
range: boolean

customer
type: Property
comment: Customer who owns the order. 0 for guests.
alternate name: customer_id
sub property of: customer
domain: Order Restored Event
range: Customer

customer ip address
type: Property
comment: Customer's IP address
alternate name: customer_ip_address
sub property of: customer ip address
domain: Order Restored Event
range: string

customer user agent
type: Property
comment: User agent of the customer
alternate name: customer_user_agent
sub property of: customer user agent
domain: Order Restored Event
range: string

customer note
type: Property
comment: Note left by customer during checkout
alternate name: customer_note
domain: Order Restored Event
range: string

billing
type: Property
comment: Billing address
alternate name: billing
sub property of: billing
sub property of: billingAddress
domain: Order Restored Event
range: Billing Address

shipping
type: Property
comment: Shipping address
alternate name: shipping
sub property of: deliveryAddress
domain: Order Restored Event
range: Shipping Address

payment method
type: Property
comment: Payment method ID
alternate name: payment_method
sub property of: payment method
sub property of: paymentMethod
domain: Order Restored Event
range: string

payment method title
type: Property
comment: Payment method title
alternate name: payment_method_title
sub property of: payment method title
domain: Order Restored Event
range: string

transaction id
type: Property
comment: Unique transaction ID
alternate name: transaction_id
sub property of: transaction id
domain: Order Restored Event
range: string

date paid
type: Property
comment: The date the order was paid, in the site's timezone
alternate name: date_paid
sub property of: date paid
domain: Order Restored Event
range: dateTime

date paid gmt
type: Property
comment: The date the order was paid, as GMT
alternate name: date_paid_gmt
sub property of: date paid gmt
domain: Order Restored Event
range: dateTime

date completed
type: Property
comment: The date the order was completed, in the site's timezone
alternate name: date_completed
sub property of: date completed
domain: Order Restored Event
range: dateTime

date completed gmt
type: Property
comment: The date the order was completed, as GMT
alternate name: date_completed_gmt
sub property of: date completed gmt
domain: Order Restored Event
range: dateTime

cart hash
type: Property
comment: MD5 hash of cart items to ensure orders are not modified
alternate name: cart_hash
sub property of: cart hash
domain: Order Restored Event
range: string

line items
type: Property
comment: Line items
alternate name: line_items
sub property of: orderedItem
domain: Order Restored Event
range: Order Line Item

tax lines
type: Property
comment: Tax lines
alternate name: tax_lines
sub property of: tax lines
domain: Order Restored Event
range: Tax Line

shipping lines
type: Property
comment: Shipping lines
alternate name: shipping_lines
domain: Order Restored Event
range: Shipping Line

fee lines
type: Property
comment: Fee lines
alternate name: fee_lines
domain: Order Restored Event
range: Fee Line

coupon lines
type: Property
comment: Coupon lines
alternate name: coupon_lines
domain: Order Restored Event
range: Coupon Line

refunds
type: Property
comment: List of refunds
alternate name: refunds
sub property of: refunds
domain: Order Restored Event
range: Order Refund Line

needs payment
type: Property
comment: Whether order needs payment
alternate name: needs_payment
sub property of: needs payment
domain: Order Restored Event
range: boolean

needs processing
type: Property
comment: Whether order needs processing
alternate name: needs_processing
sub property of: needs processing
domain: Order Restored Event
range: boolean

payment url
type: Property
comment: Payment URL
alternate name: payment_url
sub property of: payment url
domain: Order Restored Event
range: string

is editable
type: Property
comment: Whether order is editable
alternate name: is_editable
sub property of: is editable
domain: Order Restored Event
range: boolean

metadata
type: Property
comment: Meta data
alternate name: meta_data
sub property of: metadata
domain: Order Restored Event
range: Metadata

links
type: Property
comment: HAL links
alternate name: _links
domain: Order Restored Event
range: Links

id
type: Property
comment: Unique identifier for the resource
alternate name: id
domain: Customer Created Event
range: long

date created
type: Property
comment: The date the customer was created, in the site's timezone
alternate name: date_created
sub property of: date created
sub property of: dateCreated
domain: Customer Created Event
range: dateTime

date created gmt
type: Property
comment: The date the customer was created, as GMT
alternate name: date_created_gmt
sub property of: date created gmt
domain: Customer Created Event
range: dateTime

date modified
type: Property
comment: The date the customer was last modified, in the site's timezone
alternate name: date_modified
sub property of: date modified
sub property of: dateModified
domain: Customer Created Event
range: dateTime

date modified gmt
type: Property
comment: The date the customer was last modified, as GMT
alternate name: date_modified_gmt
sub property of: date modified gmt
domain: Customer Created Event
range: dateTime

email
type: Property
comment: The email address for the customer
alternate name: email
sub property of: email
domain: Customer Created Event
range: string

first name
type: Property
comment: Customer first name
alternate name: first_name
sub property of: first name
sub property of: givenName
domain: Customer Created Event
range: string

last name
type: Property
comment: Customer last name
alternate name: last_name
sub property of: last name
sub property of: familyName
domain: Customer Created Event
range: string

role
type: Property
comment: Customer role
alternate name: role
sub property of: role
domain: Customer Created Event
range: string

username
type: Property
comment: Customer login name
alternate name: username
sub property of: username
domain: Customer Created Event
range: string

billing
type: Property
comment: List of billing address data
alternate name: billing
sub property of: billing
sub property of: billingAddress
domain: Customer Created Event
range: Billing Address

shipping
type: Property
comment: List of shipping address data
alternate name: shipping
sub property of: deliveryAddress
domain: Customer Created Event
range: Shipping Address

is paying customer
type: Property
comment: Is the customer a paying customer?
alternate name: is_paying_customer
sub property of: is paying customer
domain: Customer Created Event
range: boolean

avatar url
type: Property
comment: Avatar URL
alternate name: avatar_url
sub property of: avatar url
domain: Customer Created Event
range: string

metadata
type: Property
comment: Meta data
alternate name: meta_data
sub property of: metadata
domain: Customer Created Event
range: Metadata

links
type: Property
comment: HAL links
alternate name: _links
domain: Customer Created Event
range: Links

id
type: Property
comment: Unique identifier for the resource
alternate name: id
domain: Customer Updated Event
range: long

date created
type: Property
comment: The date the customer was created, in the site's timezone
alternate name: date_created
sub property of: date created
sub property of: dateCreated
domain: Customer Updated Event
range: dateTime

date created gmt
type: Property
comment: The date the customer was created, as GMT
alternate name: date_created_gmt
sub property of: date created gmt
domain: Customer Updated Event
range: dateTime

date modified
type: Property
comment: The date the customer was last modified, in the site's timezone
alternate name: date_modified
sub property of: date modified
sub property of: dateModified
domain: Customer Updated Event
range: dateTime

date modified gmt
type: Property
comment: The date the customer was last modified, as GMT
alternate name: date_modified_gmt
sub property of: date modified gmt
domain: Customer Updated Event
range: dateTime

email
type: Property
comment: The email address for the customer
alternate name: email
sub property of: email
domain: Customer Updated Event
range: string

first name
type: Property
comment: Customer first name
alternate name: first_name
sub property of: first name
sub property of: givenName
domain: Customer Updated Event
range: string

last name
type: Property
comment: Customer last name
alternate name: last_name
sub property of: last name
sub property of: familyName
domain: Customer Updated Event
range: string

role
type: Property
comment: Customer role
alternate name: role
sub property of: role
domain: Customer Updated Event
range: string

username
type: Property
comment: Customer login name
alternate name: username
sub property of: username
domain: Customer Updated Event
range: string

billing
type: Property
comment: List of billing address data
alternate name: billing
sub property of: billing
sub property of: billingAddress
domain: Customer Updated Event
range: Billing Address

shipping
type: Property
comment: List of shipping address data
alternate name: shipping
sub property of: deliveryAddress
domain: Customer Updated Event
range: Shipping Address

is paying customer
type: Property
comment: Is the customer a paying customer?
alternate name: is_paying_customer
sub property of: is paying customer
domain: Customer Updated Event
range: boolean

avatar url
type: Property
comment: Avatar URL
alternate name: avatar_url
sub property of: avatar url
domain: Customer Updated Event
range: string

metadata
type: Property
comment: Meta data
alternate name: meta_data
sub property of: metadata
domain: Customer Updated Event
range: Metadata

links
type: Property
comment: HAL links
alternate name: _links
domain: Customer Updated Event
range: Links

id
type: Property
comment: Deleted customer ID
alternate name: id
domain: Customer Deleted Event
range: long

id
type: Property
comment: Coupon ID
alternate name: id
domain: Coupon Created Event
range: long

code
type: Property
comment: Coupon code
alternate name: code
sub property of: code
domain: Coupon Created Event
range: string

amount
type: Property
comment: Discount amount
alternate name: amount
sub property of: amount
domain: Coupon Created Event
range: string

discount type
type: Property
comment: Discount type
alternate name: discount_type
sub property of: discount type
domain: Coupon Created Event
range: string

description
type: Property
comment: Description
alternate name: description
sub property of: description
domain: Coupon Created Event
range: string

date expires
type: Property
comment: Expiry date
alternate name: date_expires
sub property of: date expires
domain: Coupon Created Event
range: dateTime

usage count
type: Property
comment: Usage count
alternate name: usage_count
sub property of: usage count
domain: Coupon Created Event
range: int

usage limit
type: Property
comment: Usage limit
alternate name: usage_limit
sub property of: usage limit
domain: Coupon Created Event
range: int

free shipping
type: Property
comment: Whether free shipping is granted
alternate name: free_shipping
sub property of: free shipping
domain: Coupon Created Event
range: boolean

metadata
type: Property
comment: Metadata
alternate name: meta_data
sub property of: metadata
domain: Coupon Created Event
range: Metadata

id
type: Property
comment: Coupon ID
alternate name: id
domain: Coupon Updated Event
range: long

code
type: Property
comment: Coupon code
alternate name: code
sub property of: code
domain: Coupon Updated Event
range: string

amount
type: Property
comment: Discount amount
alternate name: amount
sub property of: amount
domain: Coupon Updated Event
range: string

discount type
type: Property
comment: Discount type
alternate name: discount_type
sub property of: discount type
domain: Coupon Updated Event
range: string

description
type: Property
comment: Description
alternate name: description
sub property of: description
domain: Coupon Updated Event
range: string

date expires
type: Property
comment: Expiry date
alternate name: date_expires
sub property of: date expires
domain: Coupon Updated Event
range: dateTime

usage count
type: Property
comment: Usage count
alternate name: usage_count
sub property of: usage count
domain: Coupon Updated Event
range: int

usage limit
type: Property
comment: Usage limit
alternate name: usage_limit
sub property of: usage limit
domain: Coupon Updated Event
range: int

free shipping
type: Property
comment: Whether free shipping is granted
alternate name: free_shipping
sub property of: free shipping
domain: Coupon Updated Event
range: boolean

metadata
type: Property
comment: Metadata
alternate name: meta_data
sub property of: metadata
domain: Coupon Updated Event
range: Metadata

id
type: Property
comment: Deleted coupon ID
alternate name: id
domain: Coupon Deleted Event
range: long

status
type: Property
comment: HTTP status code
alternate name: status
domain: Data
range: int

entry
type: Property
domain: Settings Record
range: Settings Entry

key
type: Property
domain: Settings Entry
range: string

value
type: Property
domain: Settings Entry
range: Payment Gateway Setting

entry
type: Property
domain: Settings Record
range: Settings Entry

key
type: Property
domain: Settings Entry
range: string

value
type: Property
domain: Settings Entry
range: string

entry
type: Property
domain: Options Record
range: Options Entry

key
type: Property
domain: Options Entry
range: string

value
type: Property
domain: Options Entry
range: string

entry
type: Property
domain: Reviewer Avatar Urls Record
range: Reviewer Avatar Urls Entry

key
type: Property
domain: Reviewer Avatar Urls Entry
range: string

value
type: Property
domain: Reviewer Avatar Urls Entry
range: string

entry
type: Property
domain: Totals Record
range: Totals Entry

key
type: Property
domain: Totals Entry
range: string

value
type: Property
domain: Totals Entry
range: Sales Report Period

entry
type: Property
domain: Options Record
range: Options Entry

key
type: Property
domain: Options Entry
range: string

value
type: Property
domain: Options Entry
range: string

entry
type: Property
domain: Settings Record
range: Settings Entry

key
type: Property
domain: Settings Entry
range: string

value
type: Property
domain: Settings Entry
range: Shipping Zone Method Setting

entry
type: Property
domain: Options Record
range: Options Entry

key
type: Property
domain: Options Entry
range: string

value
type: Property
domain: Options Entry
range: string

entry
type: Property
domain: Settings Record
range: Settings Entry

key
type: Property
domain: Settings Entry
range: string

value
type: Property
domain: Settings Entry
range: string

entry
type: Property
domain: Database Tables Record
range: Database Tables Entry

key
type: Property
domain: Database Tables Entry
range: string

value
type: Property
domain: Database Tables Entry
range: boolean

entry
type: Property
domain: Taxonomies Record
range: Taxonomies Entry

key
type: Property
domain: Taxonomies Entry
range: string

value
type: Property
domain: Taxonomies Entry
range: string