iFood
iFood Merchant API — pedidos, catálogo, financeiro, logística, reviews e picking.
Authentication
This connector uses Token-based authentication.
info
Set up your connection in the Abstra Console before using it in your workflows.
How to use
Using the Smart Chat
Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".
Using the Web Editor
from abstra.connectors import run_connection_action
result = run_connection_action(
connection_name="your_connection_name",
action_name="your_action_name",
params={
"param1": "value1",
"param2": "value2"
})
Available Actions
This connector provides 192 actions:
| Action | Purpose | Parameters |
|---|---|---|
| merchant_api_catalog_v1/get_merchants_by_merchant_id_catalogs | List all available catalogs given a Merchant Id | merchantId (string) required |
| merchant_api_catalog_v1/get_merchants_by_merchant_id_catalogs_by_catalog_id_unsellable_items | List all unsellable categories or categories containing unsellable items. That is, categories or items with violations, paused ones, etc. | merchantId (string) required catalogId (string) required |
| merchant_api_catalog_v1/get_merchants_by_merchant_id_catalogs_by_catalog_id_categories | List all categories within a specific catalog, which may include items within those categories | merchantId (string) required catalogId (string) required includeItems (string) include_items (string) |
| merchant_api_catalog_v1/post_merchants_by_merchant_id_catalogs_by_catalog_id_categories | Create a category within a catalog | merchantId (string) required catalogId (string) required data: { . name (string) . status (string) . template (string) . id (string) . externalCode (string) . index (string) } (object) required |
| merchant_api_catalog_v1/get_merchants_by_merchant_id_catalogs_by_catalog_id_categories_by_category_id | Fetch a specific category, which may include items within that category | merchantId (string) required catalogId (string) required categoryId (string) required includeItems (string) include_items (string) |
| merchant_api_catalog_v1/patch_merchants_by_merchant_id_catalogs_by_catalog_id_categories_by_category_id | Edit a category. Unsent fields will preserve their former values. Status changes may be applied to the items associated with the given category. | merchantId (string) required catalogId (string) required categoryId (string) required data: { . name (string) . externalCode (string) . status (string) . index (string) } (object) required |
| merchant_api_catalog_v1/delete_merchants_by_merchant_id_catalogs_by_catalog_id_categories_by_category_id | Delete a category. All items within that category will also be deleted. This action can only be performed if the category is present in only one context. | merchantId (string) required catalogId (string) required categoryId (string) required |
| merchant_api_catalog_v1/get_merchants_by_merchant_id_catalogs_by_group_id_sellable_items | List all sellable items, it will return only items that can be sold using all attributes and schedule information. | merchantId (string) required groupId (string) required |
| merchant_api_catalog_v1/put_merchants_by_merchant_id_catalog_by_catalog_id | Add or update aisle group id in catalog. | merchantId (string) required catalogId (string) required aisleGroupId (string) |
| merchant_api_catalog_v1/patch_merchants_by_merchant_id_catalog_item_by_item_id_status | Update item status, regardless of being normal or pizza items. | merchantId (string) required itemId (string) required data: { . status (string) } (object) required |
| merchant_api_catalog_v1/patch_merchants_by_merchant_id_catalog_item_by_item_id_option_by_option_item_id_status | Update option status, regardless of being normal or pizza options. | merchantId (string) required itemId (string) required optionItemId (string) required data: { . status (string) } (object) required |
| merchant_api_catalog_v1/get_merchants_by_merchant_id_items_by_item_id | Fetch a specific item | merchantId (string) required itemId (string) required catalogId (string) |
| merchant_api_catalog_v1/patch_merchants_by_merchant_id_items_by_item_id_status | Edit the status of a item. Unsent fields will preserve their former values | merchantId (string) required itemId (string) required data: { . status (string) } (object) required |
| merchant_api_catalog_v1/post_merchants_by_merchant_id_categories_by_category_id_products_by_product_id | Create an association between a product and a category. Can be interpreted as offering a product within a category | merchantId (string) required categoryId (string) required productId (string) required data: { . status (string) . price (object) . shifts (array) . id (string) . externalCode (string) . index (string) . tags (array) } (object) required |
| merchant_api_catalog_v1/patch_merchants_by_merchant_id_categories_by_category_id_products_by_product_id | Edit an item. Unsent fields will preserve their former values | merchantId (string) required categoryId (string) required productId (string) required catalogId (string) data: { . shifts (array) . status (string) . price (object) . externalCode (string) . index (string) . tags (array) } (object) required |
| merchant_api_catalog_v1/delete_merchants_by_merchant_id_categories_by_category_id_products_by_product_id | Delete an item. Simply deletes an association between a product and a category. Does not apply any changes to the product or the category | merchantId (string) required categoryId (string) required productId (string) required |
| merchant_api_catalog_v1/post_merchants_by_merchant_id_option_groups | Create an option group. At first, it will not be associated to any item or option | merchantId (string) required data: { . name (string) . id (string) } (object) required |
| merchant_api_catalog_v1/get_merchants_by_merchant_id_option_groups | List all option groups within a merchant. It is possible to request for the options within each group | merchantId (string) required includeOptions (string) include_options (string) |
| merchant_api_catalog_v1/patch_merchants_by_merchant_id_option_groups_by_option_group_id | Update option group info Name | merchantId (string) required optionGroupId (string) required data: { . name (string) } (object) required |
| merchant_api_catalog_v1/delete_merchants_by_merchant_id_option_groups_by_option_group_id | Delete an option group. All products associated to the given option group won't receive it anymore | merchantId (string) required optionGroupId (string) required |
| merchant_api_catalog_v1/post_merchants_by_merchant_id_option_groups_by_option_group_id_products_by_product_id | Associate an option group to a product. In case the given product is already associated to an item, the given option group will also go on sale | merchantId (string) required optionGroupId (string) required productId (string) required data: { . min (string) . max (string) . index (string) } (object) required |
| merchant_api_catalog_v1/put_merchants_by_merchant_id_option_groups_by_option_group_id_products_by_product_id | Update association info between an option group and a product | merchantId (string) required optionGroupId (string) required productId (string) required data: { . min (string) . max (string) . index (string) } (object) required |
| merchant_api_catalog_v1/delete_merchants_by_merchant_id_option_groups_by_option_group_id_products_by_product_id | Disassociate an option group from a product. In case the given product is already associated to an item, the given option group will go out of sale | merchantId (string) required optionGroupId (string) required productId (string) required |
| merchant_api_catalog_v1/post_merchants_by_merchant_id_option_groups_by_option_group_id_products_by_product_id_option | Create an option within an option group | merchantId (string) required optionGroupId (string) required productId (string) required data: { . status (string) . price (object) . externalCode (string) . index (string) } (object) required |
| merchant_api_catalog_v1/patch_merchants_by_merchant_id_option_groups_by_option_group_id_products_by_product_id_option | Update an option within an option group | merchantId (string) required optionGroupId (string) required productId (string) required catalogId (string) data: { . status (string) . price (object) . externalCode (string) . index (string) } (object) required |
| merchant_api_catalog_v1/delete_merchants_by_merchant_id_option_groups_by_option_group_id_products_by_product_id_option | Delete an option from an option group | merchantId (string) required optionGroupId (string) required productId (string) required |
| merchant_api_catalog_v1/patch_merchants_by_merchant_id_option_groups_by_option_group_id_status | Update an option group's status. This operation affects all products that may be associated to the given option group | merchantId (string) required optionGroupId (string) required data: { . status (string) } (object) required |
| merchant_api_catalog_v1/get_merchants_by_merchant_id_products | List all products registered to a given merchant | merchantId (string) required limit (string) page (string) |
| merchant_api_catalog_v1/post_merchants_by_merchant_id_products | Create a product. After being created, the product isn't yet available for sale. It is necessary to associate it to a category via item creation association API | merchantId (string) required data: { . name (string) . shifts (array) . serving (string) . id (string) . description (string) . additionalInformation (string) . externalCode (string) . image (string) . dietaryRestrictions (array) . ean (string) . weight (object) . multipleImages (array) } (object) required |
| merchant_api_catalog_v1/put_merchants_by_merchant_id_products_by_product_id | Edit a product. Once updated, all items and options associated to that product will also be updated | merchantId (string) required productId (string) required data: { . name (string) . shifts (array) . serving (string) . description (string) . additionalInformation (string) . externalCode (string) . image (string) . dietaryRestrictions (array) . ean (string) . weight (object) . multipleImages (array) } (object) required |
| merchant_api_catalog_v1/delete_merchants_by_merchant_id_products_by_product_id | Delete a product. All items and options associated to that product will also be deleted in all catalogs | merchantId (string) required productId (string) required |
| merchant_api_catalog_v1/patch_merchants_by_merchant_id_products_by_product_id_status | Update a product's status. All items and options associated to that product will also be updated. | merchantId (string) required productId (string) required data: { . status (string) } (object) required |
| merchant_api_catalog_v1/patch_merchants_by_merchant_id_products_status | Batch update options and items statuses by productId or externalCode. All items and options associated to all given products will also be updated. It is also possible to define if only items or options should be update. This functionality is executed asynchronously. A batch id and an url are going to be returned. The url is from a get endpoint, where is possible to check each update result. | merchantId (string) required data (array) required |
| merchant_api_catalog_v1/patch_merchants_by_merchant_id_products_price | Batch update options and items prices by productId or externalCode. All items and options associated to all given products will also be updated. It is also possible to define if only items or options should be updated. This functionality is executed asynchronously. A batch id and an url are going to be returned. The url is from a get endpoint, where is possible to check each update result. | merchantId (string) required data (array) required |
| merchant_api_catalog_v1/get_merchants_by_merchant_id_products_external_code_by_external_code | List all products registered to a given merchant by external code | merchantId (string) required externalCode (string) required |
| merchant_api_catalog_v1/patch_merchants_by_merchant_id_products_external_code_by_external_code_status | Batch update options and items statuses by productId or externalCode. All items and options associated to all given products will also be updated. It is also possible to define if only items or options should be update. This functionality is executed asynchronously. A batch id and an url are going to be returned. The url is from a get endpoint, where is possible to check each update result. | merchantId (string) required externalCode (string) required data: { . status (string) } (object) required |
| merchant_api_catalog_v1/get_merchants_by_merchant_id_product_by_product_id | Get a product by id | merchantId (string) required productId (string) required |
| merchant_api_catalog_v1/post_merchants_by_merchant_id_pizzas | Create a pizza product. After being created, the pizza isn't yet available for sale | merchantId (string) required data: { . sizes (array) . crusts (array) . edges (array) . toppings (array) . shifts (array) . id (string) } (object) required |
| merchant_api_catalog_v1/get_merchants_by_merchant_id_pizzas | List all available pizzas within a merchant | merchantId (string) required |
| merchant_api_catalog_v1/put_merchants_by_merchant_id_pizzas_by_pizza_id | It is possible to add, edit or remove sizes, crusts, edges and topping within a pizza product. To add any of these resources, the id of the object must not be provided in the request. To edit, the id must be provided. It is important to notice that all existing resources not contained in the request will be deleted. | merchantId (string) required pizzaId (string) required data: { . sizes (array) . crusts (array) . edges (array) . toppings (array) . shifts (array) } (object) required |
| merchant_api_catalog_v1/patch_merchants_by_merchant_id_pizzas_by_pizza_id | Update a pizza product's status | merchantId (string) required pizzaId (string) required data: { . status (string) . sizeIds (array) . crustIds (array) . edgeIds (array) . toppingIds (array) } (object) required |
| merchant_api_catalog_v1/post_merchants_by_merchant_id_pizzas_by_pizza_id_categories_by_category_id | Associate a pizza product to a category with PIZZA template. At this moment, the pizza will be on sale with given prices | merchantId (string) required pizzaId (string) required categoryId (string) required data: { . catalogId (string) . crusts (array) . edges (array) . toppings (array) } (object) required |
| merchant_api_catalog_v1/delete_merchants_by_merchant_id_pizzas_by_pizza_id_categories_by_category_id | Disassociate a pizza product from a category | merchantId (string) required pizzaId (string) required categoryId (string) required |
| merchant_api_catalog_v1/patch_merchants_by_merchant_id_pizzas_prices_by_external_code | Batch update pizzas' prices by pdv within a catalog. It is possible to update topping prices by size, crusts and edges. | merchantId (string) required data: { . crusts (array) . edges (array) . toppings (array) } (object) required |
| merchant_api_catalog_v1/post_merchants_by_merchant_id_pizzas_prices | Batch update pizzas' prices within a catalog. It is possible to update topping prices by size, crusts and edges. | merchantId (string) required data: { . catalogId (string) . crusts (array) . edges (array) . toppings (array) } (object) required |
| merchant_api_catalog_v1/get_merchants_by_merchant_id_batch_by_batch_id | List all operation results within a specific batch, and whether all the operations were completed | merchantId (string) required batchId (string) required |
| merchant_api_catalog_v1/post_merchants_by_merchant_id_inventory | Creates or updates the stock of a product | merchantId (string) required data: { . productId (string) . amount (string) . globalStock (string) . allowNegativeStock (string) } (object) required |
| merchant_api_catalog_v1/get_merchants_by_merchant_id_inventory_by_product_id | Gets the stock of a product for a given ownerId | merchantId (string) required productId (string) required |
| merchant_api_catalog_v1/post_merchants_by_merchant_id_inventory_batch_delete | Deletes the stock for a list of products for a given ownerId | merchantId (string) required data: { . productIds (array) } (object) required |
| merchant_api_catalog_v1/put_merchants_by_merchant_id_multisetup_items | Create or update an item and it's linked entities. You can use products and option groups already created or inform them on the body to create new ones | merchantId (string) required data: { . item (object) . products (array) . optionGroups (array) . options (array) } (object) required |
| merchant_api_catalog_v1/patch_merchants_by_merchant_id_multisetup_options_price | Update option price | merchantId (string) required data: { . optionId (string) . price (object) . parentCustomizationOptionId (string) . priceByCatalog (array) } (object) required |
| merchant_api_catalog_v1/patch_merchants_by_merchant_id_multisetup_options_status | Update option status | merchantId (string) required data: { . optionId (string) . status (string) . parentCustomizationOptionId (string) . statusByCatalog (array) } (object) required |
| merchant_api_catalog_v1/delete_merchants_by_merchant_id_multisetup_categories_by_category_id | Delete a category in all merchant services. All items within that category will also be deleted | merchantId (string) required categoryId (string) required |
| merchant_api_catalog_v1/get_merchants_by_merchant_id_multisetup_categories_by_category_id_items | List all items within that category | merchantId (string) required categoryId (string) required |
| merchant_api_catalog_v1/delete_merchants_by_merchant_id_multisetup_option_groups_by_option_group_id | Delete an option group. All products associated to the given option group won't receive it anymore | merchantId (string) required optionGroupId (string) required |
| merchant_api_catalog_v1/get_merchants_by_merchant_id_multisetup_is_multisetup | Verify that a merchant can use the multisetup module, whose endpoints are listed in Catalog API version 2.0. | merchantId (string) required |
| merchant_api_catalog_v1/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| merchant_api_catalog_v2/get_merchants_by_merchant_id_catalogs | List all available catalogs given a Merchant Id | merchantId (string) required |
| merchant_api_catalog_v2/get_merchants_by_merchant_id_catalogs_by_catalog_id_unsellable_items | List all unsellable categories or categories containing unsellable items. That is, categories or items with violations, paused ones, etc. | merchantId (string) required catalogId (string) required |
| merchant_api_catalog_v2/get_merchants_by_merchant_id_catalogs_by_catalog_id_categories | List all categories within a specific catalog, which may include items within those categories | merchantId (string) required catalogId (string) required includeItems (string) include_items (string) |
| merchant_api_catalog_v2/post_merchants_by_merchant_id_catalogs_by_catalog_id_categories | Create a category within a catalog | merchantId (string) required catalogId (string) required data: { . name (string) . status (string) . template (string) . id (string) . externalCode (string) . index (string) } (object) required |
| merchant_api_catalog_v2/get_merchants_by_merchant_id_catalogs_by_catalog_id_categories_by_category_id | Fetch a specific category, which may include items within that category | merchantId (string) required catalogId (string) required categoryId (string) required includeItems (string) include_items (string) |
| merchant_api_catalog_v2/patch_merchants_by_merchant_id_catalogs_by_catalog_id_categories_by_category_id | Edit a category. Unsent fields will preserve their former values. Status changes may be applied to the items associated with the given category. | merchantId (string) required catalogId (string) required categoryId (string) required data: { . name (string) . externalCode (string) . status (string) . index (string) } (object) required |
| merchant_api_catalog_v2/get_merchants_by_merchant_id_catalogs_by_group_id_sellable_items | List all sellable items, it will return only items that can be sold using all attributes and schedule information. | merchantId (string) required groupId (string) required |
| merchant_api_catalog_v2/delete_merchants_by_merchant_id_categories_by_category_id | Delete a category in all merchant services. All items within that category will also be deleted | merchantId (string) required categoryId (string) required |
| merchant_api_catalog_v2/delete_merchants_by_merchant_id_categories_by_category_id_products_by_product_id | Delete an item. Simply deletes an association between a product and a category. Does not apply any changes to the product or the category | merchantId (string) required categoryId (string) required productId (string) required catalogContext (string) |
| merchant_api_catalog_v2/get_merchants_by_merchant_id_categories_by_category_id_items | List all items within that category | merchantId (string) required categoryId (string) required |
| merchant_api_catalog_v2/get_merchants_by_merchant_id_option_groups | List all option groups within a merchant. It is possible to request for the options within each group | merchantId (string) required includeOptions (string) include_options (string) catalogContext (string) |
| merchant_api_catalog_v2/patch_merchants_by_merchant_id_option_groups_by_option_group_id | Update option group info Name | merchantId (string) required optionGroupId (string) required data: { . name (string) } (object) required |
| merchant_api_catalog_v2/delete_merchants_by_merchant_id_option_groups_by_option_group_id | Delete an option group. All products associated to the given option group won't receive it anymore | merchantId (string) required optionGroupId (string) required |
| merchant_api_catalog_v2/delete_merchants_by_merchant_id_option_groups_by_option_group_id_products_by_product_id | Disassociate an option group from a product. In case the given product is already associated to an item, the given option group will go out of sale | merchantId (string) required optionGroupId (string) required productId (string) required |
| merchant_api_catalog_v2/delete_merchants_by_merchant_id_option_groups_by_option_group_id_products_by_product_id_option | Delete an option from an option group | merchantId (string) required optionGroupId (string) required productId (string) required catalogContext (string) |
| merchant_api_catalog_v2/patch_merchants_by_merchant_id_option_groups_by_option_group_id_status | Update an option group's status. This operation affects all products that may be associated to the given option group | merchantId (string) required optionGroupId (string) required data: { . status (string) } (object) required |
| merchant_api_catalog_v2/get_merchants_by_merchant_id_products | List all products registered to a given merchant | merchantId (string) required limit (string) page (string) |
| merchant_api_catalog_v2/post_merchants_by_merchant_id_products | Create a product. After being created, the product isn't yet available for sale. It is necessary to associate it to a category via item creation association API | merchantId (string) required data: { . name (string) . shifts (array) . serving (string) . id (string) . description (string) . additionalInformation (string) . externalCode (string) . image (string) . imagePath (string) . dietaryRestrictions (array) . ean (string) . weight (object) . multipleImages (array) } (object) required |
| merchant_api_catalog_v2/put_merchants_by_merchant_id_products_by_product_id | Edit a product. Once updated, all items and options associated to that product will also be updated | merchantId (string) required productId (string) required data: { . name (string) . shifts (array) . serving (string) . description (string) . additionalInformation (string) . externalCode (string) . image (string) . imagePath (string) . dietaryRestrictions (array) . ean (string) . weight (object) . multipleImages (array) } (object) required |
| merchant_api_catalog_v2/delete_merchants_by_merchant_id_products_by_product_id | Delete a product. All items and options associated to that product will also be deleted in all catalogs | merchantId (string) required productId (string) required |
| merchant_api_catalog_v2/patch_merchants_by_merchant_id_products_status | Batch update options and items statuses by productId or externalCode. All items and options associated to all given products will also be updated. It is also possible to define if only items or options should be update. This functionality is executed asynchronously. A batch id and an url are going to be returned. The url is from a get endpoint, where is possible to check each update result. | merchantId (string) required catalogContext (string) data (array) required |
| merchant_api_catalog_v2/patch_merchants_by_merchant_id_products_price | Batch update options and items prices by productId or externalCode. All items and options associated to all given products will also be updated. It is also possible to define if only items or options should be updated. This functionality is executed asynchronously. A batch id and an url are going to be returned. The url is from a get endpoint, where is possible to check each update result. | merchantId (string) required catalogContext (string) data (array) required |
| merchant_api_catalog_v2/get_merchants_by_merchant_id_products_external_code_by_external_code | List all products registered to a given merchant by external code | merchantId (string) required externalCode (string) required |
| merchant_api_catalog_v2/get_merchants_by_merchant_id_product_by_product_id | Get a product by id | merchantId (string) required productId (string) required |
| merchant_api_catalog_v2/get_merchants_by_merchant_id_batch_by_batch_id | List all operation results within a specific batch, and whether all the operations were completed | merchantId (string) required batchId (string) required |
| merchant_api_catalog_v2/post_merchants_by_merchant_id_inventory | Creates or updates the stock of a product | merchantId (string) required data: { . productId (string) . amount (string) } (object) required |
| merchant_api_catalog_v2/get_merchants_by_merchant_id_inventory_by_product_id | Gets the stock of a product for a given ownerId | merchantId (string) required productId (string) required |
| merchant_api_catalog_v2/post_merchants_by_merchant_id_inventory_batch_delete | Deletes the stock for a list of products for a given ownerId | merchantId (string) required data: { . productIds (array) } (object) required |
| merchant_api_catalog_v2/put_merchants_by_merchant_id_items | Create or update an item and it's linked entities. You can use products and option groups already created or inform them on the body to create new ones | merchantId (string) required data: { . item (object) . products (array) . optionGroups (array) . options (array) } (object) required |
| merchant_api_catalog_v2/get_merchants_by_merchant_id_items_by_item_id_flat | Get an item and it's linked entities | merchantId (string) required itemId (string) required |
| merchant_api_catalog_v2/patch_merchants_by_merchant_id_items_price | Edit the price of a item. | merchantId (string) required data: { . itemId (string) . price (object) . priceByCatalog (array) } (object) required |
| merchant_api_catalog_v2/patch_merchants_by_merchant_id_items_status | Edit the status of a item. Unsent fields will preserve their former values | merchantId (string) required data: { . itemId (string) . status (string) . statusByCatalog (array) } (object) required |
| merchant_api_catalog_v2/patch_merchants_by_merchant_id_items_external_code | Edit the external code of an item and its extensions | merchantId (string) required data: { . itemId (string) . externalCodeByCatalog (array) . externalCode (string) } (object) required |
| merchant_api_catalog_v2/patch_merchants_by_merchant_id_options_price | Update option's price | merchantId (string) required data: { . optionId (string) . price (object) . parentCustomizationOptionId (string) . priceByCatalog (array) } (object) required |
| merchant_api_catalog_v2/patch_merchants_by_merchant_id_options_external_code | Update option's external code | merchantId (string) required data: { . optionId (string) . externalCode (string) . parentCustomizationOptionId (string) . externalCodeByCatalog (array) } (object) required |
| merchant_api_catalog_v2/patch_merchants_by_merchant_id_options_status | Update option's status | merchantId (string) required data: { . optionId (string) . status (string) . parentCustomizationOptionId (string) . statusByCatalog (array) } (object) required |
| merchant_api_catalog_v2/get_merchants_by_merchant_id_catalog_version | Returns the version of the catalog, which implies the version of the API this store should use. | merchantId (string) required |
| merchant_api_catalog_v2/post_merchants_by_merchant_id_version_upgrade | Upgrade catalog's version so the owner can use all catalog API v2 endpoints. | merchantId (string) required cleanMigration (string) |
| merchant_api_catalog_v2/post_merchants_by_merchant_id_version_downgrade | Downgrade catalog's version to v1, the owner may not have access to the endpoints on the new version. | merchantId (string) required |
| merchant_api_catalog_v2/post_merchants_by_merchant_id_image_upload | Uploads a image to be used on products creation/update | merchantId (string) required data (object) required |
| merchant_api_catalog_v2/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| merchant_api_events/get_events_polling | Polls events for any orders from merchants associated with the authenticated user. Each event received from this endpoint must be properly acknowledged, otherwise it will continue to be returned on further requests.Read morehttps://developer.ifood.com.br/docs/guides/modules/order/events | types (string) groups (string) categories (string) |
| merchant_api_events/post_events_acknowledgment | Acknowledge a set of events, dismissing them from future polling calls. | data (array) required |
| merchant_api_events/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| merchant_api_financial_v2/get_merchants_by_merchant_id_sales_adjustments | Returns adjustments of merchant information for sales conciliation by a range of dates or period. | merchantId (string) required periodId (string) beginUpdateDate (string) endUpdateDate (string) |
| merchant_api_financial_v2/get_merchants_by_merchant_id_payments | Returns merchant information regarding payments by range of dates or period | merchantId (string) required periodId (string) beginExpectedExecutionDate (string) endExpectedExecutionDate (string) beginConfirmedPaymentDate (string) endConfirmedPaymentDate (string) |
| merchant_api_financial_v2/get_merchants_by_merchant_id_payment_details | Return a list of payment filtered by payment date range and status | merchantId (string) required beginPaymentDate (string) endPaymentDate (string) status (string) |
| merchant_api_financial_v2/get_merchants_by_merchant_id_occurrences | Returns information regarding occurrences by a range of dates or period. To search using periodId, assume that periodId is only updated every Wednesday of the next week Mon-Sun. If search is before Wednesday, use date filters. Read more in the api documentation. | merchantId (string) required periodId (string) type (string) transactionDateBegin (string) transactionDateEnd (string) |
| merchant_api_financial_v2/get_merchants_by_merchant_id_maintenance_fees | Returns information regarding maintenance fees by a range of dates or period. To search using periodId, assume that periodId is only updated every Wednesday of the next week Mon-Sun. If search is before Wednesday, use date filters. Read more in the api documentation. | merchantId (string) required periodId (string) transactionDateBegin (string) transactionDateEnd (string) |
| merchant_api_financial_v2/get_merchants_by_merchant_id_income_taxes | Returns information regarding income taxes by a range of dates or period. To search using periodId, assume that periodId is only updated every Wednesday of the next week Mon-Sun. If search is before Wednesday, use date filters. Read more in the api documentation. | merchantId (string) required periodId (string) transactionDateBegin (string) transactionDateEnd (string) |
| merchant_api_financial_v2/get_merchants_by_merchant_id_periods | Return a list of Period filtered by competence | merchantId (string) required competence (string) |
| merchant_api_financial_v2/get_merchants_by_merchant_id_charge_cancellations | Returns information regarding charge cancellations by a range of dates or period. To search using periodId, assume that periodId is only updated every Wednesday of the next week Mon-Sun. If search is before Wednesday, use date filters. Read more in the api documentation. | merchantId (string) required periodId (string) transactionDateBegin (string) transactionDateEnd (string) |
| merchant_api_financial_v2/get_merchants_by_merchant_id_cancellations | Returns information regarding cancellations | merchantId (string) required periodId (string) beginCancellationDate (string) endCancellationDate (string) |
| merchant_api_financial_v2/get_merchants_by_merchant_id_receivable_records | Returns merchant information regarding receivable records by range of dates and merchantId | merchantId (string) required beginReceivableDate (string) endReceivableDate (string) |
| merchant_api_financial_v2/get_merchants_by_merchant_id_sales_benefits | Returns ifood benefits of merchant information for sales conciliation by a range of dates. | merchantId (string) required periodId (string) beginOrderDate (string) endOrderDate (string) |
| merchant_api_financial_v2/get_merchants_by_merchant_id_adjustments_benefits | Returns adjustments from ifood benefits of merchant information for sales conciliation by a range of dates. | merchantId (string) required periodId (string) beginOrderDate (string) endOrderDate (string) |
| merchant_api_financial_v2/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| merchant_api_financial_v21/get_merchants_by_merchant_id_sales | Returns merchant information for sales conciliation by a range of dates or period. To search using periodId, assume that periodId is only updated every Wednesday of the next week Mon-Sun. If search is before Wednesday, use date filters. Read more in the api documentation. | merchantId (string) required periodId (string) beginLastProcessingDate (string) endLastProcessingDate (string) beginOrderDate (string) endOrderDate (string) |
| merchant_api_financial_v21/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| merchant_api_financial_v3/get_merchants_by_merchant_id_reconciliation | Returns the reconciliation file, which contains all financial entries that occurred within a calculation period. | merchantId (string) required competence (string) |
| merchant_api_financial_v3/get_merchants_by_merchant_id_settlements | Returns the net amount to be received by partner stores, as well as the value of receivables records sent to financial institutions. The submission of the beginPaymentDate and endPaymentDate or beginCalculationDate and endCalculationDate information is mandatory in the request. | merchantId (string) required |
| merchant_api_financial_v3/get_merchants_by_merchant_id_anticipations | Retrieve anticipations for a merchant based on a specified date range or anticipated date range. | merchantId (string) required |
| merchant_api_financial_v3/get_merchants_by_merchant_id_sales | Responsible for displaying all sales that occurred within a specific period. It presents information such as the unique order number, payment method, amount paid by the customer, the entity that received the payment, order status, and other relevant details for calculating the net amount to be transferred to the partner. | merchantId (string) required beginSalesDate (string) endSalesDate (string) page (string) |
| merchant_api_financial_v3/post_merchants_by_merchant_id_reconciliation_on_demand | Post reconciliation on demand | merchantId (string) required data: { . competence (string) } (object) required |
| merchant_api_financial_v3/get_merchants_by_merchant_id_reconciliation_on_demand_by_request_id | Post reconciliation on demand Copy | merchantId (string) required requestId (string) required |
| merchant_api_financial_v3/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| merchant_api_item/post_ingestion_by_merchant_id | Send new product integrations, update all product data, or reactivate them. | merchantId (string) required reset (string) data (array) required |
| merchant_api_item/patch_ingestion_by_merchant_id | A partial update is recommended if the product has already been sent previously and not all fields require changes, allowing you to send only the update and the mandatory fields. The payload is the same as the POST request, but you will only send the fields you want to update. Do not use PATCH to activate a product. For this, it is necessary to use the POST route because we need all the updated information. | merchantId (string) required data (array) required |
| merchant_api_item/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| merchant_api_logistics/get_orders_by_id | Get details for a given logistics order from its id | id (string) required |
| merchant_api_logistics/post_orders_by_id_assign_driver | Assign a driver to make the delivery | id (string) required data: { . workerName (string) . workerPhone (string) . workerVehicleType (string) } (object) required |
| merchant_api_logistics/post_orders_by_id_going_to_origin | Driver is on the way to the origin to pick up the order | id (string) required |
| merchant_api_logistics/post_orders_by_id_arrived_at_origin | Driver arrived at the origin to collect the order | id (string) required |
| merchant_api_logistics/post_orders_by_id_dispatch | Driver is on the way to the destination to deliver the order | id (string) required |
| merchant_api_logistics/post_orders_by_id_arrived_at_destination | Driver arrived at the destination address | id (string) required |
| merchant_api_logistics/post_orders_by_id_verify_delivery_code | This endpoint checks the delivery code. | id (string) required data: { . code (string) } (object) required |
| merchant_api_logistics/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| merchant_api_merchant/get_merchants | Lists the summary of all merchants related to the client in the token that contains MERCHANT scope. | page (string) size (string) |
| merchant_api_merchant/get_merchants_by_merchant_id | Gets detailed information about the merchant, such as merchant basic info, address and operations. | merchantId (string) required |
| merchant_api_merchant/get_merchants_by_merchant_id_interruptions | Lists current and future interruptions of the given merchant. | merchantId (string) required |
| merchant_api_merchant/post_merchants_by_merchant_id_interruptions | Creates an interruption for the given merchant. Will return the created interruption if the request is successful. | merchantId (string) required data: { . description (string) . start (string) . end (string) . id (string) } (object) required |
| merchant_api_merchant/delete_merchants_by_merchant_id_interruptions_by_interruption_id | Deletes a current or future interruption from the given merchant. | merchantId (string) required interruptionId (string) required |
| merchant_api_merchant/get_merchants_by_merchant_id_status | Lists availability details for all merchant's available operations. | merchantId (string) required |
| merchant_api_merchant/get_merchants_by_merchant_id_status_by_operation | Gets the details of the merchant's status based on the given operation. | merchantId (string) required operation (string) required |
| merchant_api_merchant/get_merchants_by_merchant_id_opening_hours | Gets opening hours of the given merchant. | merchantId (string) required |
| merchant_api_merchant/put_merchants_by_merchant_id_opening_hours | Creates an opening hours for the given merchant. | merchantId (string) required data: { . storeId (string) . shifts (array) } (object) required |
| merchant_api_merchant/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| merchant_api_order/get_orders_by_id | Get details for a given order from its id | id (string) required |
| merchant_api_order/get_orders_by_id_virtual_bag | Get details for a given groceries order from its id | id (string) required |
| merchant_api_order/post_orders_by_id_confirm | Confirm an order. It is mandatory to consult the order details before confirming. Otherwise the request will be ignored. | id (string) required |
| merchant_api_order/post_orders_by_id_start_preparation | Inform the start of preparation of the order. | id (string) required |
| merchant_api_order/post_orders_by_id_ready_to_pickup | Signalize that an order is ready to be delivered | id (string) required |
| merchant_api_order/post_orders_by_id_dispatch | Dispatch an order | id (string) required |
| merchant_api_order/get_orders_by_id_cancellation_reasons | Get available cancellation codes a given order from its id | id (string) required |
| merchant_api_order/post_orders_by_id_request_cancellation | Request to cancel an order | id (string) required data: { . cancellationCode (string) . reason (string) } (object) required |
| merchant_api_order/get_orders_by_id_tracking | Get driver location lat/long while the order is being delivered | id (string) required |
| merchant_api_order/post_orders_by_id_request_driver | Request an on-demand driver | id (string) required |
| merchant_api_order/post_orders_by_id_cancel_request_driver | This endpoint request to cancel a delivery that hasn't a driver allocated. | id (string) required |
| merchant_api_order/post_orders_by_id_validate_pickup_code | This endpoint checks the pickup code. | id (string) required data: { . code (string) } (object) required |
| merchant_api_order/post_orders_by_id_verify_delivery_code | This endpoint checks the delivery code. | id (string) required data: { . code (string) } (object) required |
| merchant_api_order/post_disputes_by_dispute_id_accept | Accept a Handshake Dispute | disputeId (string) required |
| merchant_api_order/post_disputes_by_dispute_id_reject | Request to reject a dispute | disputeId (string) required data: { . reason (string) } (object) required |
| merchant_api_order/post_disputes_by_dispute_id_alternatives_by_alternative_id | Respond to a dispute with a proposal | disputeId (string) required alternativeId (string) required data: { . type (string) . metadata (object) } (object) required |
| merchant_api_order/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| merchant_api_picking/post_orders_by_id_items | Add an item for a given order. You can also relate the new item to the old item | id (string) required data: { . quantity (string) . ean (string) . replacedUniqueId (string) } (object) required |
| merchant_api_picking/patch_orders_by_id_items_by_unique_id | Modify any item for a given order from its id | id (string) required uniqueId (string) required data: { . quantity (string) } (object) required |
| merchant_api_picking/delete_orders_by_id_items_by_unique_id | Remove item for a given order from its id | id (string) required uniqueId (string) required |
| merchant_api_picking/post_orders_by_id_items_by_unique_id_replace | Replace an item for a given order. | id (string) required uniqueId (string) required data: { . ean (string) . quantity (string) } (object) required |
| merchant_api_picking/post_orders_by_id_start_separation | Start separation for a given order from its id | id (string) required |
| merchant_api_picking/post_orders_by_id_end_separation | End separation for a given order from its id | id (string) required |
| merchant_api_picking/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| merchant_api_review_v1/get_merchants_by_merchant_id_reviews | Retrieves a filtered reviews list | merchantId (string) required page (string) pageSize (string) addCount (string) dateFrom (string) dateTo (string) sort (string) sortBy (string) |
| merchant_api_review_v1/get_merchants_by_merchant_id_reviews_by_review_id | Retrieves review by its id and merchant id | merchantId (string) required reviewId (string) required |
| merchant_api_review_v1/post_merchants_by_merchant_id_reviews_by_review_id_answers | Posts a text reply for a review by its id | merchantId (string) required reviewId (string) required data: { . text (string) } (object) required |
| merchant_api_review_v1/get_merchants_by_merchant_id_summary | Retrieves summary for specified merchant id | merchantId (string) required |
| merchant_api_review_v1/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| merchant_api_review_v2/get_merchants_by_merchant_id_reviews | Retrieves a filtered reviews list | merchantId (string) required page (string) pageSize (string) addCount (string) dateFrom (string) dateTo (string) sort (string) sortBy (string) |
| merchant_api_review_v2/get_merchants_by_merchant_id_reviews_by_review_id | Retrieves review by its id and merchant id | merchantId (string) required reviewId (string) required |
| merchant_api_review_v2/post_merchants_by_merchant_id_reviews_by_review_id_answers | Posts a text reply for a review by its id | merchantId (string) required reviewId (string) required data: { . text (string) } (object) required |
| merchant_api_review_v2/get_merchants_by_merchant_id_summary | Retrieves summary for specified merchant id | merchantId (string) required |
| merchant_api_review_v2/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
| merchant_api_shipping/get_merchants_by_merchant_id_delivery_availabilities | Delivery Availabilities | merchantId (string) required Latitude (string) Longitude (string) |
| merchant_api_shipping/post_merchants_by_merchant_id_orders | Request a driver for an external order | merchantId (string) required data: { . customer (object) . delivery (object) . items (array) . payments (object) . metadata (object) } (object) required |
| merchant_api_shipping/get_orders_by_id_tracking | Get driver location lat/long while the order is being delivered | id (string) required |
| merchant_api_shipping/get_orders_by_order_id_cancellation_reasons | Get available cancellation codes for the order | orderId (string) required |
| merchant_api_shipping/post_orders_by_order_id_cancel | Cancel order for request driver | orderId (string) required data: { . reason (string) . cancellationCode (string) } (object) required |
| merchant_api_shipping/post_orders_by_order_id_accept_delivery_address_change | Accept Delivery Address Change | orderId (string) required |
| merchant_api_shipping/post_orders_by_order_id_delivery_address_change_request | Request Delivery Address Change | orderId (string) required data: { . streetNumber (string) . streetName (string) . complement (string) . neighborhood (string) . city (string) . state (string) . country (string) . reference (string) . coordinates (object) } (object) required |
| merchant_api_shipping/post_orders_by_order_id_deny_delivery_address_change | Deny Delivery Address Change | orderId (string) required |
| merchant_api_shipping/post_orders_by_order_id_user_confirm_address | Confirm User Address | orderId (string) required |
| merchant_api_shipping/get_orders_by_order_id_delivery_availabilities | Delivery Availabilities for an existing order at iFood | orderId (string) required |
| merchant_api_shipping/post_orders_by_order_id_request_driver | Request a driver for an iFood order | orderId (string) required data: { . quoteId (string) } (object) required |
| merchant_api_shipping/post_orders_by_order_id_cancel_request_driver | Cancel request driver for an existing order at iFood | orderId (string) required |
| merchant_api_shipping/get_orders_by_order_id_safe_delivery | Get Safe Delivery Score | orderId (string) required |
| merchant_api_shipping/custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |