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. Please note that the values of this field (which is for the local shop offer) differs from availability on the high level offer.

Effects When Used​

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

Allowed Enum Values​

in_stock

You have more than 3 items or more available in your local inventory.

out_of_stock

Items with 0 in quantity

limited_availability

You have two or less items in your local inventory.

on_display_to_order

Items that are displayed in-shop, but not immediately available for purchase: Such as large furniture items, or different sizes and colors of a display model.

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 SensitiveTrueIf 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​

📅 2025-02-24

Added

Initial definition

References​