docs.jsonld
type: ApiDocumentation
entrypoint: /api/v2
supported class: Address
supported class: Adjustment
supported class: Administrator
supported class: AvatarImage
supported class: CatalogPromotion
supported class: CatalogPromotionAction
supported class: CatalogPromotionScope
supported class: CatalogPromotionTranslation
supported class: Channel
supported class: ChannelPricing
supported class: Country
supported class: Currency
supported class: Customer
supported class: CustomerGroup
supported class: ExchangeRate
supported class: Locale
supported class: Order
supported class: OrderItem
supported class: OrderItemUnit
supported class: Payment
supported class: PaymentMethod
supported class: Product
supported class: ProductAssociationType
supported class: ProductAssociationTypeTranslation
supported class: ProductImage
supported class: ProductOption
supported class: ProductOptionTranslation
supported class: ProductOptionValue
supported class: ProductReview
supported class: ProductTaxon
supported class: ProductTranslation
supported class: ProductVariant
supported class: ProductVariantTranslation
supported class: Promotion
supported class: Province
supported class: ResetPasswordRequest
supported class: Shipment
supported class: ShippingCategory
supported class: ShippingMethod
supported class: ShippingMethodTranslation
supported class: ShopBillingData
supported class: TaxCategory
supported class: Taxon
supported class: TaxonTranslation
supported class: VerifyCustomerAccount
supported class: Zone
supported class: ZoneMember
supported class: Block
supported class: FrequentlyAskedQuestion
supported class: Media
supported class: Page
supported class: Section
supported class: ProductFile
supported class: ProductLabel
supported class: ProductLabelTranslation
supported class: SEOContent
supported class: SEOContentTranslation
supported class: TaxonImage
supported class: Brand
supported class: TierPrice
supported class: Entrypoint
supported class: ConstraintViolation
supported class: ConstraintViolationList

Address
type: Class
title: Address
supported property: SupportedProperty
  property: businessId
  title: businessId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: taxId
  title: taxId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: vatNumber
  title: vatNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: customer
  title: customer
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: firstName
  title: firstName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastName
  title: lastName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: company
  title: company
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: countryCode
  title: countryCode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: provinceCode
  title: provinceCode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: provinceName
  title: provinceName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: street
  title: street
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: city
  title: city
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: postcode
  title: postcode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: fullName
  title: fullName
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Address resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Address resource.
  returns: Address
supported operation: Retrieves a Address resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Address resource.
  returns: Address
supported operation: Deletes the Address resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Address resource.
  returns: Nothing
supported operation: Replaces the Address resource.
  type: Operation
  type: ReplaceAction
  expects: Address
  method: PUT
  title: Replaces the Address resource.
  returns: Address

businessId
type: Property
domain: Address
range: string

taxId
type: Property
domain: Address
range: string

vatNumber
type: Property
domain: Address
range: string

customer
type: Link
domain: Address
max cardinality: 1
range: Customer

firstName
type: Property
domain: Address
range: string

lastName
type: Property
domain: Address
range: string

phoneNumber
type: Property
domain: Address
range: string

company
type: Property
domain: Address
range: string

countryCode
type: Property
domain: Address
range: string

provinceCode
type: Property
domain: Address
range: string

provinceName
type: Property
domain: Address
range: string

street
type: Property
domain: Address
range: string

city
type: Property
domain: Address
range: string

postcode
type: Property
domain: Address
range: string

createdAt
type: Property
domain: Address
range: dateTime

updatedAt
type: Property
domain: Address
range: dateTime

fullName
type: Property
domain: Address
range: string

Adjustment
type: Class
title: Adjustment
supported operation: Retrieves a Adjustment resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Adjustment resource.
  returns: Adjustment
supported operation: Retrieves a Adjustment resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Adjustment resource.
  returns: Adjustment

Administrator
type: Class
title: Administrator
supported property: SupportedProperty
  property: operators
  title: operators
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: firstName
  title: firstName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastName
  title: lastName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: localeCode
  title: localeCode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: avatar
  title: avatar
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: username
  title: username
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: usernameCanonical
  title: usernameCanonical
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: salt
  title: salt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: password
  title: password
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: plainPassword
  title: plainPassword
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: lastLogin
  title: lastLogin
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: emailVerificationToken
  title: emailVerificationToken
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: passwordResetToken
  title: passwordResetToken
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: passwordRequestedAt
  title: passwordRequestedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: verifiedAt
  title: verifiedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: locked
  title: locked
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: expiresAt
  title: expiresAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: credentialsExpireAt
  title: credentialsExpireAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: roles
  title: roles
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: oauthAccounts
  title: oauthAccounts
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: emailCanonical
  title: emailCanonical
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: encoderName
  title: encoderName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: enabled
  title: enabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: image
  title: image
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: credentialsNonExpired
  title: credentialsNonExpired
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: accountNonExpired
  title: accountNonExpired
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: accountNonLocked
  title: accountNonLocked
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: role
  title: role
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: passwordRequestNonExpired
  title: passwordRequestNonExpired
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: verified
  title: verified
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Administrator resource.
supported operation: Replaces the Administrator resource.
supported operation: Deletes the Administrator resource.

operators
type: Property
domain: Administrator
range: Order

firstName
type: Property
domain: Administrator
range: string

lastName
type: Property
domain: Administrator
range: string

localeCode
type: Property
domain: Administrator
range: string

avatar
type: Link
domain: Administrator
max cardinality: 1
range: AvatarImage

username
type: Property
domain: Administrator
range: string

usernameCanonical
type: Property
domain: Administrator
range: string

salt
type: Property
domain: Administrator
range: string

password
type: Property
domain: Administrator
range: string

plainPassword
type: Property
domain: Administrator
range: string

lastLogin
type: Property
domain: Administrator
range: dateTime

emailVerificationToken
type: Property
domain: Administrator
range: string

passwordResetToken
type: Property
domain: Administrator
range: string

passwordRequestedAt
type: Property
domain: Administrator
range: dateTime

verifiedAt
type: Property
domain: Administrator
range: dateTime

locked
type: Property
domain: Administrator
range: boolean

expiresAt
type: Property
domain: Administrator
range: dateTime

credentialsExpireAt
type: Property
domain: Administrator
range: dateTime

roles
type: Property
domain: Administrator

oauthAccounts
type: Property
domain: Administrator

email
type: Property
domain: Administrator
range: string

emailCanonical
type: Property
domain: Administrator
range: string

encoderName
type: Property
domain: Administrator
range: string

createdAt
type: Property
domain: Administrator
range: dateTime

updatedAt
type: Property
domain: Administrator
range: dateTime

enabled
type: Property
domain: Administrator
range: boolean

image
type: Property
domain: Administrator

credentialsNonExpired
type: Property
domain: Administrator
range: boolean

accountNonExpired
type: Property
domain: Administrator
range: boolean

accountNonLocked
type: Property
domain: Administrator
range: boolean

role
type: Property
domain: Administrator
range: string

passwordRequestNonExpired
type: Property
domain: Administrator

verified
type: Property
domain: Administrator
range: boolean

oAuthAccounts
type: Property
domain: Administrator

expired
type: Property
domain: Administrator

AvatarImage
type: Class
title: AvatarImage
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: file
  title: file
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: path
  title: path
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: owner
  title: owner
  required: true
  readable: true
  writeable: true
supported operation: Retrieves a AvatarImage resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a AvatarImage resource.
  returns: AvatarImage
supported operation: Deletes the AvatarImage resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the AvatarImage resource.
  returns: Nothing

type
type: Property
domain: AvatarImage
range: string

file
type: Property
domain: AvatarImage

path
type: Property
domain: AvatarImage
range: string

owner
type: Link
domain: AvatarImage
max cardinality: 1
range: Administrator

CatalogPromotion
type: Class
title: CatalogPromotion
supported property: SupportedProperty
  property: channels
  title: channels
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: code
  title: code
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: startDate
  title: startDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: endDate
  title: endDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: priority
  title: priority
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: exclusive
  title: exclusive
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: state
  title: state
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: scopes
  title: scopes
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: actions
  title: actions
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: enabled
  title: enabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: translations
  title: translations
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: translationsCache
  title: translationsCache
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: currentLocale
  title: currentLocale
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: currentTranslation
  title: currentTranslation
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: fallbackLocale
  title: fallbackLocale
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: channel
  title: channel
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: translationClass
  title: translationClass
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: label
  title: label
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: translation
  title: translation
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: scope
  title: scope
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: action
  title: action
  required: false
  readable: false
  writeable: true
supported operation: Retrieves a CatalogPromotion resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a CatalogPromotion resource.
  returns: CatalogPromotion
supported operation: Retrieves a CatalogPromotion resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a CatalogPromotion resource.
  returns: CatalogPromotion
supported operation: Replaces the CatalogPromotion resource.
  type: Operation
  type: ReplaceAction
  expects: CatalogPromotion
  method: PUT
  title: Replaces the CatalogPromotion resource.
  returns: CatalogPromotion

channels
type: Link
domain: CatalogPromotion
range: Channel

id
type: Property
domain: CatalogPromotion
range: integer

name
type: Property
domain: CatalogPromotion
range: string

code
type: Property
domain: CatalogPromotion
range: string

startDate
type: Property
domain: CatalogPromotion
range: dateTime

endDate
type: Property
domain: CatalogPromotion
range: dateTime

priority
type: Property
domain: CatalogPromotion
range: integer

exclusive
type: Property
domain: CatalogPromotion
range: boolean

state
type: Property
domain: CatalogPromotion
range: string

scopes
type: Link
domain: CatalogPromotion
range: CatalogPromotionScope

actions
type: Link
domain: CatalogPromotion
range: CatalogPromotionAction

enabled
type: Property
domain: CatalogPromotion
range: boolean

translations
type: Link
domain: CatalogPromotion
range: CatalogPromotionTranslation

translationsCache
type: Property
domain: CatalogPromotion

currentLocale
type: Property
domain: CatalogPromotion
range: string

currentTranslation
type: Property
domain: CatalogPromotion

fallbackLocale
type: Property
domain: CatalogPromotion
range: string

channel
type: Property
domain: CatalogPromotion

translationClass
type: Property
domain: CatalogPromotion

label
type: Property
domain: CatalogPromotion
range: string

description
type: Property
domain: CatalogPromotion
range: string

translation
type: Property
domain: CatalogPromotion

scope
type: Property
domain: CatalogPromotion

action
type: Property
domain: CatalogPromotion

CatalogPromotionAction
type: Class
title: CatalogPromotionAction
supported operation: Retrieves a CatalogPromotionAction resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a CatalogPromotionAction resource.
  returns: Nothing

CatalogPromotionScope
type: Class
title: CatalogPromotionScope
supported operation: Retrieves a CatalogPromotionScope resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a CatalogPromotionScope resource.
  returns: Nothing

CatalogPromotionTranslation
type: Class
title: CatalogPromotionTranslation
supported operation: Retrieves a CatalogPromotionTranslation resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a CatalogPromotionTranslation resource.
  returns: CatalogPromotionTranslation

Channel
type: Class
title: Channel
supported property: SupportedProperty
  property: baseCurrency
  title: baseCurrency
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: defaultLocale
  title: defaultLocale
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: defaultTaxZone
  title: defaultTaxZone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: taxCalculationStrategy
  title: taxCalculationStrategy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: currencies
  title: currencies
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: locales
  title: locales
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: countries
  title: countries
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: themeName
  title: themeName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: contactEmail
  title: contactEmail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: contactPhoneNumber
  title: contactPhoneNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: skippingShippingStepAllowed
  title: skippingShippingStepAllowed
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: skippingPaymentStepAllowed
  title: skippingPaymentStepAllowed
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: accountVerificationRequired
  title: accountVerificationRequired
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: shopBillingData
  title: shopBillingData
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: menuTaxon
  title: menuTaxon
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: code
  title: code
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: hostname
  title: hostname
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: color
  title: color
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: enabled
  title: enabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: referenceableContent
  title: referenceableContent
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: googleAnalyticsCode
  title: googleAnalyticsCode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: googleTagManagerId
  title: googleTagManagerId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: metadataTitle
  title: metadataTitle
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: metadataDescription
  title: metadataDescription
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: notIndexable
  title: notIndexable
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: baseMetadataTitle
  title: baseMetadataTitle
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: baseMetadataDescription
  title: baseMetadataDescription
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: openGraphMetadataTitle
  title: openGraphMetadataTitle
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Channel resource.

baseCurrency
type: Link
domain: Channel
max cardinality: 1
range: Currency

defaultLocale
type: Link
domain: Channel
max cardinality: 1
range: Locale

defaultTaxZone
type: Link
domain: Channel
max cardinality: 1
range: Zone

taxCalculationStrategy
type: Property
domain: Channel
range: string

currencies
type: Link
domain: Channel
range: Currency

locales
type: Link
domain: Channel
range: Locale

countries
type: Link
domain: Channel
range: Country

