Store – actions

This article helps you understand the API behaviour in enabling/disabling the outlet/store of a given brand on ordering platform.

Written By Ops UrbanPiper (Collaborator)

Updated at May 3rd, 2021

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


  1. What is the purpose of this API?
    - This API is used to enable/disable the store/outlet on the ordering platform. In production, for aggregators, this API to be used once the outlet mapping is done with the requested aggregators.

    Note: Don't make an API call when the platform is not yet integrated with the given outlet.

  2. Is it possible to disable the multiple stores at a time in a single API call?
    - No. This API uses a location-wise request. Based on the value passed under the attribute - "location_ref_id", the request will be made to that specific store.

  3. Can the request be made specific to particular platforms?
    - Yes. By specifying the platform values inside the array "platforms", the request can be made specific to the particular platforms.

  4. What all "platform" values are supported?
    • In production, supported values are — urbanpiper ( for Meraki), zomato, swiggy, dunzo, amazon, foodpanda, ubereats, zomatomarket, swiggystore, amazon, magicpin, dotpe, eazydiner, talabat, deliveroo, jahez.

  5. Why POS partners are asked to use "urbanpiper" and not aggregator values for "platforms" in the sandbox env?
    - The aggregators haven't shared any staging environment to connect our sandbox for seamless integration testing. Given that, when an API request with aggregator platforms values are being sent to UrbanPiper, the request will end up failing when the system tries to make a request to the upstream system. Thus, it is recommended to use "urbanpiper" as the platform value while testing this API. During the integration sign-off stage, we shall test this API with one of the aggregator platforms.

  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 20. 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. 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 Store status change from the dropdown.
    • Or, use the Webhooks API to configure the webhook endpoints in Quint Dashboard by specifying the event - store_action mentioned in the API documentation.
    • Note: For more info - https://api-ordering-docs.urbanpiper.com/#store-actions-callback.

  8. During testing, received error - "Location not valid for platform |"swiggy"|". What does this mean?
    - Make sure the "platforms" value set as "urbanpiper" while testing in the sandbox environment. Refer to point no. 5. If you receive this error in production, make sure the platform is enabled for the business and the outlet is integrated with the platform.

  9. Is it expected to receive a "callback" when the platform used in "urbanpiper"?
    - No. The callbacks will be triggered only for the aggregator values (such as zomato, swiggy, etc) passed under "platforms".

Was this article helpful?