Availability Tutorial

How to specify availability, popularity, or stock level for a product

This tutorial describes how to specify availability, popularity, and stock level for a single product.

Information about a specific product's availability, popularity, and stock levels is stored inside the Availability object.

Take a look at the relationships between the Availability object and other resources in the Emporix Commerce Engine:

Before you start

Make sure you created a product. For more information, check out How to add your first product.

Create the Availability object

We recommend not to create a new product availability for a main sitecode. A site named main works as an aggregator of availability data from other sites. It's not possible to later retrieve availability for a single site when it's called main. Use a different sitecode for creating product availabilities.

To add availability-related information for a specific product, you need to send a request to the Creating a new availability for a product endpoint.

To test the endpoint, open the API reference or check the example of a curl request.

API Reference

curl -i -X POST \
  'https://api.emporix.io/availability/{tenant}/availability/{productId}/{site}' \
  -H 'Authorization: Bearer {{OAUTH2_ACCESS_TOKEN}}' \
  -H 'Content-Type: application/json' \
  -d '{
    "stockLevel": 10,
    "available": true,
    "popularity": 5,
    "distributionChannel": "ASSORTMENT",
    "metadata": {
      "mixins": {
        "productCustomAttributes": "https://res.cloudinary.com/saas-ag/raw/upload/schemata/productCustomAttributesMixIn.v29.json"
      }
    },
    "mixins": {
      "productCustomAttributes": {
        "minOrderQuantity": 2
      }
    }
  }'

Manage product availabilities in bulk

You can also manage multiple availabilities for a product at once. A single product can have different availabilities per site, so each availability entry is identified by the combination of productId and site.

To create or update multiple product availabilities at once, send a request to one of the following endpoints:

• Creating multiple product availabilities
• Upserting multiple availabilities information of a product

Example bulk request:

curl -i -X POST \
  'https://api.emporix.io/availability/{tenant}/availability/bulk' \
  -H 'Authorization: Bearer {{OAUTH2_ACCESS_TOKEN}}' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "productId": "PRODUCT-1",
      "site": "site-a",
      "stockLevel": 10,
      "available": true
    },
    {
      "productId": "PRODUCT-1",
      "site": "site-b",
      "stockLevel": 0,
      "available": false
    }
  ]'

In this example, the same product has different availability on two sites: site-a and site-b where both records are created in a single bulk operation.

Retrieve the availability information of a product

To check if a product's availability was added successfully, you need to send a request to the Retrieving a product's availability endpoint with the product's ID in the request body.

You can also retrieve availability information for multiple products at once by sending a request to the Retrieving product availabilities for a site endpoint.

To test the endpoint, open the API reference or check the example of a curl request.

API Reference

curl -i -X GET \
  'https://api.emporix.io/availability/{tenant}/availability/{productId}/{site}' \
  -H 'Authorization: Bearer {{OAUTH2_ACCESS_TOKEN}}'

How to calculate a product bundle's stock level

The Availability Service makes it possible to automatically calculate the stock level of a product bundle. The value is always equal to the lowest stock level of the bundled products.

For a product bundle's availability to be calculated, all products in the bundle need to have their availability and stock levels specified. Otherwise, the bundle will be treated as unavailable.

Before you start

Make sure the following requirements are fulfilled:

• You have already created all products that make up the bundle.

For instructions, check out How to add your first product.

• You have already specified stock levels for all products that make up the bundle.

For instructions, check out How to specify availability, popularity, or stock level for a product.

• You have already created a product bundle.

For instructions, check out How to create a bundle of personalized products.

Retrieve the product bundle's availability information

To find out what the stock level of a product bundle is, you need to send a request to the Retrieving a product's availability endpoint with the product bundle's ID in the path.

To test the endpoint, open the API reference or check the example of a curl request.

API Reference

curl -i -X GET \
  'https://api.emporix.io/availability/{tenant}/availability/{productId}/{site}' \
  -H 'Authorization: Bearer {{OAUTH2_ACCESS_TOKEN}}'

The response includes both the availability information of the bundle as a whole, as well as the bundled products.