themeName
type: Property
domain: Channel
range: string

contactEmail
type: Property
domain: Channel
range: string

contactPhoneNumber
type: Property
domain: Channel
range: string

skippingShippingStepAllowed
type: Property
domain: Channel
range: boolean

skippingPaymentStepAllowed
type: Property
domain: Channel
range: boolean

accountVerificationRequired
type: Property
domain: Channel
range: boolean

shopBillingData
type: Link
domain: Channel
max cardinality: 1
range: ShopBillingData

menuTaxon
type: Link
domain: Channel
max cardinality: 1
range: Taxon

id
type: Property
domain: Channel
range: integer

code
type: Property
domain: Channel
range: string

name
type: Property
domain: Channel
range: string

description
type: Property
domain: Channel
range: string

hostname
type: Property
domain: Channel
range: string

color
type: Property
domain: Channel
range: string

createdAt
type: Property
domain: Channel
range: dateTime

updatedAt
type: Property
domain: Channel
range: dateTime

enabled
type: Property
domain: Channel
range: boolean

referenceableContent
type: Link
domain: Channel
max cardinality: 1
range: SEOContent

googleAnalyticsCode
type: Property
domain: Channel
range: string

googleTagManagerId
type: Property
domain: Channel
range: string

metadataTitle
type: Property
domain: Channel
range: string

metadataDescription
type: Property
domain: Channel
range: string

notIndexable
type: Property
domain: Channel
range: boolean

baseMetadataTitle
type: Property
domain: Channel
range: string

baseMetadataDescription
type: Property
domain: Channel
range: string

openGraphMetadataTitle
type: Property
domain: Channel
range: string

openGraphMetadataDescription
type: Property
domain: Channel
range: string

openGraphMetadataUrl
type: Property
domain: Channel
range: string

openGraphMetadataType
type: Property
domain: Channel
range: string

openGraphMetadataImage
type: Property
domain: Channel
range: string

currency
type: Property
domain: Channel

locale
type: Property
domain: Channel

country
type: Property
domain: Channel

ChannelPricing
type: Class
title: ChannelPricing
supported operation: Retrieves a ChannelPricing resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ChannelPricing resource.
  returns: Nothing

Country
type: Class
title: Country
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: code
  title: code
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: provinces
  title: provinces
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: enabled
  title: enabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: province
  title: province
  required: false
  readable: false
  writeable: true
supported operation: Retrieves a Country resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Country resource.
  returns: Country
supported operation: Retrieves a Country resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Country resource.
  returns: Country
supported operation: Replaces the Country resource.
  type: Operation
  type: ReplaceAction
  expects: Country
  method: PUT
  title: Replaces the Country resource.
  returns: Country

id
type: Property
domain: Country
range: integer

code
type: Property
domain: Country
range: string

provinces
type: Link
domain: Country
range: Province

enabled
type: Property
domain: Country
range: boolean

name
type: Property
domain: Country
range: string

province
type: Property
domain: Country

Currency
type: Class
title: Currency
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: code
  title: code
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Currency resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Currency resource.
  returns: Currency
supported operation: Retrieves a Currency resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Currency resource.
  returns: Currency

id
type: Property
domain: Currency
range: integer

code
type: Property
domain: Currency
range: string

createdAt
type: Property
domain: Currency
range: dateTime

updatedAt
type: Property
domain: Currency
range: dateTime

name
type: Property
domain: Currency
range: string

Customer
type: Class
title: Customer
supported property: SupportedProperty
  property: firstName
  title: firstName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastName
  title: lastName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: password
  title: password
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subscribedToNewsletter
  title: subscribedToNewsletter
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: channelCode
  title: channelCode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: localeCode
  title: localeCode
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Customer resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Customer resource.
  returns: Customer
supported operation: Retrieves a Customer resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Customer resource.
  returns: Customer
supported operation: Replaces the Customer resource.
  type: Operation
  type: ReplaceAction
  expects: Customer
  method: PUT
  title: Replaces the Customer resource.
  returns: Nothing
supported operation: Replaces the Customer resource.
  type: Operation
  type: ReplaceAction
  expects: Customer
  method: PUT
  title: Replaces the Customer resource.
  returns: Customer

firstName
type: Property
domain: Customer
range: string

lastName
type: Property
domain: Customer
range: string

email
type: Property
domain: Customer
range: string

password
type: Property
domain: Customer
range: string

subscribedToNewsletter
type: Property
domain: Customer
range: boolean

channelCode
type: Property
domain: Customer
range: string

localeCode
type: Property
domain: Customer
range: string

CustomerGroup
type: Class
title: CustomerGroup
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: code
  title: code
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a CustomerGroup resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a CustomerGroup resource.
  returns: CustomerGroup
supported operation: Replaces the CustomerGroup resource.
  type: Operation
  type: ReplaceAction
  expects: CustomerGroup
  method: PUT
  title: Replaces the CustomerGroup resource.
  returns: CustomerGroup
supported operation: Deletes the CustomerGroup resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the CustomerGroup resource.
  returns: Nothing

id
type: Property
domain: CustomerGroup
range: integer

code
type: Property
domain: CustomerGroup
range: string

name
type: Property
domain: CustomerGroup
range: string

ExchangeRate
type: Class
title: ExchangeRate
supported property: SupportedProperty
  property: ratio
  title: ratio
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sourceCurrency
  title: sourceCurrency
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: targetCurrency
  title: targetCurrency
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a ExchangeRate resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ExchangeRate resource.
  returns: ExchangeRate
supported operation: Replaces the ExchangeRate resource.
  type: Operation
  type: ReplaceAction
  expects: ExchangeRate
  method: PUT
  title: Replaces the ExchangeRate resource.
  returns: ExchangeRate
supported operation: Deletes the ExchangeRate resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the ExchangeRate resource.
  returns: Nothing

ratio
type: Property
domain: ExchangeRate
range: string

sourceCurrency
type: Link
domain: ExchangeRate
max cardinality: 1
range: Currency

targetCurrency
type: Link
domain: ExchangeRate
max cardinality: 1
range: Currency

createdAt
type: Property
domain: ExchangeRate
range: dateTime

updatedAt
type: Property
domain: ExchangeRate
range: dateTime

Locale
type: Class
title: Locale
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: code
  title: code
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Locale resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Locale resource.
  returns: Locale
supported operation: Retrieves a Locale resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Locale resource.
  returns: Locale

id
type: Property
domain: Locale
range: integer

code
type: Property
domain: Locale
range: string

createdAt
type: Property
domain: Locale
range: dateTime

updatedAt
type: Property
domain: Locale
range: dateTime

name
type: Property
domain: Locale
range: string

Order
type: Class
title: Order
supported property: SupportedProperty
  property: notes2
  title: notes2
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: operator
  title: operator
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: heardAboutUs
  title: heardAboutUs
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: customer
  title: customer
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: channel
  title: channel
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: shippingAddress
  title: shippingAddress
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: billingAddress
  title: billingAddress
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: payments
  title: payments
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: shipments
  title: shipments
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: currencyCode
  title: currencyCode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: localeCode
  title: localeCode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: promotionCoupon
  title: promotionCoupon
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: checkoutState
  title: checkoutState
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: paymentState
  title: paymentState
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: shippingState
  title: shippingState
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: promotions
  title: promotions
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: customerIp
  title: customerIp
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdByGuest
  title: createdByGuest
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: checkoutCompletedAt
  title: checkoutCompletedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: number
  title: number
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: notes
  title: notes
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: items
  title: items
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: itemsTotal
  title: itemsTotal
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: adjustments
  title: adjustments
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: adjustmentsTotal
  title: adjustmentsTotal
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: total
  title: total
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: state
  title: state
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: paymentFeeTotal
  title: paymentFeeTotal
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: customerWithAuthorization
  title: customerWithAuthorization
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Order resource.
supported operation: Deletes the Order resource.
supported operation: Updates the Order resource.
supported operation: Creates a Order resource.
supported operation: Replaces the Order resource.

notes2
type: Property
domain: Order
range: string

operator
type: Link
domain: Order
max cardinality: 1
range: Administrator

heardAboutUs
type: Property
domain: Order
range: string

customer
type: Link
domain: Order
max cardinality: 1
range: Customer

channel
type: Link
domain: Order
max cardinality: 1
range: Channel

shippingAddress
type: Link
domain: Order
max cardinality: 1
range: Address

billingAddress
type: Link
domain: Order
max cardinality: 1
range: Address

payments
type: Link
domain: Order
range: Payment

shipments
type: Link
domain: Order
range: Shipment

currencyCode
type: Property
domain: Order
range: string

localeCode
type: Property
domain: Order
range: string

promotionCoupon
type: Property
domain: Order

checkoutState
type: Property
domain: Order
range: string

paymentState
type: Property
domain: Order
range: string

shippingState
type: Property
domain: Order
range: string

promotions
type: Link
domain: Order
range: Promotion

customerIp
type: Property
domain: Order
range: string

createdByGuest
type: Property
domain: Order
range: boolean

id
type: Property
domain: Order
range: integer

checkoutCompletedAt
type: Property
domain: Order
range: dateTime

number
type: Property
domain: Order
range: string

notes
type: Property
domain: Order
range: string

items
type: Link
domain: Order
range: OrderItem

itemsTotal
type: Property
domain: Order
range: integer

adjustments
type: Link
domain: Order
range: Adjustment

adjustmentsTotal
type: Property
domain: Order
range: integer

total
type: Property
domain: Order
range: integer

state
type: Property
domain: Order
range: string

createdAt
type: Property
domain: Order
range: dateTime

updatedAt
type: Property
domain: Order
range: dateTime

paymentFeeTotal
type: Property
domain: Order
range: integer

customerWithAuthorization
type: Property
domain: Order

user
type: Property
domain: Order

itemUnits
type: Property
domain: Order

payment
type: Property
domain: Order

lastPayment
type: Property
domain: Order

shippingRequired
type: Property
domain: Order
range: boolean

shipment
type: Property
domain: Order

promotionSubjectTotal
type: Property
domain: Order
range: integer

promotionSubjectCount
type: Property
domain: Order
range: integer

promotion
type: Property
domain: Order

taxTotal
type: Property
domain: Order
range: integer

shippingTotal
type: Property
domain: Order
range: integer

orderPromotionTotal
type: Property
domain: Order
range: integer

nonDiscountedItemsTotal
type: Property
domain: Order
range: integer

checkoutCompleted
type: Property
domain: Order
range: boolean

item
type: Property
domain: Order

totalQuantity
type: Property
domain: Order
range: integer

empty
type: Property
domain: Order
range: boolean

adjustmentsRecursively
type: Property
domain: Order
range: string

adjustment
type: Property
domain: Order

adjustmentsTotalRecursively
type: Property
domain: Order
range: integer

tokenValue
type: Property
domain: Order
range: string

channelCode
type: Property
domain: Order
range: string

email
type: Property
domain: Order
range: string

OrderItem
type: Class
title: OrderItem
supported operation: Retrieves a OrderItem resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a OrderItem resource.
  returns: OrderItem
supported operation: Retrieves a OrderItem resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a OrderItem resource.
  returns: OrderItem

OrderItemUnit
type: Class
title: OrderItemUnit
supported operation: Retrieves a OrderItemUnit resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a OrderItemUnit resource.
  returns: OrderItemUnit
supported operation: Retrieves a OrderItemUnit resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a OrderItemUnit resource.
  returns: OrderItemUnit

Payment
type: Class
title: Payment
supported property: SupportedProperty
  property: order
  title: order
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: method
  title: method
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: currencyCode
  title: currencyCode
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: amount
  title: amount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: state
  title: state
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: details
  title: details
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Payment resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Payment resource.
  returns: Payment
supported operation: Retrieves a Payment resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Payment resource.
  returns: Payment
supported operation: Updates the Payment resource.
  type: Operation
  expects: Nothing
  method: PATCH
  title: Updates the Payment resource.
  returns: Payment

order
type: Link
domain: Payment
max cardinality: 1
range: Order

method
type: Link
domain: Payment
max cardinality: 1
range: PaymentMethod

currencyCode
type: Property
domain: Payment
range: string

amount
type: Property
domain: Payment
range: integer

state
type: Property
domain: Payment
range: string

details
type: Property
domain: Payment

createdAt
type: Property
domain: Payment
range: dateTime

updatedAt
type: Property
domain: Payment
range: dateTime

PaymentMethod
type: Class
title: PaymentMethod
supported operation: Retrieves a PaymentMethod resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a PaymentMethod resource.
  returns: PaymentMethod
supported operation: Retrieves a PaymentMethod resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a PaymentMethod resource.
  returns: PaymentMethod

