shapes
type: ShapeGeneration
shape reference chain limit: 5
omitted shape reference count: 10
omitted shape reference:
  reference from: OrderCreatedEventShape
  reference to: OrderLineItemShape
  omitted because: over-long
omitted shape reference:
  reference from: OrderInputShape
  reference to: OrderLineItemInputShape
  omitted because: over-long
omitted shape reference:
  reference from: OrderRestoredEventShape
  reference to: OrderLineItemShape
  omitted because: over-long
omitted shape reference:
  reference from: OrderShape
  reference to: OrderLineItemShape
  omitted because: over-long
omitted shape reference:
  reference from: OrderShape
  reference to: OrderShape
  omitted because: cycle
omitted shape reference:
  reference from: OrderUpdatedEventShape
  reference to: OrderLineItemShape
  omitted because: over-long
omitted shape reference:
  reference from: ProductBrandShape
  reference to: ProductBrandShape
  omitted because: cycle
omitted shape reference:
  reference from: ProductCategoryShape
  reference to: ProductCategoryShape
  omitted because: cycle
omitted shape reference:
  reference from: ProductShape
  reference to: ProductShape
  omitted because: cycle
omitted shape reference:
  reference from: RefundShape
  reference to: OrderLineItemShape
  omitted because: over-long

SelfLinkShape
type: NodeShape
target class: SelfLink
property:
  path: href
  name: href
  description: URL to the resource
  datatype: anyURI
  min count: 1
  max count: 1

CollectionLinkShape
type: NodeShape
target class: CollectionLink
property:
  path: href
  name: href
  description: URL to the collection
  datatype: anyURI
  min count: 1
  max count: 1

LinksShape
type: NodeShape
target class: Links
property:
  path: self
  name: self
  description: Link to this resource
  node: SelfLinkShape
  class: SelfLink
  node kind: BlankNodeOrIRI
property:
  path: collection
  name: collection
  description: Link to the collection
  node: CollectionLinkShape
  class: CollectionLink
  node kind: BlankNodeOrIRI

MetadataShape
type: NodeShape
target class: Metadata
property:
  path: metaIdentifier
  name: meta identifier
  description: Metadata ID
  datatype: long
  max count: 1
property:
  path: key
  name: key
  description: Metadata key
  datatype: string
  min count: 1
  max count: 1
property:
  path: value
  name: value
  description: Metadata value
  datatype: string
  min count: 1
  max count: 1
property:
  path: displayKey
  name: display key
  description: Meta key for UI display
  datatype: string
  max count: 1
property:
  path: displayValue
  name: display value
  description: Meta value for UI display
  datatype: string
  max count: 1

ImageShape
type: NodeShape
target class: Image
property:
  path: imageIdentifier
  name: image identifier
  description: Image ID
  datatype: long
  max count: 1
property:
  path: src
  name: src
  description: Image URL
  datatype: anyURI
  min count: 1
  max count: 1
property:
  path: name
  name: name
  description: Image name
  datatype: string
  max count: 1
property:
  path: alt
  name: alt
  description: Image alt text
  datatype: string
  max count: 1
