FAQ#

Jump to the specific topic:

• What is the significance of the Quantity field?
• How to use max_sales_quantity?
• How frequently can vendors push assortment API updates?
• How can vendors check the status of the API updates?
• How much time is required for product updates to be reflected on the frontend?
• How many SKUs can PUT /catalog accommodate in a single request?
• How do I generate credentials to use Partner API/Catalog?
• How do I access the Shops Integrations Plugin?

What is the significance of the Quantity field?#

We don’t store the quantity field; it acts as a reference in comparison with the already configured sales buffer in the catalog. It is used for the deactivation of products when the quantity is less than the sales buffer.

Eg. if you send quantity as 3 & sales buffer is configured as 5, the product will be deactivated on the front end i.e quantity < sale_buffer

The use case to deactivate products based on quantity is not valid on a single product update.

Please update multiple SKUs to achieve the deactivation based on quantity.

How to use max_sales_quantity?#

Max sales quantity is configured at item level via API, it will limit the number of items a customer can place in an order. I.e if the max sales quantity for the Milk product is set to 5, the customer can place up to 5 quantities of Milk in an order.

How frequently can vendors push assortment API updates?#

The decision regarding frequency of updating stock lies with the vendor. On our end, it's important to note that Cloudflare will block an IP address if the number of requests exceeds 60 per minute. We suggest to use bulk endpoint updates if they want to update multiple products as it provides visibility to vendors on downloading logs from the configured webhook

How can vendors check the status of the API updates?#

In the Partner Portal shops integration plugin, vendors can get an overview of jobs, any error with respect to SKU will be listed there, if SKU is not found please review the request body for SKUs available on catalog. Assortment API is used for updating the existing products in catalog not for creating new products. If the vendor configures the webhook, they can receive the status of updates at SKU level.

How much time is required for product updates to be reflected on the frontend?#

It takes up to 30 minutes to reflect the changes on the front end. However, this time might vary depending on pending job queues with Catalog service.

How many SKUs can PUT /catalog accommodate in a single request?#

We don’t have estimates on the number of SKUs, our services can consume data up to 100MB which is a fairly large assortment size for a single store.

How do I generate credentials to use Partner API/Catalog?#

Please see the token management section here

How do I access the Shops Integrations Plugin?#

1. All current Shops partners of any size can access the Shops Integrations plugin in Partner Portal, you will be given access by your account manager or during registration with us.
2. It is advised to limit the access to Shops plugins in Partner Portal to only those who need to perform a function for your business - this is because Partner Portal can contain sensitive information i.e webhook configurations
3. Please reach out to your account manager if you do not know how to gain access to Partner Portal