Product
type: Class
title: Product
supported property: SupportedProperty
  property: ean
  title: ean
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: minQuantity
  title: minQuantity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: minPrice
  title: minPrice
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: maxPrice
  title: maxPrice
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: markup
  title: markup
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: onlyBreakpoints
  title: onlyBreakpoints
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: files
  title: files
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: variants
  title: variants
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: variantSelectionMethod
  title: variantSelectionMethod
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: productTaxons
  title: productTaxons
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: channels
  title: channels
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: mainTaxon
  title: mainTaxon
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: reviews
  title: reviews
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: averageRating
  title: averageRating
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: images
  title: images
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: code
  title: code
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: attributes
  title: attributes
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: options
  title: options
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: associations
  title: associations
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: enabled
  title: enabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: translations
  title: translations
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: translationsCache
  title: translationsCache
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: currentLocale
  title: currentLocale
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: currentTranslation
  title: currentTranslation
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: fallbackLocale
  title: fallbackLocale
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: referenceableContent
  title: referenceableContent
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SEOBrand
  title: SEOBrand
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SEOGtin8
  title: SEOGtin8
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SEOGtin13
  title: SEOGtin13
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: SEOGtin14
  title: SEOGtin14
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Product resource.
supported operation: Replaces the Product resource.
supported operation: Deletes the Product resource.

ean
type: Property
domain: Product
range: string

minQuantity
type: Property
domain: Product
range: integer

minPrice
type: Property
domain: Product
range: integer

maxPrice
type: Property
domain: Product
range: integer

markup
type: Property
domain: Product
range: integer

onlyBreakpoints
type: Property
domain: Product
range: boolean

files
type: Link
domain: Product
range: ProductFile

variants
type: Link
domain: Product
range: ProductVariant

variantSelectionMethod
type: Property
domain: Product
range: string

productTaxons
type: Link
domain: Product
range: ProductTaxon

channels
type: Link
domain: Product
range: Channel

mainTaxon
type: Link
domain: Product
max cardinality: 1
range: Taxon

reviews
type: Link
domain: Product
range: ProductReview

averageRating
type: Property
domain: Product
range: decimal

images
type: Link
domain: Product
range: ProductImage

id
type: Property
domain: Product
range: integer

code
type: Property
domain: Product
range: string

attributes
type: Property
domain: Product

options
type: Link
domain: Product
range: ProductOption

associations
type: Property
domain: Product

createdAt
type: Property
domain: Product
range: dateTime

updatedAt
type: Property
domain: Product
range: dateTime

enabled
type: Property
domain: Product
range: boolean

translations
type: Link
domain: Product
range: ProductTranslation

translationsCache
type: Property
domain: Product

currentLocale
type: Property
domain: Product
range: string

currentTranslation
type: Property
domain: Product

fallbackLocale
type: Property
domain: Product
range: string

referenceableContent
type: Link
domain: Product
max cardinality: 1
range: SEOContent

SEOBrand
type: Property
domain: Product
range: string

SEOGtin8
type: Property
domain: Product
range: string

SEOGtin13
type: Property
domain: Product
range: string

SEOGtin14
type: Property
domain: Product
range: string

SEOMpn
type: Property
domain: Product
range: string

SEOIsbn
type: Property
domain: Product
range: string

SEOSku
type: Property
domain: Product
range: string

SEOOfferAggregated
type: Property
domain: Product
range: boolean

brand
type: Link
domain: Product
max cardinality: 1
range: Brand

labels
type: Link
domain: Product
range: ProductLabel

callouts
type: Property
domain: Product

metadataTitle
type: Property
domain: Product
range: string

metadataDescription
type: Property
domain: Product
range: string

openGraphMetadataImage
type: Property
domain: Product
range: string

richSnippetSubjectParent
type: Property
domain: Product

richSnippetSubjectType
type: Property
domain: Product
range: string

firstVariant
type: Property
domain: Product

mainImage
type: Property
domain: Product

enabledVariantsWith1Option
type: Property
domain: Product

enabledVariants
type: Property
domain: Product

notIndexable
type: Property
domain: Product
range: boolean

baseMetadataTitle
type: Property
domain: Product
range: string

baseMetadataDescription
type: Property
domain: Product
range: string

openGraphMetadataTitle
type: Property
domain: Product
range: string

openGraphMetadataDescription
type: Property
domain: Product
range: string

openGraphMetadataUrl
type: Property
domain: Product
range: string

openGraphMetadataType
type: Property
domain: Product
range: string

baseOpenGraphMetadataImage
type: Property
domain: Product
range: string

sEOBrand
type: Property
domain: Product
range: string

sEOGtin8
type: Property
domain: Product
range: string

sEOGtin13
type: Property
domain: Product
range: string

sEOGtin14
type: Property
domain: Product
range: string

sEOMpn
type: Property
domain: Product
range: string

sEOIsbn
type: Property
domain: Product
range: string

sEOSku
type: Property
domain: Product
range: string

label
type: Property
domain: Product

callout
type: Property
domain: Product

file
type: Property
domain: Product

name
type: Property
domain: Product
range: string

description
type: Property
domain: Product
range: string

slug
type: Property
domain: Product
range: string

shortDescription
type: Property
domain: Product
range: string

variantSelectionMethodChoice
type: Property
domain: Product
range: boolean

variantSelectionMethodLabel
type: Property
domain: Product
range: string

productTaxon
type: Property
domain: Product

taxons
type: Property
domain: Product

taxon
type: Property
domain: Product

channel
type: Property
domain: Product

acceptedReviews
type: Property
domain: Product

image
type: Property
domain: Product

variantSelectionMethodLabels
type: Property
domain: Product

translation
type: Property
domain: Product

metaKeywords
type: Property
domain: Product
range: string

metaDescription
type: Property
domain: Product
range: string

attribute
type: Property
domain: Product

attributeByCodeAndLocale
type: Property
domain: Product

variant
type: Property
domain: Product

option
type: Property
domain: Product

association
type: Property
domain: Product

simple
type: Property
domain: Product
range: boolean

configurable
type: Property
domain: Product
range: boolean

notEmptyAttributeByCodeAndLocale
type: Property
domain: Product

ProductAssociationType
type: Class
title: ProductAssociationType
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: code
  title: code
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: translations
  title: translations
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: translationsCache
  title: translationsCache
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: currentLocale
  title: currentLocale
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: currentTranslation
  title: currentTranslation
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: fallbackLocale
  title: fallbackLocale
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: translation
  title: translation
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a ProductAssociationType resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProductAssociationType resource.
  returns: ProductAssociationType
supported operation: Replaces the ProductAssociationType resource.
  type: Operation
  type: ReplaceAction
  expects: ProductAssociationType
  method: PUT
  title: Replaces the ProductAssociationType resource.
  returns: ProductAssociationType
supported operation: Deletes the ProductAssociationType resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the ProductAssociationType resource.
  returns: Nothing

id
type: Property
domain: ProductAssociationType
range: integer

code
type: Property
domain: ProductAssociationType
range: string

name
type: Property
domain: ProductAssociationType
range: string

createdAt
type: Property
domain: ProductAssociationType
range: dateTime

updatedAt
type: Property
domain: ProductAssociationType
range: dateTime

translations
type: Link
domain: ProductAssociationType
range: ProductAssociationTypeTranslation

translationsCache
type: Property
domain: ProductAssociationType

currentLocale
type: Property
domain: ProductAssociationType
range: string

currentTranslation
type: Property
domain: ProductAssociationType

fallbackLocale
type: Property
domain: ProductAssociationType
range: string

translation
type: Property
domain: ProductAssociationType

ProductAssociationTypeTranslation
type: Class
title: ProductAssociationTypeTranslation
supported operation: Retrieves a ProductAssociationTypeTranslation resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProductAssociationTypeTranslation resource.
  returns: ProductAssociationTypeTranslation

ProductImage
type: Class
title: ProductImage
supported property: SupportedProperty
  property: productVariants
  title: productVariants
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: file
  title: file
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: path
  title: path
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: owner
  title: owner
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: productVariant
  title: productVariant
  required: false
  readable: false
  writeable: true
supported operation: Retrieves a ProductImage resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProductImage resource.
  returns: ProductImage
supported operation: Retrieves a ProductImage resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProductImage resource.
  returns: ProductImage

productVariants
type: Link
domain: ProductImage
range: ProductVariant

type
type: Property
domain: ProductImage
range: string

file
type: Property
domain: ProductImage

path
type: Property
domain: ProductImage
range: string

owner
type: Link
domain: ProductImage
max cardinality: 1
range: Product

productVariant
type: Property
domain: ProductImage

ProductOption
type: Class
title: ProductOption
supported property: SupportedProperty
  property: required
  title: required
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: multiple
  title: multiple
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: switcher
  title: switcher
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: code
  title: code
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: position
  title: position
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: values
  title: values
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: translations
  title: translations
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: translationsCache
  title: translationsCache
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: currentLocale
  title: currentLocale
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: currentTranslation
  title: currentTranslation
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: fallbackLocale
  title: fallbackLocale
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: value
  title: value
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: translation
  title: translation
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a ProductOption resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProductOption resource.
  returns: ProductOption
supported operation: Retrieves a ProductOption resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProductOption resource.
  returns: ProductOption
supported operation: Replaces the ProductOption resource.
  type: Operation
  type: ReplaceAction
  expects: ProductOption
  method: PUT
  title: Replaces the ProductOption resource.
  returns: ProductOption

required
type: Property
domain: ProductOption
range: boolean

multiple
type: Property
domain: ProductOption
range: boolean

switcher
type: Property
domain: ProductOption
range: boolean

id
type: Property
domain: ProductOption
range: integer

code
type: Property
domain: ProductOption
range: string

position
type: Property
domain: ProductOption
range: integer

values
type: Link
domain: ProductOption
range: ProductOptionValue

createdAt
type: Property
domain: ProductOption
range: dateTime

updatedAt
type: Property
domain: ProductOption
range: dateTime

translations
type: Link
domain: ProductOption
range: ProductOptionTranslation

translationsCache
type: Property
domain: ProductOption

currentLocale
type: Property
domain: ProductOption
range: string

currentTranslation
type: Property
domain: ProductOption

fallbackLocale
type: Property
domain: ProductOption
range: string

name
type: Property
domain: ProductOption
range: string

value
type: Property
domain: ProductOption

translation
type: Property
domain: ProductOption

ProductOptionTranslation
type: Class
title: ProductOptionTranslation
supported operation: Retrieves a ProductOptionTranslation resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProductOptionTranslation resource.
  returns: ProductOptionTranslation

ProductOptionValue
type: Class
title: ProductOptionValue
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: code
  title: code
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: option
  title: option
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: translations
  title: translations
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: translationsCache
  title: translationsCache
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: currentLocale
  title: currentLocale
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: currentTranslation
  title: currentTranslation
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: fallbackLocale
  title: fallbackLocale
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: value
  title: value
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: optionCode
  title: optionCode
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: translation
  title: translation
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a ProductOptionValue resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProductOptionValue resource.
  returns: ProductOptionValue
supported operation: Retrieves a ProductOptionValue resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProductOptionValue resource.
  returns: ProductOptionValue

id
type: Property
domain: ProductOptionValue
range: integer

code
type: Property
domain: ProductOptionValue
range: string

option
type: Link
domain: ProductOptionValue
max cardinality: 1
range: ProductOption

translations
type: Property
domain: ProductOptionValue

translationsCache
type: Property
domain: ProductOptionValue

currentLocale
type: Property
domain: ProductOptionValue
range: string

currentTranslation
type: Property
domain: ProductOptionValue

fallbackLocale
type: Property
domain: ProductOptionValue
range: string

value
type: Property
domain: ProductOptionValue
range: string

optionCode
type: Property
domain: ProductOptionValue
range: string

name
type: Property
domain: ProductOptionValue
range: string

translation
type: Property
domain: ProductOptionValue

ProductReview
type: Class
title: ProductReview
supported property: SupportedProperty
  property: title
  title: title
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: rating
  title: rating
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: comment
  title: comment
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: author
  title: author
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: reviewSubject
  title: reviewSubject
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: rating
  title: rating
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: comment
  title: comment
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: product
  title: product
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a ProductReview resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProductReview resource.
  returns: ProductReview
supported operation: Retrieves a ProductReview resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProductReview resource.
  returns: ProductReview
supported operation: Deletes the ProductReview resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the ProductReview resource.
  returns: Nothing
supported operation: Replaces the ProductReview resource.
  type: Operation
  type: ReplaceAction
  expects: ProductReview
  method: PUT
  title: Replaces the ProductReview resource.
  returns: ProductReview
supported operation: Updates the ProductReview resource.
  type: Operation
  expects: Nothing
  method: PATCH
  title: Updates the ProductReview resource.
  returns: ProductReview
supported operation: Updates the ProductReview resource.
  type: Operation
  expects: Nothing
  method: PATCH
  title: Updates the ProductReview resource.
  returns: ProductReview

title
type: Property
domain: ProductReview
range: string

rating
type: Property
domain: ProductReview
range: integer

comment
type: Property
domain: ProductReview
range: string

author
type: Link
domain: ProductReview
max cardinality: 1
range: Customer

status
type: Property
domain: ProductReview
range: string

reviewSubject
type: Link
domain: ProductReview
max cardinality: 1
range: Product

createdAt
type: Property
domain: ProductReview
range: dateTime

updatedAt
type: Property
domain: ProductReview
range: dateTime

product
type: Property
domain: ProductReview
range: string

email
type: Property
domain: ProductReview
range: string

ProductTaxon
type: Class
title: ProductTaxon
supported property: SupportedProperty
  property: product
  title: product
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: taxon
  title: taxon
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: position
  title: position
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a ProductTaxon resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProductTaxon resource.
  returns: ProductTaxon
supported operation: Retrieves a ProductTaxon resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProductTaxon resource.
  returns: ProductTaxon

product
type: Link
domain: ProductTaxon
max cardinality: 1
range: Product

taxon
type: Link
domain: ProductTaxon
max cardinality: 1
range: Taxon

position
type: Property
domain: ProductTaxon
range: integer

ProductTranslation
type: Class
title: ProductTranslation
supported operation: Retrieves a ProductTranslation resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProductTranslation resource.
  returns: ProductTranslation
supported operation: Retrieves a ProductTranslation resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProductTranslation resource.
  returns: ProductTranslation

ProductVariant
type: Class
title: ProductVariant
supported property: SupportedProperty
  property: packUnits
  title: packUnits
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: packLength
  title: packLength
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: packWidth
  title: packWidth
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: packHeight
  title: packHeight
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: packWeight
  title: packWeight
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: version
  title: version
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: onHold
  title: onHold
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: onHand
  title: onHand
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: tracked
  title: tracked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: weight
  title: weight
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: width
  title: width
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: height
  title: height
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: depth
  title: depth
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: taxCategory
  title: taxCategory
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: shippingCategory
  title: shippingCategory
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: channelPricings
  title: channelPricings
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: shippingRequired
  title: shippingRequired
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: images
  title: images
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: code
  title: code
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: product
  title: product
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: optionValues
  title: optionValues
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: position
  title: position
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: enabled
  title: enabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: translations
  title: translations
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: translationsCache
  title: translationsCache
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: currentLocale
  title: currentLocale
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: currentTranslation
  title: currentTranslation
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: fallbackLocale
  title: fallbackLocale
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: tierPrices
  title: tierPrices
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: mainImage
  title: mainImage
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a ProductVariant resource.
supported operation: Replaces the ProductVariant resource.
supported operation: Deletes the ProductVariant resource.

packUnits
type: Property
domain: ProductVariant
range: integer

packLength
type: Property
domain: ProductVariant
range: string

packWidth
type: Property
domain: ProductVariant
range: string

packHeight
type: Property
domain: ProductVariant
range: string

packWeight
type: Property
domain: ProductVariant
range: string

version
type: Property
domain: ProductVariant
range: integer

onHold
type: Property
domain: ProductVariant
range: integer

onHand
type: Property
domain: ProductVariant
range: integer

tracked
type: Property
domain: ProductVariant
range: boolean

weight
type: Property
domain: ProductVariant
range: decimal

width
type: Property
domain: ProductVariant
range: decimal

height
type: Property
domain: ProductVariant
range: decimal

depth
type: Property
domain: ProductVariant
range: decimal

taxCategory
type: Link
domain: ProductVariant
max cardinality: 1
range: TaxCategory

shippingCategory
type: Link
domain: ProductVariant
max cardinality: 1
range: ShippingCategory

channelPricings
type: Link
domain: ProductVariant
range: ChannelPricing

shippingRequired
type: Property
domain: ProductVariant
range: boolean

images
type: Link
domain: ProductVariant
range: ProductImage

id
type: Property
domain: ProductVariant
range: integer

code
type: Property
domain: ProductVariant
range: string

product
type: Link
domain: ProductVariant
max cardinality: 1
range: Product

optionValues
type: Link
domain: ProductVariant
range: ProductOptionValue

position
type: Property
domain: ProductVariant
range: integer

createdAt
type: Property
domain: ProductVariant
range: dateTime

updatedAt
type: Property
domain: ProductVariant
range: dateTime

enabled
type: Property
domain: ProductVariant
range: boolean

translations
type: Link
domain: ProductVariant
range: ProductVariantTranslation

translationsCache
type: Property
domain: ProductVariant

currentLocale
type: Property
domain: ProductVariant
range: string

currentTranslation
type: Property
domain: ProductVariant

fallbackLocale
type: Property
domain: ProductVariant
range: string

tierPrices
type: Link
domain: ProductVariant
range: TierPrice

mainImage
type: Property
domain: ProductVariant

inStock
type: Property
domain: ProductVariant
range: boolean

inventoryName
type: Property
domain: ProductVariant
range: string

shippingWeight
type: Property
domain: ProductVariant
range: decimal

shippingWidth
type: Property
domain: ProductVariant
range: decimal

shippingHeight
type: Property
domain: ProductVariant
range: decimal

shippingDepth
type: Property
domain: ProductVariant
range: decimal

shippingVolume
type: Property
domain: ProductVariant
range: decimal

channelPricingForChannel
type: Property
domain: ProductVariant

channelPricing
type: Property
domain: ProductVariant

image
type: Property
domain: ProductVariant

name
type: Property
domain: ProductVariant
range: string

descriptor
type: Property
domain: ProductVariant
range: string

optionValue
type: Property
domain: ProductVariant

translation
type: Property
domain: ProductVariant

ProductVariantTranslation
type: Class
title: ProductVariantTranslation
supported operation: Retrieves a ProductVariantTranslation resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProductVariantTranslation resource.
  returns: ProductVariantTranslation
supported operation: Retrieves a ProductVariantTranslation resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProductVariantTranslation resource.
  returns: ProductVariantTranslation

Promotion
type: Class
title: Promotion
supported property: SupportedProperty
  property: channels
  title: channels
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: code
  title: code
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: priority
  title: priority
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: exclusive
  title: exclusive
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: usageLimit
  title: usageLimit
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: used
  title: used
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: startsAt
  title: startsAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: endsAt
  title: endsAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: couponBased
  title: couponBased
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: coupons
  title: coupons
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: rules
  title: rules
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: actions
  title: actions
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: appliesToDiscounted
  title: appliesToDiscounted
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: channel
  title: channel
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: coupon
  title: coupon
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: rule
  title: rule
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: action
  title: action
  required: false
  readable: false
  writeable: true
supported operation: Retrieves a Promotion resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Promotion resource.
  returns: Promotion
supported operation: Deletes the Promotion resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Promotion resource.
  returns: Nothing

channels
type: Link
domain: Promotion
range: Channel

id
type: Property
domain: Promotion
range: integer

code
type: Property
domain: Promotion
range: string

name
type: Property
domain: Promotion
range: string

description
type: Property
domain: Promotion
range: string

priority
type: Property
domain: Promotion
range: integer

exclusive
type: Property
domain: Promotion
range: boolean

usageLimit
type: Property
domain: Promotion
range: integer

used
type: Property
domain: Promotion
range: integer

startsAt
type: Property
domain: Promotion
range: dateTime

endsAt
type: Property
domain: Promotion
range: dateTime

couponBased
type: Property
domain: Promotion
range: boolean

coupons
type: Property
domain: Promotion

rules
type: Property
domain: Promotion

actions
type: Property
domain: Promotion

appliesToDiscounted
type: Property
domain: Promotion
range: boolean

createdAt
type: Property
domain: Promotion
range: dateTime

updatedAt
type: Property
domain: Promotion
range: dateTime

channel
type: Property
domain: Promotion

coupon
type: Property
domain: Promotion

rule
type: Property
domain: Promotion

action
type: Property
domain: Promotion

Province
type: Class
title: Province
supported operation: Retrieves a Province resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Province resource.
  returns: Province
supported operation: Replaces the Province resource.
  type: Operation
  type: ReplaceAction
  expects: Province
  method: PUT
  title: Replaces the Province resource.
  returns: Province

ResetPasswordRequest
type: Class
title: ResetPasswordRequest
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: channelCode
  title: channelCode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: locale
  title: locale
  required: false
  readable: true
  writeable: true
supported operation: Updates the ResetPasswordRequest resource.
  type: Operation
  expects: ResetPasswordRequest
  method: PATCH
  title: Updates the ResetPasswordRequest resource.
  returns: Nothing

email
type: Property
domain: ResetPasswordRequest
range: string

channelCode
type: Property
domain: ResetPasswordRequest
range: string

locale
type: Property
domain: ResetPasswordRequest
range: string

Shipment
type: Class
title: Shipment
supported property: SupportedProperty
  property: upsPackagesOverride
  title: upsPackagesOverride
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: upsPackageLengthOverride
  title: upsPackageLengthOverride
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: upsPackageWidthOverride
  title: upsPackageWidthOverride
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: upsPackageHeightOverride
  title: upsPackageHeightOverride
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: upsPackageWeightOverride
  title: upsPackageWeightOverride
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: upsServiceCodeOverride
  title: upsServiceCodeOverride
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: upsSelectedServiceCode
  title: upsSelectedServiceCode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: upsLastRateResponse
  title: upsLastRateResponse
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: order
  title: order
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: adjustments
  title: adjustments
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: adjustmentsTotal
  title: adjustmentsTotal
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: state
  title: state
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: method
  title: method
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: units
  title: units
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: tracking
  title: tracking
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: shippedAt
  title: shippedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: adjustment
  title: adjustment
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: unit
  title: unit
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: tracked
  title: tracked
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: shippables
  title: shippables
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: shippingWeight
  title: shippingWeight
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: shippingVolume
  title: shippingVolume
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: shippingUnitCount
  title: shippingUnitCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: shippingUnitTotal
  title: shippingUnitTotal
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Shipment resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Shipment resource.
  returns: Shipment
supported operation: Retrieves a Shipment resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Shipment resource.
  returns: Shipment
supported operation: Updates the Shipment resource.
  type: Operation
  expects: Shipment
  method: PATCH
  title: Updates the Shipment resource.
  returns: Shipment

upsPackagesOverride
type: Property
domain: Shipment
range: integer

upsPackageLengthOverride
type: Property
domain: Shipment
range: string

upsPackageWidthOverride
type: Property
domain: Shipment
range: string

upsPackageHeightOverride
type: Property
domain: Shipment
range: string

upsPackageWeightOverride
type: Property
domain: Shipment
range: string

upsServiceCodeOverride
type: Property
domain: Shipment
range: string

upsSelectedServiceCode
type: Property
domain: Shipment
range: string

upsLastRateResponse
type: Property
domain: Shipment
range: string

order
type: Link
domain: Shipment
max cardinality: 1
range: Order

adjustments
type: Link
domain: Shipment
range: Adjustment

adjustmentsTotal
type: Property
domain: Shipment
range: integer

state
type: Property
domain: Shipment
range: string

method
type: Link
domain: Shipment
max cardinality: 1
range: ShippingMethod

units
type: Link
domain: Shipment
range: OrderItemUnit

tracking
type: Property
domain: Shipment
range: string

shippedAt
type: Property
domain: Shipment
range: dateTime

createdAt
type: Property
domain: Shipment
range: dateTime

updatedAt
type: Property
domain: Shipment
range: dateTime

adjustment
type: Property
domain: Shipment

unit
type: Property
domain: Shipment

tracked
type: Property
domain: Shipment
range: boolean

shippables
type: Property
domain: Shipment

shippingWeight
type: Property
domain: Shipment
range: decimal

shippingVolume
type: Property
domain: Shipment
range: decimal

shippingUnitCount
type: Property
domain: Shipment
range: integer

shippingUnitTotal
type: Property
domain: Shipment
range: integer

ShippingCategory
type: Class
title: ShippingCategory
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: code
  title: code
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a ShippingCategory resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ShippingCategory resource.
  returns: ShippingCategory
supported operation: Replaces the ShippingCategory resource.
  type: Operation
  type: ReplaceAction
  expects: ShippingCategory
  method: PUT
  title: Replaces the ShippingCategory resource.
  returns: ShippingCategory
supported operation: Deletes the ShippingCategory resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the ShippingCategory resource.
  returns: Nothing

id
type: Property
domain: ShippingCategory
range: integer

code
type: Property
domain: ShippingCategory
range: string

name
type: Property
domain: ShippingCategory
range: string

description
type: Property
domain: ShippingCategory
range: string

createdAt
type: Property
domain: ShippingCategory
range: dateTime

updatedAt
type: Property
domain: ShippingCategory
range: dateTime

ShippingMethod
type: Class
title: ShippingMethod
supported property: SupportedProperty
  property: zone
  title: zone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: taxCategory
  title: taxCategory
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: channels
  title: channels
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: code
  title: code
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: position
  title: position
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: category
  title: category
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: categoryRequirement
  title: categoryRequirement
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: calculator
  title: calculator
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: configuration
  title: configuration
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: rules
  title: rules
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: archivedAt
  title: archivedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: enabled
  title: enabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: translations
  title: translations
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: translationsCache
  title: translationsCache
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: currentLocale
  title: currentLocale
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: currentTranslation
  title: currentTranslation
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: fallbackLocale
  title: fallbackLocale
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: channel
  title: channel
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: translationClass
  title: translationClass
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: rule
  title: rule
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: translation
  title: translation
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a ShippingMethod resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ShippingMethod resource.
  returns: ShippingMethod
supported operation: Retrieves a ShippingMethod resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ShippingMethod resource.
  returns: ShippingMethod
supported operation: Replaces the ShippingMethod resource.
  type: Operation
  type: ReplaceAction
  expects: ShippingMethod
  method: PUT
  title: Replaces the ShippingMethod resource.
  returns: ShippingMethod
supported operation: Deletes the ShippingMethod resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the ShippingMethod resource.
  returns: Nothing
supported operation: Updates the ShippingMethod resource.
  type: Operation
  expects: Nothing
  method: PATCH
  title: Updates the ShippingMethod resource.
  returns: ShippingMethod
supported operation: Updates the ShippingMethod resource.
  type: Operation
  expects: Nothing
  method: PATCH
  title: Updates the ShippingMethod resource.
  returns: ShippingMethod

zone
type: Link
domain: ShippingMethod
max cardinality: 1
range: Zone

taxCategory
type: Link
domain: ShippingMethod
max cardinality: 1
range: TaxCategory

channels
type: Link
domain: ShippingMethod
range: Channel

id
type: Property
domain: ShippingMethod
range: integer

code
type: Property
domain: ShippingMethod
range: string

position
type: Property
domain: ShippingMethod
range: integer

category
type: Link
domain: ShippingMethod
max cardinality: 1
range: ShippingCategory

categoryRequirement
type: Property
domain: ShippingMethod
range: integer

calculator
type: Property
domain: ShippingMethod
range: string

configuration
type: Property
domain: ShippingMethod

rules
type: Property
domain: ShippingMethod

archivedAt
type: Property
domain: ShippingMethod
range: dateTime

createdAt
type: Property
domain: ShippingMethod
range: dateTime

updatedAt
type: Property
domain: ShippingMethod
range: dateTime

enabled
type: Property
domain: ShippingMethod
range: boolean

translations
type: Link
domain: ShippingMethod
range: ShippingMethodTranslation

translationsCache
type: Property
domain: ShippingMethod

currentLocale
type: Property
domain: ShippingMethod
range: string

currentTranslation
type: Property
domain: ShippingMethod

fallbackLocale
type: Property
domain: ShippingMethod
range: string

channel
type: Property
domain: ShippingMethod

translationClass
type: Property
domain: ShippingMethod

name
type: Property
domain: ShippingMethod
range: string

description
type: Property
domain: ShippingMethod
range: string

rule
type: Property
domain: ShippingMethod

translation
type: Property
domain: ShippingMethod

ShippingMethodTranslation
type: Class
title: ShippingMethodTranslation
supported operation: Retrieves a ShippingMethodTranslation resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ShippingMethodTranslation resource.
  returns: ShippingMethodTranslation
supported operation: Retrieves a ShippingMethodTranslation resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ShippingMethodTranslation resource.
  returns: ShippingMethodTranslation

ShopBillingData
type: Class
title: ShopBillingData
supported operation: Retrieves a ShopBillingData resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ShopBillingData resource.
  returns: ShopBillingData

TaxCategory
type: Class
title: TaxCategory
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: code
  title: code
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: rates
  title: rates
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: rate
  title: rate
  required: false
  readable: false
  writeable: true
supported operation: Retrieves a TaxCategory resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a TaxCategory resource.
  returns: TaxCategory
supported operation: Replaces the TaxCategory resource.
  type: Operation
  type: ReplaceAction
  expects: TaxCategory
  method: PUT
  title: Replaces the TaxCategory resource.
  returns: TaxCategory
supported operation: Deletes the TaxCategory resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the TaxCategory resource.
  returns: Nothing

id
type: Property
domain: TaxCategory
range: integer

code
type: Property
domain: TaxCategory
range: string

name
type: Property
domain: TaxCategory
range: string

description
type: Property
domain: TaxCategory
range: string

rates
type: Property
domain: TaxCategory

createdAt
type: Property
domain: TaxCategory
range: dateTime

updatedAt
type: Property
domain: TaxCategory
range: dateTime

rate
type: Property
domain: TaxCategory

Taxon
type: Class
title: Taxon
supported property: SupportedProperty
  property: icon
  title: icon
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: menuAssoc
  title: menuAssoc
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: redirect
  title: redirect
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: images
  title: images
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: code
  title: code
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: root
  title: root
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: parent
  title: parent
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: children
  title: children
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: left
  title: left
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: right
  title: right
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: level
  title: level
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: position
  title: position
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: translations
  title: translations
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: translationsCache
  title: translationsCache
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: currentLocale
  title: currentLocale
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: currentTranslation
  title: currentTranslation
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: fallbackLocale
  title: fallbackLocale
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: enabled
  title: enabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: richSnippetSubjectParent
  title: richSnippetSubjectParent
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: richSnippetSubjectType
  title: richSnippetSubjectType
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: image
  title: image
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: translationClass
  title: translationClass
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: slug
  title: slug
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ancestors
  title: ancestors
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: child
  title: child
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: enabledChildren
  title: enabledChildren
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: fullname
  title: fullname
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: translation
  title: translation
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Taxon resource.
supported operation: Replaces the Taxon resource.
supported operation: Deletes the Taxon resource.

icon
type: Property
domain: Taxon
range: string

menuAssoc
type: Link
domain: Taxon
max cardinality: 1
range: Taxon

redirect
type: Property
domain: Taxon
range: string

images
type: Link
domain: Taxon
range: TaxonImage

id
type: Property
domain: Taxon
range: integer

code
type: Property
domain: Taxon
range: string

root
type: Link
domain: Taxon
max cardinality: 1
range: Taxon

parent
type: Link
domain: Taxon
max cardinality: 1
range: Taxon

children
type: Link
domain: Taxon
range: Taxon

left
type: Property
domain: Taxon
range: integer

right
type: Property
domain: Taxon
range: integer

level
type: Property
domain: Taxon
range: integer

position
type: Property
domain: Taxon
range: integer

translations
type: Link
domain: Taxon
range: TaxonTranslation

translationsCache
type: Property
domain: Taxon

currentLocale
type: Property
domain: Taxon
range: string

currentTranslation
type: Property
domain: Taxon

fallbackLocale
type: Property
domain: Taxon
range: string

enabled
type: Property
domain: Taxon
range: boolean

createdAt
type: Property
domain: Taxon
range: dateTime

updatedAt
type: Property
domain: Taxon
range: dateTime

richSnippetSubjectParent
type: Property
domain: Taxon

richSnippetSubjectType
type: Property
domain: Taxon
range: string

image
type: Property
domain: Taxon

translationClass
type: Property
domain: Taxon

name
type: Property
domain: Taxon
range: string

slug
type: Property
domain: Taxon
range: string

description
type: Property
domain: Taxon
range: string

ancestors
type: Property
domain: Taxon

child
type: Property
domain: Taxon

enabledChildren
type: Property
domain: Taxon

fullname
type: Property
domain: Taxon
range: string

translation
type: Property
domain: Taxon

TaxonTranslation
type: Class
title: TaxonTranslation
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: slug
  title: slug
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: locale
  title: locale
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: translatable
  title: translatable
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a TaxonTranslation resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a TaxonTranslation resource.
  returns: TaxonTranslation
supported operation: Retrieves a TaxonTranslation resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a TaxonTranslation resource.
  returns: TaxonTranslation

name
type: Property
domain: TaxonTranslation
range: string

slug
type: Property
domain: TaxonTranslation
range: string

description
type: Property
domain: TaxonTranslation
range: string

locale
type: Property
domain: TaxonTranslation
range: string

translatable
type: Link
domain: TaxonTranslation
max cardinality: 1
range: Taxon

VerifyCustomerAccount
type: Class
title: VerifyCustomerAccount
supported property: SupportedProperty
  property: shopUserId
  title: shopUserId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: channelCode
  title: channelCode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: localeCode
  title: localeCode
  required: false
  readable: true
  writeable: true
supported operation: Updates the VerifyCustomerAccount resource.
  type: Operation
  expects: VerifyCustomerAccount
  method: PATCH
  title: Updates the VerifyCustomerAccount resource.
  returns: Nothing

shopUserId
type: Property
domain: VerifyCustomerAccount

channelCode
type: Property
domain: VerifyCustomerAccount
range: string

localeCode
type: Property
domain: VerifyCustomerAccount
range: string

Zone
type: Class
title: Zone
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: code
  title: code
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: scope
  title: scope
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: members
  title: members
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: types
  title: types
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: member
  title: member
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: false
  writeable: false
supported operation: Retrieves a Zone resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Zone resource.
  returns: Zone
supported operation: Replaces the Zone resource.
  type: Operation
  type: ReplaceAction
  expects: Zone
  method: PUT
  title: Replaces the Zone resource.
  returns: Zone
supported operation: Deletes the Zone resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Zone resource.
  returns: Nothing

id
type: Property
domain: Zone
range: integer

code
type: Property
domain: Zone
range: string

name
type: Property
domain: Zone
range: string

type
type: Property
domain: Zone
range: string

scope
type: Property
domain: Zone
range: string

members
type: Link
domain: Zone
range: ZoneMember

types
type: Property
domain: Zone

member
type: Property
domain: Zone

createdAt
type: Property
domain: Zone

updatedAt
type: Property
domain: Zone

ZoneMember
type: Class
title: ZoneMember
supported operation: Retrieves a ZoneMember resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ZoneMember resource.
  returns: ZoneMember

Block
type: Class
title: Block
supported property: SupportedProperty
  property: code
  title: code
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: enabled
  title: enabled
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: sections
  title: sections
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: products
  title: products
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: channels
  title: channels
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: translations
  title: translations
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: taxons
  title: taxons
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: taxonomies
  title: taxonomies
  required: false
  readable: false
  writeable: false
supported operation: Retrieves a Block resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Block resource.
  returns: Block

code
type: Property
domain: Block
range: string

enabled
type: Property
domain: Block
range: boolean

sections
type: Property
domain: Block
range: Section

products
type: Link
domain: Block
range: Product

channels
type: Link
domain: Block
range: Channel

translations
type: Property
domain: Block

taxons
type: Property
domain: Block

taxonomies
type: Property
domain: Block
range: Taxon

FrequentlyAskedQuestion
type: Class
title: FrequentlyAskedQuestion
supported property: SupportedProperty
  property: code
  title: code
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: position
  title: position
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: channels
  title: channels
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: enabled
  title: enabled
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: translations
  title: translations
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a FrequentlyAskedQuestion resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a FrequentlyAskedQuestion resource.
  returns: FrequentlyAskedQuestion

code
type: Property
domain: FrequentlyAskedQuestion
range: string

position
type: Property
domain: FrequentlyAskedQuestion
range: integer

channels
type: Link
domain: FrequentlyAskedQuestion
range: Channel

enabled
type: Property
domain: FrequentlyAskedQuestion
range: boolean

translations
type: Property
domain: FrequentlyAskedQuestion

Media
type: Class
title: Media
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: code
  title: code
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: path
  title: path
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: mimeType
  title: mimeType
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: width
  title: width
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: height
  title: height
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: saveWithOriginalName
  title: saveWithOriginalName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: enabled
  title: enabled
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: sections
  title: sections
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: products
  title: products
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: channels
  title: channels
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: translations
  title: translations
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Media resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Media resource.
  returns: Media

type
type: Property
domain: Media
range: string

code
type: Property
domain: Media
range: string

path
type: Property
domain: Media
range: string

mimeType
type: Property
domain: Media
range: string

width
type: Property
domain: Media
range: integer

height
type: Property
domain: Media
range: integer

saveWithOriginalName
type: Property
domain: Media
range: boolean

enabled
type: Property
domain: Media
range: boolean

sections
type: Property
domain: Media
range: Section

products
type: Link
domain: Media
range: Product

channels
type: Link
domain: Media
range: Channel

translations
type: Property
domain: Media

Page
type: Class
title: Page
supported property: SupportedProperty
  property: code
  title: code
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: publishAt
  title: publishAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: translations
  title: translations
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: enabled
  title: enabled
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: products
  title: products
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: sections
  title: sections
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: channels
  title: channels
  required: false
  readable: false
  writeable: false
supported operation: Retrieves a Page resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Page resource.
  returns: Page

code
type: Property
domain: Page
range: string

publishAt
type: Property
domain: Page
range: dateTime

translations
type: Property
domain: Page

enabled
type: Property
domain: Page
range: boolean

createdAt
type: Property
domain: Page
range: dateTime

updatedAt
type: Property
domain: Page
range: dateTime

products
type: Property
domain: Page
range: Product

sections
type: Property
domain: Page
range: Section

channels
type: Property
domain: Page
range: Channel

Section
type: Class
title: Section
supported property: SupportedProperty
  property: code
  title: code
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Section resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Section resource.
  returns: Section

code
type: Property
domain: Section
range: string

ProductFile
type: Class
title: ProductFile
supported property: SupportedProperty
  property: owner
  title: owner
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: mimeType
  title: mimeType
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: file
  title: file
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: path
  title: path
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: mime_type
  title: mime_type
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a ProductFile resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProductFile resource.
  returns: ProductFile
supported operation: Retrieves a ProductFile resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProductFile resource.
  returns: ProductFile

owner
type: Link
domain: ProductFile
max cardinality: 1
range: Product

type
type: Property
domain: ProductFile
range: string

mimeType
type: Property
domain: ProductFile
range: string

file
type: Property
domain: ProductFile

path
type: Property
domain: ProductFile
range: string

mime_type
type: Property
domain: ProductFile

ProductLabel
type: Class
title: ProductLabel
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: code
  title: code
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: translations
  title: translations
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: translationsCache
  title: translationsCache
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: currentLocale
  title: currentLocale
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: currentTranslation
  title: currentTranslation
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: fallbackLocale
  title: fallbackLocale
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: labelTranslation
  title: labelTranslation
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: translation
  title: translation
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a ProductLabel resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProductLabel resource.
  returns: ProductLabel
supported operation: Retrieves a ProductLabel resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProductLabel resource.
  returns: ProductLabel
supported operation: Replaces the ProductLabel resource.
  type: Operation
  type: ReplaceAction
  expects: ProductLabel
  method: PUT
  title: Replaces the ProductLabel resource.
  returns: ProductLabel
supported operation: Deletes the ProductLabel resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the ProductLabel resource.
  returns: Nothing

id
type: Property
domain: ProductLabel
range: integer

code
type: Property
domain: ProductLabel
range: string

translations
type: Link
domain: ProductLabel
range: ProductLabelTranslation

translationsCache
type: Property
domain: ProductLabel

currentLocale
type: Property
domain: ProductLabel
range: string

currentTranslation
type: Property
domain: ProductLabel

fallbackLocale
type: Property
domain: ProductLabel
range: string

name
type: Property
domain: ProductLabel
range: string

labelTranslation
type: Property
domain: ProductLabel

translation
type: Property
domain: ProductLabel

ProductLabelTranslation
type: Class
title: ProductLabelTranslation
supported operation: Retrieves a ProductLabelTranslation resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProductLabelTranslation resource.
  returns: ProductLabelTranslation

SEOContent
type: Class
title: SEOContent
supported property: SupportedProperty
  property: translations
  title: translations
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: translationsCache
  title: translationsCache
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: currentLocale
  title: currentLocale
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: currentTranslation
  title: currentTranslation
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: fallbackLocale
  title: fallbackLocale
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: notIndexable
  title: notIndexable
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: metadataTitle
  title: metadataTitle
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: metadataDescription
  title: metadataDescription
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: openGraphMetadataTitle
  title: openGraphMetadataTitle
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: openGraphMetadataDescription
  title: openGraphMetadataDescription
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: openGraphMetadataUrl
  title: openGraphMetadataUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: openGraphMetadataType
  title: openGraphMetadataType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: openGraphMetadataImage
  title: openGraphMetadataImage
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: translation
  title: translation
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: code
  title: code
  required: false
  readable: false
  writeable: false
supported operation: Retrieves a SEOContent resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a SEOContent resource.
  returns: SEOContent
supported operation: Replaces the SEOContent resource.
  type: Operation
  type: ReplaceAction
  expects: SEOContent
  method: PUT
  title: Replaces the SEOContent resource.
  returns: SEOContent
supported operation: Deletes the SEOContent resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the SEOContent resource.
  returns: Nothing

translations
type: Link
domain: SEOContent
range: SEOContentTranslation

translationsCache
type: Property
domain: SEOContent

currentLocale
type: Property
domain: SEOContent
range: string

currentTranslation
type: Property
domain: SEOContent

fallbackLocale
type: Property
domain: SEOContent
range: string

notIndexable
type: Property
domain: SEOContent
range: boolean

metadataTitle
type: Property
domain: SEOContent
range: string

metadataDescription
type: Property
domain: SEOContent
range: string

openGraphMetadataTitle
type: Property
domain: SEOContent
range: string

openGraphMetadataDescription
type: Property
domain: SEOContent
range: string

openGraphMetadataUrl
type: Property
domain: SEOContent
range: string

openGraphMetadataType
type: Property
domain: SEOContent
range: string

openGraphMetadataImage
type: Property
domain: SEOContent
range: string

translation
type: Property
domain: SEOContent

code
type: Property
domain: SEOContent

SEOContentTranslation
type: Class
title: SEOContentTranslation
supported operation: Retrieves a SEOContentTranslation resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a SEOContentTranslation resource.
  returns: SEOContentTranslation
supported operation: Retrieves a SEOContentTranslation resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a SEOContentTranslation resource.
  returns: SEOContentTranslation

TaxonImage
type: Class
title: TaxonImage
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: file
  title: file
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: path
  title: path
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: owner
  title: owner
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a TaxonImage resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a TaxonImage resource.
  returns: TaxonImage
supported operation: Retrieves a TaxonImage resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a TaxonImage resource.
  returns: TaxonImage

type
type: Property
domain: TaxonImage
range: string

file
type: Property
domain: TaxonImage

path
type: Property
domain: TaxonImage
range: string

owner
type: Link
domain: TaxonImage
max cardinality: 1
range: Taxon

Brand
type: Class
title: Brand
supported property: SupportedProperty
  property: plate_default
  title: plate_default
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: plate_per_color
  title: plate_per_color
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: production_time
  title: production_time
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: setup_default
  title: setup_default
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: url
  title: url
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: freight
  title: freight
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: shipFromCompanyName
  title: shipFromCompanyName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: shipFromAddress1
  title: shipFromAddress1
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: shipFromAddress2
  title: shipFromAddress2
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: shipFromCity
  title: shipFromCity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: shipFromState
  title: shipFromState
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: shipFromPostalCode
  title: shipFromPostalCode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: shipFromCountryCode
  title: shipFromCountryCode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: shipFromPhone
  title: shipFromPhone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: shipFromResidential
  title: shipFromResidential
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: code
  title: code
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: products
  title: products
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: images
  title: images
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: plateDefault
  title: plateDefault
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: platePerColor
  title: platePerColor
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: productionTime
  title: productionTime
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: setupDefault
  title: setupDefault
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: product
  title: product
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: image
  title: image
  required: false
  readable: false
  writeable: true
supported operation: Retrieves a Brand resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Brand resource.
  returns: Brand
supported operation: Replaces the Brand resource.
  type: Operation
  type: ReplaceAction
  expects: Brand
  method: PUT
  title: Replaces the Brand resource.
  returns: Brand
supported operation: Deletes the Brand resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Brand resource.
  returns: Nothing

plate_default
type: Property
domain: Brand
range: integer

plate_per_color
type: Property
domain: Brand
range: integer

production_time
type: Property
domain: Brand
range: string

setup_default
type: Property
domain: Brand
range: integer

url
type: Property
domain: Brand
range: string

freight
type: Property
domain: Brand
range: boolean

shipFromCompanyName
type: Property
domain: Brand
range: string

shipFromAddress1
type: Property
domain: Brand
range: string

shipFromAddress2
type: Property
domain: Brand
range: string

shipFromCity
type: Property
domain: Brand
range: string

shipFromState
type: Property
domain: Brand
range: string

shipFromPostalCode
type: Property
domain: Brand
range: string

shipFromCountryCode
type: Property
domain: Brand
range: string

shipFromPhone
type: Property
domain: Brand
range: string

shipFromResidential
type: Property
domain: Brand
range: boolean

id
type: Property
domain: Brand
range: integer

code
type: Property
domain: Brand
range: string

name
type: Property
domain: Brand
range: string

products
type: Link
domain: Brand
range: Product

images
type: Property
domain: Brand

plateDefault
type: Property
domain: Brand
range: integer

platePerColor
type: Property
domain: Brand
range: integer

productionTime
type: Property
domain: Brand
range: string

setupDefault
type: Property
domain: Brand
range: integer

product
type: Property
domain: Brand

image
type: Property
domain: Brand

TierPrice
type: Class
title: TierPrice
supported property: SupportedProperty
  property: manufacturerPrice
  title: manufacturerPrice
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: priceWithOptions
  title: priceWithOptions
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: productVariant
  title: productVariant
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: price
  title: price
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: qty
  title: qty
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: channel
  title: channel
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: customerGroup
  title: customerGroup
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a TierPrice resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a TierPrice resource.
  returns: TierPrice
supported operation: Retrieves a TierPrice resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a TierPrice resource.
  returns: TierPrice
supported operation: Replaces the TierPrice resource.
  type: Operation
  type: ReplaceAction
  expects: TierPrice
  method: PUT
  title: Replaces the TierPrice resource.
  returns: TierPrice
supported operation: Deletes the TierPrice resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the TierPrice resource.
  returns: Nothing

manufacturerPrice
type: Property
domain: TierPrice
range: integer

priceWithOptions
type: Property
domain: TierPrice

productVariant
type: Link
domain: TierPrice
max cardinality: 1
range: ProductVariant

price
type: Property
domain: TierPrice
range: integer

qty
type: Property
domain: TierPrice
range: integer

channel
type: Link
domain: TierPrice
max cardinality: 1
range: Channel

customerGroup
type: Link
domain: TierPrice
max cardinality: 1
range: CustomerGroup

Entrypoint
type: Class
title: The API entrypoint
supported property: SupportedProperty
  property: The collection of Address resources
  title: The collection of Address resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Administrator resources
  title: The collection of Administrator resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of AvatarImage resources
  title: The collection of AvatarImage resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of CatalogPromotion resources
  title: The collection of CatalogPromotion resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Channel resources
  title: The collection of Channel resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Country resources
  title: The collection of Country resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Currency resources
  title: The collection of Currency resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Customer resources
  title: The collection of Customer resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of CustomerGroup resources
  title: The collection of CustomerGroup resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ExchangeRate resources
  title: The collection of ExchangeRate resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Locale resources
  title: The collection of Locale resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Order resources
  title: The collection of Order resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Payment resources
  title: The collection of Payment resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Product resources
  title: The collection of Product resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ProductAssociationType resources
  title: The collection of ProductAssociationType resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ProductImage resources
  title: The collection of ProductImage resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ProductOption resources
  title: The collection of ProductOption resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ProductOptionValue resources
  title: The collection of ProductOptionValue resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ProductReview resources
  title: The collection of ProductReview resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ProductTaxon resources
  title: The collection of ProductTaxon resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ProductVariant resources
  title: The collection of ProductVariant resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Promotion resources
  title: The collection of Promotion resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ResetPasswordRequest resources
  title: The collection of ResetPasswordRequest resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Shipment resources
  title: The collection of Shipment resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ShippingCategory resources
  title: The collection of ShippingCategory resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ShippingMethod resources
  title: The collection of ShippingMethod resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of TaxCategory resources
  title: The collection of TaxCategory resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Taxon resources
  title: The collection of Taxon resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of TaxonTranslation resources
  title: The collection of TaxonTranslation resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of VerifyCustomerAccount resources
  title: The collection of VerifyCustomerAccount resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Zone resources
  title: The collection of Zone resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Block resources
  title: The collection of Block resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of FrequentlyAskedQuestion resources
  title: The collection of FrequentlyAskedQuestion resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Media resources
  title: The collection of Media resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Page resources
  title: The collection of Page resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Section resources
  title: The collection of Section resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ProductFile resources
  title: The collection of ProductFile resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ProductLabel resources
  title: The collection of ProductLabel resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of SEOContent resources
  title: The collection of SEOContent resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of TaxonImage resources
  title: The collection of TaxonImage resources
  readable: true
  writeable: false
supported operation: The API entrypoint.

The collection of Address resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Address
supported operation: Retrieves the collection of Address resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Address resources.
  returns: Collection
supported operation: Creates a Address resource.
  type: Operation
  type: CreateAction
  expects: Address
  method: POST
  title: Creates a Address resource.
  returns: Address

The collection of Administrator resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Administrator
supported operation: Retrieves the collection of Administrator resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Administrator resources.
  returns: Collection
supported operation: Creates a Administrator resource.
  type: Operation
  type: CreateAction
  expects: Administrator
  method: POST
  title: Creates a Administrator resource.
  returns: Administrator

The collection of AvatarImage resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: AvatarImage
supported operation: Creates a AvatarImage resource.
  type: Operation
  type: CreateAction
  expects: AvatarImage
  method: POST
  title: Creates a AvatarImage resource.
  returns: AvatarImage