property:
  path: dateCreated
  name: date created
  description: The date the image was created (in the site's timezone)
  datatype: dateTime
  max count: 1
property:
  path: dateModified
  name: date modified
  description: The date the image was last modified (in the site's timezone)
  datatype: dateTime
  max count: 1

BillingAddressShape
type: NodeShape
target class: BillingAddress
property:
  path: firstName
  name: first name
  description: First name
  datatype: string
  min count: 1
  max count: 1
property:
  path: lastName
  name: last name
  description: Last name
  datatype: string
  min count: 1
  max count: 1
property:
  path: company
  name: company
  description: Company name
  datatype: string
  max count: 1
property:
  path: address1
  name: address1
  description: Address line 1
  datatype: string
  min count: 1
  max count: 1
property:
  path: address2
  name: address2
  description: Address line 2
  datatype: string
  max count: 1
property:
  path: city
  name: city
  description: City
  datatype: string
  min count: 1
  max count: 1
property:
  path: state
  name: state
  description: State/Province code
  datatype: string
  max count: 1
property:
  path: postcode
  name: postcode
  description: Postal/ZIP code
  datatype: string
  min count: 1
  max count: 1
property:
  path: country
  name: country
  description: Country code (ISO 3166-1 alpha-2)
  datatype: string
  min count: 1
  max count: 1
property:
  path: email
  name: email
  description: Email address
  datatype: string
  max count: 1
property:
  path: phone
  name: phone
  description: Phone number
  datatype: string
  max count: 1

ShippingAddressShape
type: NodeShape
target class: ShippingAddress
property:
  path: firstName
  name: first name
  description: First name
  datatype: string
  min count: 1
  max count: 1
property:
  path: lastName
  name: last name
  description: Last name
  datatype: string
  min count: 1
  max count: 1
property:
  path: company
  name: company
  description: Company name
  datatype: string
  max count: 1
property:
  path: address1
  name: address1
  description: Address line 1
  datatype: string
  min count: 1
  max count: 1
property:
  path: address2
  name: address2
  description: Address line 2
  datatype: string
  max count: 1
property:
  path: city
  name: city
  description: City
  datatype: string
  min count: 1
  max count: 1
property:
  path: state
  name: state
  description: State/Province code
  datatype: string
  max count: 1
property:
  path: postcode
  name: postcode
  description: Postal/ZIP code
  datatype: string
  min count: 1
  max count: 1
property:
  path: country
  name: country
  description: Country code (ISO 3166-1 alpha-2)
  datatype: string
  min count: 1
  max count: 1
property:
  path: phone
  name: phone
  description: Phone number
  datatype: string
  max count: 1

ErrorShape
type: NodeShape
target class: Error
property:
  path: code
  name: code
  description: Error code
  datatype: string
  min count: 1
  max count: 1
property:
  path: message
  name: message
  description: Human-readable error message
  datatype: string
  min count: 1
  max count: 1
property:
  path: data
  name: data
  description: Additional error data
  node: dataShape
  class: data
  node kind: BlankNodeOrIRI
  max count: 1

ProductCategoryRefShape
type: NodeShape
target class: ProductCategoryRef
property:
  path: id
  name: id
  description: Category ID
  datatype: long
  min count: 1
  max count: 1
property:
  path: name
  name: name
  description: Category name
  datatype: string
  max count: 1
property:
  path: slug
  name: slug
  description: Category slug
  datatype: string
  max count: 1

ProductTagRefShape
type: NodeShape
target class: ProductTagRef
property:
  path: id
  name: id
  description: Tag ID
  datatype: long
  min count: 1
  max count: 1
property:
  path: name
  name: name
  description: Tag name
  datatype: string
  max count: 1
property:
  path: slug
  name: slug
  description: Tag slug
  datatype: string
  max count: 1

ProductImageShape
type: NodeShape
target class: ProductImage
property:
  path: imageIdentifier
  name: image identifier
  description: Image ID (attachment ID from Media Library)
  datatype: long
  max count: 1
property:
  path: dateCreated
  name: date created
  description: The date the image was created, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateCreatedGmt
  name: date created gmt
  description: The date the image was created, as GMT
  datatype: dateTime
  max count: 1
property:
  path: dateModified
  name: date modified
  description: The date the image was last modified, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateModifiedGmt
  name: date modified gmt
  description: The date the image was last modified, as GMT
  datatype: dateTime
  max count: 1
property:
  path: src
  name: src
  description: Image URL
  datatype: anyURI
  min count: 1
  max count: 1
property:
  path: name
  name: name
  description: Image name
  datatype: string
  max count: 1
property:
  path: alt
  name: alt
  description: Image alternative text
  datatype: string
  max count: 1

ProductAttributeShape
type: NodeShape
target class: ProductAttribute
property:
  path: attributeIdentifier
  name: attribute identifier
  description: Attribute ID (0 for custom product attribute)
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: Attribute name
  datatype: string
  min count: 1
  max count: 1
property:
  path: position
  name: position
  description: Attribute position in list
  datatype: int
  max count: 1
property:
  path: visible
  name: visible
  description: Whether visible on product page
  datatype: boolean
  max count: 1
property:
  path: variation
  name: variation
  description: Whether used for variations
  datatype: boolean
  max count: 1
property:
  path: options
  name: options
  description: List of attribute term values
  datatype: string

DefaultAttributeShape
type: NodeShape
target class: DefaultAttribute
property:
  path: attributeIdentifier
  name: attribute identifier
  description: Attribute ID (0 for custom product attribute)
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: Attribute name
  datatype: string
  min count: 1
  max count: 1
property:
  path: option
  name: option
  description: Selected attribute term
  datatype: string
  min count: 1
  max count: 1

ProductDownloadShape
type: NodeShape
target class: ProductDownload
property:
  path: downloadIdentifier
  name: download identifier
  description: Download ID (MD5 hash)
  datatype: string
  max count: 1
property:
  path: name
  name: name
  description: Download file name
  datatype: string
  min count: 1
  max count: 1
property:
  path: file
  name: file
  description: Download file URL
  datatype: anyURI
  min count: 1
  max count: 1

ProductDimensionsShape
type: NodeShape
target class: ProductDimensions
property:
  path: length
  name: length
  description: Length
  datatype: string
  max count: 1
property:
  path: width
  name: width
  description: Width
  datatype: string
  max count: 1
property:
  path: height
  name: height
  description: Height
  datatype: string
  max count: 1

ProductMetadataShape
type: NodeShape
target class: ProductMetadata
property:
  path: metaIdentifier
  name: meta identifier
  description: Meta ID
  datatype: long
  max count: 1
property:
  path: key
  name: key
  description: Meta key
  datatype: string
  min count: 1
  max count: 1
property:
  path: value
  name: value
  description: Meta value
  datatype: string
  min count: 1
  max count: 1

CategoryImageShape
type: NodeShape
target class: CategoryImage
property:
  path: imageIdentifier
  name: image identifier
  description: Image ID
  datatype: long
  max count: 1
property:
  path: dateCreated
  name: date created
  description: The date the image was created, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateCreatedGmt
  name: date created gmt
  description: The date the image was created, as GMT
  datatype: dateTime
  max count: 1
property:
  path: dateModified
  name: date modified
  description: The date the image was last modified, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateModifiedGmt
  name: date modified gmt
  description: The date the image was last modified, as GMT
  datatype: dateTime
  max count: 1
property:
  path: src
  name: src
  description: Image URL
  datatype: anyURI
  max count: 1
property:
  path: name
  name: name
  description: Image name
  datatype: string
  max count: 1
property:
  path: alt
  name: alt
  description: Image alternative text
  datatype: string
  max count: 1

ProductCategoryShape
type: NodeShape
target class: ProductCategory
property:
  path: id
  name: id
  description: Unique identifier for the resource
  datatype: long
  min count: 1
  max count: 1
property:
  path: name
  name: name
  description: Category name
  datatype: string
  min count: 1
  max count: 1
property:
  path: slug
  name: slug
  description: An alphanumeric identifier for the resource unique to its type
  datatype: string
  max count: 1
property:
  path: parent
  name: parent
  description: The ID for the parent of the resource
  class: ProductCategory
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: description
  name: description
  description: HTML description of the resource
  datatype: string
  max count: 1
property:
  path: display
  name: display
  description: Category archive display type
  datatype: string
  max count: 1
  in: default
  in: products
  in: subcategories
  in: both
property:
  path: image
  name: image
  description: Image data
  node: CategoryImageShape
  class: CategoryImage
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: menuOrder
  name: menu order
  description: Menu order, used to custom sort the resource
  datatype: int
  max count: 1
property:
  path: count
  name: count
  description: Number of published products for the resource
  datatype: int
  max count: 1
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

ProductCategoryInputShape
type: NodeShape
target class: ProductCategoryInput
property:
  path: name
  name: name
  description: Category name
  datatype: string
  min count: 1
  max count: 1
property:
  path: slug
  name: slug
  description: An alphanumeric identifier for the resource unique to its type
  datatype: string
  max count: 1
property:
  path: parent
  name: parent
  description: The ID for the parent of the resource
  node: ProductCategoryShape
  class: ProductCategory
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: description
  name: description
  description: HTML description of the resource
  datatype: string
  max count: 1
property:
  path: display
  name: display
  description: Category archive display type
  datatype: string
  max count: 1
  in: default
  in: products
  in: subcategories
  in: both
property:
  path: image
  name: image
  description: Image data
  node: CategoryImageShape
  class: CategoryImage
  node kind: BlankNodeOrIRI
  max count: 1

ProductTagShape
type: NodeShape
target class: ProductTag
property:
  path: id
  name: id
  description: Unique identifier
  datatype: long
  min count: 1
  max count: 1
property:
  path: name
  name: name
  description: Tag name
  datatype: string
  min count: 1
  max count: 1
property:
  path: slug
  name: slug
  description: URL-friendly slug
  datatype: string
  min count: 1
  max count: 1
property:
  path: description
  name: description
  description: Description
  datatype: string
  max count: 1
property:
  path: count
  name: count
  description: Number of products with this tag
  datatype: int
  max count: 1
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

ProductTagInputShape
type: NodeShape
target class: ProductTagInput
property:
  path: name
  name: name
  description: Tag name
  datatype: string
  min count: 1
  max count: 1
property:
  path: slug
  name: slug
  description: URL-friendly slug
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: Description
  datatype: string
  max count: 1

ProductBrandShape
type: NodeShape
target class: ProductBrand
property:
  path: id
  name: id
  description: Unique identifier for the resource
  datatype: long
  min count: 1
  max count: 1
property:
  path: name
  name: name
  description: Brand name
  datatype: string
  min count: 1
  max count: 1
property:
  path: slug
  name: slug
  description: An alphanumeric identifier for the resource unique to its type
  datatype: string
  max count: 1
property:
  path: parent
  name: parent
  description: The ID for the parent of the resource
  class: ProductBrand
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: description
  name: description
  description: HTML description of the resource
  datatype: string
  max count: 1
property:
  path: display
  name: display
  description: Brand archive display type
  datatype: string
  max count: 1
  in: default
  in: products
  in: subcategories
  in: both
property:
  path: image
  name: image
  description: Image data
  node: CategoryImageShape
  class: CategoryImage
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: menuOrder
  name: menu order
  description: Menu order, used to custom sort the resource
  datatype: int
  max count: 1
property:
  path: count
  name: count
  description: Number of published products for the resource
  datatype: int
  max count: 1
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

ProductBrandInputShape
type: NodeShape
target class: ProductBrandInput
property:
  path: name
  name: name
  description: Brand name
  datatype: string
  min count: 1
  max count: 1
property:
  path: slug
  name: slug
  description: An alphanumeric identifier for the resource unique to its type
  datatype: string
  max count: 1
property:
  path: parent
  name: parent
  description: The ID for the parent of the resource
  node: ProductBrandShape
  class: ProductBrand
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: description
  name: description
  description: HTML description of the resource
  datatype: string
  max count: 1
property:
  path: display
  name: display
  description: Brand archive display type
  datatype: string
  max count: 1
  in: default
  in: products
  in: subcategories
  in: both
property:
  path: image
  name: image
  description: Image data
  node: CategoryImageShape
  class: CategoryImage
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: menuOrder
  name: menu order
  description: Menu order, used to custom sort the resource
  datatype: int
  max count: 1

ProductShape
type: NodeShape
target class: Product
property:
  path: id
  name: id
  description: Unique identifier for the resource
  datatype: long
  min count: 1
  max count: 1
property:
  path: name
  name: name
  description: Product name
  datatype: string
  min count: 1
  max count: 1
property:
  path: slug
  name: slug
  description: URL-friendly slug
  datatype: string
  min count: 1
  max count: 1
property:
  path: permalink
  name: permalink
  description: Product URL
  datatype: anyURI
  max count: 1
property:
  path: dateCreated
  name: date created
  description: The date the product was created, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateCreatedGmt
  name: date created gmt
  description: The date the product was created, as GMT
  datatype: dateTime
  max count: 1
property:
  path: dateModified
  name: date modified
  description: The date the product was last modified, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateModifiedGmt
  name: date modified gmt
  description: The date the product was last modified, as GMT
  datatype: dateTime
  max count: 1
property:
  path: type
  name: type
  description: Product type
  datatype: string
  min count: 1
  max count: 1
  in: simple
  in: grouped
  in: external
  in: variable
property:
  path: status
  name: status
  description: Product status (post status)
  datatype: string
  min count: 1
  max count: 1
  in: publish
  in: draft
  in: pending
  in: private
  in: auto-draft
  in: trash
property:
  path: featured
  name: featured
  description: Featured product
  datatype: boolean
  max count: 1
property:
  path: catalogVisibility
  name: catalog visibility
  description: Catalog visibility
  datatype: string
  max count: 1
  in: visible
  in: catalog
  in: search
  in: hidden
property:
  path: description
  name: description
  description: Product description
  datatype: string
  max count: 1
property:
  path: shortDescription
  name: short description
  description: Product short description
  datatype: string
  max count: 1
property:
  path: sku
  name: sku
  description: Unique identifier (Stock Keeping Unit)
  datatype: string
  max count: 1
property:
  path: globalUniqueId
  name: global unique id
  description: Global product identifier
  datatype: string
  or:
    datatype: string
    pattern: ^\d{8}$|^\d{12,14}$
  or:
    datatype: string
    pattern: ^\d{8}$|^\d{12}$
  or:
    datatype: string
    pattern: ^\d{8}$|^\d{13}$
  or:
    datatype: string
    pattern: ^[\d-]{10,17}$|^\d{9}[\dX]$
  max count: 1
property:
  path: price
  name: price
  description: Current product price
  datatype: string
  max count: 1
property:
  path: regularPrice
  name: regular price
  description: Product regular price
  datatype: string
  max count: 1
property:
  path: salePrice
  name: sale price
  description: Product sale price
  datatype: string
  max count: 1
property:
  path: dateOnSaleFrom
  name: date on sale from
  description: Start date of sale price, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateOnSaleFromGmt
  name: date on sale from gmt
  description: Start date of sale price, as GMT
  datatype: dateTime
  max count: 1
property:
  path: dateOnSaleTo
  name: date on sale to
  description: End date of sale price, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateOnSaleToGmt
  name: date on sale to gmt
  description: End date of sale price, as GMT
  datatype: dateTime
  max count: 1
property:
  path: priceHtml
  name: price html
  description: Price formatted in HTML
  datatype: string
  max count: 1
property:
  path: onSale
  name: on sale
  description: Shows if the product is on sale
  datatype: boolean
  max count: 1
property:
  path: purchasable
  name: purchasable
  description: Shows if the product can be bought
  datatype: boolean
  max count: 1
property:
  path: totalSales
  name: total sales
  description: Amount of sales
  datatype: long
  max count: 1
property:
  path: virtual
  name: virtual
  description: If the product is virtual (no shipping)
  datatype: boolean
  max count: 1

ProductShippingClassShape
type: NodeShape
target class: ProductShippingClass
property:
  path: id
  name: id
  description: Unique identifier for the resource
  datatype: long
  min count: 1
  max count: 1
property:
  path: name
  name: name
  description: Shipping class name
  datatype: string
  min count: 1
  max count: 1
property:
  path: slug
  name: slug
  description: An alphanumeric identifier for the resource unique to its type
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: HTML description of the resource
  datatype: string
  max count: 1
property:
  path: count
  name: count
  description: Number of published products for the resource
  datatype: int
  max count: 1
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

ProductVariationShape
type: NodeShape
target class: ProductVariation
property:
  path: id
  name: id
  description: Unique identifier
  datatype: long
  min count: 1
  max count: 1
property:
  path: dateCreated
  name: date created
  description: The date the variation was created, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateCreatedGmt
  name: date created gmt
  description: The date the variation was created, as GMT
  datatype: dateTime
  max count: 1
property:
  path: dateModified
  name: date modified
  description: The date the variation was last modified, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateModifiedGmt
  name: date modified gmt
  description: The date the variation was last modified, as GMT
  datatype: dateTime
  max count: 1
property:
  path: description
  name: description
  description: Variation description
  datatype: string
  max count: 1
property:
  path: permalink
  name: permalink
  description: Variation URL
  datatype: string
  max count: 1
property:
  path: sku
  name: sku
  description: SKU
  datatype: string
  max count: 1
property:
  path: globalUniqueId
  name: global unique id
  description: Global product identifier
  datatype: string
  or:
    datatype: string
    pattern: ^\d{8}$|^\d{12,14}$
  or:
    datatype: string
    pattern: ^\d{8}$|^\d{12}$
  or:
    datatype: string
    pattern: ^\d{8}$|^\d{13}$
  or:
    datatype: string
    pattern: ^[\d-]{10,17}$|^\d{9}[\dX]$
  max count: 1
property:
  path: price
  name: price
  description: Current price
  datatype: string
  max count: 1
property:
  path: regularPrice
  name: regular price
  description: Regular price
  datatype: string
  max count: 1
property:
  path: salePrice
  name: sale price
  description: Sale price
  datatype: string
  max count: 1
property:
  path: dateOnSaleFrom
  name: date on sale from
  description: Start date of sale price, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateOnSaleFromGmt
  name: date on sale from gmt
  description: Start date of sale price, as GMT
  datatype: dateTime
  max count: 1
property:
  path: dateOnSaleTo
  name: date on sale to
  description: End date of sale price, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateOnSaleToGmt
  name: date on sale to gmt
  description: End date of sale price, as GMT
  datatype: dateTime
  max count: 1
property:
  path: onSale
  name: on sale
  description: Shows if the variation is on sale
  datatype: boolean
  max count: 1
property:
  path: status
  name: status
  description: Variation status
  datatype: string
  max count: 1
  in: publish
  in: draft
  in: pending
  in: private
  in: auto-draft
  in: trash
property:
  path: purchasable
  name: purchasable
  description: Shows if the variation can be bought
  datatype: boolean
  max count: 1
property:
  path: virtual
  name: virtual
  description: If the variation is virtual
  datatype: boolean
  max count: 1
property:
  path: downloadable
  name: downloadable
  description: If the variation is downloadable
  datatype: boolean
  max count: 1
property:
  path: downloads
  name: downloads
  description: List of downloadable files
  node: ProductDownloadShape
  class: ProductDownload
  node kind: BlankNodeOrIRI
property:
  path: downloadLimit
  name: download limit
  description: Number of times downloadable files can be downloaded after purchase
  datatype: int
  max count: 1
property:
  path: downloadExpiry
  name: download expiry
  description: Number of days until access to downloadable files expires
  datatype: int
  max count: 1
property:
  path: taxStatus
  name: tax status
  description: Tax status
  datatype: string
  max count: 1
  in: taxable
  in: shipping
  in: none
property:
  path: taxClass
  name: tax class
  description: Tax class
  datatype: string
  max count: 1
property:
  path: manageStock
  name: manage stock
  description: Stock management at variation level
  max count: 1
  in: true
  in: false
  in: parent
property:
  path: stockQuantity
  name: stock quantity
  description: Stock quantity
  datatype: long
  max count: 1
property:
  path: stockStatus
  name: stock status
  description: Controls the stock status of the variation
  datatype: string
  max count: 1
  in: instock
  in: outofstock
  in: onbackorder

ProductInputShape
type: NodeShape
target class: ProductInput
property:
  path: name
  name: name
  description: Product name
  datatype: string
  min count: 1
  max count: 1
property:
  path: slug
  name: slug
  description: URL-friendly slug
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: Product type
  datatype: string
  max count: 1
  in: simple
  in: grouped
  in: external
  in: variable
property:
  path: status
  name: status
  description: Product status
  datatype: string
  max count: 1
  in: publish
  in: draft
  in: pending
  in: private
  in: auto-draft
  in: trash
property:
  path: featured
  name: featured
  description: Featured product
  datatype: boolean
  max count: 1
property:
  path: catalogVisibility
  name: catalog visibility
  description: Catalog visibility
  datatype: string
  max count: 1
  in: visible
  in: catalog
  in: search
  in: hidden
property:
  path: description
  name: description
  description: Product description
  datatype: string
  max count: 1
property:
  path: shortDescription
  name: short description
  description: Product short description
  datatype: string
  max count: 1
property:
  path: sku
  name: sku
  description: SKU
  datatype: string
  max count: 1
property:
  path: globalUniqueId
  name: global unique id
  description: Global product identifier
  datatype: string
  or:
    datatype: string
    pattern: ^\d{8}$|^\d{12,14}$
  or:
    datatype: string
    pattern: ^\d{8}$|^\d{12}$
  or:
    datatype: string
    pattern: ^\d{8}$|^\d{13}$
  or:
    datatype: string
    pattern: ^[\d-]{10,17}$|^\d{9}[\dX]$
  max count: 1
property:
  path: regularPrice
  name: regular price
  description: Product regular price
  datatype: string
  max count: 1
property:
  path: salePrice
  name: sale price
  description: Product sale price
  datatype: string
  max count: 1
property:
  path: dateOnSaleFrom
  name: date on sale from
  description: Start date of sale price, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateOnSaleFromGmt
  name: date on sale from gmt
  description: Start date of sale price, as GMT
  datatype: dateTime
  max count: 1
property:
  path: dateOnSaleTo
  name: date on sale to
  description: End date of sale price, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateOnSaleToGmt
  name: date on sale to gmt
  description: End date of sale price, as GMT
  datatype: dateTime
  max count: 1
property:
  path: virtual
  name: virtual
  description: If the product is virtual
  datatype: boolean
  max count: 1
property:
  path: downloadable
  name: downloadable
  description: If the product is downloadable
  datatype: boolean
  max count: 1
property:
  path: downloads
  name: downloads
  description: List of downloadable files
  node: ProductDownloadShape
  class: ProductDownload
  node kind: BlankNodeOrIRI
property:
  path: downloadLimit
  name: download limit
  description: Download limit
  datatype: int
  max count: 1
property:
  path: downloadExpiry
  name: download expiry
  description: Download expiry in days
  datatype: int
  max count: 1
property:
  path: externalUrl
  name: external url
  description: Product external URL
  datatype: string
  max count: 1
property:
  path: buttonText
  name: button text
  description: Product external button text
  datatype: string
  max count: 1
property:
  path: taxStatus
  name: tax status
  description: Tax status
  datatype: string
  max count: 1
  in: taxable
  in: shipping
  in: none
property:
  path: taxClass
  name: tax class
  description: Tax class
  datatype: string
  max count: 1
property:
  path: manageStock
  name: manage stock
  description: Whether to manage stock
  datatype: boolean
  max count: 1
property:
  path: stockQuantity
  name: stock quantity
  description: Stock quantity
  datatype: long
  max count: 1
property:
  path: stockStatus
  name: stock status
  description: Stock status
  datatype: string
  max count: 1
  in: instock
  in: outofstock
  in: onbackorder

ProductVariationInputShape
type: NodeShape
target class: ProductVariationInput
property:
  path: description
  name: description
  description: Description
  datatype: string
  max count: 1
property:
  path: sku
  name: sku
  description: SKU
  datatype: string
  max count: 1
property:
  path: globalUniqueId
  name: global unique id
  description: Global product identifier
  datatype: string
  or:
    datatype: string
    pattern: ^\d{8}$|^\d{12,14}$
  or:
    datatype: string
    pattern: ^\d{8}$|^\d{12}$
  or:
    datatype: string
    pattern: ^\d{8}$|^\d{13}$
  or:
    datatype: string
    pattern: ^[\d-]{10,17}$|^\d{9}[\dX]$
  max count: 1
property:
  path: regularPrice
  name: regular price
  description: Regular price
  datatype: string
  max count: 1
property:
  path: salePrice
  name: sale price
  description: Sale price
  datatype: string
  max count: 1
property:
  path: dateOnSaleFrom
  name: date on sale from
  description: Start date of sale price, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateOnSaleFromGmt
  name: date on sale from gmt
  description: Start date of sale price, as GMT
  datatype: dateTime
  max count: 1
property:
  path: dateOnSaleTo
  name: date on sale to
  description: End date of sale price, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateOnSaleToGmt
  name: date on sale to gmt
  description: End date of sale price, as GMT
  datatype: dateTime
  max count: 1
property:
  path: status
  name: status
  description: Variation status
  datatype: string
  max count: 1
  in: publish
  in: draft
  in: pending
  in: private
  in: auto-draft
  in: trash
property:
  path: virtual
  name: virtual
  description: If the variation is virtual
  datatype: boolean
  max count: 1
property:
  path: downloadable
  name: downloadable
  description: If the variation is downloadable
  datatype: boolean
  max count: 1
property:
  path: downloads
  name: downloads
  description: List of downloadable files
  node: ProductDownloadShape
  class: ProductDownload
  node kind: BlankNodeOrIRI
property:
  path: downloadLimit
  name: download limit
  description: Download limit
  datatype: int
  max count: 1
property:
  path: downloadExpiry
  name: download expiry
  description: Download expiry in days
  datatype: int
  max count: 1
property:
  path: taxStatus
  name: tax status
  description: Tax status
  datatype: string
  max count: 1
  in: taxable
  in: shipping
  in: none
property:
  path: taxClass
  name: tax class
  description: Tax class
  datatype: string
  max count: 1
property:
  path: manageStock
  name: manage stock
  description: Stock management setting
  max count: 1
  in: true
  in: false
  in: parent
property:
  path: stockQuantity
  name: stock quantity
  description: Stock quantity
  datatype: long
  max count: 1
property:
  path: stockStatus
  name: stock status
  description: Stock status
  datatype: string
  max count: 1
  in: instock
  in: outofstock
  in: onbackorder
property:
  path: backorders
  name: backorders
  description: Backorder status
  datatype: string
  max count: 1
  in: no
  in: notify
  in: yes
property:
  path: weight
  name: weight
  description: Variation weight
  datatype: string
  max count: 1
property:
  path: dimensions
  name: dimensions
  description: Variation dimensions
  node: ProductDimensionsShape
  class: ProductDimensions
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: shippingClass
  name: shipping class
  description: Shipping class slug
  datatype: string
  max count: 1
property:
  path: image
  name: image
  description: Variation image
  node: ProductImageShape
  class: ProductImage
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: attributes
  name: attributes
  description: List of variation attributes
  node: DefaultAttributeShape
  class: DefaultAttribute
  node kind: BlankNodeOrIRI
property:
  path: menuOrder
  name: menu order
  description: Menu order
  datatype: int
  max count: 1
property:
  path: metaData
  name: meta data
  description: Meta data
  node: ProductMetadataShape
  class: ProductMetadata
  node kind: BlankNodeOrIRI

ProductAttributeTaxonomyShape
type: NodeShape
target class: ProductAttributeTaxonomy
property:
  path: id
  name: id
  description: Unique identifier
  datatype: long
  min count: 1
  max count: 1
property:
  path: name
  name: name
  description: Attribute name
  datatype: string
  min count: 1
  max count: 1
property:
  path: slug
  name: slug
  description: Attribute slug
  datatype: string
  min count: 1
  max count: 1
property:
  path: type
  name: type
  description: Attribute type
  datatype: string
  max count: 1
property:
  path: orderBy
  name: order by
  description: Default sort order. Options: menu_order, name, name_num and id. Default is menu_order.
  datatype: string
  max count: 1
  in: menu_order
  in: name
  in: name_num
  in: id
property:
  path: hasArchives
  name: has archives
  description: Whether attribute has archives
  datatype: boolean
  max count: 1
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

ProductAttributeTermShape
type: NodeShape
target class: ProductAttributeTerm
property:
  path: id
  name: id
  description: Unique identifier
  datatype: long
  min count: 1
  max count: 1
property:
  path: name
  name: name
  description: Term name
  datatype: string
  min count: 1
  max count: 1
property:
  path: slug
  name: slug
  description: Term slug
  datatype: string
  min count: 1
  max count: 1
property:
  path: description
  name: description
  description: Term description
  datatype: string
  max count: 1
property:
  path: menuOrder
  name: menu order
  description: Menu order
  datatype: int
  max count: 1
property:
  path: count
  name: count
  description: Number of products with this term
  datatype: int
  max count: 1
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

OrderLineItemShape
type: NodeShape
target class: OrderLineItem
property:
  path: id
  name: id
  description: Line item ID
  datatype: long
  min count: 1
  max count: 1
property:
  path: name
  name: name
  description: Product name
  datatype: string
  min count: 1
  max count: 1
property:
  path: product
  name: product
  description: Product
  node: ProductShape
  class: Product
  node kind: BlankNodeOrIRI
  min count: 1
  max count: 1
property:
  path: variation
  name: variation
  description: Variation (0 if not a variation)
  node: ProductVariationShape
  class: ProductVariation
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: quantity
  name: quantity
  description: Quantity ordered
  datatype: int
  min count: 1
  max count: 1
property:
  path: taxClass
  name: tax class
  description: Tax class
  datatype: string
  max count: 1
property:
  path: subtotal
  name: subtotal
  description: Line subtotal (before discounts)
  datatype: string
  max count: 1
property:
  path: subtotalTax
  name: subtotal tax
  description: Line subtotal tax
  datatype: string
  max count: 1
property:
  path: total
  name: total
  description: Line total (after discounts)
  datatype: string
  max count: 1
property:
  path: totalTax
  name: total tax
  description: Line total tax
  datatype: string
  max count: 1
property:
  path: taxes
  name: taxes
  description: Line taxes
  node: OrderItemTaxShape
  class: OrderItemTax
  node kind: BlankNodeOrIRI
property:
  path: metadata
  name: metadata
  description: Meta data
  node: MetadataShape
  class: Metadata
  node kind: BlankNodeOrIRI
property:
  path: sku
  name: sku
  description: Product SKU
  datatype: string
  max count: 1
property:
  path: price
  name: price
  description: Product price
  datatype: string
  max count: 1
property:
  path: image
  name: image
  description: Product image
  node: ImageShape
  class: Image
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: parentName
  name: parent name
  description: Parent product name if the product is a variation
  datatype: string
  max count: 1
property:
  path: globalUniqueId
  name: global unique id
  description: GTIN, UPC, EAN, or ISBN - global product identifier
  datatype: string
  max count: 1

OrderItemTaxShape
type: NodeShape
target class: OrderItemTax
property:
  path: taxRateIdentifier
  name: tax rate identifier
  description: Tax rate ID
  datatype: long
  min count: 1
  max count: 1
property:
  path: total
  name: total
  description: Tax total
  datatype: string
  max count: 1
property:
  path: subtotal
  name: subtotal
  description: Tax subtotal
  datatype: string
  max count: 1

OrderLineItemInputShape
type: NodeShape
target class: OrderLineItemInput
property:
  path: itemIdentifier
  name: item identifier
  description: Line item ID (for updates)
  datatype: long
  max count: 1
property:
  path: product
  name: product
  description: Product
  node: ProductShape
  class: Product
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: variation
  name: variation
  description: Variation
  node: ProductVariationShape
  class: ProductVariation
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: quantity
  name: quantity
  description: Quantity
  datatype: int
  max count: 1
property:
  path: taxClass
  name: tax class
  description: Tax class
  datatype: string
  max count: 1
property:
  path: subtotal
  name: subtotal
  description: Line subtotal
  datatype: string
  max count: 1
property:
  path: total
  name: total
  description: Line total
  datatype: string
  max count: 1
property:
  path: metadata
  name: metadata
  description: Meta data
  node: MetadataShape
  class: Metadata
  node kind: BlankNodeOrIRI

ShippingLineShape
type: NodeShape
target class: ShippingLine
property:
  path: id
  name: id
  description: Shipping line ID
  datatype: long
  min count: 1
  max count: 1
property:
  path: methodTitle
  name: method title
  description: Shipping method title
  datatype: string
  min count: 1
  max count: 1
property:
  path: methodId
  name: method id
  description: Shipping method ID
  datatype: string
  min count: 1
  max count: 1
property:
  path: instanceId
  name: instance id
  description: Shipping instance ID
  datatype: string
  max count: 1
property:
  path: total
  name: total
  description: Shipping total
  datatype: string
  max count: 1
property:
  path: totalTax
  name: total tax
  description: Shipping total tax
  datatype: string
  max count: 1
property:
  path: taxes
  name: taxes
  description: Shipping taxes
  node: OrderItemTaxShape
  class: OrderItemTax
  node kind: BlankNodeOrIRI
property:
  path: metadata
  name: metadata
  description: Meta data
  node: MetadataShape
  class: Metadata
  node kind: BlankNodeOrIRI

ShippingLineInputShape
type: NodeShape
target class: ShippingLineInput
property:
  path: itemIdentifier
  name: item identifier
  description: Shipping line ID (for updates)
  datatype: long
  max count: 1
property:
  path: methodTitle
  name: method title
  description: Shipping method title
  datatype: string
  max count: 1
property:
  path: methodId
  name: method id
  description: Shipping method ID
  datatype: string
  max count: 1
property:
  path: total
  name: total
  description: Shipping total
  datatype: string
  max count: 1
property:
  path: metadata
  name: metadata
  description: Meta data
  node: MetadataShape
  class: Metadata
  node kind: BlankNodeOrIRI

TaxLineShape
type: NodeShape
target class: TaxLine
property:
  path: id
  name: id
  description: Tax line ID
  datatype: long
  min count: 1
  max count: 1
property:
  path: rateCode
  name: rate code
  description: Tax rate code
  datatype: string
  max count: 1
property:
  path: rate
  name: rate
  description: Tax rate
  node: TaxRateShape
  class: TaxRate
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: label
  name: label
  description: Tax rate label
  datatype: string
  max count: 1
property:
  path: compound
  name: compound
  description: Whether compound tax
  datatype: boolean
  max count: 1
property:
  path: taxTotal
  name: tax total
  description: Tax total
  datatype: string
  max count: 1
property:
  path: shippingTaxTotal
  name: shipping tax total
  description: Shipping tax total
  datatype: string
  max count: 1
property:
  path: ratePercent
  name: rate percent
  description: Tax rate percentage
  datatype: double
  max count: 1
property:
  path: metadata
  name: metadata
  description: Metadata
  node: MetadataShape
  class: Metadata
  node kind: BlankNodeOrIRI

TaxRateShape
type: NodeShape
target class: TaxRate
property:
  path: id
  name: id
  description: Unique identifier for the resource
  datatype: long
  min count: 1
  max count: 1
property:
  path: country
  name: country
  description: Country ISO 3166 code
  datatype: string
  max count: 1
property:
  path: state
  name: state
  description: State code
  datatype: string
  max count: 1
property:
  path: postcode
  name: postcode
  description: Postcode/ZIP. Deprecated: use postcodes instead
  datatype: string
  max count: 1
property:
  path: city
  name: city
  description: City name. Deprecated: use cities instead
  datatype: string
  max count: 1
property:
  path: postcodes
  name: postcodes
  description: Postcodes/ZIPs
  datatype: string
property:
  path: cities
  name: cities
  description: City names
  datatype: string
property:
  path: rate
  name: rate
  description: Tax rate
  datatype: string
  max count: 1
property:
  path: name
  name: name
  description: Tax rate name
  datatype: string
  max count: 1
property:
  path: priority
  name: priority
  description: Tax priority. Only 1 matching rate per priority will be used. Default is 1.
  datatype: int
  max count: 1
property:
  path: compound
  name: compound
  description: Whether this is a compound tax rate. Compound rates are applied on top of other tax rates. Default is false.
  datatype: boolean
  max count: 1
property:
  path: shipping
  name: shipping
  description: Whether this tax rate also gets applied to shipping. Default is true.
  datatype: boolean
  max count: 1
property:
  path: order
  name: order
  description: Indicates the order that will appear in queries
  datatype: int
  max count: 1
property:
  path: taxClass
  name: tax class
  description: Tax class. Default is 'standard'.
  datatype: string
  max count: 1
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

FeeLineShape
type: NodeShape
target class: FeeLine
property:
  path: id
  name: id
  description: Fee line ID
  datatype: long
  min count: 1
  max count: 1
property:
  path: name
  name: name
  description: Fee name
  datatype: string
  min count: 1
  max count: 1
property:
  path: taxClass
  name: tax class
  description: Tax class
  datatype: string
  max count: 1
property:
  path: taxStatus
  name: tax status
  description: Tax status
  datatype: string
  max count: 1
  in: taxable
  in: shipping
  in: none
property:
  path: amount
  name: amount
  description: Fee amount
  datatype: string
  max count: 1
property:
  path: total
  name: total
  description: Fee total
  datatype: string
  max count: 1
property:
  path: totalTax
  name: total tax
  description: Fee total tax
  datatype: string
  max count: 1
property:
  path: taxes
  name: taxes
  description: Fee taxes
  node: OrderItemTaxShape
  class: OrderItemTax
  node kind: BlankNodeOrIRI
property:
  path: metadata
  name: metadata
  description: Meta data
  node: MetadataShape
  class: Metadata
  node kind: BlankNodeOrIRI

FeeLineInputShape
type: NodeShape
target class: FeeLineInput
property:
  path: itemIdentifier
  name: item identifier
  description: Fee line ID (for updates)
  datatype: long
  max count: 1
property:
  path: name
  name: name
  description: Fee name
  datatype: string
  max count: 1
property:
  path: taxClass
  name: tax class
  description: Tax class
  datatype: string
  max count: 1
property:
  path: taxStatus
  name: tax status
  description: Tax status
  datatype: string
  max count: 1
  in: taxable
  in: shipping
  in: none
property:
  path: total
  name: total
  description: Fee total
  datatype: string
  max count: 1
property:
  path: metadata
  name: metadata
  description: Meta data
  node: MetadataShape
  class: Metadata
  node kind: BlankNodeOrIRI

CouponLineShape
type: NodeShape
target class: CouponLine
property:
  path: id
  name: id
  description: Coupon line ID
  datatype: long
  min count: 1
  max count: 1
property:
  path: code
  name: code
  description: Coupon code
  datatype: string
  min count: 1
  max count: 1
property:
  path: discount
  name: discount
  description: Discount amount
  datatype: string
  max count: 1
property:
  path: discountTax
  name: discount tax
  description: Discount tax amount
  datatype: string
  max count: 1
property:
  path: discountType
  name: discount type
  description: Type of discount (percent, fixed_cart, etc.)
  datatype: string
  max count: 1
property:
  path: freeShipping
  name: free shipping
  description: Whether coupon grants free shipping
  datatype: boolean
  max count: 1
property:
  path: nominalAmount
  name: nominal amount
  description: Original coupon value before calculation (e.g., 10 for 10% off or $10 off)
  datatype: double
  max count: 1
property:
  path: metadata
  name: metadata
  description: Meta data
  node: MetadataShape
  class: Metadata
  node kind: BlankNodeOrIRI

CouponLineInputShape
type: NodeShape
target class: CouponLineInput
property:
  path: itemIdentifier
  name: item identifier
  description: Coupon line ID (for updates)
  datatype: long
  max count: 1
property:
  path: code
  name: code
  description: Coupon code
  datatype: string
  max count: 1
property:
  path: metadata
  name: metadata
  description: Meta data
  node: MetadataShape
  class: Metadata
  node kind: BlankNodeOrIRI

OrderRefundLineShape
type: NodeShape
target class: OrderRefundLine
property:
  path: id
  name: id
  description: Refund ID
  datatype: long
  min count: 1
  max count: 1
property:
  path: reason
  name: reason
  description: Refund reason
  datatype: string
  max count: 1
property:
  path: total
  name: total
  description: Refund total
  datatype: string
  max count: 1

RefundShape
type: NodeShape
target class: Refund
property:
  path: id
  name: id
  description: Refund ID
  datatype: long
  min count: 1
  max count: 1
property:
  path: parent
  name: parent
  description: The order the refund is associated with. Only present in standalone refunds endpoint.
  node: OrderShape
  class: Order
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: dateCreated
  name: date created
  description: The date the refund was created, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateCreatedGmt
  name: date created gmt
  description: The date the refund was created, as GMT
  datatype: dateTime
  max count: 1
property:
  path: amount
  name: amount
  description: Total refund amount. If provided, takes precedence over line item totals.
  datatype: string
  max count: 1
property:
  path: reason
  name: reason
  description: Refund reason
  datatype: string
  max count: 1
property:
  path: refundedBy
  name: refunded by
  description: User ID who performed the refund
  node: CustomerShape
  class: Customer
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: refundedPayment
  name: refunded payment
  description: Whether the payment was refunded via the API. See api_refund.
  datatype: boolean
  max count: 1
property:
  path: metadata
  name: metadata
  description: Meta data
  node: MetadataShape
  class: Metadata
  node kind: BlankNodeOrIRI
property:
  path: lineItems
  name: line items
  description: Refund line items
  class: OrderLineItem
  node kind: BlankNodeOrIRI
property:
  path: taxLines
  name: tax lines
  description: Tax lines data
  node: TaxLineShape
  class: TaxLine
  node kind: BlankNodeOrIRI
property:
  path: shippingLines
  name: shipping lines
  description: Shipping lines data
  node: ShippingLineShape
  class: ShippingLine
  node kind: BlankNodeOrIRI
property:
  path: feeLines
  name: fee lines
  description: Fee lines data
  node: FeeLineShape
  class: FeeLine
  node kind: BlankNodeOrIRI
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

OrderShape
type: NodeShape
target class: Order
property:
  path: id
  name: id
  description: Unique identifier
  datatype: long
  min count: 1
  max count: 1
property:
  path: parent
  name: parent
  description: Parent order (for order parts)
  class: Order
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: number
  name: number
  description: Order number (may differ from ID)
  datatype: string
  max count: 1
property:
  path: orderKey
  name: order key
  description: Order key (for guest checkout links)
  datatype: string
  max count: 1
property:
  path: createdVia
  name: created via
  description: Shows where the order was created. Can only be set during creation.
  datatype: string
  max count: 1
property:
  path: version
  name: version
  description: Version of WooCommerce which last updated the order
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Order status
  datatype: string
  min count: 1
  max count: 1
  in: pending
  in: processing
  in: on-hold
  in: completed
  in: cancelled
  in: refunded
  in: failed
  in: trash
  in: auto-draft
  in: checkout-draft
property:
  path: currency
  name: currency
  description: Currency code (ISO 4217)
  datatype: string
  min count: 1
  max count: 1
property:
  path: currencySymbol
  name: currency symbol
  description: Currency symbol
  datatype: string
  max count: 1
property:
  path: dateCreated
  name: date created
  description: The date the order was created, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateCreatedGmt
  name: date created gmt
  description: The date the order was created, as GMT
  datatype: dateTime
  max count: 1
property:
  path: dateModified
  name: date modified
  description: The date the order was last modified, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateModifiedGmt
  name: date modified gmt
  description: The date the order was last modified, as GMT
  datatype: dateTime
  max count: 1
property:
  path: discountTotal
  name: discount total
  description: Total discount amount
  datatype: string
  max count: 1
property:
  path: discountTax
  name: discount tax
  description: Total discount tax
  datatype: string
  max count: 1
property:
  path: shippingTotal
  name: shipping total
  description: Total shipping amount
  datatype: string
  max count: 1
property:
  path: shippingTax
  name: shipping tax
  description: Total shipping tax
  datatype: string
  max count: 1
property:
  path: cartTax
  name: cart tax
  description: Sum of line item taxes only
  datatype: string
  max count: 1
property:
  path: total
  name: total
  description: Grand total
  datatype: string
  max count: 1
property:
  path: totalTax
  name: total tax
  description: Sum of all taxes
  datatype: string
  max count: 1
property:
  path: pricesIncludeTax
  name: prices include tax
  description: True if prices included tax during checkout
  datatype: boolean
  max count: 1
property:
  path: customer
  name: customer
  description: Customer who owns the order. 0 for guests.
  node: CustomerShape
  class: Customer
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: customerIpAddress
  name: customer ip address
  description: Customer's IP address
  datatype: string
  max count: 1
property:
  path: customerUserAgent
  name: customer user agent
  description: User agent of the customer
  datatype: string
  max count: 1
property:
  path: customerNote
  name: customer note
  description: Note left by customer during checkout
  datatype: string
  max count: 1
property:
  path: billing
  name: billing
  description: Billing address
  node: BillingAddressShape
  class: BillingAddress
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: shipping
  name: shipping
  description: Shipping address
  node: ShippingAddressShape
  class: ShippingAddress
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: paymentMethod
  name: payment method
  description: Payment method ID
  datatype: string
  max count: 1
property:
  path: paymentMethodTitle
  name: payment method title
  description: Payment method title
  datatype: string
  max count: 1
property:
  path: transactionId
  name: transaction id
  description: Unique transaction ID
  datatype: string
  max count: 1

CustomerShape
type: NodeShape
target class: Customer
property:
  path: id
  name: id
  description: Unique identifier for the resource
  datatype: long
  min count: 1
  max count: 1
property:
  path: dateCreated
  name: date created
  description: The date the customer was created, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateCreatedGmt
  name: date created gmt
  description: The date the customer was created, as GMT
  datatype: dateTime
  max count: 1
property:
  path: dateModified
  name: date modified
  description: The date the customer was last modified, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateModifiedGmt
  name: date modified gmt
  description: The date the customer was last modified, as GMT
  datatype: dateTime
  max count: 1
property:
  path: email
  name: email
  description: The email address for the customer
  datatype: string
  min count: 1
  max count: 1
property:
  path: firstName
  name: first name
  description: Customer first name
  datatype: string
  max count: 1
property:
  path: lastName
  name: last name
  description: Customer last name
  datatype: string
  max count: 1
property:
  path: role
  name: role
  description: Customer role
  datatype: string
  max count: 1
property:
  path: username
  name: username
  description: Customer login name
  datatype: string
  max count: 1
property:
  path: billing
  name: billing
  description: List of billing address data
  node: BillingAddressShape
  class: BillingAddress
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: shipping
  name: shipping
  description: List of shipping address data
  node: ShippingAddressShape
  class: ShippingAddress
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: isPayingCustomer
  name: is paying customer
  description: Is the customer a paying customer?
  datatype: boolean
  max count: 1
property:
  path: avatarUrl
  name: avatar url
  description: Avatar URL
  datatype: string
  max count: 1
property:
  path: metadata
  name: metadata
  description: Meta data
  node: MetadataShape
  class: Metadata
  node kind: BlankNodeOrIRI
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

RefundInputShape
type: NodeShape
target class: RefundInput
property:
  path: amount
  name: amount
  description: Total refund amount. If provided, takes precedence over line item totals.
  datatype: string
  max count: 1
property:
  path: reason
  name: reason
  description: Refund reason
  datatype: string
  max count: 1
property:
  path: refundedBy
  name: refunded by
  description: User ID who performed the refund
  node: CustomerShape
  class: Customer
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: metadata
  name: metadata
  description: Meta data
  node: MetadataShape
  class: Metadata
  node kind: BlankNodeOrIRI
property:
  path: lineItems
  name: line items
  description: Line items to refund
  node: RefundLineItemInputShape
  class: RefundLineItemInput
  node kind: BlankNodeOrIRI
property:
  path: shippingLines
  name: shipping lines
  description: Shipping lines data
  node: ShippingLineInputShape
  class: ShippingLineInput
  node kind: BlankNodeOrIRI
property:
  path: feeLines
  name: fee lines
  description: Fee lines data
  node: FeeLineInputShape
  class: FeeLineInput
  node kind: BlankNodeOrIRI
property:
  path: apiRefund
  name: api refund
  description: When true, the payment gateway API is used to generate the refund. Default is true.
  datatype: boolean
  max count: 1
property:
  path: apiRestock
  name: api restock
  description: When true, the selected line items are restocked. Default is true.
  datatype: boolean
  max count: 1

RefundLineItemInputShape
type: NodeShape
target class: RefundLineItemInput
property:
  path: lineItemIdentifier
  name: line item identifier
  description: Line item ID
  datatype: long
  min count: 1
  max count: 1
property:
  path: quantity
  name: quantity
  description: Quantity to refund
  datatype: int
  max count: 1
property:
  path: refundTotal
  name: refund total
  description: Refund total for this item
  datatype: string
  max count: 1
property:
  path: refundTax
  name: refund tax
  description: Refund tax totals
  node: RefundTaxInputShape
  class: RefundTaxInput
  node kind: BlankNodeOrIRI

RefundTaxInputShape
type: NodeShape
target class: RefundTaxInput
property:
  path: taxRateIdentifier
  name: tax rate identifier
  description: Tax rate ID
  datatype: long
  min count: 1
  max count: 1
property:
  path: refundTotal
  name: refund total
  description: Refund amount
  datatype: string
  max count: 1

OrderNoteShape
type: NodeShape
target class: OrderNote
property:
  path: id
  name: id
  description: Note ID
  datatype: long
  min count: 1
  max count: 1
property:
  path: author
  name: author
  description: Note author
  datatype: string
  max count: 1
property:
  path: dateCreated
  name: date created
  description: The date the note was created, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateCreatedGmt
  name: date created gmt
  description: The date the note was created, as GMT
  datatype: dateTime
  max count: 1
property:
  path: note
  name: note
  description: Note content
  datatype: string
  min count: 1
  max count: 1
property:
  path: customerNote
  name: customer note
  description: Whether note is for customer (visible to customer). Default is false.
  datatype: boolean
  max count: 1
property:
  path: addedByUser
  name: added by user
  description: Whether added by user (not system). Default is false.
  datatype: boolean
  max count: 1
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

OrderNoteInputShape
type: NodeShape
target class: OrderNoteInput
property:
  path: note
  name: note
  description: Note content
  datatype: string
  min count: 1
  max count: 1
property:
  path: customerNote
  name: customer note
  description: Whether note is for customer
  datatype: boolean
  max count: 1
property:
  path: addedByUser
  name: added by user
  description: Whether added by user (not system)
  datatype: boolean
  max count: 1

OrderInputShape
type: NodeShape
target class: OrderInput
property:
  path: parent
  name: parent
  description: Parent order ID
  node: OrderShape
  class: Order
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: status
  name: status
  description: Order status
  datatype: string
  max count: 1
  in: pending
  in: processing
  in: on-hold
  in: completed
  in: cancelled
  in: refunded
  in: failed
  in: trash
  in: auto-draft
  in: checkout-draft
property:
  path: currency
  name: currency
  description: Currency code
  datatype: string
  max count: 1
property:
  path: customer
  name: customer
  description: Customer ID
  node: CustomerShape
  class: Customer
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: customerNote
  name: customer note
  description: Customer note
  datatype: string
  max count: 1
property:
  path: billing
  name: billing
  description: Billing address
  node: BillingAddressShape
  class: BillingAddress
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: shipping
  name: shipping
  description: Shipping address
  node: ShippingAddressShape
  class: ShippingAddress
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: paymentMethod
  name: payment method
  description: Payment method ID
  datatype: string
  max count: 1
property:
  path: paymentMethodTitle
  name: payment method title
  description: Payment method title
  datatype: string
  max count: 1
property:
  path: transactionId
  name: transaction id
  description: Transaction ID
  datatype: string
  max count: 1
property:
  path: lineItems
  name: line items
  description: Line items
  class: OrderLineItemInput
  node kind: BlankNodeOrIRI
property:
  path: shippingLines
  name: shipping lines
  description: Shipping lines
  node: ShippingLineInputShape
  class: ShippingLineInput
  node kind: BlankNodeOrIRI
property:
  path: feeLines
  name: fee lines
  description: Fee lines
  node: FeeLineInputShape
  class: FeeLineInput
  node kind: BlankNodeOrIRI
property:
  path: couponLines
  name: coupon lines
  description: Coupon lines
  node: CouponLineInputShape
  class: CouponLineInput
  node kind: BlankNodeOrIRI
property:
  path: setPaid
  name: set paid
  description: Define if the order is paid. Will set status to processing and reduce stock.
  datatype: boolean
  max count: 1
property:
  path: metadata
  name: metadata
  description: Meta data
  node: MetadataShape
  class: Metadata
  node kind: BlankNodeOrIRI

CustomerInputShape
type: NodeShape
target class: CustomerInput
property:
  path: email
  name: email
  description: The email address for the customer
  datatype: string
  min count: 1
  max count: 1
property:
  path: firstName
  name: first name
  description: Customer first name
  datatype: string
  max count: 1
property:
  path: lastName
  name: last name
  description: Customer last name
  datatype: string
  max count: 1
property:
  path: username
  name: username
  description: Customer login name
  datatype: string
  max count: 1
property:
  path: password
  name: password
  description: Customer password
  datatype: string
  max count: 1
property:
  path: billing
  name: billing
  description: List of billing address data
  node: BillingAddressShape
  class: BillingAddress
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: shipping
  name: shipping
  description: List of shipping address data
  node: ShippingAddressShape
  class: ShippingAddress
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: metadata
  name: metadata
  description: Meta data
  node: MetadataShape
  class: Metadata
  node kind: BlankNodeOrIRI

CustomerDownloadShape
type: NodeShape
target class: CustomerDownload
property:
  path: downloadId
  name: download id
  description: Download ID (MD5)
  datatype: string
  min count: 1
  max count: 1
property:
  path: downloadUrl
  name: download url
  description: Download file URL
  datatype: anyURI
  min count: 1
  max count: 1
property:
  path: product
  name: product
  description: Downloadable product
  node: ProductShape
  class: Product
  node kind: BlankNodeOrIRI
  min count: 1
  max count: 1
property:
  path: productName
  name: product name
  description: Product name
  datatype: string
  min count: 1
  max count: 1
property:
  path: downloadName
  name: download name
  description: Downloadable file name
  datatype: string
  min count: 1
  max count: 1
property:
  path: order
  name: order
  description: Order
  node: OrderShape
  class: Order
  node kind: BlankNodeOrIRI
  min count: 1
  max count: 1
property:
  path: orderKey
  name: order key
  description: Order key
  datatype: string
  min count: 1
  max count: 1
property:
  path: downloadsRemaining
  name: downloads remaining
  description: Number of downloads remaining
  datatype: string
  min count: 1
  max count: 1
property:
  path: accessExpires
  name: access expires
  description: The date when download access expires, in the site's timezone. Can be 'never'.
  datatype: string
  max count: 1
property:
  path: accessExpiresGmt
  name: access expires gmt
  description: The date when download access expires, as GMT. Can be 'never'.
  datatype: string
  max count: 1
property:
  path: file
  name: file
  description: File details
  node: CustomerDownloadFileShape
  class: CustomerDownloadFile
  node kind: BlankNodeOrIRI
  min count: 1
  max count: 1
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

CustomerDownloadFileShape
type: NodeShape
target class: CustomerDownloadFile
property:
  path: name
  name: name
  description: File name
  datatype: string
  min count: 1
  max count: 1
property:
  path: file
  name: file
  description: File URL
  datatype: anyURI
  min count: 1
  max count: 1

ProductReviewShape
type: NodeShape
target class: ProductReview
property:
  path: id
  name: id
  description: Unique identifier
  datatype: long
  min count: 1
  max count: 1
property:
  path: dateCreated
  name: date created
  description: The date the review was created (in the site's timezone)
  datatype: dateTime
  max count: 1
property:
  path: dateCreatedGmt
  name: date created gmt
  description: The date the review was created (GMT)
  datatype: dateTime
  max count: 1
property:
  path: product
  name: product
  description: Product the review belongs to
  node: ProductShape
  class: Product
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: status
  name: status
  description: Status of the review
  datatype: string
  max count: 1
  in: approved
  in: hold
  in: spam
  in: trash
  in: unspam
  in: untrash
property:
  path: reviewer
  name: reviewer
  description: Reviewer name
  datatype: string
  max count: 1
property:
  path: reviewerEmail
  name: reviewer email
  description: Reviewer email
  datatype: string
  max count: 1
property:
  path: review
  name: review
  description: Review content
  datatype: string
  max count: 1
property:
  path: rating
  name: rating
  description: Review rating (0 to 5)
  datatype: int
  max count: 1
  min inclusive: 0
  max inclusive: 5
property:
  path: verified
  name: verified
  description: Whether reviewer purchased the product
  datatype: boolean
  max count: 1
property:
  path: reviewerAvatarUrls
  name: reviewer avatar urls
  description: Avatar URLs for the reviewer
  node: ContainerShape
  class: Container
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

ProductReviewInputShape
type: NodeShape
target class: ProductReviewInput
property:
  path: product
  name: product
  description: Product the review belongs to
  node: ProductShape
  class: Product
  node kind: BlankNodeOrIRI
  min count: 1
  max count: 1
property:
  path: status
  name: status
  description: Status of the review
  datatype: string
  max count: 1
  in: approved
  in: hold
  in: spam
  in: trash
  in: unspam
  in: untrash
property:
  path: reviewer
  name: reviewer
  description: Reviewer name
  datatype: string
  min count: 1
  max count: 1
property:
  path: reviewerEmail
  name: reviewer email
  description: Reviewer email
  datatype: string
  min count: 1
  max count: 1
property:
  path: review
  name: review
  description: Review content
  datatype: string
  min count: 1
  max count: 1
property:
  path: rating
  name: rating
  description: Review rating (0 to 5)
  datatype: int
  max count: 1
  min inclusive: 0
  max inclusive: 5

ProductShippingClassInputShape
type: NodeShape
target class: ProductShippingClassInput
property:
  path: name
  name: name
  description: Shipping class name
  datatype: string
  min count: 1
  max count: 1
property:
  path: slug
  name: slug
  description: An alphanumeric identifier for the shipping class (slug)
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: Shipping class description
  datatype: string
  max count: 1

ReportShape
type: NodeShape
target class: Report
property:
  path: slug
  name: slug
  description: Report slug/identifier
  datatype: string
  min count: 1
  max count: 1
property:
  path: description
  name: description
  description: Report description
  datatype: string
  min count: 1
  max count: 1
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

SalesReportShape
type: NodeShape
target class: SalesReport
property:
  path: totalSales
  name: total sales
  description: Gross sales in the period
  datatype: string
  min count: 1
  max count: 1
property:
  path: netSales
  name: net sales
  description: Net sales in the period
  datatype: string
  min count: 1
  max count: 1
property:
  path: averageSales
  name: average sales
  description: Average net daily sales
  datatype: string
  min count: 1
  max count: 1
property:
  path: totalOrders
  name: total orders
  description: Total number of orders placed
  datatype: int
  min count: 1
  max count: 1
property:
  path: totalItems
  name: total items
  description: Total number of items purchased
  datatype: int
  min count: 1
  max count: 1
property:
  path: totalTax
  name: total tax
  description: Total charged for taxes
  datatype: string
  min count: 1
  max count: 1
property:
  path: totalShipping
  name: total shipping
  description: Total charged for shipping
  datatype: string
  min count: 1
  max count: 1
property:
  path: totalRefunds
  name: total refunds
  description: Total of refunded orders
  datatype: int
  min count: 1
  max count: 1
property:
  path: totalDiscount
  name: total discount
  description: Total of coupons used
  datatype: int
  min count: 1
  max count: 1
property:
  path: totalsGroupedBy
  name: totals grouped by
  description: Group type (day, month, etc.)
  datatype: string
  min count: 1
  max count: 1
property:
  path: totals
  name: totals
  description: Totals breakdown by date
  node: ContainerShape
  class: Container
  node kind: BlankNodeOrIRI
  min count: 1
  max count: 1
property:
  path: totalCustomers
  name: total customers
  description: Total number of customers
  datatype: int
  min count: 1
  max count: 1
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

SalesReportPeriodShape
type: NodeShape
target class: SalesReportPeriod
property:
  path: sales
  name: sales
  description: Sales amount
  datatype: string
  min count: 1
  max count: 1
property:
  path: orders
  name: orders
  description: Number of orders
  datatype: int
  min count: 1
  max count: 1
property:
  path: items
  name: items
  description: Number of items
  datatype: int
  min count: 1
  max count: 1
property:
  path: tax
  name: tax
  description: Tax amount
  datatype: string
  min count: 1
  max count: 1
property:
  path: shipping
  name: shipping
  description: Shipping amount
  datatype: string
  min count: 1
  max count: 1
property:
  path: discount
  name: discount
  description: Discount amount
  datatype: string
  min count: 1
  max count: 1
property:
  path: customers
  name: customers
  description: Number of customers
  datatype: int
  min count: 1
  max count: 1

TopSellersReportItemShape
type: NodeShape
target class: TopSellersReportItem
property:
  path: title
  name: title
  description: Product title
  datatype: string
  min count: 1
  max count: 1
property:
  path: product
  name: product
  description: Product
  node: ProductShape
  class: Product
  node kind: BlankNodeOrIRI
  min count: 1
  max count: 1
property:
  path: quantity
  name: quantity
  description: Total number of purchases
  datatype: int
  min count: 1
  max count: 1
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

ReportTotalsItemShape
type: NodeShape
target class: ReportTotalsItem
property:
  path: slug
  name: slug
  description: An alphanumeric identifier for the resource
  datatype: string
  min count: 1
  max count: 1
property:
  path: name
  name: name
  description: Item type name
  datatype: string
  min count: 1
  max count: 1
property:
  path: total
  name: total
  description: Total count
  datatype: string
  min count: 1
  max count: 1

CouponShape
type: NodeShape
target class: Coupon
property:
  path: id
  name: id
  description: Unique identifier for the object
  datatype: long
  min count: 1
  max count: 1
property:
  path: code
  name: code
  description: Coupon code
  datatype: string
  min count: 1
  max count: 1
property:
  path: amount
  name: amount
  description: The amount of discount. Should always be numeric, even if setting a percentage.
  datatype: string
  max count: 1
property:
  path: dateCreated
  name: date created
  description: The date the coupon was created, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateCreatedGmt
  name: date created gmt
  description: The date the coupon was created, as GMT
  datatype: dateTime
  max count: 1
property:
  path: dateModified
  name: date modified
  description: The date the coupon was last modified, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateModifiedGmt
  name: date modified gmt
  description: The date the coupon was last modified, as GMT
  datatype: dateTime
  max count: 1
property:
  path: discountType
  name: discount type
  description: Determines the type of discount that will be applied
  datatype: string
  max count: 1
  in: percent
  in: fixed_cart
  in: fixed_product
property:
  path: description
  name: description
  description: Coupon description
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Coupon publication status
  datatype: string
  max count: 1
property:
  path: dateExpires
  name: date expires
  description: The date the coupon expires, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateExpiresGmt
  name: date expires gmt
  description: The date the coupon expires, as GMT
  datatype: dateTime
  max count: 1
property:
  path: usageCount
  name: usage count
  description: Number of times the coupon has been used already
  datatype: int
  max count: 1
property:
  path: individualUse
  name: individual use
  description: If true, the coupon can only be used individually. Other applied coupons will be removed from the cart.
  datatype: boolean
  max count: 1
property:
  path: products
  name: products
  description: List of products the coupon can be used on
  node: ProductShape
  class: Product
  node kind: BlankNodeOrIRI
property:
  path: excludedProducts
  name: excluded products
  description: List of products the coupon cannot be used on
  node: ProductShape
  class: Product
  node kind: BlankNodeOrIRI
property:
  path: usageLimit
  name: usage limit
  description: How many times the coupon can be used in total
  datatype: int
  max count: 1
property:
  path: usageLimitPerUser
  name: usage limit per user
  description: How many times the coupon can be used per customer
  datatype: int
  max count: 1
property:
  path: limitUsageToXItems
  name: limit usage to xitems
  description: Max number of items in the cart the coupon can be applied to
  datatype: int
  max count: 1
property:
  path: freeShipping
  name: free shipping
  description: If true and if the free shipping method requires a coupon, this coupon will enable free shipping
  datatype: boolean
  max count: 1
property:
  path: productCategories
  name: product categories
  description: List of category IDs the coupon applies to
  node: ProductCategoryShape
  class: ProductCategory
  node kind: BlankNodeOrIRI
property:
  path: excludedProductCategories
  name: excluded product categories
  description: List of category IDs the coupon does not apply to
  node: ProductCategoryShape
  class: ProductCategory
  node kind: BlankNodeOrIRI
property:
  path: excludeSaleItems
  name: exclude sale items
  description: If true, this coupon will not be applied to items that have sale prices
  datatype: boolean
  max count: 1
property:
  path: minimumAmount
  name: minimum amount
  description: Minimum order amount that needs to be in the cart before coupon applies
  datatype: string
  max count: 1
property:
  path: maximumAmount
  name: maximum amount
  description: Maximum order amount allowed when using the coupon
  datatype: string
  max count: 1
property:
  path: emailRestrictions
  name: email restrictions
  description: List of email addresses that can use this coupon
  datatype: string
property:
  path: usedBy
  name: used by
  description: List of user IDs (or guest email addresses) that have used the coupon
  datatype: string
property:
  path: metadata
  name: metadata
  description: Meta data
  node: MetadataShape
  class: Metadata
  node kind: BlankNodeOrIRI
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

CouponInputShape
type: NodeShape
target class: CouponInput
property:
  path: code
  name: code
  description: Coupon code
  datatype: string
  min count: 1
  max count: 1
property:
  path: amount
  name: amount
  description: The amount of discount. Should always be numeric, even if setting a percentage.
  datatype: string
  max count: 1
property:
  path: discountType
  name: discount type
  description: Determines the type of discount that will be applied
  datatype: string
  max count: 1
  in: percent
  in: fixed_cart
  in: fixed_product
property:
  path: description
  name: description
  description: Coupon description
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Coupon publication status
  datatype: string
  max count: 1
property:
  path: dateExpires
  name: date expires
  description: The date the coupon expires, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateExpiresGmt
  name: date expires gmt
  description: The date the coupon expires, as GMT
  datatype: dateTime
  max count: 1
property:
  path: individualUse
  name: individual use
  description: If true, the coupon can only be used individually
  datatype: boolean
  max count: 1
property:
  path: products
  name: products
  description: List of products the coupon can be used on
  node: ProductShape
  class: Product
  node kind: BlankNodeOrIRI
property:
  path: excludedProducts
  name: excluded products
  description: List of products the coupon cannot be used on
  node: ProductShape
  class: Product
  node kind: BlankNodeOrIRI
property:
  path: usageLimit
  name: usage limit
  description: How many times the coupon can be used in total
  datatype: int
  max count: 1
property:
  path: usageLimitPerUser
  name: usage limit per user
  description: How many times the coupon can be used per customer
  datatype: int
  max count: 1
property:
  path: limitUsageToXItems
  name: limit usage to xitems
  description: Max number of items in the cart the coupon can be applied to
  datatype: int
  max count: 1
property:
  path: freeShipping
  name: free shipping
  description: If true, this coupon grants free shipping
  datatype: boolean
  max count: 1
property:
  path: productCategories
  name: product categories
  description: List of category IDs the coupon applies to
  node: ProductCategoryShape
  class: ProductCategory
  node kind: BlankNodeOrIRI
property:
  path: excludedProductCategories
  name: excluded product categories
  description: List of category IDs the coupon does not apply to
  node: ProductCategoryShape
  class: ProductCategory
  node kind: BlankNodeOrIRI
property:
  path: excludeSaleItems
  name: exclude sale items
  description: If true, this coupon will not be applied to items that have sale prices
  datatype: boolean
  max count: 1
property:
  path: minimumAmount
  name: minimum amount
  description: Minimum order amount that needs to be in the cart before coupon applies
  datatype: string
  max count: 1
property:
  path: maximumAmount
  name: maximum amount
  description: Maximum order amount allowed when using the coupon
  datatype: string
  max count: 1
property:
  path: emailRestrictions
  name: email restrictions
  description: List of email addresses that can use this coupon
  datatype: string
property:
  path: metadata
  name: metadata
  description: Meta data
  node: MetadataShape
  class: Metadata
  node kind: BlankNodeOrIRI

TaxRateInputShape
type: NodeShape
target class: TaxRateInput
property:
  path: country
  name: country
  description: Country ISO 3166 code
  datatype: string
  max count: 1
property:
  path: state
  name: state
  description: State code
  datatype: string
  max count: 1
property:
  path: postcode
  name: postcode
  description: Postcode/ZIP. Deprecated: use postcodes instead
  datatype: string
  max count: 1
property:
  path: city
  name: city
  description: City name. Deprecated: use cities instead
  datatype: string
  max count: 1
property:
  path: postcodes
  name: postcodes
  description: Postcodes/ZIPs
  datatype: string
property:
  path: cities
  name: cities
  description: City names
  datatype: string
property:
  path: rate
  name: rate
  description: Tax rate
  datatype: string
  max count: 1
property:
  path: name
  name: name
  description: Tax rate name
  datatype: string
  max count: 1
property:
  path: priority
  name: priority
  description: Tax priority. Only 1 matching rate per priority will be used. Default is 1.
  datatype: int
  max count: 1
property:
  path: compound
  name: compound
  description: Whether this is a compound tax rate. Compound rates are applied on top of other tax rates. Default is false.
  datatype: boolean
  max count: 1
property:
  path: shipping
  name: shipping
  description: Whether this tax rate also gets applied to shipping. Default is true.
  datatype: boolean
  max count: 1
property:
  path: order
  name: order
  description: Indicates the order that will appear in queries
  datatype: int
  max count: 1
property:
  path: taxClass
  name: tax class
  description: Tax class. Default is 'standard'.
  datatype: string
  max count: 1

TaxClassShape
type: NodeShape
target class: TaxClass
property:
  path: slug
  name: slug
  description: Unique identifier for the resource
  datatype: string
  min count: 1
  max count: 1
property:
  path: name
  name: name
  description: Tax class name
  datatype: string
  min count: 1
  max count: 1
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

TaxClassInputShape
type: NodeShape
target class: TaxClassInput
property:
  path: name
  name: name
  description: Tax class name
  datatype: string
  min count: 1
  max count: 1

ShippingMethodShape
type: NodeShape
target class: ShippingMethod
property:
  path: id
  name: id
  description: Method ID
  datatype: string
  min count: 1
  max count: 1
property:
  path: title
  name: title
  description: Shipping method title
  datatype: string
  min count: 1
  max count: 1
property:
  path: description
  name: description
  description: Shipping method description
  datatype: string
  min count: 1
  max count: 1
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

ShippingZoneShape
type: NodeShape
target class: ShippingZone
property:
  path: id
  name: id
  description: Unique identifier for the resource
  datatype: long
  min count: 1
  max count: 1
property:
  path: name
  name: name
  description: Shipping zone name
  datatype: string
  min count: 1
  max count: 1
property:
  path: order
  name: order
  description: Shipping zone order
  datatype: int
  max count: 1
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

ShippingZoneInputShape
type: NodeShape
target class: ShippingZoneInput
property:
  path: name
  name: name
  description: Shipping zone name
  datatype: string
  min count: 1
  max count: 1
property:
  path: order
  name: order
  description: Shipping zone order
  datatype: int
  max count: 1

ShippingZoneLocationShape
type: NodeShape
target class: ShippingZoneLocation
property:
  path: code
  name: code
  description: Shipping zone location code
  datatype: string
  min count: 1
  max count: 1
property:
  path: type
  name: type
  description: Shipping zone location type
  datatype: string
  min count: 1
  max count: 1
  in: postcode
  in: state
  in: country
  in: continent
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

ShippingZoneLocationInputShape
type: NodeShape
target class: ShippingZoneLocationInput
property:
  path: code
  name: code
  description: Shipping zone location code
  datatype: string
  min count: 1
  max count: 1
property:
  path: type
  name: type
  description: Shipping zone location type
  datatype: string
  max count: 1
  in: postcode
  in: state
  in: country
  in: continent

ShippingZoneMethodSettingShape
type: NodeShape
target class: ShippingZoneMethodSetting
property:
  path: settingIdentifier
  name: setting identifier
  description: A unique identifier for the setting
  datatype: string
  min count: 1
  max count: 1
property:
  path: label
  name: label
  description: A human readable label for the setting used in interfaces
  datatype: string
  min count: 1
  max count: 1
property:
  path: description
  name: description
  description: A human readable description for the setting used in interfaces
  datatype: string
  min count: 1
  max count: 1
property:
  path: type
  name: type
  description: Type of setting
  datatype: string
  min count: 1
  max count: 1
  in: text
  in: email
  in: number
  in: color
  in: password
  in: textarea
  in: select
  in: multiselect
  in: radio
  in: image_width
  in: checkbox
  in: title
  in: price
property:
  path: value
  name: value
  description: Setting value
  datatype: string
  min count: 1
  max count: 1
property:
  path: default
  name: default
  description: Default value for the setting
  datatype: string
  min count: 1
  max count: 1
property:
  path: tip
  name: tip
  description: Additional help text shown to the user about the setting
  datatype: string
  min count: 1
  max count: 1
property:
  path: placeholder
  name: placeholder
  description: Placeholder text to be displayed in text inputs
  datatype: string
  min count: 1
  max count: 1
property:
  path: options
  name: options
  description: Options for select/multiselect types. Keys are option values, values are display labels.
  node: ContainerShape
  class: Container
  node kind: BlankNodeOrIRI
  max count: 1

ShippingZoneMethodShape
type: NodeShape
target class: ShippingZoneMethod
property:
  path: instance
  name: instance
  description: Shipping method instance ID
  datatype: int
  min count: 1
  max count: 1
property:
  path: title
  name: title
  description: Shipping method customer facing title
  datatype: string
  min count: 1
  max count: 1
property:
  path: order
  name: order
  description: Shipping method sort order
  datatype: int
  min count: 1
  max count: 1
property:
  path: enabled
  name: enabled
  description: Shipping method enabled status
  datatype: boolean
  min count: 1
  max count: 1
property:
  path: methodId
  name: method id
  description: Shipping method ID
  datatype: string
  min count: 1
  max count: 1
property:
  path: methodTitle
  name: method title
  description: Shipping method title
  datatype: string
  min count: 1
  max count: 1
property:
  path: methodDescription
  name: method description
  description: Shipping method description
  datatype: string
  min count: 1
  max count: 1
property:
  path: settings
  name: settings
  description: Shipping method settings. Keys are setting IDs.
  node: ContainerShape
  class: Container
  node kind: BlankNodeOrIRI
  min count: 1
  max count: 1
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

ShippingZoneMethodCreateInputShape
type: NodeShape
target class: ShippingZoneMethodCreateInput
property:
  path: methodId
  name: method id
  description: Shipping method ID (e.g., 'flat_rate', 'free_shipping', 'local_pickup')
  datatype: string
  min count: 1
  max count: 1
property:
  path: order
  name: order
  description: Shipping method sort order
  datatype: int
  max count: 1
property:
  path: enabled
  name: enabled
  description: Shipping method enabled status
  datatype: boolean
  max count: 1

ShippingZoneMethodUpdateInputShape
type: NodeShape
target class: ShippingZoneMethodUpdateInput
property:
  path: order
  name: order
  description: Shipping method sort order
  datatype: int
  max count: 1
property:
  path: enabled
  name: enabled
  description: Shipping method enabled status
  datatype: boolean
  max count: 1
property:
  path: settings
  name: settings
  description: Settings to update. Keys are setting IDs, values are the new setting values.
  node: ContainerShape
  class: Container
  node kind: BlankNodeOrIRI
  max count: 1

SettingOptionsLinkShape
type: NodeShape
target class: SettingOptionsLink
property:
  path: href
  name: href
  description: URL to the setting options
  datatype: anyURI
  min count: 1
  max count: 1

SettingGroupLinksShape
type: NodeShape
target class: SettingGroupLinks
property:
  path: options
  name: options
  description: Link to the setting options for this group
  node: SettingOptionsLinkShape
  class: SettingOptionsLink
  node kind: BlankNodeOrIRI

SettingGroupShape
type: NodeShape
target class: SettingGroup
property:
  path: id
  name: id
  description: A unique identifier that can be used to link settings together
  datatype: string
  min count: 1
  max count: 1
property:
  path: label
  name: label
  description: A human readable label for the setting used in interfaces
  datatype: string
  min count: 1
  max count: 1
property:
  path: description
  name: description
  description: A human readable description for the setting used in interfaces
  datatype: string
  min count: 1
  max count: 1
property:
  path: parentId
  name: parent id
  description: ID of parent grouping
  datatype: string
  min count: 1
  max count: 1
property:
  path: subGroups
  name: sub groups
  description: IDs for settings sub groups
  datatype: string
property:
  path: links
  name: links
  description: HAL links
  node: SettingGroupLinksShape
  class: SettingGroupLinks
  node kind: BlankNodeOrIRI
  max count: 1

SettingOptionShape
type: NodeShape
target class: SettingOption
property:
  path: id
  name: id
  description: A unique identifier for the setting
  datatype: string
  min count: 1
  max count: 1
property:
  path: label
  name: label
  description: A human readable label for the setting used in interfaces
  datatype: string
  min count: 1
  max count: 1
property:
  path: description
  name: description
  description: A human readable description for the setting used in interfaces
  datatype: string
  min count: 1
  max count: 1
property:
  path: value
  name: value
  description: Setting value. String for most types, array of strings for multiselect.
  datatype: string
property:
  path: default
  name: default
  description: Default value for the setting. String for most types, array of strings for multiselect.
  datatype: string
property:
  path: tip
  name: tip
  description: Additional help text shown to the user about the setting
  datatype: string
  max count: 1
property:
  path: placeholder
  name: placeholder
  description: Placeholder text to be displayed in text inputs
  datatype: string
  max count: 1
property:
  path: type
  name: type
  description: Type of setting control
  datatype: string
  min count: 1
  max count: 1
  in: text
  in: email
  in: number
  in: color
  in: password
  in: textarea
  in: select
  in: multiselect
  in: radio
  in: image_width
  in: checkbox
property:
  path: options
  name: options
  description: Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons
  node: ContainerShape
  class: Container
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: groupId
  name: group id
  description: An identifier for the group this setting belongs to
  datatype: string
  max count: 1
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

SettingOptionInputShape
type: NodeShape
target class: SettingOptionInput
property:
  path: value
  name: value
  description: Setting value to update. String for most types, array of strings for multiselect.
  datatype: string

SettingOptionBatchInputShape
type: NodeShape
target class: SettingOptionBatchInput
property:
  path: settingIdentifier
  name: setting identifier
  description: Setting ID
  datatype: string
  min count: 1
  max count: 1
property:
  path: value
  name: value
  description: Setting value to update. String for most types, array of strings for multiselect.
  datatype: string

SettingOptionBatchRequestShape
type: NodeShape
target class: SettingOptionBatchRequest
property:
  path: update
  name: update
  description: Settings to update
  node: SettingOptionBatchInputShape
  class: SettingOptionBatchInput
  node kind: BlankNodeOrIRI

SettingOptionBatchResponseShape
type: NodeShape
target class: SettingOptionBatchResponse
property:
  path: update
  name: update
  description: Updated settings
  node: SettingOptionShape
  class: SettingOption
  node kind: BlankNodeOrIRI

PaymentGatewaySettingShape
type: NodeShape
target class: PaymentGatewaySetting
property:
  path: settingIdentifier
  name: setting identifier
  description: A unique identifier for the setting
  datatype: string
  min count: 1
  max count: 1
property:
  path: label
  name: label
  description: A human readable label for the setting used in interfaces
  datatype: string
  min count: 1
  max count: 1
property:
  path: description
  name: description
  description: A human readable description for the setting used in interfaces
  datatype: string
  min count: 1
  max count: 1
property:
  path: type
  name: type
  description: Type of setting control
  datatype: string
  min count: 1
  max count: 1
  in: text
  in: email
  in: number
  in: color
  in: password
  in: textarea
  in: select
  in: multiselect
  in: radio
  in: image_width
  in: checkbox
property:
  path: value
  name: value
  description: Setting value
  datatype: string
  max count: 1
property:
  path: default
  name: default
  description: Default value for the setting
  datatype: string
  max count: 1
property:
  path: tip
  name: tip
  description: Additional help text shown to the user about the setting
  datatype: string
  max count: 1
property:
  path: placeholder
  name: placeholder
  description: Placeholder text to be displayed in text inputs
  datatype: string
  max count: 1
property:
  path: options
  name: options
  description: Array of options (key value pairs) for inputs such as select, multiselect, and radio buttons
  node: ContainerShape
  class: Container
  node kind: BlankNodeOrIRI
  max count: 1

PaymentGatewayShape
type: NodeShape
target class: PaymentGateway
property:
  path: id
  name: id
  description: Payment gateway ID
  datatype: string
  min count: 1
  max count: 1
property:
  path: title
  name: title
  description: Payment gateway title on checkout
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: Payment gateway description on checkout
  datatype: string
  max count: 1
property:
  path: order
  name: order
  description: Payment gateway sort order
  datatype: int
  max count: 1
property:
  path: enabled
  name: enabled
  description: Payment gateway enabled status
  datatype: boolean
  max count: 1
property:
  path: methodTitle
  name: method title
  description: Payment gateway method title
  datatype: string
  max count: 1
property:
  path: methodDescription
  name: method description
  description: Payment gateway method description
  datatype: string
  max count: 1
property:
  path: methodSupports
  name: method supports
  description: Supported features for this payment gateway
  datatype: string
property:
  path: settings
  name: settings
  description: Payment gateway settings, keyed by setting ID
  node: ContainerShape
  class: Container
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

PaymentGatewayInputShape
type: NodeShape
target class: PaymentGatewayInput
property:
  path: title
  name: title
  description: Payment gateway title on checkout
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: Payment gateway description on checkout
  datatype: string
  max count: 1
property:
  path: order
  name: order
  description: Payment gateway sort order
  datatype: int
  max count: 1
property:
  path: enabled
  name: enabled
  description: Payment gateway enabled status
  datatype: boolean
  max count: 1
property:
  path: settings
  name: settings
  description: Settings values to update, keyed by setting ID
  node: ContainerShape
  class: Container
  node kind: BlankNodeOrIRI
  max count: 1

WebhookShape
type: NodeShape
target class: Webhook
property:
  path: id
  name: id
  description: Unique identifier for the resource
  datatype: long
  min count: 1
  max count: 1
property:
  path: name
  name: name
  description: A friendly name for the webhook
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Webhook status
  datatype: string
  max count: 1
  in: active
  in: paused
  in: disabled
property:
  path: topic
  name: topic
  description: Webhook topic (e.g., order.updated)
  datatype: string
  min count: 1
  max count: 1
property:
  path: resource
  name: resource
  description: Webhook resource (derived from topic)
  datatype: string
  max count: 1
property:
  path: event
  name: event
  description: Webhook event (derived from topic)
  datatype: string
  max count: 1
property:
  path: hooks
  name: hooks
  description: WooCommerce action names associated with the webhook
  datatype: string
property:
  path: deliveryUrl
  name: delivery url
  description: The URL where the webhook payload is delivered
  datatype: string
  min count: 1
  max count: 1
property:
  path: secret
  name: secret
  description: Secret key used to generate a hash of the delivered webhook (HMAC-SHA256)
  datatype: string
  max count: 1
property:
  path: dateCreated
  name: date created
  description: The date the webhook was created, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateCreatedGmt
  name: date created gmt
  description: The date the webhook was created, as GMT
  datatype: dateTime
  max count: 1
property:
  path: dateModified
  name: date modified
  description: The date the webhook was last modified, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateModifiedGmt
  name: date modified gmt
  description: The date the webhook was last modified, as GMT
  datatype: dateTime
  max count: 1
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

WebhookCreateInputShape
type: NodeShape
target class: WebhookCreateInput
property:
  path: name
  name: name
  description: A friendly name for the webhook
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Webhook status
  datatype: string
  max count: 1
  in: active
  in: paused
  in: disabled
property:
  path: topic
  name: topic
  description: Webhook topic (e.g., order.updated)
  datatype: string
  min count: 1
  max count: 1
property:
  path: deliveryUrl
  name: delivery url
  description: The URL where the webhook payload is delivered
  datatype: string
  min count: 1
  max count: 1
property:
  path: secret
  name: secret
  description: Secret key used to generate a hash of the delivered webhook
  datatype: string
  max count: 1

WebhookUpdateInputShape
type: NodeShape
target class: WebhookUpdateInput
property:
  path: name
  name: name
  description: A friendly name for the webhook
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Webhook status
  datatype: string
  max count: 1
  in: active
  in: paused
  in: disabled
property:
  path: topic
  name: topic
  description: Webhook topic (e.g., order.updated)
  datatype: string
  max count: 1
property:
  path: secret
  name: secret
  description: Secret key used to generate a hash of the delivered webhook
  datatype: string
  max count: 1

SystemStatusEnvironmentShape
type: NodeShape
target class: SystemStatusEnvironment
property:
  path: homeUrl
  name: home url
  description: Home URL
  datatype: string
  max count: 1
property:
  path: siteUrl
  name: site url
  description: Site URL
  datatype: string
  max count: 1
property:
  path: version
  name: version
  description: WooCommerce version
  datatype: string
  max count: 1
property:
  path: logDirectory
  name: log directory
  description: Log directory
  datatype: string
  max count: 1
property:
  path: logDirectoryWritable
  name: log directory writable
  description: Is log directory writable?
  datatype: boolean
  max count: 1
property:
  path: wpVersion
  name: wp version
  description: WordPress version
  datatype: string
  max count: 1
property:
  path: wpMultisite
  name: wp multisite
  description: Is WordPress multisite?
  datatype: boolean
  max count: 1
property:
  path: wpMemoryLimit
  name: wp memory limit
  description: WordPress memory limit
  datatype: long
  max count: 1
property:
  path: wpDebugMode
  name: wp debug mode
  description: Is WordPress debug mode active?
  datatype: boolean
  max count: 1
property:
  path: wpCron
  name: wp cron
  description: Are WordPress cron jobs enabled?
  datatype: boolean
  max count: 1
property:
  path: wpEnvironmentType
  name: wp environment type
  description: WordPress environment type
  datatype: string
  max count: 1
property:
  path: language
  name: language
  description: WordPress language
  datatype: string
  max count: 1
property:
  path: serverInfo
  name: server info
  description: Server info
  datatype: string
  max count: 1
property:
  path: phpVersion
  name: php version
  description: PHP version
  datatype: string
  max count: 1
property:
  path: phpPostMaxSize
  name: php post max size
  description: PHP post max size
  datatype: long
  max count: 1
property:
  path: phpMaxExecutionTime
  name: php max execution time
  description: PHP max execution time
  datatype: int
  max count: 1
property:
  path: phpMaxInputVars
  name: php max input vars
  description: PHP max input vars
  datatype: int
  max count: 1
property:
  path: curlVersion
  name: curl version
  description: cURL version
  datatype: string
  max count: 1
property:
  path: suhosinInstalled
  name: suhosin installed
  description: Is SUHOSIN installed?
  datatype: boolean
  max count: 1
property:
  path: maxUploadSize
  name: max upload size
  description: Max upload size
  datatype: long
  max count: 1
property:
  path: mysqlVersion
  name: mysql version
  description: MySQL version
  datatype: string
  max count: 1
property:
  path: defaultTimezone
  name: default timezone
  description: Default timezone
  datatype: string
  max count: 1
property:
  path: fsockopenOrCurlEnabled
  name: fsockopen or curl enabled
  description: Is fsockopen/cURL enabled?
  datatype: boolean
  max count: 1
property:
  path: soapclientEnabled
  name: soapclient enabled
  description: Is SoapClient class enabled?
  datatype: boolean
  max count: 1
property:
  path: domdocumentEnabled
  name: domdocument enabled
  description: Is DomDocument class enabled?
  datatype: boolean
  max count: 1
property:
  path: gzipEnabled
  name: gzip enabled
  description: Is GZip enabled?
  datatype: boolean
  max count: 1
property:
  path: mbstringEnabled
  name: mbstring enabled
  description: Is mbstring enabled?
  datatype: boolean
  max count: 1
property:
  path: remotePostSuccessful
  name: remote post successful
  description: Remote POST successful?
  datatype: boolean
  max count: 1
property:
  path: remotePostResponse
  name: remote post response
  description: Remote POST response
  datatype: string
  max count: 1
property:
  path: remoteGetSuccessful
  name: remote get successful
  description: Remote GET successful?
  datatype: boolean
  max count: 1
property:
  path: remoteGetResponse
  name: remote get response
  description: Remote GET response
  datatype: string
  max count: 1

SystemStatusDatabaseShape
type: NodeShape
target class: SystemStatusDatabase
property:
  path: wcDatabaseVersion
  name: wc database version
  description: WooCommerce database version
  datatype: string
  max count: 1
property:
  path: databasePrefix
  name: database prefix
  description: Database prefix
  datatype: string
  max count: 1
property:
  path: maxmindGeoipDatabase
  name: maxmind geoip database
  description: MaxMind GeoIP database
  datatype: string
  max count: 1
property:
  path: databaseTables
  name: database tables
  description: Database tables (table name to existence status)
  node: ContainerShape
  class: Container
  node kind: BlankNodeOrIRI
  max count: 1

SystemStatusActivePluginShape
type: NodeShape
target class: SystemStatusActivePlugin
property:
  path: plugin
  name: plugin
  description: Plugin path
  datatype: string
  max count: 1
property:
  path: name
  name: name
  description: Plugin name
  datatype: string
  max count: 1
property:
  path: version
  name: version
  description: Plugin version
  datatype: string
  max count: 1
property:
  path: versionLatest
  name: version latest
  description: Latest version of the plugin
  datatype: string
  max count: 1
property:
  path: url
  name: url
  description: Plugin URL
  datatype: anyURI
  max count: 1
property:
  path: authorName
  name: author name
  description: Plugin author name
  datatype: string
  max count: 1
property:
  path: authorUrl
  name: author url
  description: Plugin author URL
  datatype: string
  max count: 1
property:
  path: networkActivated
  name: network activated
  description: Is the plugin network activated?
  datatype: boolean
  max count: 1

SystemStatusThemeOverrideShape
type: NodeShape
target class: SystemStatusThemeOverride
property:
  path: file
  name: file
  description: Template file path
  datatype: string
  max count: 1
property:
  path: version
  name: version
  description: Version of the template
  datatype: string
  max count: 1
property:
  path: coreVersion
  name: core version
  description: Core version of the template
  datatype: string
  max count: 1

SystemStatusThemeShape
type: NodeShape
target class: SystemStatusTheme
property:
  path: name
  name: name
  description: Theme name
  datatype: string
  max count: 1
property:
  path: version
  name: version
  description: Theme version
  datatype: string
  max count: 1
property:
  path: versionLatest
  name: version latest
  description: Latest version of the theme
  datatype: string
  max count: 1
property:
  path: authorUrl
  name: author url
  description: Theme author URL
  datatype: string
  max count: 1
property:
  path: isChildTheme
  name: is child theme
  description: Is this theme a child theme?
  datatype: boolean
  max count: 1
property:
  path: hasWoocommerceSupport
  name: has woocommerce support
  description: Does the theme declare WooCommerce support?
  datatype: boolean
  max count: 1
property:
  path: hasWoocommerceFile
  name: has woocommerce file
  description: Does the theme have a woocommerce.php file?
  datatype: boolean
  max count: 1
property:
  path: hasOutdatedTemplates
  name: has outdated templates
  description: Does this theme have outdated templates?
  datatype: boolean
  max count: 1
property:
  path: overrides
  name: overrides
  description: Template overrides
  node: SystemStatusThemeOverrideShape
  class: SystemStatusThemeOverride
  node kind: BlankNodeOrIRI
property:
  path: parentName
  name: parent name
  description: Parent theme name
  datatype: string
  max count: 1
property:
  path: parentVersion
  name: parent version
  description: Parent theme version
  datatype: string
  max count: 1
property:
  path: parentVersionLatest
  name: parent version latest
  description: Latest version of the parent theme
  datatype: string
  max count: 1
property:
  path: parentAuthorUrl
  name: parent author url
  description: Parent theme author URL
  datatype: string
  max count: 1

SystemStatusSettingsShape
type: NodeShape
target class: SystemStatusSettings
property:
  path: apiEnabled
  name: api enabled
  description: REST API enabled?
  datatype: boolean
  max count: 1
property:
  path: forceSsl
  name: force ssl
  description: SSL forced?
  datatype: boolean
  max count: 1
property:
  path: currency
  name: currency
  description: Currency
  datatype: string
  max count: 1
property:
  path: currencySymbol
  name: currency symbol
  description: Currency symbol
  datatype: string
  max count: 1
property:
  path: currencyPosition
  name: currency position
  description: Currency position
  datatype: string
  max count: 1
property:
  path: thousandSeparator
  name: thousand separator
  description: Thousand separator
  datatype: string
  max count: 1
property:
  path: decimalSeparator
  name: decimal separator
  description: Decimal separator
  datatype: string
  max count: 1
property:
  path: numberOfDecimals
  name: number of decimals
  description: Number of decimals
  datatype: int
  max count: 1
property:
  path: geolocationEnabled
  name: geolocation enabled
  description: Geolocation enabled?
  datatype: boolean
  max count: 1
property:
  path: taxonomies
  name: taxonomies
  description: Taxonomy terms for product/order statuses
  node: ContainerShape
  class: Container
  node kind: BlankNodeOrIRI
  max count: 1

SystemStatusSecurityShape
type: NodeShape
target class: SystemStatusSecurity
property:
  path: secureConnection
  name: secure connection
  description: Is the connection to your store secure?
  datatype: boolean
  max count: 1
property:
  path: hideErrors
  name: hide errors
  description: Hide errors from visitors?
  datatype: boolean
  max count: 1

SystemStatusPageShape
type: NodeShape
target class: SystemStatusPage
property:
  path: pageName
  name: page name
  description: Page name
  datatype: string
  max count: 1
property:
  path: pageId
  name: page id
  description: Page ID
  datatype: string
  max count: 1
property:
  path: pageSet
  name: page set
  description: Is the page set?
  datatype: boolean
  max count: 1
property:
  path: pageExists
  name: page exists
  description: Does the page exist?
  datatype: boolean
  max count: 1
property:
  path: pageVisible
  name: page visible
  description: Is the page visible?
  datatype: boolean
  max count: 1
property:
  path: shortcode
  name: shortcode
  description: Shortcode for the page
  datatype: string
  max count: 1
property:
  path: shortcodeRequired
  name: shortcode required
  description: Is the shortcode required?
  datatype: boolean
  max count: 1
property:
  path: shortcodePresent
  name: shortcode present
  description: Is the shortcode present?
  datatype: boolean
  max count: 1

SystemStatusShape
type: NodeShape
target class: SystemStatus
property:
  path: environment
  name: environment
  description: Environment properties
  node: SystemStatusEnvironmentShape
  class: SystemStatusEnvironment
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: database
  name: database
  description: Database properties
  node: SystemStatusDatabaseShape
  class: SystemStatusDatabase
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: activePlugins
  name: active plugins
  description: Active plugins
  node: SystemStatusActivePluginShape
  class: SystemStatusActivePlugin
  node kind: BlankNodeOrIRI
property:
  path: theme
  name: theme
  description: Theme properties
  node: SystemStatusThemeShape
  class: SystemStatusTheme
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: settings
  name: settings
  description: Settings properties
  node: SystemStatusSettingsShape
  class: SystemStatusSettings
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: security
  name: security
  description: Security properties
  node: SystemStatusSecurityShape
  class: SystemStatusSecurity
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: pages
  name: pages
  description: WooCommerce pages
  node: SystemStatusPageShape
  class: SystemStatusPage
  node kind: BlankNodeOrIRI
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

SystemStatusToolShape
type: NodeShape
target class: SystemStatusTool
property:
  path: id
  name: id
  description: A unique identifier for the tool
  datatype: string
  min count: 1
  max count: 1
property:
  path: name
  name: name
  description: Tool name
  datatype: string
  min count: 1
  max count: 1
property:
  path: action
  name: action
  description: What running the tool will do
  datatype: string
  min count: 1
  max count: 1
property:
  path: description
  name: description
  description: Tool description
  datatype: string
  min count: 1
  max count: 1
property:
  path: success
  name: success
  description: Did the tool run successfully?
  datatype: boolean
  max count: 1
property:
  path: message
  name: message
  description: Tool return message
  datatype: string
  max count: 1
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

SystemStatusToolRunInputShape
type: NodeShape
target class: SystemStatusToolRunInput
property:
  path: confirm
  name: confirm
  description: Confirm execution of the tool
  datatype: boolean
  max count: 1

DataEndpointShape
type: NodeShape
target class: DataEndpoint
property:
  path: slug
  name: slug
  description: Data resource ID
  datatype: string
  min count: 1
  max count: 1
property:
  path: description
  name: description
  description: Data resource description
  datatype: string
  min count: 1
  max count: 1
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

StateShape
type: NodeShape
target class: State
property:
  path: code
  name: code
  description: State code
  datatype: string
  min count: 1
  max count: 1
property:
  path: name
  name: name
  description: Full name of state
  datatype: string
  min count: 1
  max count: 1

ContinentCountryShape
type: NodeShape
target class: ContinentCountry
property:
  path: code
  name: code
  description: ISO3166 alpha-2 country code
  datatype: string
  min count: 1
  max count: 1
property:
  path: name
  name: name
  description: Full name of country
  datatype: string
  min count: 1
  max count: 1
property:
  path: currencyCode
  name: currency code
  description: Default ISO4217 alpha-3 currency code for the country
  datatype: string
  max count: 1
property:
  path: currencyPos
  name: currency pos
  description: Currency symbol position for this country
  datatype: string
  max count: 1
property:
  path: decimalSep
  name: decimal sep
  description: Decimal separator for displayed prices for this country
  datatype: string
  max count: 1
property:
  path: dimensionUnit
  name: dimension unit
  description: The unit lengths are defined in for this country
  datatype: string
  max count: 1
property:
  path: numDecimals
  name: num decimals
  description: Number of decimal points shown in displayed prices for this country
  datatype: int
  max count: 1
property:
  path: thousandSep
  name: thousand sep
  description: Thousands separator for displayed prices in this country
  datatype: string
  max count: 1
property:
  path: weightUnit
  name: weight unit
  description: The unit weights are defined in for this country
  datatype: string
  max count: 1
property:
  path: states
  name: states
  description: List of states in this country
  node: StateShape
  class: State
  node kind: BlankNodeOrIRI

ContinentShape
type: NodeShape
target class: Continent
property:
  path: code
  name: code
  description: 2 character continent code
  datatype: string
  min count: 1
  max count: 1
property:
  path: name
  name: name
  description: Full name of continent
  datatype: string
  min count: 1
  max count: 1
property:
  path: countries
  name: countries
  description: List of countries on this continent
  node: ContinentCountryShape
  class: ContinentCountry
  node kind: BlankNodeOrIRI
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

CountryShape
type: NodeShape
target class: Country
property:
  path: code
  name: code
  description: ISO3166 alpha-2 country code
  datatype: string
  min count: 1
  max count: 1
property:
  path: name
  name: name
  description: Full name of country
  datatype: string
  min count: 1
  max count: 1
property:
  path: states
  name: states
  description: List of states in this country
  node: StateShape
  class: State
  node kind: BlankNodeOrIRI
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

CurrencyShape
type: NodeShape
target class: Currency
property:
  path: code
  name: code
  description: ISO4217 currency code
  datatype: string
  min count: 1
  max count: 1
property:
  path: name
  name: name
  description: Full name of currency
  datatype: string
  min count: 1
  max count: 1
property:
  path: symbol
  name: symbol
  description: Currency symbol
  datatype: string
  min count: 1
  max count: 1
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

OrderReceiptRequestShape
type: NodeShape
target class: OrderReceiptRequest
property:
  path: expirationDate
  name: expiration date
  description: Receipt expiration date in yyyy-mm-dd format
  datatype: string
  max count: 1
property:
  path: expirationDays
  name: expiration days
  description: Number of days until receipt expires
  datatype: int
  max count: 1
property:
  path: forceNew
  name: force new
  description: Force generation of a new receipt URL even if one exists
  datatype: boolean
  max count: 1

SendOrderDetailsRequestShape
type: NodeShape
target class: SendOrderDetailsRequest
property:
  path: email
  name: email
  description: Email address to send to. Required if order has no billing email.
  datatype: string
  max count: 1
property:
  path: forceEmailUpdate
  name: force email update
  description: If true, update the order's billing email with the provided email address.
  datatype: boolean
  max count: 1

SendEmailRequestShape
type: NodeShape
target class: SendEmailRequest
property:
  path: templateId
  name: template id
  description: The email template to use. If omitted (10.7.0+), the best template is auto-selected based on order status.
  datatype: string
  max count: 1
property:
  path: email
  name: email
  description: Email address to send to. Required if order has no billing email.
  datatype: string
  max count: 1
property:
  path: forceEmailUpdate
  name: force email update
  description: If true, update the order's billing email with the provided email address.
  datatype: boolean
  max count: 1

ActionMessageResponseShape
type: NodeShape
target class: ActionMessageResponse
property:
  path: message
  name: message
  description: Success message describing the action taken.
  datatype: string
  min count: 1
  max count: 1

EmailTemplateShape
type: NodeShape
target class: EmailTemplate
property:
  path: templateIdentifier
  name: template identifier
  description: Template identifier (e.g., 'customer_completed_order', 'customer_invoice').
  datatype: string
  min count: 1
  max count: 1
property:
  path: title
  name: title
  description: Display title of the template.
  datatype: string
  min count: 1
  max count: 1
property:
  path: description
  name: description
  description: Description of when this template is used.
  datatype: string
  min count: 1
  max count: 1

ProductCreatedEventShape
type: NodeShape
target class: ProductCreatedEvent
property:
  path: id
  name: id
  description: Unique identifier for the resource
  datatype: long
  min count: 1
  max count: 1
property:
  path: name
  name: name
  description: Product name
  datatype: string
  min count: 1
  max count: 1
property:
  path: slug
  name: slug
  description: URL-friendly slug
  datatype: string
  min count: 1
  max count: 1
property:
  path: permalink
  name: permalink
  description: Product URL
  datatype: anyURI
  max count: 1
property:
  path: dateCreated
  name: date created
  description: The date the product was created, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateCreatedGmt
  name: date created gmt
  description: The date the product was created, as GMT
  datatype: dateTime
  max count: 1
property:
  path: dateModified
  name: date modified
  description: The date the product was last modified, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateModifiedGmt
  name: date modified gmt
  description: The date the product was last modified, as GMT
  datatype: dateTime
  max count: 1
property:
  path: type
  name: type
  description: Product type
  datatype: string
  min count: 1
  max count: 1
  in: simple
  in: grouped
  in: external
  in: variable
property:
  path: status
  name: status
  description: Product status (post status)
  datatype: string
  min count: 1
  max count: 1
  in: publish
  in: draft
  in: pending
  in: private
  in: auto-draft
  in: trash
property:
  path: featured
  name: featured
  description: Featured product
  datatype: boolean
  max count: 1
property:
  path: catalogVisibility
  name: catalog visibility
  description: Catalog visibility
  datatype: string
  max count: 1
  in: visible
  in: catalog
  in: search
  in: hidden
property:
  path: description
  name: description
  description: Product description
  datatype: string
  max count: 1
property:
  path: shortDescription
  name: short description
  description: Product short description
  datatype: string
  max count: 1
property:
  path: sku
  name: sku
  description: Unique identifier (Stock Keeping Unit)
  datatype: string
  max count: 1
property:
  path: globalUniqueId
  name: global unique id
  description: Global product identifier
  datatype: string
  or:
    datatype: string
    pattern: ^\d{8}$|^\d{12,14}$
  or:
    datatype: string
    pattern: ^\d{8}$|^\d{12}$
  or:
    datatype: string
    pattern: ^\d{8}$|^\d{13}$
  or:
    datatype: string
    pattern: ^[\d-]{10,17}$|^\d{9}[\dX]$
  max count: 1
property:
  path: price
  name: price
  description: Current product price
  datatype: string
  max count: 1
property:
  path: regularPrice
  name: regular price
  description: Product regular price
  datatype: string
  max count: 1
property:
  path: salePrice
  name: sale price
  description: Product sale price
  datatype: string
  max count: 1
property:
  path: dateOnSaleFrom
  name: date on sale from
  description: Start date of sale price, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateOnSaleFromGmt
  name: date on sale from gmt
  description: Start date of sale price, as GMT
  datatype: dateTime
  max count: 1
property:
  path: dateOnSaleTo
  name: date on sale to
  description: End date of sale price, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateOnSaleToGmt
  name: date on sale to gmt
  description: End date of sale price, as GMT
  datatype: dateTime
  max count: 1
property:
  path: priceHtml
  name: price html
  description: Price formatted in HTML
  datatype: string
  max count: 1
property:
  path: onSale
  name: on sale
  description: Shows if the product is on sale
  datatype: boolean
  max count: 1
property:
  path: purchasable
  name: purchasable
  description: Shows if the product can be bought
  datatype: boolean
  max count: 1
property:
  path: totalSales
  name: total sales
  description: Amount of sales
  datatype: long
  max count: 1
property:
  path: virtual
  name: virtual
  description: If the product is virtual (no shipping)
  datatype: boolean
  max count: 1

ProductUpdatedEventShape
type: NodeShape
target class: ProductUpdatedEvent
property:
  path: id
  name: id
  description: Unique identifier for the resource
  datatype: long
  min count: 1
  max count: 1
property:
  path: name
  name: name
  description: Product name
  datatype: string
  min count: 1
  max count: 1
property:
  path: slug
  name: slug
  description: URL-friendly slug
  datatype: string
  min count: 1
  max count: 1
property:
  path: permalink
  name: permalink
  description: Product URL
  datatype: anyURI
  max count: 1
property:
  path: dateCreated
  name: date created
  description: The date the product was created, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateCreatedGmt
  name: date created gmt
  description: The date the product was created, as GMT
  datatype: dateTime
  max count: 1
property:
  path: dateModified
  name: date modified
  description: The date the product was last modified, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateModifiedGmt
  name: date modified gmt
  description: The date the product was last modified, as GMT
  datatype: dateTime
  max count: 1
property:
  path: type
  name: type
  description: Product type
  datatype: string
  min count: 1
  max count: 1
  in: simple
  in: grouped
  in: external
  in: variable
property:
  path: status
  name: status
  description: Product status (post status)
  datatype: string
  min count: 1
  max count: 1
  in: publish
  in: draft
  in: pending
  in: private
  in: auto-draft
  in: trash
property:
  path: featured
  name: featured
  description: Featured product
  datatype: boolean
  max count: 1
property:
  path: catalogVisibility
  name: catalog visibility
  description: Catalog visibility
  datatype: string
  max count: 1
  in: visible
  in: catalog
  in: search
  in: hidden
property:
  path: description
  name: description
  description: Product description
  datatype: string
  max count: 1
property:
  path: shortDescription
  name: short description
  description: Product short description
  datatype: string
  max count: 1
property:
  path: sku
  name: sku
  description: Unique identifier (Stock Keeping Unit)
  datatype: string
  max count: 1
property:
  path: globalUniqueId
  name: global unique id
  description: Global product identifier
  datatype: string
  or:
    datatype: string
    pattern: ^\d{8}$|^\d{12,14}$
  or:
    datatype: string
    pattern: ^\d{8}$|^\d{12}$
  or:
    datatype: string
    pattern: ^\d{8}$|^\d{13}$
  or:
    datatype: string
    pattern: ^[\d-]{10,17}$|^\d{9}[\dX]$
  max count: 1
property:
  path: price
  name: price
  description: Current product price
  datatype: string
  max count: 1
property:
  path: regularPrice
  name: regular price
  description: Product regular price
  datatype: string
  max count: 1
property:
  path: salePrice
  name: sale price
  description: Product sale price
  datatype: string
  max count: 1
property:
  path: dateOnSaleFrom
  name: date on sale from
  description: Start date of sale price, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateOnSaleFromGmt
  name: date on sale from gmt
  description: Start date of sale price, as GMT
  datatype: dateTime
  max count: 1
property:
  path: dateOnSaleTo
  name: date on sale to
  description: End date of sale price, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateOnSaleToGmt
  name: date on sale to gmt
  description: End date of sale price, as GMT
  datatype: dateTime
  max count: 1
property:
  path: priceHtml
  name: price html
  description: Price formatted in HTML
  datatype: string
  max count: 1
property:
  path: onSale
  name: on sale
  description: Shows if the product is on sale
  datatype: boolean
  max count: 1
property:
  path: purchasable
  name: purchasable
  description: Shows if the product can be bought
  datatype: boolean
  max count: 1
property:
  path: totalSales
  name: total sales
  description: Amount of sales
  datatype: long
  max count: 1
property:
  path: virtual
  name: virtual
  description: If the product is virtual (no shipping)
  datatype: boolean
  max count: 1

ProductDeletedEventShape
type: NodeShape
target class: ProductDeletedEvent
property:
  path: id
  name: id
  description: Deleted product ID
  datatype: long
  min count: 1
  max count: 1

ProductRestoredEventShape
type: NodeShape
target class: ProductRestoredEvent
property:
  path: id
  name: id
  description: Unique identifier for the resource
  datatype: long
  min count: 1
  max count: 1
property:
  path: name
  name: name
  description: Product name
  datatype: string
  min count: 1
  max count: 1
property:
  path: slug
  name: slug
  description: URL-friendly slug
  datatype: string
  min count: 1
  max count: 1
property:
  path: permalink
  name: permalink
  description: Product URL
  datatype: anyURI
  max count: 1
property:
  path: dateCreated
  name: date created
  description: The date the product was created, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateCreatedGmt
  name: date created gmt
  description: The date the product was created, as GMT
  datatype: dateTime
  max count: 1
property:
  path: dateModified
  name: date modified
  description: The date the product was last modified, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateModifiedGmt
  name: date modified gmt
  description: The date the product was last modified, as GMT
  datatype: dateTime
  max count: 1
property:
  path: type
  name: type
  description: Product type
  datatype: string
  min count: 1
  max count: 1
  in: simple
  in: grouped
  in: external
  in: variable
property:
  path: status
  name: status
  description: Product status (post status)
  datatype: string
  min count: 1
  max count: 1
  in: publish
  in: draft
  in: pending
  in: private
  in: auto-draft
  in: trash
property:
  path: featured
  name: featured
  description: Featured product
  datatype: boolean
  max count: 1
property:
  path: catalogVisibility
  name: catalog visibility
  description: Catalog visibility
  datatype: string
  max count: 1
  in: visible
  in: catalog
  in: search
  in: hidden
property:
  path: description
  name: description
  description: Product description
  datatype: string
  max count: 1
property:
  path: shortDescription
  name: short description
  description: Product short description
  datatype: string
  max count: 1
property:
  path: sku
  name: sku
  description: Unique identifier (Stock Keeping Unit)
  datatype: string
  max count: 1
property:
  path: globalUniqueId
  name: global unique id
  description: Global product identifier
  datatype: string
  or:
    datatype: string
    pattern: ^\d{8}$|^\d{12,14}$
  or:
    datatype: string
    pattern: ^\d{8}$|^\d{12}$
  or:
    datatype: string
    pattern: ^\d{8}$|^\d{13}$
  or:
    datatype: string
    pattern: ^[\d-]{10,17}$|^\d{9}[\dX]$
  max count: 1
property:
  path: price
  name: price
  description: Current product price
  datatype: string
  max count: 1
property:
  path: regularPrice
  name: regular price
  description: Product regular price
  datatype: string
  max count: 1
property:
  path: salePrice
  name: sale price
  description: Product sale price
  datatype: string
  max count: 1
property:
  path: dateOnSaleFrom
  name: date on sale from
  description: Start date of sale price, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateOnSaleFromGmt
  name: date on sale from gmt
  description: Start date of sale price, as GMT
  datatype: dateTime
  max count: 1
property:
  path: dateOnSaleTo
  name: date on sale to
  description: End date of sale price, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateOnSaleToGmt
  name: date on sale to gmt
  description: End date of sale price, as GMT
  datatype: dateTime
  max count: 1
property:
  path: priceHtml
  name: price html
  description: Price formatted in HTML
  datatype: string
  max count: 1
property:
  path: onSale
  name: on sale
  description: Shows if the product is on sale
  datatype: boolean
  max count: 1
property:
  path: purchasable
  name: purchasable
  description: Shows if the product can be bought
  datatype: boolean
  max count: 1
property:
  path: totalSales
  name: total sales
  description: Amount of sales
  datatype: long
  max count: 1
property:
  path: virtual
  name: virtual
  description: If the product is virtual (no shipping)
  datatype: boolean
  max count: 1

OrderCreatedEventShape
type: NodeShape
target class: OrderCreatedEvent
property:
  path: id
  name: id
  description: Unique identifier
  datatype: long
  min count: 1
  max count: 1
property:
  path: parent
  name: parent
  description: Parent order (for order parts)
  node: OrderShape
  class: Order
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: number
  name: number
  description: Order number (may differ from ID)
  datatype: string
  max count: 1
property:
  path: orderKey
  name: order key
  description: Order key (for guest checkout links)
  datatype: string
  max count: 1
property:
  path: createdVia
  name: created via
  description: Shows where the order was created. Can only be set during creation.
  datatype: string
  max count: 1
property:
  path: version
  name: version
  description: Version of WooCommerce which last updated the order
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Order status
  datatype: string
  min count: 1
  max count: 1
  in: pending
  in: processing
  in: on-hold
  in: completed
  in: cancelled
  in: refunded
  in: failed
  in: trash
  in: auto-draft
  in: checkout-draft
property:
  path: currency
  name: currency
  description: Currency code (ISO 4217)
  datatype: string
  min count: 1
  max count: 1
property:
  path: currencySymbol
  name: currency symbol
  description: Currency symbol
  datatype: string
  max count: 1
property:
  path: dateCreated
  name: date created
  description: The date the order was created, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateCreatedGmt
  name: date created gmt
  description: The date the order was created, as GMT
  datatype: dateTime
  max count: 1
property:
  path: dateModified
  name: date modified
  description: The date the order was last modified, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateModifiedGmt
  name: date modified gmt
  description: The date the order was last modified, as GMT
  datatype: dateTime
  max count: 1
property:
  path: discountTotal
  name: discount total
  description: Total discount amount
  datatype: string
  max count: 1
property:
  path: discountTax
  name: discount tax
  description: Total discount tax
  datatype: string
  max count: 1
property:
  path: shippingTotal
  name: shipping total
  description: Total shipping amount
  datatype: string
  max count: 1
property:
  path: shippingTax
  name: shipping tax
  description: Total shipping tax
  datatype: string
  max count: 1
property:
  path: cartTax
  name: cart tax
  description: Sum of line item taxes only
  datatype: string
  max count: 1
property:
  path: total
  name: total
  description: Grand total
  datatype: string
  max count: 1
property:
  path: totalTax
  name: total tax
  description: Sum of all taxes
  datatype: string
  max count: 1
property:
  path: pricesIncludeTax
  name: prices include tax
  description: True if prices included tax during checkout
  datatype: boolean
  max count: 1
property:
  path: customer
  name: customer
  description: Customer who owns the order. 0 for guests.
  node: CustomerShape
  class: Customer
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: customerIpAddress
  name: customer ip address
  description: Customer's IP address
  datatype: string
  max count: 1
property:
  path: customerUserAgent
  name: customer user agent
  description: User agent of the customer
  datatype: string
  max count: 1
property:
  path: customerNote
  name: customer note
  description: Note left by customer during checkout
  datatype: string
  max count: 1
property:
  path: billing
  name: billing
  description: Billing address
  node: BillingAddressShape
  class: BillingAddress
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: shipping
  name: shipping
  description: Shipping address
  node: ShippingAddressShape
  class: ShippingAddress
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: paymentMethod
  name: payment method
  description: Payment method ID
  datatype: string
  max count: 1
property:
  path: paymentMethodTitle
  name: payment method title
  description: Payment method title
  datatype: string
  max count: 1
property:
  path: transactionId
  name: transaction id
  description: Unique transaction ID
  datatype: string
  max count: 1

OrderUpdatedEventShape
type: NodeShape
target class: OrderUpdatedEvent
property:
  path: id
  name: id
  description: Unique identifier
  datatype: long
  min count: 1
  max count: 1
property:
  path: parent
  name: parent
  description: Parent order (for order parts)
  node: OrderShape
  class: Order
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: number
  name: number
  description: Order number (may differ from ID)
  datatype: string
  max count: 1
property:
  path: orderKey
  name: order key
  description: Order key (for guest checkout links)
  datatype: string
  max count: 1
property:
  path: createdVia
  name: created via
  description: Shows where the order was created. Can only be set during creation.
  datatype: string
  max count: 1
property:
  path: version
  name: version
  description: Version of WooCommerce which last updated the order
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Order status
  datatype: string
  min count: 1
  max count: 1
  in: pending
  in: processing
  in: on-hold
  in: completed
  in: cancelled
  in: refunded
  in: failed
  in: trash
  in: auto-draft
  in: checkout-draft
property:
  path: currency
  name: currency
  description: Currency code (ISO 4217)
  datatype: string
  min count: 1
  max count: 1
property:
  path: currencySymbol
  name: currency symbol
  description: Currency symbol
  datatype: string
  max count: 1
property:
  path: dateCreated
  name: date created
  description: The date the order was created, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateCreatedGmt
  name: date created gmt
  description: The date the order was created, as GMT
  datatype: dateTime
  max count: 1
property:
  path: dateModified
  name: date modified
  description: The date the order was last modified, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateModifiedGmt
  name: date modified gmt
  description: The date the order was last modified, as GMT
  datatype: dateTime
  max count: 1
property:
  path: discountTotal
  name: discount total
  description: Total discount amount
  datatype: string
  max count: 1
property:
  path: discountTax
  name: discount tax
  description: Total discount tax
  datatype: string
  max count: 1
property:
  path: shippingTotal
  name: shipping total
  description: Total shipping amount
  datatype: string
  max count: 1
property:
  path: shippingTax
  name: shipping tax
  description: Total shipping tax
  datatype: string
  max count: 1
property:
  path: cartTax
  name: cart tax
  description: Sum of line item taxes only
  datatype: string
  max count: 1
property:
  path: total
  name: total
  description: Grand total
  datatype: string
  max count: 1
property:
  path: totalTax
  name: total tax
  description: Sum of all taxes
  datatype: string
  max count: 1
property:
  path: pricesIncludeTax
  name: prices include tax
  description: True if prices included tax during checkout
  datatype: boolean
  max count: 1
property:
  path: customer
  name: customer
  description: Customer who owns the order. 0 for guests.
  node: CustomerShape
  class: Customer
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: customerIpAddress
  name: customer ip address
  description: Customer's IP address
  datatype: string
  max count: 1
property:
  path: customerUserAgent
  name: customer user agent
  description: User agent of the customer
  datatype: string
  max count: 1
property:
  path: customerNote
  name: customer note
  description: Note left by customer during checkout
  datatype: string
  max count: 1
property:
  path: billing
  name: billing
  description: Billing address
  node: BillingAddressShape
  class: BillingAddress
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: shipping
  name: shipping
  description: Shipping address
  node: ShippingAddressShape
  class: ShippingAddress
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: paymentMethod
  name: payment method
  description: Payment method ID
  datatype: string
  max count: 1
property:
  path: paymentMethodTitle
  name: payment method title
  description: Payment method title
  datatype: string
  max count: 1
property:
  path: transactionId
  name: transaction id
  description: Unique transaction ID
  datatype: string
  max count: 1

OrderDeletedEventShape
type: NodeShape
target class: OrderDeletedEvent
property:
  path: id
  name: id
  description: Deleted order ID
  datatype: long
  min count: 1
  max count: 1

OrderRestoredEventShape
type: NodeShape
target class: OrderRestoredEvent
property:
  path: id
  name: id
  description: Unique identifier
  datatype: long
  min count: 1
  max count: 1
property:
  path: parent
  name: parent
  description: Parent order (for order parts)
  node: OrderShape
  class: Order
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: number
  name: number
  description: Order number (may differ from ID)
  datatype: string
  max count: 1
property:
  path: orderKey
  name: order key
  description: Order key (for guest checkout links)
  datatype: string
  max count: 1
property:
  path: createdVia
  name: created via
  description: Shows where the order was created. Can only be set during creation.
  datatype: string
  max count: 1
property:
  path: version
  name: version
  description: Version of WooCommerce which last updated the order
  datatype: string
  max count: 1
property:
  path: status
  name: status
  description: Order status
  datatype: string
  min count: 1
  max count: 1
  in: pending
  in: processing
  in: on-hold
  in: completed
  in: cancelled
  in: refunded
  in: failed
  in: trash
  in: auto-draft
  in: checkout-draft
property:
  path: currency
  name: currency
  description: Currency code (ISO 4217)
  datatype: string
  min count: 1
  max count: 1
property:
  path: currencySymbol
  name: currency symbol
  description: Currency symbol
  datatype: string
  max count: 1
property:
  path: dateCreated
  name: date created
  description: The date the order was created, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateCreatedGmt
  name: date created gmt
  description: The date the order was created, as GMT
  datatype: dateTime
  max count: 1
property:
  path: dateModified
  name: date modified
  description: The date the order was last modified, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateModifiedGmt
  name: date modified gmt
  description: The date the order was last modified, as GMT
  datatype: dateTime
  max count: 1
property:
  path: discountTotal
  name: discount total
  description: Total discount amount
  datatype: string
  max count: 1
property:
  path: discountTax
  name: discount tax
  description: Total discount tax
  datatype: string
  max count: 1
property:
  path: shippingTotal
  name: shipping total
  description: Total shipping amount
  datatype: string
  max count: 1
property:
  path: shippingTax
  name: shipping tax
  description: Total shipping tax
  datatype: string
  max count: 1
property:
  path: cartTax
  name: cart tax
  description: Sum of line item taxes only
  datatype: string
  max count: 1
property:
  path: total
  name: total
  description: Grand total
  datatype: string
  max count: 1
property:
  path: totalTax
  name: total tax
  description: Sum of all taxes
  datatype: string
  max count: 1
property:
  path: pricesIncludeTax
  name: prices include tax
  description: True if prices included tax during checkout
  datatype: boolean
  max count: 1
property:
  path: customer
  name: customer
  description: Customer who owns the order. 0 for guests.
  node: CustomerShape
  class: Customer
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: customerIpAddress
  name: customer ip address
  description: Customer's IP address
  datatype: string
  max count: 1
property:
  path: customerUserAgent
  name: customer user agent
  description: User agent of the customer
  datatype: string
  max count: 1
property:
  path: customerNote
  name: customer note
  description: Note left by customer during checkout
  datatype: string
  max count: 1
property:
  path: billing
  name: billing
  description: Billing address
  node: BillingAddressShape
  class: BillingAddress
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: shipping
  name: shipping
  description: Shipping address
  node: ShippingAddressShape
  class: ShippingAddress
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: paymentMethod
  name: payment method
  description: Payment method ID
  datatype: string
  max count: 1
property:
  path: paymentMethodTitle
  name: payment method title
  description: Payment method title
  datatype: string
  max count: 1
property:
  path: transactionId
  name: transaction id
  description: Unique transaction ID
  datatype: string
  max count: 1

CustomerCreatedEventShape
type: NodeShape
target class: CustomerCreatedEvent
property:
  path: id
  name: id
  description: Unique identifier for the resource
  datatype: long
  min count: 1
  max count: 1
property:
  path: dateCreated
  name: date created
  description: The date the customer was created, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateCreatedGmt
  name: date created gmt
  description: The date the customer was created, as GMT
  datatype: dateTime
  max count: 1
property:
  path: dateModified
  name: date modified
  description: The date the customer was last modified, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateModifiedGmt
  name: date modified gmt
  description: The date the customer was last modified, as GMT
  datatype: dateTime
  max count: 1
property:
  path: email
  name: email
  description: The email address for the customer
  datatype: string
  min count: 1
  max count: 1
property:
  path: firstName
  name: first name
  description: Customer first name
  datatype: string
  max count: 1
property:
  path: lastName
  name: last name
  description: Customer last name
  datatype: string
  max count: 1
property:
  path: role
  name: role
  description: Customer role
  datatype: string
  max count: 1
property:
  path: username
  name: username
  description: Customer login name
  datatype: string
  max count: 1
property:
  path: billing
  name: billing
  description: List of billing address data
  node: BillingAddressShape
  class: BillingAddress
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: shipping
  name: shipping
  description: List of shipping address data
  node: ShippingAddressShape
  class: ShippingAddress
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: isPayingCustomer
  name: is paying customer
  description: Is the customer a paying customer?
  datatype: boolean
  max count: 1
property:
  path: avatarUrl
  name: avatar url
  description: Avatar URL
  datatype: string
  max count: 1
property:
  path: metadata
  name: metadata
  description: Meta data
  node: MetadataShape
  class: Metadata
  node kind: BlankNodeOrIRI
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

CustomerUpdatedEventShape
type: NodeShape
target class: CustomerUpdatedEvent
property:
  path: id
  name: id
  description: Unique identifier for the resource
  datatype: long
  min count: 1
  max count: 1
property:
  path: dateCreated
  name: date created
  description: The date the customer was created, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateCreatedGmt
  name: date created gmt
  description: The date the customer was created, as GMT
  datatype: dateTime
  max count: 1
property:
  path: dateModified
  name: date modified
  description: The date the customer was last modified, in the site's timezone
  datatype: dateTime
  max count: 1
property:
  path: dateModifiedGmt
  name: date modified gmt
  description: The date the customer was last modified, as GMT
  datatype: dateTime
  max count: 1
property:
  path: email
  name: email
  description: The email address for the customer
  datatype: string
  min count: 1
  max count: 1
property:
  path: firstName
  name: first name
  description: Customer first name
  datatype: string
  max count: 1
property:
  path: lastName
  name: last name
  description: Customer last name
  datatype: string
  max count: 1
property:
  path: role
  name: role
  description: Customer role
  datatype: string
  max count: 1
property:
  path: username
  name: username
  description: Customer login name
  datatype: string
  max count: 1
property:
  path: billing
  name: billing
  description: List of billing address data
  node: BillingAddressShape
  class: BillingAddress
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: shipping
  name: shipping
  description: List of shipping address data
  node: ShippingAddressShape
  class: ShippingAddress
  node kind: BlankNodeOrIRI
  max count: 1
property:
  path: isPayingCustomer
  name: is paying customer
  description: Is the customer a paying customer?
  datatype: boolean
  max count: 1
property:
  path: avatarUrl
  name: avatar url
  description: Avatar URL
  datatype: string
  max count: 1
property:
  path: metadata
  name: metadata
  description: Meta data
  node: MetadataShape
  class: Metadata
  node kind: BlankNodeOrIRI
property:
  path: links
  name: links
  description: HAL links
  node: LinksShape
  class: Links
  node kind: BlankNodeOrIRI
  max count: 1

CustomerDeletedEventShape
type: NodeShape
target class: CustomerDeletedEvent
property:
  path: id
  name: id
  description: Deleted customer ID
  datatype: long
  min count: 1
  max count: 1

CouponCreatedEventShape
type: NodeShape
target class: CouponCreatedEvent
property:
  path: id
  name: id
  description: Coupon ID
  datatype: long
  min count: 1
  max count: 1
property:
  path: code
  name: code
  description: Coupon code
  datatype: string
  min count: 1
  max count: 1
property:
  path: amount
  name: amount
  description: Discount amount
  datatype: string
  max count: 1
property:
  path: discountType
  name: discount type
  description: Discount type
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: Description
  datatype: string
  max count: 1
property:
  path: dateExpires
  name: date expires
  description: Expiry date
  datatype: dateTime
  max count: 1
property:
  path: usageCount
  name: usage count
  description: Usage count
  datatype: int
  max count: 1
property:
  path: usageLimit
  name: usage limit
  description: Usage limit
  datatype: int
  max count: 1
property:
  path: freeShipping
  name: free shipping
  description: Whether free shipping is granted
  datatype: boolean
  max count: 1
property:
  path: metadata
  name: metadata
  description: Metadata
  node: MetadataShape
  class: Metadata
  node kind: BlankNodeOrIRI

CouponUpdatedEventShape
type: NodeShape
target class: CouponUpdatedEvent
property:
  path: id
  name: id
  description: Coupon ID
  datatype: long
  min count: 1
  max count: 1
property:
  path: code
  name: code
  description: Coupon code
  datatype: string
  min count: 1
  max count: 1
property:
  path: amount
  name: amount
  description: Discount amount
  datatype: string
  max count: 1
property:
  path: discountType
  name: discount type
  description: Discount type
  datatype: string
  max count: 1
property:
  path: description
  name: description
  description: Description
  datatype: string
  max count: 1
property:
  path: dateExpires
  name: date expires
  description: Expiry date
  datatype: dateTime
  max count: 1
property:
  path: usageCount
  name: usage count
  description: Usage count
  datatype: int
  max count: 1
property:
  path: usageLimit
  name: usage limit
  description: Usage limit
  datatype: int
  max count: 1
property:
  path: freeShipping
  name: free shipping
  description: Whether free shipping is granted
  datatype: boolean
  max count: 1
property:
  path: metadata
  name: metadata
  description: Metadata
  node: MetadataShape
  class: Metadata
  node kind: BlankNodeOrIRI

CouponDeletedEventShape
type: NodeShape
target class: CouponDeletedEvent
property:
  path: id
  name: id
  description: Deleted coupon ID
  datatype: long
  min count: 1
  max count: 1

dataShape
type: NodeShape
target class: data
property:
  path: status
  name: status
  description: HTTP status code
  datatype: int
  min count: 1
  max count: 1

ContainerShape
type: NodeShape
target class: Container
property:
  path:
    inverse path: settings
  class: PaymentGateway
  min count: 1
  max count: 1
property:
  path: entry
  node: EntryShape
  class: Entry
  node kind: BlankNodeOrIRI
sparql: SPARQLConstraint
  message: Record entry keys must be unique
  select: SELECT $this ?key WHERE { $this <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.PaymentGateway/settings/entry> ?left, ?right . FILTER(?left != ?right) ?left <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.PaymentGateway/settings/key> ?key . ?right <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.PaymentGateway/settings/key> ?key . }

EntryShape
type: NodeShape
target class: Entry
property:
  path:
    inverse path: entry
  class: Container
  min count: 1
  max count: 1
property:
  path: key
  datatype: string
  min count: 1
  max count: 1
property:
  path: value
  node: PaymentGatewaySettingShape
  class: PaymentGatewaySetting
  node kind: BlankNodeOrIRI
  min count: 1
  max count: 1

ContainerShape
type: NodeShape
target class: Container
property:
  path:
    inverse path: settings
  class: PaymentGatewayInput
  min count: 1
  max count: 1
property:
  path: entry
  node: EntryShape
  class: Entry
  node kind: BlankNodeOrIRI
sparql: SPARQLConstraint
  message: Record entry keys must be unique
  select: SELECT $this ?key WHERE { $this <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.PaymentGatewayInput/settings/entry> ?left, ?right . FILTER(?left != ?right) ?left <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.PaymentGatewayInput/settings/key> ?key . ?right <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.PaymentGatewayInput/settings/key> ?key . }

EntryShape
type: NodeShape
target class: Entry
property:
  path:
    inverse path: entry
  class: Container
  min count: 1
  max count: 1
property:
  path: key
  datatype: string
  min count: 1
  max count: 1
property:
  path: value
  datatype: string
  min count: 1
  max count: 1

ContainerShape
type: NodeShape
target class: Container
property:
  path:
    inverse path: options
  class: PaymentGatewaySetting
  min count: 1
  max count: 1
property:
  path: entry
  node: EntryShape
  class: Entry
  node kind: BlankNodeOrIRI
sparql: SPARQLConstraint
  message: Record entry keys must be unique
  select: SELECT $this ?key WHERE { $this <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.PaymentGatewaySetting/options/entry> ?left, ?right . FILTER(?left != ?right) ?left <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.PaymentGatewaySetting/options/key> ?key . ?right <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.PaymentGatewaySetting/options/key> ?key . }

EntryShape
type: NodeShape
target class: Entry
property:
  path:
    inverse path: entry
  class: Container
  min count: 1
  max count: 1
property:
  path: key
  datatype: string
  min count: 1
  max count: 1
property:
  path: value
  datatype: string
  min count: 1
  max count: 1

ContainerShape
type: NodeShape
target class: Container
property:
  path:
    inverse path: reviewerAvatarUrls
  class: ProductReview
  min count: 1
  max count: 1
property:
  path: entry
  node: EntryShape
  class: Entry
  node kind: BlankNodeOrIRI
sparql: SPARQLConstraint
  message: Record entry keys must be unique
  select: SELECT $this ?key WHERE { $this <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.ProductReview/reviewerAvatarUrls/entry> ?left, ?right . FILTER(?left != ?right) ?left <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.ProductReview/reviewerAvatarUrls/key> ?key . ?right <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.ProductReview/reviewerAvatarUrls/key> ?key . }

EntryShape
type: NodeShape
target class: Entry
property:
  path:
    inverse path: entry
  class: Container
  min count: 1
  max count: 1
property:
  path: key
  datatype: string
  min count: 1
  max count: 1
property:
  path: value
  datatype: string
  min count: 1
  max count: 1

ContainerShape
type: NodeShape
target class: Container
property:
  path:
    inverse path: totals
  class: SalesReport
  min count: 1
  max count: 1
property:
  path: entry
  node: EntryShape
  class: Entry
  node kind: BlankNodeOrIRI
sparql: SPARQLConstraint
  message: Record entry keys must be unique
  select: SELECT $this ?key WHERE { $this <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.SalesReport/totals/entry> ?left, ?right . FILTER(?left != ?right) ?left <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.SalesReport/totals/key> ?key . ?right <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.SalesReport/totals/key> ?key . }

EntryShape
type: NodeShape
target class: Entry
property:
  path:
    inverse path: entry
  class: Container
  min count: 1
  max count: 1
property:
  path: key
  datatype: string
  min count: 1
  max count: 1
property:
  path: value
  node: SalesReportPeriodShape
  class: SalesReportPeriod
  node kind: BlankNodeOrIRI
  min count: 1
  max count: 1

ContainerShape
type: NodeShape
target class: Container
property:
  path:
    inverse path: options
  class: SettingOption
  min count: 1
  max count: 1
property:
  path: entry
  node: EntryShape
  class: Entry
  node kind: BlankNodeOrIRI
sparql: SPARQLConstraint
  message: Record entry keys must be unique
  select: SELECT $this ?key WHERE { $this <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.SettingOption/options/entry> ?left, ?right . FILTER(?left != ?right) ?left <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.SettingOption/options/key> ?key . ?right <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.SettingOption/options/key> ?key . }

EntryShape
type: NodeShape
target class: Entry
property:
  path:
    inverse path: entry
  class: Container
  min count: 1
  max count: 1
property:
  path: key
  datatype: string
  min count: 1
  max count: 1
property:
  path: value
  datatype: string
  min count: 1
  max count: 1

ContainerShape
type: NodeShape
target class: Container
property:
  path:
    inverse path: settings
  class: ShippingZoneMethod
  min count: 1
  max count: 1
property:
  path: entry
  node: EntryShape
  class: Entry
  node kind: BlankNodeOrIRI
sparql: SPARQLConstraint
  message: Record entry keys must be unique
  select: SELECT $this ?key WHERE { $this <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.ShippingZoneMethod/settings/entry> ?left, ?right . FILTER(?left != ?right) ?left <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.ShippingZoneMethod/settings/key> ?key . ?right <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.ShippingZoneMethod/settings/key> ?key . }

EntryShape
type: NodeShape
target class: Entry
property:
  path:
    inverse path: entry
  class: Container
  min count: 1
  max count: 1
property:
  path: key
  datatype: string
  min count: 1
  max count: 1
property:
  path: value
  node: ShippingZoneMethodSettingShape
  class: ShippingZoneMethodSetting
  node kind: BlankNodeOrIRI
  min count: 1
  max count: 1

ContainerShape
type: NodeShape
target class: Container
property:
  path:
    inverse path: options
  class: ShippingZoneMethodSetting
  min count: 1
  max count: 1
property:
  path: entry
  node: EntryShape
  class: Entry
  node kind: BlankNodeOrIRI
sparql: SPARQLConstraint
  message: Record entry keys must be unique
  select: SELECT $this ?key WHERE { $this <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.ShippingZoneMethodSetting/options/entry> ?left, ?right . FILTER(?left != ?right) ?left <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.ShippingZoneMethodSetting/options/key> ?key . ?right <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.ShippingZoneMethodSetting/options/key> ?key . }

EntryShape
type: NodeShape
target class: Entry
property:
  path:
    inverse path: entry
  class: Container
  min count: 1
  max count: 1
property:
  path: key
  datatype: string
  min count: 1
  max count: 1
property:
  path: value
  datatype: string
  min count: 1
  max count: 1

ContainerShape
type: NodeShape
target class: Container
property:
  path:
    inverse path: settings
  class: ShippingZoneMethodUpdateInput
  min count: 1
  max count: 1
property:
  path: entry
  node: EntryShape
  class: Entry
  node kind: BlankNodeOrIRI
sparql: SPARQLConstraint
  message: Record entry keys must be unique
  select: SELECT $this ?key WHERE { $this <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.ShippingZoneMethodUpdateInput/settings/entry> ?left, ?right . FILTER(?left != ?right) ?left <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.ShippingZoneMethodUpdateInput/settings/key> ?key . ?right <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.ShippingZoneMethodUpdateInput/settings/key> ?key . }

EntryShape
type: NodeShape
target class: Entry
property:
  path:
    inverse path: entry
  class: Container
  min count: 1
  max count: 1
property:
  path: key
  datatype: string
  min count: 1
  max count: 1
property:
  path: value
  datatype: string
  min count: 1
  max count: 1

ContainerShape
type: NodeShape
target class: Container
property:
  path:
    inverse path: databaseTables
  class: SystemStatusDatabase
  min count: 1
  max count: 1
property:
  path: entry
  node: EntryShape
  class: Entry
  node kind: BlankNodeOrIRI
sparql: SPARQLConstraint
  message: Record entry keys must be unique
  select: SELECT $this ?key WHERE { $this <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.SystemStatusDatabase/databaseTables/entry> ?left, ?right . FILTER(?left != ?right) ?left <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.SystemStatusDatabase/databaseTables/key> ?key . ?right <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.SystemStatusDatabase/databaseTables/key> ?key . }

EntryShape
type: NodeShape
target class: Entry
property:
  path:
    inverse path: entry
  class: Container
  min count: 1
  max count: 1
property:
  path: key
  datatype: string
  min count: 1
  max count: 1
property:
  path: value
  datatype: boolean
  min count: 1
  max count: 1

ContainerShape
type: NodeShape
target class: Container
property:
  path:
    inverse path: taxonomies
  class: SystemStatusSettings
  min count: 1
  max count: 1
property:
  path: entry
  node: EntryShape
  class: Entry
  node kind: BlankNodeOrIRI
sparql: SPARQLConstraint
  message: Record entry keys must be unique
  select: SELECT $this ?key WHERE { $this <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.SystemStatusSettings/taxonomies/entry> ?left, ?right . FILTER(?left != ?right) ?left <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.SystemStatusSettings/taxonomies/key> ?key . ?right <https://relay.inferal.com/ontology/woocommerce/record/WooCommerce.SystemStatusSettings/taxonomies/key> ?key . }

EntryShape
type: NodeShape
target class: Entry
property:
  path:
    inverse path: entry
  class: Container
  min count: 1
  max count: 1
property:
  path: key
  datatype: string
  min count: 1
  max count: 1
property:
  path: value
  datatype: string
  min count: 1
  max count: 1

path: downloadable
name: downloadable
description: If the product is downloadable
datatype: boolean
max count: 1

path: downloads
name: downloads
description: List of downloadable files
node: ProductDownloadShape
class: ProductDownload
node kind: BlankNodeOrIRI

path: downloadLimit
name: download limit
description: Number of times downloadable files can be downloaded after purchase. Default is -1.
datatype: int
max count: 1

path: downloadExpiry
name: download expiry
description: Number of days until access to downloadable files expires. Default is -1.
datatype: int
max count: 1

path: externalUrl
name: external url
description: Product external URL. Only for external products.
datatype: string
max count: 1

path: buttonText
name: button text
description: Product external button text. Only for external products.
datatype: string
max count: 1

path: taxStatus
name: tax status
description: Tax status
datatype: string
max count: 1
in: taxable
in: shipping
in: none

path: taxClass
name: tax class
description: Tax class
datatype: string
max count: 1

path: manageStock
name: manage stock
description: Stock management at product level
datatype: boolean
max count: 1

path: stockQuantity
name: stock quantity
description: Stock quantity
datatype: long
max count: 1

path: stockStatus
name: stock status
description: Controls the stock status of the product
datatype: string
max count: 1
in: instock
in: outofstock
in: onbackorder

path: backorders
name: backorders
description: If managing stock, this controls if backorders are allowed
datatype: string
max count: 1
in: no
in: notify
in: yes

path: backordersAllowed
name: backorders allowed
description: Shows if backorders are allowed
datatype: boolean
max count: 1

path: backordered
name: backordered
description: Shows if the product is on backordered
datatype: boolean
max count: 1

path: soldIndividually
name: sold individually
description: Allow one item to be bought in a single order
datatype: boolean
max count: 1

path: weight
name: weight
description: Product weight
datatype: string
max count: 1

path: dimensions
name: dimensions
description: Product dimensions
node: ProductDimensionsShape
class: ProductDimensions
node kind: BlankNodeOrIRI
max count: 1

path: shippingRequired
name: shipping required
description: Shows if the product need to be shipped
datatype: boolean
max count: 1

path: shippingTaxable
name: shipping taxable
description: Shows whether or not the product shipping is taxable
datatype: boolean
max count: 1

path: shippingClass
name: shipping class
description: Shipping class slug
datatype: string
max count: 1

path: shippingClassId
name: shipping class id
description: Shipping class ID
node: ProductShippingClassShape
class: ProductShippingClass
node kind: BlankNodeOrIRI
max count: 1

path: reviewsAllowed
name: reviews allowed
description: Allow reviews
datatype: boolean
max count: 1

path: averageRating
name: average rating
description: Reviews average rating
datatype: string
max count: 1

path: ratingCount
name: rating count
description: Amount of reviews that the product have
datatype: int
max count: 1

path: relatedProducts
name: related products
description: List of related products
class: Product
node kind: BlankNodeOrIRI

path: upsellProducts
name: upsell products
description: List of up-sell products
class: Product
node kind: BlankNodeOrIRI

path: crossSellProducts
name: cross sell products
description: List of cross-sell products
class: Product
node kind: BlankNodeOrIRI

path: parent
name: parent
description: Parent product
class: Product
node kind: BlankNodeOrIRI
max count: 1

path: purchaseNote
name: purchase note
description: Optional note to send the customer after purchase
datatype: string
max count: 1

path: categories
name: categories
description: List of categories
node: ProductCategoryRefShape
class: ProductCategoryRef
node kind: BlankNodeOrIRI

path: tags
name: tags
description: List of tags
node: ProductTagRefShape
class: ProductTagRef
node kind: BlankNodeOrIRI

path: images
name: images
description: List of images
node: ProductImageShape
class: ProductImage
node kind: BlankNodeOrIRI

path: attributes
name: attributes
description: List of attributes
node: ProductAttributeShape
class: ProductAttribute
node kind: BlankNodeOrIRI

path: defaultAttributes
name: default attributes
description: Defaults variation attributes
node: DefaultAttributeShape
class: DefaultAttribute
node kind: BlankNodeOrIRI

path: variations
name: variations
description: List of variation IDs
node: ProductVariationShape
class: ProductVariation
node kind: BlankNodeOrIRI

path: groupedProducts
name: grouped products
description: List of grouped product IDs
class: Product
node kind: BlankNodeOrIRI

path: menuOrder
name: menu order
description: Menu order, used to custom sort products
datatype: int
max count: 1

path: metaData
name: meta data
description: Meta data
node: ProductMetadataShape
class: ProductMetadata
node kind: BlankNodeOrIRI

path: links
name: links
description: HAL links
node: LinksShape
class: Links
node kind: BlankNodeOrIRI
max count: 1

path: backorders
name: backorders
description: If managing stock, this controls if backorders are allowed
datatype: string
max count: 1
in: no
in: notify
in: yes

path: backordersAllowed
name: backorders allowed
description: Shows if backorders are allowed
datatype: boolean
max count: 1

path: backordered
name: backordered
description: Shows if the variation is on backordered
datatype: boolean
max count: 1

path: weight
name: weight
description: Variation weight
datatype: string
max count: 1

path: dimensions
name: dimensions
description: Variation dimensions
node: ProductDimensionsShape
class: ProductDimensions
node kind: BlankNodeOrIRI
max count: 1

path: shippingClass
name: shipping class
description: Shipping class slug
datatype: string
max count: 1

path: shippingClassId
name: shipping class id
description: Shipping class ID
node: ProductShippingClassShape
class: ProductShippingClass
node kind: BlankNodeOrIRI
max count: 1

path: image
name: image
description: Variation image
node: ProductImageShape
class: ProductImage
node kind: BlankNodeOrIRI
max count: 1

path: attributes
name: attributes
description: List of variation attributes
node: DefaultAttributeShape
class: DefaultAttribute
node kind: BlankNodeOrIRI

path: menuOrder
name: menu order
description: Menu order
datatype: int
max count: 1

path: metaData
name: meta data
description: Meta data
node: ProductMetadataShape
class: ProductMetadata
node kind: BlankNodeOrIRI

path: links
name: links
description: HAL links
node: LinksShape
class: Links
node kind: BlankNodeOrIRI
max count: 1

path: backorders
name: backorders
description: Backorder status
datatype: string
max count: 1
in: no
in: notify
in: yes

path: soldIndividually
name: sold individually
description: Allow one item to be bought in a single order
datatype: boolean
max count: 1

path: weight
name: weight
description: Product weight
datatype: string
max count: 1

path: dimensions
name: dimensions
description: Product dimensions
node: ProductDimensionsShape
class: ProductDimensions
node kind: BlankNodeOrIRI
max count: 1

path: shippingClass
name: shipping class
description: Shipping class slug
datatype: string
max count: 1

path: reviewsAllowed
name: reviews allowed
description: Allow reviews
datatype: boolean
max count: 1

path: upsellProducts
name: upsell products
description: List of up-sell products
node: ProductShape
class: Product
node kind: BlankNodeOrIRI

path: crossSellProducts
name: cross sell products
description: List of cross-sell products
node: ProductShape
class: Product
node kind: BlankNodeOrIRI

path: parent
name: parent
description: Product parent
node: ProductShape
class: Product
node kind: BlankNodeOrIRI
max count: 1

path: purchaseNote
name: purchase note
description: Optional note to send the customer after purchase
datatype: string
max count: 1

path: categories
name: categories
description: List of categories
node: ProductCategoryRefShape
class: ProductCategoryRef
node kind: BlankNodeOrIRI

path: tags
name: tags
description: List of tags
node: ProductTagRefShape
class: ProductTagRef
node kind: BlankNodeOrIRI

path: images
name: images
description: List of images
node: ProductImageShape
class: ProductImage
node kind: BlankNodeOrIRI

path: attributes
name: attributes
description: List of attributes
node: ProductAttributeShape
class: ProductAttribute
node kind: BlankNodeOrIRI

path: defaultAttributes
name: default attributes
description: Defaults variation attributes
node: DefaultAttributeShape
class: DefaultAttribute
node kind: BlankNodeOrIRI

path: groupedProducts
name: grouped products
description: List of grouped product IDs
node: ProductShape
class: Product
node kind: BlankNodeOrIRI

path: menuOrder
name: menu order
description: Menu order
datatype: int
max count: 1

path: metaData
name: meta data
description: Meta data
node: ProductMetadataShape
class: ProductMetadata
node kind: BlankNodeOrIRI

path: datePaid
name: date paid
description: The date the order was paid, in the site's timezone
datatype: dateTime
max count: 1

path: datePaidGmt
name: date paid gmt
description: The date the order was paid, as GMT
datatype: dateTime
max count: 1

path: dateCompleted
name: date completed
description: The date the order was completed, in the site's timezone
datatype: dateTime
max count: 1

path: dateCompletedGmt
name: date completed gmt
description: The date the order was completed, as GMT
datatype: dateTime
max count: 1

path: cartHash
name: cart hash
description: MD5 hash of cart items to ensure orders are not modified
datatype: string
max count: 1

path: lineItems
name: line items
description: Line items
class: OrderLineItem
node kind: BlankNodeOrIRI

path: taxLines
name: tax lines
description: Tax lines
node: TaxLineShape
class: TaxLine
node kind: BlankNodeOrIRI

path: shippingLines
name: shipping lines
description: Shipping lines
node: ShippingLineShape
class: ShippingLine
node kind: BlankNodeOrIRI

path: feeLines
name: fee lines
description: Fee lines
node: FeeLineShape
class: FeeLine
node kind: BlankNodeOrIRI

path: couponLines
name: coupon lines
description: Coupon lines
node: CouponLineShape
class: CouponLine
node kind: BlankNodeOrIRI

path: refunds
name: refunds
description: List of refunds
node: OrderRefundLineShape
class: OrderRefundLine
node kind: BlankNodeOrIRI

path: needsPayment
name: needs payment
description: Whether order needs payment
datatype: boolean
max count: 1

path: needsProcessing
name: needs processing
description: Whether order needs processing
datatype: boolean
max count: 1

path: paymentUrl
name: payment url
description: Payment URL
datatype: string
max count: 1

path: isEditable
name: is editable
description: Whether order is editable
datatype: boolean
max count: 1

path: metadata
name: metadata
description: Meta data
node: MetadataShape
class: Metadata
node kind: BlankNodeOrIRI

path: links
name: links
description: HAL links
node: LinksShape
class: Links
node kind: BlankNodeOrIRI
max count: 1

path: downloadable
name: downloadable
description: If the product is downloadable
datatype: boolean
max count: 1

path: downloads
name: downloads
description: List of downloadable files
node: ProductDownloadShape
class: ProductDownload
node kind: BlankNodeOrIRI

path: downloadLimit
name: download limit
description: Number of times downloadable files can be downloaded after purchase. Default is -1.
datatype: int
max count: 1

path: downloadExpiry
name: download expiry
description: Number of days until access to downloadable files expires. Default is -1.
datatype: int
max count: 1

path: externalUrl
name: external url
description: Product external URL. Only for external products.
datatype: string
max count: 1

path: buttonText
name: button text
description: Product external button text. Only for external products.
datatype: string
max count: 1

path: taxStatus
name: tax status
description: Tax status
datatype: string
max count: 1
in: taxable
in: shipping
in: none

path: taxClass
name: tax class
description: Tax class
datatype: string
max count: 1

path: manageStock
name: manage stock
description: Stock management at product level
datatype: boolean
max count: 1

path: stockQuantity
name: stock quantity
description: Stock quantity
datatype: long
max count: 1

path: stockStatus
name: stock status
description: Controls the stock status of the product
datatype: string
max count: 1
in: instock
in: outofstock
in: onbackorder

path: backorders
name: backorders
description: If managing stock, this controls if backorders are allowed
datatype: string
max count: 1
in: no
in: notify
in: yes

path: backordersAllowed
name: backorders allowed
description: Shows if backorders are allowed
datatype: boolean
max count: 1

path: backordered
name: backordered
description: Shows if the product is on backordered
datatype: boolean
max count: 1

path: soldIndividually
name: sold individually
description: Allow one item to be bought in a single order
datatype: boolean
max count: 1

path: weight
name: weight
description: Product weight
datatype: string
max count: 1

path: dimensions
name: dimensions
description: Product dimensions
node: ProductDimensionsShape
class: ProductDimensions
node kind: BlankNodeOrIRI
max count: 1

path: shippingRequired
name: shipping required
description: Shows if the product need to be shipped
datatype: boolean
max count: 1

path: shippingTaxable
name: shipping taxable
description: Shows whether or not the product shipping is taxable
datatype: boolean
max count: 1

path: shippingClass
name: shipping class
description: Shipping class slug
datatype: string
max count: 1

path: shippingClassId
name: shipping class id
description: Shipping class ID
node: ProductShippingClassShape
class: ProductShippingClass
node kind: BlankNodeOrIRI
max count: 1

path: reviewsAllowed
name: reviews allowed
description: Allow reviews
datatype: boolean
max count: 1

path: averageRating
name: average rating
description: Reviews average rating
datatype: string
max count: 1

path: ratingCount
name: rating count
description: Amount of reviews that the product have
datatype: int
max count: 1

path: relatedProducts
name: related products
description: List of related products
node: ProductShape
class: Product
node kind: BlankNodeOrIRI

path: upsellProducts
name: upsell products
description: List of up-sell products
node: ProductShape
class: Product
node kind: BlankNodeOrIRI

path: crossSellProducts
name: cross sell products
description: List of cross-sell products
node: ProductShape
class: Product
node kind: BlankNodeOrIRI

path: parent
name: parent
description: Parent product
node: ProductShape
class: Product
node kind: BlankNodeOrIRI
max count: 1

path: purchaseNote
name: purchase note
description: Optional note to send the customer after purchase
datatype: string
max count: 1

path: categories
name: categories
description: List of categories
node: ProductCategoryRefShape
class: ProductCategoryRef
node kind: BlankNodeOrIRI

path: tags
name: tags
description: List of tags
node: ProductTagRefShape
class: ProductTagRef
node kind: BlankNodeOrIRI

path: images
name: images
description: List of images
node: ProductImageShape
class: ProductImage
node kind: BlankNodeOrIRI

path: attributes
name: attributes
description: List of attributes
node: ProductAttributeShape
class: ProductAttribute
node kind: BlankNodeOrIRI

path: defaultAttributes
name: default attributes
description: Defaults variation attributes
node: DefaultAttributeShape
class: DefaultAttribute
node kind: BlankNodeOrIRI

path: variations
name: variations
description: List of variation IDs
node: ProductVariationShape
class: ProductVariation
node kind: BlankNodeOrIRI

path: groupedProducts
name: grouped products
description: List of grouped product IDs
node: ProductShape
class: Product
node kind: BlankNodeOrIRI

path: menuOrder
name: menu order
description: Menu order, used to custom sort products
datatype: int
max count: 1

path: metaData
name: meta data
description: Meta data
node: ProductMetadataShape
class: ProductMetadata
node kind: BlankNodeOrIRI

path: links
name: links
description: HAL links
node: LinksShape
class: Links
node kind: BlankNodeOrIRI
max count: 1

path: downloadable
name: downloadable
description: If the product is downloadable
datatype: boolean
max count: 1

path: downloads
name: downloads
description: List of downloadable files
node: ProductDownloadShape
class: ProductDownload
node kind: BlankNodeOrIRI

path: downloadLimit
name: download limit
description: Number of times downloadable files can be downloaded after purchase. Default is -1.
datatype: int
max count: 1

path: downloadExpiry
name: download expiry
description: Number of days until access to downloadable files expires. Default is -1.
datatype: int
max count: 1

path: externalUrl
name: external url
description: Product external URL. Only for external products.
datatype: string
max count: 1

path: buttonText
name: button text
description: Product external button text. Only for external products.
datatype: string
max count: 1

path: taxStatus
name: tax status
description: Tax status
datatype: string
max count: 1
in: taxable
in: shipping
in: none

path: taxClass
name: tax class
description: Tax class
datatype: string
max count: 1

path: manageStock
name: manage stock
description: Stock management at product level
datatype: boolean
max count: 1

path: stockQuantity
name: stock quantity
description: Stock quantity
datatype: long
max count: 1

path: stockStatus
name: stock status
description: Controls the stock status of the product
datatype: string
max count: 1
in: instock
in: outofstock
in: onbackorder

path: backorders
name: backorders
description: If managing stock, this controls if backorders are allowed
datatype: string
max count: 1
in: no
in: notify
in: yes

path: backordersAllowed
name: backorders allowed
description: Shows if backorders are allowed
datatype: boolean
max count: 1

path: backordered
name: backordered
description: Shows if the product is on backordered
datatype: boolean
max count: 1

path: soldIndividually
name: sold individually
description: Allow one item to be bought in a single order
datatype: boolean
max count: 1

path: weight
name: weight
description: Product weight
datatype: string
max count: 1

path: dimensions
name: dimensions
description: Product dimensions
node: ProductDimensionsShape
class: ProductDimensions
node kind: BlankNodeOrIRI
max count: 1

path: shippingRequired
name: shipping required
description: Shows if the product need to be shipped
datatype: boolean
max count: 1

path: shippingTaxable
name: shipping taxable
description: Shows whether or not the product shipping is taxable
datatype: boolean
max count: 1

path: shippingClass
name: shipping class
description: Shipping class slug
datatype: string
max count: 1

path: shippingClassId
name: shipping class id
description: Shipping class ID
node: ProductShippingClassShape
class: ProductShippingClass
node kind: BlankNodeOrIRI
max count: 1

path: reviewsAllowed
name: reviews allowed
description: Allow reviews
datatype: boolean
max count: 1

path: averageRating
name: average rating
description: Reviews average rating
datatype: string
max count: 1

path: ratingCount
name: rating count
description: Amount of reviews that the product have
datatype: int
max count: 1

path: relatedProducts
name: related products
description: List of related products
node: ProductShape
class: Product
node kind: BlankNodeOrIRI

path: upsellProducts
name: upsell products
description: List of up-sell products
node: ProductShape
class: Product
node kind: BlankNodeOrIRI

path: crossSellProducts
name: cross sell products
description: List of cross-sell products
node: ProductShape
class: Product
node kind: BlankNodeOrIRI

path: parent
name: parent
description: Parent product
node: ProductShape
class: Product
node kind: BlankNodeOrIRI
max count: 1

path: purchaseNote
name: purchase note
description: Optional note to send the customer after purchase
datatype: string
max count: 1

path: categories
name: categories
description: List of categories
node: ProductCategoryRefShape
class: ProductCategoryRef
node kind: BlankNodeOrIRI

path: tags
name: tags
description: List of tags
node: ProductTagRefShape
class: ProductTagRef
node kind: BlankNodeOrIRI

path: images
name: images
description: List of images
node: ProductImageShape
class: ProductImage
node kind: BlankNodeOrIRI

path: attributes
name: attributes
description: List of attributes
node: ProductAttributeShape
class: ProductAttribute
node kind: BlankNodeOrIRI

path: defaultAttributes
name: default attributes
description: Defaults variation attributes
node: DefaultAttributeShape
class: DefaultAttribute
node kind: BlankNodeOrIRI

path: variations
name: variations
description: List of variation IDs
node: ProductVariationShape
class: ProductVariation
node kind: BlankNodeOrIRI

path: groupedProducts
name: grouped products
description: List of grouped product IDs
node: ProductShape
class: Product
node kind: BlankNodeOrIRI

path: menuOrder
name: menu order
description: Menu order, used to custom sort products
datatype: int
max count: 1

path: metaData
name: meta data
description: Meta data
node: ProductMetadataShape
class: ProductMetadata
node kind: BlankNodeOrIRI

path: links
name: links
description: HAL links
node: LinksShape
class: Links
node kind: BlankNodeOrIRI
max count: 1

path: downloadable
name: downloadable
description: If the product is downloadable
datatype: boolean
max count: 1

path: downloads
name: downloads
description: List of downloadable files
node: ProductDownloadShape
class: ProductDownload
node kind: BlankNodeOrIRI

path: downloadLimit
name: download limit
description: Number of times downloadable files can be downloaded after purchase. Default is -1.
datatype: int
max count: 1

path: downloadExpiry
name: download expiry
description: Number of days until access to downloadable files expires. Default is -1.
datatype: int
max count: 1

path: externalUrl
name: external url
description: Product external URL. Only for external products.
datatype: string
max count: 1

path: buttonText
name: button text
description: Product external button text. Only for external products.
datatype: string
max count: 1

path: taxStatus
name: tax status
description: Tax status
datatype: string
max count: 1
in: taxable
in: shipping
in: none

path: taxClass
name: tax class
description: Tax class
datatype: string
max count: 1

path: manageStock
name: manage stock
description: Stock management at product level
datatype: boolean
max count: 1

path: stockQuantity
name: stock quantity
description: Stock quantity
datatype: long
max count: 1

path: stockStatus
name: stock status
description: Controls the stock status of the product
datatype: string
max count: 1
in: instock
in: outofstock
in: onbackorder

path: backorders
name: backorders
description: If managing stock, this controls if backorders are allowed
datatype: string
max count: 1
in: no
in: notify
in: yes

path: backordersAllowed
name: backorders allowed
description: Shows if backorders are allowed
datatype: boolean
max count: 1

path: backordered
name: backordered
description: Shows if the product is on backordered
datatype: boolean
max count: 1

path: soldIndividually
name: sold individually
description: Allow one item to be bought in a single order
datatype: boolean
max count: 1

path: weight
name: weight
description: Product weight
datatype: string
max count: 1

path: dimensions
name: dimensions
description: Product dimensions
node: ProductDimensionsShape
class: ProductDimensions
node kind: BlankNodeOrIRI
max count: 1

path: shippingRequired
name: shipping required
description: Shows if the product need to be shipped
datatype: boolean
max count: 1

path: shippingTaxable
name: shipping taxable
description: Shows whether or not the product shipping is taxable
datatype: boolean
max count: 1

path: shippingClass
name: shipping class
description: Shipping class slug
datatype: string
max count: 1

path: shippingClassId
name: shipping class id
description: Shipping class ID
node: ProductShippingClassShape
class: ProductShippingClass
node kind: BlankNodeOrIRI
max count: 1

path: reviewsAllowed
name: reviews allowed
description: Allow reviews
datatype: boolean
max count: 1

path: averageRating
name: average rating
description: Reviews average rating
datatype: string
max count: 1

path: ratingCount
name: rating count
description: Amount of reviews that the product have
datatype: int
max count: 1

path: relatedProducts
name: related products
description: List of related products
node: ProductShape
class: Product
node kind: BlankNodeOrIRI

path: upsellProducts
name: upsell products
description: List of up-sell products
node: ProductShape
class: Product
node kind: BlankNodeOrIRI

path: crossSellProducts
name: cross sell products
description: List of cross-sell products
node: ProductShape
class: Product
node kind: BlankNodeOrIRI

path: parent
name: parent
description: Parent product
node: ProductShape
class: Product
node kind: BlankNodeOrIRI
max count: 1

path: purchaseNote
name: purchase note
description: Optional note to send the customer after purchase
datatype: string
max count: 1

path: categories
name: categories
description: List of categories
node: ProductCategoryRefShape
class: ProductCategoryRef
node kind: BlankNodeOrIRI

path: tags
name: tags
description: List of tags
node: ProductTagRefShape
class: ProductTagRef
node kind: BlankNodeOrIRI

path: images
name: images
description: List of images
node: ProductImageShape
class: ProductImage
node kind: BlankNodeOrIRI

path: attributes
name: attributes
description: List of attributes
node: ProductAttributeShape
class: ProductAttribute
node kind: BlankNodeOrIRI

path: defaultAttributes
name: default attributes
description: Defaults variation attributes
node: DefaultAttributeShape
class: DefaultAttribute
node kind: BlankNodeOrIRI

path: variations
name: variations
description: List of variation IDs
node: ProductVariationShape
class: ProductVariation
node kind: BlankNodeOrIRI

path: groupedProducts
name: grouped products
description: List of grouped product IDs
node: ProductShape
class: Product
node kind: BlankNodeOrIRI

path: menuOrder
name: menu order
description: Menu order, used to custom sort products
datatype: int
max count: 1

path: metaData
name: meta data
description: Meta data
node: ProductMetadataShape
class: ProductMetadata
node kind: BlankNodeOrIRI

path: links
name: links
description: HAL links
node: LinksShape
class: Links
node kind: BlankNodeOrIRI
max count: 1

path: datePaid
name: date paid
description: The date the order was paid, in the site's timezone
datatype: dateTime
max count: 1

path: datePaidGmt
name: date paid gmt
description: The date the order was paid, as GMT
datatype: dateTime
max count: 1

path: dateCompleted
name: date completed
description: The date the order was completed, in the site's timezone
datatype: dateTime
max count: 1

path: dateCompletedGmt
name: date completed gmt
description: The date the order was completed, as GMT
datatype: dateTime
max count: 1

path: cartHash
name: cart hash
description: MD5 hash of cart items to ensure orders are not modified
datatype: string
max count: 1

path: lineItems
name: line items
description: Line items
class: OrderLineItem
node kind: BlankNodeOrIRI

path: taxLines
name: tax lines
description: Tax lines
node: TaxLineShape
class: TaxLine
node kind: BlankNodeOrIRI

path: shippingLines
name: shipping lines
description: Shipping lines
node: ShippingLineShape
class: ShippingLine
node kind: BlankNodeOrIRI

path: feeLines
name: fee lines
description: Fee lines
node: FeeLineShape
class: FeeLine
node kind: BlankNodeOrIRI

path: couponLines
name: coupon lines
description: Coupon lines
node: CouponLineShape
class: CouponLine
node kind: BlankNodeOrIRI

path: refunds
name: refunds
description: List of refunds
node: OrderRefundLineShape
class: OrderRefundLine
node kind: BlankNodeOrIRI

path: needsPayment
name: needs payment
description: Whether order needs payment
datatype: boolean
max count: 1

path: needsProcessing
name: needs processing
description: Whether order needs processing
datatype: boolean
max count: 1

path: paymentUrl
name: payment url
description: Payment URL
datatype: string
max count: 1

path: isEditable
name: is editable
description: Whether order is editable
datatype: boolean
max count: 1

path: metadata
name: metadata
description: Meta data
node: MetadataShape
class: Metadata
node kind: BlankNodeOrIRI

path: links
name: links
description: HAL links
node: LinksShape
class: Links
node kind: BlankNodeOrIRI
max count: 1

path: datePaid
name: date paid
description: The date the order was paid, in the site's timezone
datatype: dateTime
max count: 1

path: datePaidGmt
name: date paid gmt
description: The date the order was paid, as GMT
datatype: dateTime
max count: 1

path: dateCompleted
name: date completed
description: The date the order was completed, in the site's timezone
datatype: dateTime
max count: 1

path: dateCompletedGmt
name: date completed gmt
description: The date the order was completed, as GMT
datatype: dateTime
max count: 1

path: cartHash
name: cart hash
description: MD5 hash of cart items to ensure orders are not modified
datatype: string
max count: 1

path: lineItems
name: line items
description: Line items
class: OrderLineItem
node kind: BlankNodeOrIRI

path: taxLines
name: tax lines
description: Tax lines
node: TaxLineShape
class: TaxLine
node kind: BlankNodeOrIRI

path: shippingLines
name: shipping lines
description: Shipping lines
node: ShippingLineShape
class: ShippingLine
node kind: BlankNodeOrIRI

path: feeLines
name: fee lines
description: Fee lines
node: FeeLineShape
class: FeeLine
node kind: BlankNodeOrIRI

path: couponLines
name: coupon lines
description: Coupon lines
node: CouponLineShape
class: CouponLine
node kind: BlankNodeOrIRI

path: refunds
name: refunds
description: List of refunds
node: OrderRefundLineShape
class: OrderRefundLine
node kind: BlankNodeOrIRI

path: needsPayment
name: needs payment
description: Whether order needs payment
datatype: boolean
max count: 1

path: needsProcessing
name: needs processing
description: Whether order needs processing
datatype: boolean
max count: 1

path: paymentUrl
name: payment url
description: Payment URL
datatype: string
max count: 1

path: isEditable
name: is editable
description: Whether order is editable
datatype: boolean
max count: 1

path: metadata
name: metadata
description: Meta data
node: MetadataShape
class: Metadata
node kind: BlankNodeOrIRI

path: links
name: links
description: HAL links
node: LinksShape
class: Links
node kind: BlankNodeOrIRI
max count: 1

path: datePaid
name: date paid
description: The date the order was paid, in the site's timezone
datatype: dateTime
max count: 1

path: datePaidGmt
name: date paid gmt
description: The date the order was paid, as GMT
datatype: dateTime
max count: 1

path: dateCompleted
name: date completed
description: The date the order was completed, in the site's timezone
datatype: dateTime
max count: 1

path: dateCompletedGmt
name: date completed gmt
description: The date the order was completed, as GMT
datatype: dateTime
max count: 1

path: cartHash
name: cart hash
description: MD5 hash of cart items to ensure orders are not modified
datatype: string
max count: 1

path: lineItems
name: line items
description: Line items
class: OrderLineItem
node kind: BlankNodeOrIRI

path: taxLines
name: tax lines
description: Tax lines
node: TaxLineShape
class: TaxLine
node kind: BlankNodeOrIRI

path: shippingLines
name: shipping lines
description: Shipping lines
node: ShippingLineShape
class: ShippingLine
node kind: BlankNodeOrIRI

path: feeLines
name: fee lines
description: Fee lines
node: FeeLineShape
class: FeeLine
node kind: BlankNodeOrIRI

path: couponLines
name: coupon lines
description: Coupon lines
node: CouponLineShape
class: CouponLine
node kind: BlankNodeOrIRI

path: refunds
name: refunds
description: List of refunds
node: OrderRefundLineShape
class: OrderRefundLine
node kind: BlankNodeOrIRI

path: needsPayment
name: needs payment
description: Whether order needs payment
datatype: boolean
max count: 1

path: needsProcessing
name: needs processing
description: Whether order needs processing
datatype: boolean
max count: 1

path: paymentUrl
name: payment url
description: Payment URL
datatype: string
max count: 1

path: isEditable
name: is editable
description: Whether order is editable
datatype: boolean
max count: 1

path: metadata
name: metadata
description: Meta data
node: MetadataShape
class: Metadata
node kind: BlankNodeOrIRI

path: links
name: links
description: HAL links
node: LinksShape
class: Links
node kind: BlankNodeOrIRI
max count: 1