Item – actions

This article helps you understand the API behaviour in enabling/disabling the items, options of a given location on ordering platform.

Written By Ops UrbanPiper (Collaborator)

Updated at June 16th, 2020

API Document Reference - https://api-ordering-docs.urbanpiper.com/#item-actions


  1. What is the purpose of this API?
    - This API is used to enable/disable the items & options of a particular location on the ordering platform.

  2. When this API should be called?
    - This API should be called when a particular outlet of a brand is taken live on integration in the production environment.

  3. Is it possible to perform "action" for the items/options of multiple locations in one API call?
    - No. The API uses location-wise product enable/disable action.

  4. Is it possible to perform "action" platform-wise?
    - No. The API request will perform "action" across all the ordering platforms the products are available.

  5. Is it possible to perform "action" only to options/variants?
    - By passing the POS options/variants ids under the attributes "item_ref_ids[]", it is possible to perform "action" for options/variants. In case, where there is a scenario that exists to have the same POS "ref_id"s clash between items and options,  it is advised to use "option_ref_ids[]" to perform "action" to only options. Thus, the POS "ref_id" that exists for items won't be fallen under the "action" you perform specific to options/variants.

  6. What is the throttle limit for this API?
    - A throttle limit is applicable to this endpoint limiting the maximum number of requests/min to 50. If you breach this threshold, the platform will respond with a 429 error response code and you will not be able to make new requests for a duration of 1 min.

  7. Can the bulk payload for "item_ref_ids/option_ref_ids" be expected?
    - Yes.

  8. How many items/options can be sent under "item_ref_ids"/"option_ref_ids" in single API call?
    - 200

  9. How to configure the "callback_url" for this API?
    • POS partners can configure the "callback_url" in the Quint dashboard under Configuration>Webhooks choosing event type as Item Stock In/Out from the dropdown.
    • Or, use the Webhooks API to configure the webhook endpoints in Quint Dashboard by specifying the event - item_state_toggle mentioned in the API documentation.
    • Note: For more info - https://api-ordering-docs.urbanpiper.com/#item-actions-callback

  10. Is it expected not to receive a "callback" for this API in staging?
    - Yes. The callbacks will be triggered only in the production where the aggregator platforms are enabled.

  11. What all the possible actions available?
    • enable - to enable a set of items/options.
    • disable - to disable a set of items/options.
    • enable_all - to enable all the items/options.
    • disable_all - to disable all the items/options.

Was this article helpful?