The collection of CatalogPromotion resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: CatalogPromotion
supported operation: Retrieves the collection of CatalogPromotion resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of CatalogPromotion resources.
  returns: Collection
supported operation: Creates a CatalogPromotion resource.
  type: Operation
  type: CreateAction
  expects: CatalogPromotion
  method: POST
  title: Creates a CatalogPromotion resource.
  returns: CatalogPromotion

The collection of Channel resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Channel
supported operation: Retrieves the collection of Channel resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Channel resources.
  returns: Collection
supported operation: Creates a Channel resource.
  type: Operation
  type: CreateAction
  expects: Channel
  method: POST
  title: Creates a Channel resource.
  returns: Channel

The collection of Country resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Country
supported operation: Retrieves the collection of Country resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Country resources.
  returns: Collection
supported operation: Retrieves the collection of Country resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Country resources.
  returns: Collection
supported operation: Creates a Country resource.
  type: Operation
  type: CreateAction
  expects: Country
  method: POST
  title: Creates a Country resource.
  returns: Country

The collection of Currency resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Currency
supported operation: Retrieves the collection of Currency resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Currency resources.
  returns: Collection
supported operation: Creates a Currency resource.
  type: Operation
  type: CreateAction
  expects: Currency
  method: POST
  title: Creates a Currency resource.
  returns: Currency
supported operation: Retrieves the collection of Currency resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Currency resources.
  returns: Collection

The collection of Customer resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Customer
supported operation: Creates a Customer resource.
  type: Operation
  type: CreateAction
  expects: Customer
  method: POST
  title: Creates a Customer resource.
  returns: Nothing

The collection of CustomerGroup resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: CustomerGroup
supported operation: Retrieves the collection of CustomerGroup resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of CustomerGroup resources.
  returns: Collection
supported operation: Creates a CustomerGroup resource.
  type: Operation
  type: CreateAction
  expects: CustomerGroup
  method: POST
  title: Creates a CustomerGroup resource.
  returns: CustomerGroup

The collection of ExchangeRate resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ExchangeRate
supported operation: Retrieves the collection of ExchangeRate resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ExchangeRate resources.
  returns: Collection
supported operation: Creates a ExchangeRate resource.
  type: Operation
  type: CreateAction
  expects: ExchangeRate
  method: POST
  title: Creates a ExchangeRate resource.
  returns: ExchangeRate

The collection of Locale resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Locale
supported operation: Retrieves the collection of Locale resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Locale resources.
  returns: Collection
supported operation: Creates a Locale resource.
  type: Operation
  type: CreateAction
  expects: Locale
  method: POST
  title: Creates a Locale resource.
  returns: Locale
supported operation: Retrieves the collection of Locale resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Locale resources.
  returns: Collection

The collection of Order resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Order
supported operation: Retrieves the collection of Order resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Order resources.
  returns: Collection
supported operation: Creates a Order resource.
  type: Operation
  type: CreateAction
  expects: Order
  method: POST
  title: Creates a Order resource.
  returns: Order
supported operation: Retrieves the collection of Order resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Order resources.
  returns: Collection

The collection of Payment resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Payment
supported operation: Retrieves the collection of Payment resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Payment resources.
  returns: Collection

The collection of Product resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Product
supported operation: Retrieves the collection of Product resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Product resources.
  returns: Collection
supported operation: Retrieves the collection of Product resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Product resources.
  returns: Collection
supported operation: Creates a Product resource.
  type: Operation
  type: CreateAction
  expects: Product
  method: POST
  title: Creates a Product resource.
  returns: Product
supported operation: Retrieves the collection of Product resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Product resources.
  returns: Collection

The collection of ProductAssociationType resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ProductAssociationType
supported operation: Retrieves the collection of ProductAssociationType resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProductAssociationType resources.
  returns: Collection
supported operation: Creates a ProductAssociationType resource.
  type: Operation
  type: CreateAction
  expects: ProductAssociationType
  method: POST
  title: Creates a ProductAssociationType resource.
  returns: ProductAssociationType

The collection of ProductImage resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ProductImage
supported operation: Retrieves the collection of ProductImage resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProductImage resources.
  returns: Collection

The collection of ProductOption resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ProductOption
supported operation: Retrieves the collection of ProductOption resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProductOption resources.
  returns: Collection
supported operation: Retrieves the collection of ProductOption resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProductOption resources.
  returns: Collection
supported operation: Creates a ProductOption resource.
  type: Operation
  type: CreateAction
  expects: ProductOption
  method: POST
  title: Creates a ProductOption resource.
  returns: ProductOption

The collection of ProductOptionValue resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ProductOptionValue
supported operation: Retrieves the collection of ProductOptionValue resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProductOptionValue resources.
  returns: Collection

The collection of ProductReview resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ProductReview
supported operation: Retrieves the collection of ProductReview resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProductReview resources.
  returns: Collection
supported operation: Creates a ProductReview resource.
  type: Operation
  type: CreateAction
  expects: ProductReview
  method: POST
  title: Creates a ProductReview resource.
  returns: ProductReview
supported operation: Retrieves the collection of ProductReview resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProductReview resources.
  returns: Collection

The collection of ProductTaxon resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ProductTaxon
supported operation: Retrieves the collection of ProductTaxon resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProductTaxon resources.
  returns: Collection

The collection of ProductVariant resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ProductVariant
supported operation: Retrieves the collection of ProductVariant resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProductVariant resources.
  returns: Collection
supported operation: Creates a ProductVariant resource.
  type: Operation
  type: CreateAction
  expects: ProductVariant
  method: POST
  title: Creates a ProductVariant resource.
  returns: ProductVariant
supported operation: Retrieves the collection of ProductVariant resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProductVariant resources.
  returns: Collection

The collection of Promotion resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Promotion
supported operation: Creates a Promotion resource.
  type: Operation
  type: CreateAction
  expects: Promotion
  method: POST
  title: Creates a Promotion resource.
  returns: Promotion
supported operation: Retrieves the collection of Promotion resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Promotion resources.
  returns: Collection

The collection of ResetPasswordRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ResetPasswordRequest
supported operation: Creates a ResetPasswordRequest resource.
  type: Operation
  type: CreateAction
  expects: ResetPasswordRequest
  method: POST
  title: Creates a ResetPasswordRequest resource.
  returns: Nothing

The collection of Shipment resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Shipment
supported operation: Retrieves the collection of Shipment resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Shipment resources.
  returns: Collection

The collection of ShippingCategory resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ShippingCategory
supported operation: Retrieves the collection of ShippingCategory resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ShippingCategory resources.
  returns: Collection
supported operation: Creates a ShippingCategory resource.
  type: Operation
  type: CreateAction
  expects: ShippingCategory
  method: POST
  title: Creates a ShippingCategory resource.
  returns: ShippingCategory

The collection of ShippingMethod resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ShippingMethod
supported operation: Retrieves the collection of ShippingMethod resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ShippingMethod resources.
  returns: Collection
supported operation: Creates a ShippingMethod resource.
  type: Operation
  type: CreateAction
  expects: ShippingMethod
  method: POST
  title: Creates a ShippingMethod resource.
  returns: ShippingMethod

The collection of TaxCategory resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: TaxCategory
supported operation: Retrieves the collection of TaxCategory resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TaxCategory resources.
  returns: Collection
supported operation: Creates a TaxCategory resource.
  type: Operation
  type: CreateAction
  expects: TaxCategory
  method: POST
  title: Creates a TaxCategory resource.
  returns: TaxCategory

The collection of Taxon resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Taxon
supported operation: Retrieves the collection of Taxon resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Taxon resources.
  returns: Collection
supported operation: Creates a Taxon resource.
  type: Operation
  type: CreateAction
  expects: Taxon
  method: POST
  title: Creates a Taxon resource.
  returns: Taxon
supported operation: Retrieves the collection of Taxon resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Taxon resources.
  returns: Collection
supported operation: Retrieves the collection of Taxon resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Taxon resources.
  returns: Collection

The collection of TaxonTranslation resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: TaxonTranslation
supported operation: Retrieves the collection of TaxonTranslation resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TaxonTranslation resources.
  returns: Collection

The collection of VerifyCustomerAccount resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: VerifyCustomerAccount
supported operation: Creates a VerifyCustomerAccount resource.
  type: Operation
  type: CreateAction
  expects: VerifyCustomerAccount
  method: POST
  title: Creates a VerifyCustomerAccount resource.
  returns: Nothing

The collection of Zone resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Zone
supported operation: Retrieves the collection of Zone resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Zone resources.
  returns: Collection
supported operation: Creates a Zone resource.
  type: Operation
  type: CreateAction
  expects: Zone
  method: POST
  title: Creates a Zone resource.
  returns: Zone

The collection of Block resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Block
supported operation: Retrieves the collection of Block resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Block resources.
  returns: Collection

The collection of FrequentlyAskedQuestion resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: FrequentlyAskedQuestion
supported operation: Retrieves the collection of FrequentlyAskedQuestion resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of FrequentlyAskedQuestion resources.
  returns: Collection

The collection of Media resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Media
supported operation: Retrieves the collection of Media resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Media resources.
  returns: Collection

The collection of Page resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Page
supported operation: Retrieves the collection of Page resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Page resources.
  returns: Collection

The collection of Section resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Section
supported operation: Retrieves the collection of Section resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Section resources.
  returns: Collection

The collection of ProductFile resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ProductFile
supported operation: Retrieves the collection of ProductFile resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProductFile resources.
  returns: Collection

The collection of ProductLabel resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ProductLabel
supported operation: Retrieves the collection of ProductLabel resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProductLabel resources.
  returns: Collection
supported operation: Retrieves the collection of ProductLabel resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProductLabel resources.
  returns: Collection
supported operation: Creates a ProductLabel resource.
  type: Operation
  type: CreateAction
  expects: ProductLabel
  method: POST
  title: Creates a ProductLabel resource.
  returns: ProductLabel

The collection of SEOContent resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: SEOContent
supported operation: Retrieves the collection of SEOContent resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of SEOContent resources.
  returns: Collection
supported operation: Creates a SEOContent resource.
  type: Operation
  type: CreateAction
  expects: SEOContent
  method: POST
  title: Creates a SEOContent resource.
  returns: SEOContent

The collection of TaxonImage resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: TaxonImage
supported operation: Retrieves the collection of TaxonImage resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TaxonImage resources.
  returns: Collection

The collection of Brand resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Brand
supported operation: Retrieves the collection of Brand resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Brand resources.
  returns: Collection
supported operation: Retrieves the collection of Brand resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Brand resources.
  returns: Collection
supported operation: Creates a Brand resource.
  type: Operation
  type: CreateAction
  expects: Brand
  method: POST
  title: Creates a Brand resource.
  returns: Brand

The collection of TierPrice resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: TierPrice
supported operation: Retrieves the collection of TierPrice resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TierPrice resources.
  returns: Collection
supported operation: Creates a TierPrice resource.
  type: Operation
  type: CreateAction
  expects: TierPrice
  method: POST
  title: Creates a TierPrice resource.
  returns: TierPrice

ConstraintViolation
type: Class
title: A constraint violation
supported property: SupportedProperty
  property: propertyPath
  title: propertyPath
  description: The property path of the violation
  readable: true
  writeable: false
supported property: SupportedProperty
  property: message
  title: message
  description: The message associated with the violation
  readable: true
  writeable: false

propertyPath
type: Property
domain: ConstraintViolation
range: string

message
type: Property
domain: ConstraintViolation
range: string

ConstraintViolationList
type: Class
subclass of: Error
title: A constraint violation list
supported property: SupportedProperty
  property: violations
  title: violations
  description: The violations
  readable: true
  writeable: false

violations
type: Property
domain: ConstraintViolationList
range: ConstraintViolation

SupportedProperty
property: oAuthAccounts
title: oAuthAccounts
required: false
readable: true
writeable: true

SupportedProperty
property: expired
title: expired
required: false
readable: false
writeable: false

Retrieves a Administrator resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a Administrator resource.
returns: Administrator

Replaces the Administrator resource.
type: Operation
type: ReplaceAction
expects: Administrator
method: PUT
title: Replaces the Administrator resource.
returns: Administrator

Deletes the Administrator resource.
type: Operation
type: DeleteAction
method: DELETE
title: Deletes the Administrator resource.
returns: Nothing

SupportedProperty
property: openGraphMetadataDescription
title: openGraphMetadataDescription
required: false
readable: true
writeable: false

SupportedProperty
property: openGraphMetadataUrl
title: openGraphMetadataUrl
required: false
readable: true
writeable: false

SupportedProperty
property: openGraphMetadataType
title: openGraphMetadataType
required: false
readable: true
writeable: false

SupportedProperty
property: openGraphMetadataImage
title: openGraphMetadataImage
required: false
readable: true
writeable: false

SupportedProperty
property: currency
title: currency
required: false
readable: false
writeable: true

