Skip to content

ProductAvailability

The Availability object represents a product availability status.

classDiagram
  direction LR
  ProductAvailability --> Url
  ProductAvailability --> VisibilityConfig
  class Url{
  }
  class ProductAvailability{
    int id
    string name
    bool isAvailable
    bool isNotificationEnabled
    Url imageUrl
    VisibilityConfig visibilityConfig
  }

Properties

Attribute name Type Description
id int The unique identifier of the product's availability.
name string The name of the product's availability.
isAvailable bool Returns true if customer can buy the product with given availability
isNotificationEnabled bool Returns true if product availability notification form is enabled for given availability.
imageUrl Url The Url object of the availability image.
visibilityConfig VisibilityConfig The VisibilityConfig object represents visibility configuration when purchasing the product is impossible.

Examples

id property

{{ productAvailability.id }}
1

name property

{{ productAvailability.name }}
In stock

isAvailable property

{{ productAvailability.isAvailable }}
true

isNotificationEnabled property

{{ productAvailability.isNotificationEnabled }}
true

imageUrl property

{{ productAvailability.imageUrl }}
/link/to/availability/image

visibilityConfig property

{{ productAvailability.visibilityConfig.isProductPageGalleryAndNameGrey }}
true