availability
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
Related Fields
Allowed Enum Values
download
in_stock
out_of_stock
preorder
backorder
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.
- XML
- CSV
<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>
availability
download
Click to show more valid CSV examples
availability
download
availability
in_stock
availability
out_of_stock
availability,availability_date
preorder,2021-03-21
availability,availability_date
backorder,2021-03-21
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.
- XML
- CSV
<g:availability>unknown</g:availability>
<g:availability></g:availability>
Properties
| Property | Value | Description |
|---|---|---|
| Data Type | enum | Closest data type in code |
| Nested | False | Defines if this field consists of one or more sub-fields |
| Case Sensitive | False | If small or large letters matter for this field |
| Repeatable | False | If you can supply multiple items of this field (it´s a list) |
| Repeatable limit | 0 | If a list, this specifices the max number of items |
Changelog
📅 2023-09-14
Enum value backorder does not require availability_date to be set anymore.
📅 2023-03-20
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
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
Offers with value out_of_stock are no longer orderable. See deprecation notice below.
Value not_available_for_purchase should no longer be used, please use out_of_stock instead
📅 2023-01-05
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
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
New enum value backorder, this value should be used for products that are orderable but currently not in stock.
📅 2022-12-07
Initial definition