SupportedProperty
property: locale
title: locale
required: false
readable: false
writeable: true

SupportedProperty
property: country
title: country
required: false
readable: false
writeable: true

Retrieves a Channel resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a Channel resource.
returns: Channel

Retrieves a Channel resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a Channel resource.
returns: Channel

SupportedProperty
property: itemUnits
title: itemUnits
required: false
readable: true
writeable: false

SupportedProperty
property: payment
title: payment
required: false
readable: false
writeable: true

SupportedProperty
property: lastPayment
title: lastPayment
required: false
readable: true
writeable: false

SupportedProperty
property: shippingRequired
title: shippingRequired
required: false
readable: true
writeable: false

SupportedProperty
property: shipment
title: shipment
required: false
readable: false
writeable: true

SupportedProperty
property: promotionSubjectTotal
title: promotionSubjectTotal
required: false
readable: true
writeable: false

SupportedProperty
property: promotionSubjectCount
title: promotionSubjectCount
required: false
readable: true
writeable: false

SupportedProperty
property: promotion
title: promotion
required: false
readable: false
writeable: true

SupportedProperty
property: taxTotal
title: taxTotal
required: false
readable: true
writeable: false

SupportedProperty
property: shippingTotal
title: shippingTotal
required: false
readable: true
writeable: false

SupportedProperty
property: orderPromotionTotal
title: orderPromotionTotal
required: false
readable: true
writeable: false

SupportedProperty
property: nonDiscountedItemsTotal
title: nonDiscountedItemsTotal
required: false
readable: true
writeable: false

SupportedProperty
property: checkoutCompleted
title: checkoutCompleted
required: false
readable: true
writeable: false

SupportedProperty
property: item
title: item
required: false
readable: false
writeable: true

SupportedProperty
property: totalQuantity
title: totalQuantity
required: false
readable: true
writeable: false

SupportedProperty
property: empty
title: empty
required: false
readable: true
writeable: false

SupportedProperty
property: adjustmentsRecursively
title: adjustmentsRecursively
required: false
readable: true
writeable: true

SupportedProperty
property: adjustment
title: adjustment
required: false
readable: false
writeable: true

SupportedProperty
property: adjustmentsTotalRecursively
title: adjustmentsTotalRecursively
required: false
readable: true
writeable: false

SupportedProperty
property: tokenValue
title: tokenValue
required: false
readable: true
writeable: true

SupportedProperty
property: localeCode
title: localeCode
required: false
readable: true
writeable: true

SupportedProperty
property: channelCode
title: channelCode
required: false
readable: true
writeable: true

SupportedProperty
property: email
title: email
required: false
readable: true
writeable: true

Retrieves a Order resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a Order resource.
returns: Order

Retrieves a Order resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a Order resource.
returns: Order

Deletes the Order resource.
type: Operation
type: DeleteAction
method: DELETE
title: Deletes the Order resource.
returns: Nothing

Updates the Order resource.
type: Operation
expects: Nothing
method: PATCH
title: Updates the Order resource.
returns: Order

Creates a Order resource.
type: Operation
type: CreateAction
expects: Order
method: POST
title: Creates a Order resource.
returns: Order

Updates the Order resource.
type: Operation
expects: Order
method: PATCH
title: Updates the Order resource.
returns: Order

Updates the Order resource.
type: Operation
expects: Order
method: PATCH
title: Updates the Order resource.
returns: Order

Updates the Order resource.
type: Operation
expects: Order
method: PATCH
title: Updates the Order resource.
returns: Order

Retrieves a Order resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a Order resource.
returns: Order

Updates the Order resource.
type: Operation
expects: Order
method: PATCH
title: Updates the Order resource.
returns: Order

Deletes the Order resource.
type: Operation
type: DeleteAction
method: DELETE
title: Deletes the Order resource.
returns: Nothing

Updates the Order resource.
type: Operation
expects: Order
method: PATCH
title: Updates the Order resource.
returns: Order

Replaces the Order resource.
type: Operation
type: ReplaceAction
expects: Order
method: PUT
title: Replaces the Order resource.
returns: Order

SupportedProperty
property: SEOMpn
title: SEOMpn
required: false
readable: true
writeable: true

SupportedProperty
property: SEOIsbn
title: SEOIsbn
required: false
readable: true
writeable: true

SupportedProperty
property: SEOSku
title: SEOSku
required: false
readable: true
writeable: true

SupportedProperty
property: SEOOfferAggregated
title: SEOOfferAggregated
required: false
readable: false
writeable: false

SupportedProperty
property: brand
title: brand
required: false
readable: true
writeable: true

SupportedProperty
property: labels
title: labels
required: false
readable: true
writeable: true

SupportedProperty
property: callouts
title: callouts
required: false
readable: true
writeable: true

SupportedProperty
property: metadataTitle
title: metadataTitle
required: false
readable: true
writeable: false

SupportedProperty
property: metadataDescription
title: metadataDescription
required: false
readable: true
writeable: false

SupportedProperty
property: openGraphMetadataImage
title: openGraphMetadataImage
required: false
readable: true
writeable: false

SupportedProperty
property: richSnippetSubjectParent
title: richSnippetSubjectParent
required: false
readable: true
writeable: false

SupportedProperty
property: richSnippetSubjectType
title: richSnippetSubjectType
required: false
readable: true
writeable: false

SupportedProperty
property: firstVariant
title: firstVariant
required: false
readable: true
writeable: false

SupportedProperty
property: mainImage
title: mainImage
required: false
readable: true
writeable: false

SupportedProperty
property: enabledVariantsWith1Option
title: enabledVariantsWith1Option
required: false
readable: true
writeable: false

SupportedProperty
property: enabledVariants
title: enabledVariants
required: false
readable: true
writeable: false

SupportedProperty
property: notIndexable
title: notIndexable
required: false
readable: true
writeable: false

SupportedProperty
property: baseMetadataTitle
title: baseMetadataTitle
required: false
readable: true
writeable: false

SupportedProperty
property: baseMetadataDescription
title: baseMetadataDescription
required: false
readable: true
writeable: false

SupportedProperty
property: openGraphMetadataTitle
title: openGraphMetadataTitle
required: false
readable: true
writeable: false

SupportedProperty
property: openGraphMetadataDescription
title: openGraphMetadataDescription
required: false
readable: true
writeable: false

SupportedProperty
property: openGraphMetadataUrl
title: openGraphMetadataUrl
required: false
readable: true
writeable: false

SupportedProperty
property: openGraphMetadataType
title: openGraphMetadataType
required: false
readable: true
writeable: false

SupportedProperty
property: baseOpenGraphMetadataImage
title: baseOpenGraphMetadataImage
required: false
readable: true
writeable: false

SupportedProperty
property: sEOBrand
title: sEOBrand
required: false
readable: true
writeable: true

SupportedProperty
property: sEOGtin8
title: sEOGtin8
required: false
readable: true
writeable: true

SupportedProperty
property: sEOGtin13
title: sEOGtin13
required: false
readable: true
writeable: true

SupportedProperty
property: sEOGtin14
title: sEOGtin14
required: false
readable: true
writeable: true

SupportedProperty
property: sEOMpn
title: sEOMpn
required: false
readable: true
writeable: true

SupportedProperty
property: sEOIsbn
title: sEOIsbn
required: false
readable: true
writeable: true

SupportedProperty
property: sEOSku
title: sEOSku
required: false
readable: true
writeable: true

SupportedProperty
property: label
title: label
required: false
readable: false
writeable: true

SupportedProperty
property: callout
title: callout
required: false
readable: false
writeable: true

SupportedProperty
property: file
title: file
required: false
readable: false
writeable: true

SupportedProperty
property: name
title: name
required: false
readable: true
writeable: true

SupportedProperty
property: description
title: description
required: false
readable: true
writeable: true

SupportedProperty
property: slug
title: slug
required: false
readable: true
writeable: true

SupportedProperty
property: shortDescription
title: shortDescription
required: false
readable: true
writeable: true

SupportedProperty
property: variantSelectionMethodChoice
title: variantSelectionMethodChoice
required: false
readable: true
writeable: false

SupportedProperty
property: variantSelectionMethodLabel
title: variantSelectionMethodLabel
required: false
readable: true
writeable: false

SupportedProperty
property: productTaxon
title: productTaxon
required: false
readable: false
writeable: true

SupportedProperty
property: taxons
title: taxons
required: false
readable: true
writeable: false

SupportedProperty
property: taxon
title: taxon
required: false
readable: false
writeable: false

SupportedProperty
property: channel
title: channel
required: false
readable: false
writeable: true

SupportedProperty
property: acceptedReviews
title: acceptedReviews
required: false
readable: true
writeable: false

SupportedProperty
property: image
title: image
required: false
readable: false
writeable: true

SupportedProperty
property: variantSelectionMethodLabels
title: variantSelectionMethodLabels
required: false
readable: true
writeable: false

SupportedProperty
property: translation
title: translation
required: false
readable: true
writeable: true

SupportedProperty
property: metaKeywords
title: metaKeywords
required: false
readable: true
writeable: true

SupportedProperty
property: metaDescription
title: metaDescription
required: false
readable: true
writeable: true

SupportedProperty
property: attribute
title: attribute
required: false
readable: false
writeable: true

SupportedProperty
property: attributeByCodeAndLocale
title: attributeByCodeAndLocale
required: false
readable: false
writeable: false

SupportedProperty
property: variant
title: variant
required: false
readable: false
writeable: true

SupportedProperty
property: option
title: option
required: false
readable: false
writeable: true

SupportedProperty
property: association
title: association
required: false
readable: false
writeable: true

SupportedProperty
property: simple
title: simple
required: false
readable: true
writeable: false

SupportedProperty
property: configurable
title: configurable
required: false
readable: true
writeable: false

SupportedProperty
property: notEmptyAttributeByCodeAndLocale
title: notEmptyAttributeByCodeAndLocale
required: false
readable: false
writeable: false

Retrieves a Product resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a Product resource.
returns: Product

Retrieves a Product resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a Product resource.
returns: Product

Retrieves a Product resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a Product resource.
returns: Product

Replaces the Product resource.
type: Operation
type: ReplaceAction
expects: Product
method: PUT
title: Replaces the Product resource.
returns: Product

Deletes the Product resource.
type: Operation
type: DeleteAction
method: DELETE
title: Deletes the Product resource.
returns: Nothing

Retrieves a Product resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a Product resource.
returns: Product

SupportedProperty
property: inStock
title: inStock
required: false
readable: true
writeable: false

SupportedProperty
property: inventoryName
title: inventoryName
required: false
readable: true
writeable: false

SupportedProperty
property: shippingWeight
title: shippingWeight
required: false
readable: true
writeable: false

SupportedProperty
property: shippingWidth
title: shippingWidth
required: false
readable: true
writeable: false

SupportedProperty
property: shippingHeight
title: shippingHeight
required: false
readable: true
writeable: false

SupportedProperty
property: shippingDepth
title: shippingDepth
required: false
readable: true
writeable: false

SupportedProperty
property: shippingVolume
title: shippingVolume
required: false
readable: true
writeable: false

SupportedProperty
property: channelPricingForChannel
title: channelPricingForChannel
required: false
readable: false
writeable: false

SupportedProperty
property: channelPricing
title: channelPricing
required: false
readable: false
writeable: true

SupportedProperty
property: image
title: image
required: false
readable: false
writeable: true

SupportedProperty
property: name
title: name
required: false
readable: true
writeable: true

SupportedProperty
property: descriptor
title: descriptor
required: false
readable: true
writeable: false

SupportedProperty
property: optionValue
title: optionValue
required: false
readable: false
writeable: true

SupportedProperty
property: translation
title: translation
required: false
readable: true
writeable: true

Retrieves a ProductVariant resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a ProductVariant resource.
returns: ProductVariant

Replaces the ProductVariant resource.
type: Operation
type: ReplaceAction
expects: ProductVariant
method: PUT
title: Replaces the ProductVariant resource.
returns: ProductVariant

Retrieves a ProductVariant resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a ProductVariant resource.
returns: ProductVariant

Deletes the ProductVariant resource.
type: Operation
type: DeleteAction
method: DELETE
title: Deletes the ProductVariant resource.
returns: Nothing

Retrieves a Taxon resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a Taxon resource.
returns: Taxon

Replaces the Taxon resource.
type: Operation
type: ReplaceAction
expects: Taxon
method: PUT
title: Replaces the Taxon resource.
returns: Taxon

Retrieves a Taxon resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a Taxon resource.
returns: Taxon

Deletes the Taxon resource.
type: Operation
type: DeleteAction
method: DELETE
title: Deletes the Taxon resource.
returns: Nothing

SupportedProperty
property: The collection of Brand resources
title: The collection of Brand resources
readable: true
writeable: false

SupportedProperty
property: The collection of TierPrice resources
title: The collection of TierPrice resources
readable: true
writeable: false

The API entrypoint.
type: Operation
method: GET
returns: EntryPoint