Skip to main content

availability

Required Field

This field is required and must not be omitted

Description​

Use the availability attribute to display your stock status.

Effects When Used​

  • Enables us to indicate if a customer can order the product

Allowed Enum Values​

download

When the product is made digitally available, eg. game or software downloads

in_stock

You're currently accepting orders for this product and can fulfill the purchase request directly.

out_of_stock

You're not currently accepting orders for this product.

preorder

You're currently taking orders for this product, but it's not yet been released for sale. You're required to provide the availability date availability_date attribute to indicate the day that the product becomes available for delivery.

backorder

The product is not available at the moment, but you're accepting orders and it'll be shipped as soon as it becomes available again. This status can be combined with the availability date availability_date attribute to indicate the day that the product becomes available for delivery.

Validation Rules​

  • Value must be one of the allowed enum values

Best Practices​

Do​

  • Use up-to-date stock info

Don´t​

  • Don't use out of stock when the shop is temporarily down
  • Don't use out of stock when you want to remove the product from the listing
  • Don't use out of stock for products that are discontinued

Example Values​

Here are examples of how a valid availability value should look like in XML and CSV (with header) respectively.

Valid Value
<g:availability>download</g:availability>
Click to show more valid XML examples
<g:availability>download</g:availability>
<g:availability>in_stock</g:availability>
<g:availability>out_of_stock</g:availability>
<g:availability>preorder</g:availability>
<g:availability_date>2021-03-21</g:availability_date>
<g:availability>backorder</g:availability>
<g:availability_date>2021-03-21</g:availability_date>

Error Codes​

Below you will find possible error codes generated when validating this field alongside with an example in XML and CSV that would trigger the code. Please refer to the validation rules to understand the cause.

validation_invalid_enum
<g:availability>unknown</g:availability>
validation_missing_value
<g:availability></g:availability>

Properties​

PropertyValueDescription
Data TypeenumClosest data type in code
NestedFalseDefines if this field consists of one or more sub-fields
Case SensitiveFalseIf small or large letters matter for this field
RepeatableFalseIf you can supply multiple items of this field (it´s a list)
Repeatable limit0If a list, this specifices the max number of items

Changelog​

📅 2024-05-14

Removed

Enum value not_available_for_purchase is no longer supported. Please use out_of_stock instead.

📅 2023-09-14

Deprecated

Enum value backorder does not require availability_date to be set anymore.

📅 2023-03-20

Deprecated

Enum value download is now deprecated and should not be used anymore. Download is a delivery option and should be specified using the shipping field.

📅 2023-03-17

Deprecated

Enum value pickup has been removed and should not be used anymore. Using pickup value would result in validation error. Pickup is a delivery option and should be specified using the shipping field.

📅 2023-03-13

Changed

Offers with value out_of_stock are no longer orderable. See deprecation notice below.

Deprecated

Value not_available_for_purchase should no longer be used, please use out_of_stock instead

📅 2023-01-05

Deprecated

Enum value pickup is now deprecated and should not be used anymore. Pickup is a delivery option and should be specified using the shipping field.

📅 2022-12-20

Deprecated

Previously out_of_stock values were still orderable, from now on out_of_stock will not be orderable. If you want to represent a product that is not in stock but still orderable you should use backorder and set availability_date

📅 2022-12-08

Added

New enum value backorder, this value should be used for products that are orderable but currently not in stock.

📅 2022-12-07

Added

Initial definition

References​