API Document Reference - https://api-ordering-docs.urbanpiper.com/#item-option-actions
- 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.
- 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. For Meraki, when the brand is live on a website or apps.
- 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.
- Is it possible to perform "action" platform-wise?
- No. The API request will perform "action" across all the ordering platforms the products are available.
- Is it possible to perform "action" only to options/variants?
- Yes. This can be done by passing the POS options/variants ids under the attributes "option_ref_ids[]".
- 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.
- Can the bulk payload for "item_ref_ids/option_ref_ids" be expected?
- Yes.
- How many items/options can be sent under "item_ref_ids"/"option_ref_ids" in single API call?
- 400
- 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 for Items actions and Option Stock In/Out for Option actions from the dropdown.
- Or, use the Webhooks API to configure the webhook endpoints in Quint Dashboard by specifying the event — item_state_toggle for Item actions and option_state_toggle for Option actions mentioned in the API documentation.
- For more info on Item actions callback - https://api-ordering-docs.urbanpiper.com/#item-actions-callback
- For more info on Option actions callback - https://api-ordering-docs.urbanpiper.com/#option-actions-callback
- Is it expected not to receive a "callback" for this API in the sandbox?
- Yes. The callbacks will be triggered only in the production where the aggregator platforms are enabled.
- 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.