Skip to main content

Rappi

Pedidos, cardápios, disponibilidade, lojas, financeiro e webhooks para aliados integrados.

Rappi Logo

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 118 actions:

ActionPurposeParameters
orders/get_ordersGera uma lista de novos pedidos criados pelas lojas do aliado autenticado.storeId (string)
orders/get_orders_status_sentGera uma lista de pedidos com status SENT atualizados nos últimos 10 minutos.storeId (string)
orders/put_orders_by_order_id_take_by_cooking_timeAceita um pedido em status SENT e inicia o preparo, opcionalmente ajustando o tempo de cozimento.orderId (string)
cookingTime (string)
orders/put_orders_by_order_id_rejectRejeita um pedido em status SENT por itens inválidos, preço incorreto, etc..orderId (string)
data: {
. reason (string)
. cancel_type (string)
. items_ids (array)
. items_skus (array)
} (object) required
orders/post_orders_by_order_id_ready_for_pickupNotifica o app do Rappi que o pedido está pronto para ser retirado pelo entregador. Limite de 3 chamadas por pedido.orderId (string)
orders/get_orders_by_order_id_eventsRecupera os eventos atualizações de status de um pedido.orderId (string)
orders/customCall 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
_headers (object)
menus/get_menuGera a lista de cardápios criados pelo aliado autenticado.No parameters
menus/post_menuCria ou atualiza um cardápio para a loja indicada em storeId.data: {
. storeId (string)
. items (array)
} (object) required
menus/get_menu_approved_by_store_idApresenta o estado atual de aprovação de um cardápio.storeId (string)
menus/get_menu_rappi_by_store_idApresenta o último cardápio criado para uma loja.storeId (string)
menus/customCall 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
_headers (object)
availability/post_availability_items_statusGera uma lista de disponibilidade dos artigos por SKU no app do Rappi.data: {
. store_id (string)
. item_ids (array)
} (object) required
availability/post_availability_items_rappi_statusGera uma lista de disponibilidade dos artigos por ID do Rappi.data: {
. store_id (string)
. item_ids (array)
} (object) required
availability/put_availability_stores_itemsAdministra a disponibilidade dos artigos por SKU.data (array) required
availability/put_availability_stores_items_rappiAdministra a disponibilidade dos artigos por ID do Rappi.data (array) required
availability/post_availability_storesGera uma lista do status de disponibilidade de lojas.data (array) required
availability/put_availability_storesAdministra de forma assíncrona a disponibilidade de uma loja.data: {
. turn_on (array)
. turn_off (array)
} (object) required
availability/put_availability_stores_enable_massiveAdministra de forma assíncrona a disponibilidade de múltiplas lojas até 300 por chamada.data: {
. stores (array)
} (object) required
availability/put_availability_stores_enableAdministra de forma síncrona a disponibilidade de uma loja e retorna resultado imediato.data: {
. stores (array)
} (object) required
availability/customCall 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
_headers (object)
stores/get_stores_paGera a lista de lojas do partner autenticado.No parameters
stores/put_stores_pa_by_store_id_statusAtualiza se a loja está integrada ou não.storeId (string)
integrated (boolean) required
stores/get_store_by_store_id_menu_currentObtém o cardápio atual da loja.storeId (string)
stores/get_stores_pa_by_store_id_check_in_codeRecupera o código de check-in usado para vincular a loja ao integrador.storeId (string)
stores/get_stores_integration_statusRetorna a hierarquia de lojas com o status de integração. Requer o header adicional Authorization-Partners.Authorization-Partners (string) required
stores/post_stores_provisioningProvisiona lojas em lote de forma assíncrona.Authorization-Partners (string) required
data: {
. stores (array)
} (object) required
stores/post_stores_deprovisioningRemove o provisionamento de lojas em lote de forma assíncrona.Authorization-Partners (string) required
data: {
. stores (array)
} (object) required
stores/customCall 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
_headers (object)
webhooks/post_webhookCria uma nova configuração de webhook para uma lista de lojas.data: {
. event (string)
. url (string)
. stores (array)
} (object) required
webhooks/get_webhook_by_eventGera uma lista dos webhooks configurados de todas as lojas para um evento.event (string)
webhooks/put_webhook_by_event_add_storesAdiciona lojas a um webhook existente.event (string)
data: {
. stores (array)
} (object) required
webhooks/put_webhook_by_event_change_urlAtualiza a URL de callback para o webhook das lojas indicadas.event (string)
data: {
. url (string)
. stores (array)
} (object) required
webhooks/delete_webhook_by_event_remove_storesRemover lojas do webhookevent (string)
data: {
. stores (array)
} (object) required
webhooks/put_webhook_by_event_reset_secretReinicia o segredo e gera um novo para o cliente autenticado.event (string)
webhooks/put_webhook_by_event_change_statusHabilitar/desabilitar webhook por lojaevent (string)
data: {
. stores (array)
} (object) required
webhooks/get_clients_by_client_id_webhooksLista todas as configurações de webhook do integrador para todas as lojas.clientId (string)
webhooks/post_clients_by_client_id_webhooksConfigura um webhook que se aplica a todas as lojas do integrador. Requer JWT do integrador Auth0.clientId (string)
data: {
. event (string)
. url (string)
. secret (string)
} (object) required
webhooks/delete_clients_by_client_id_webhooksRemover webhook de integraçãoclientId (string)
event (string) required
webhooks/customCall 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
_headers (object)
rest_orders/get_ordersGera uma lista de novos pedidos criados a partir de um cliente específico.No parameters
rest_orders/get_stores_by_store_id_ordersGera uma lista de novos pedidos de uma loja específica.storeId (string)
rest_orders/get_orders_status_sentGera uma lista de novos pedidos criados em status SENT.No parameters
rest_orders/put_stores_by_store_id_orders_by_order_id_takeAceita um pedido para iniciar o preparo.storeId (string)
orderId (string)
rest_orders/put_stores_by_store_id_orders_by_order_id_cooking_time_by_cooking_time_takeAceitar pedido com novo tempo de preparostoreId (string)
orderId (string)
cookingTime (integer)
rest_orders/get_stores_by_store_id_orders_by_order_id_handoffRetorna o código de confirmação e o código QR do pedido.storeId (string)
orderId (string)
rest_orders/post_stores_by_store_id_orders_by_order_id_bag_drink_confirmationConfirma o número de sacolas e se há bebidas fora da sacola.storeId (string)
orderId (string)
data: {
. number_of_bags (integer)
. has_drinks_outside_bag (boolean)
} (object) required
rest_orders/post_stores_by_store_id_orders_by_order_id_ready_for_pickupNotificar pedido pronto para retiradastoreId (string)
orderId (string)
rest_orders/put_stores_by_store_id_orders_by_order_id_cancel_type_by_cancel_type_rejectRejeitar pedidostoreId (string)
orderId (string)
cancelType (string)
data: {
. description (string)
. additional_info (object)
} (object) required
rest_orders/customCall 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
_headers (object)
rest_menu/get_stores_by_store_id_store_menuRecupera o cardápio completo incluindo itens, categorias e tipos de menu.storeId (integer)
rest_menu/post_stores_by_store_id_store_menuFaz o upload do cardápio completo para processamento.storeId (integer)
data: {
. storeId (integer)
. menus (array)
. categories (array)
. items (array)
} (object) required
rest_menu/get_stores_by_store_id_menuListar cardápios da lojastoreId (integer)
rest_menu/post_stores_by_store_id_menuCriar ou atualizar cardápiosstoreId (integer)
data (array) required
rest_menu/delete_stores_by_store_id_menuDeleta múltiplos cardápios da loja.storeId (integer)
data (array) required
rest_menu/get_stores_by_store_id_menu_by_menu_idDetalhes de um cardápiostoreId (integer)
menuId (integer)
rest_menu/get_stores_by_store_id_categoriesListar categorias da lojastoreId (integer)
rest_menu/post_stores_by_store_id_categoriesCriar ou atualizar categoriasstoreId (integer)
data (array) required
rest_menu/delete_stores_by_store_id_categoriesDeletar categoriasstoreId (integer)
data: {
. ids (array)
} (object) required
rest_menu/get_stores_by_store_id_categories_by_category_idDetalhes de uma categoriastoreId (integer)
categoryId (integer)
rest_menu/get_stores_by_store_id_itemsListar itens da lojastoreId (integer)
rest_menu/post_stores_by_store_id_itemsCriar ou atualizar itensstoreId (integer)
data (array) required
rest_menu/delete_stores_by_store_id_itemsDeletar itensstoreId (integer)
data (array) required
rest_menu/get_stores_by_store_id_items_by_item_idDetalhes de um itemstoreId (integer)
itemId (integer)
rest_menu/customCall 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
_headers (object)
rest_availability/patch_stores_by_store_id_products_by_identity_type_stockGerencia de forma assíncrona a disponibilidade dos produtos por RAPPI id ou SKU.storeId (string)
identityType (string)
data: {
. available (array)
. unavailable (array)
} (object) required
rest_availability/post_stores_by_store_id_products_by_identity_type_stock_statusConsultar status de disponibilidade de produtosstoreId (string)
identityType (string)
data: {
. products (array)
} (object) required
rest_availability/patch_stores_by_store_id_toppings_by_identity_type_stockGerenciar disponibilidade de toppingsstoreId (string)
identityType (string)
data: {
. available (array)
. unavailable (array)
} (object) required
rest_availability/post_stores_by_store_id_toppings_by_identity_type_stock_statusConsultar status de toppingsstoreId (string)
identityType (string)
data: {
. toppings (array)
} (object) required
rest_availability/patch_stores_by_store_id_items_by_identity_type_stockGerenciar disponibilidade combinada de produtos e toppingsstoreId (string)
identityType (string)
data: {
. available (array)
. unavailable (array)
} (object) required
rest_availability/post_stores_by_store_id_items_by_identity_type_stock_statusConsultar status combinado de produtos e toppingsstoreId (string)
identityType (string)
data: {
. items (array)
} (object) required
rest_availability/customCall 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
_headers (object)
utils/get_corridor_store_by_store_idListar corredores da lojastoreId (string)
utils/get_corridor_schedule_by_corridor_id_store_by_store_idHorários de um corredor por lojacorridorId (string)
storeId (string)
utils/post_corridor_schedule_by_corridor_id_store_by_store_idCriar horários de corredor por lojacorridorId (string)
storeId (string)
data: {
. schedule_details (array)
} (object) required
utils/put_corridor_schedule_by_corridor_id_store_by_store_idAtualizar horários de corredor por lojacorridorId (string)
storeId (string)
data: {
. schedule_details (array)
} (object) required
utils/delete_corridor_schedule_by_corridor_id_store_by_store_id_by_corridor_product_schedule_idDeletar horário de corredor lojacorridorId (string)
storeId (string)
corridorProductScheduleId (string)
utils/get_corridor_integration_by_integration_idListar corredores por integraçãointegrationId (string)
utils/get_corridor_schedule_by_corridor_id_integration_by_integration_idHorários de corredor por integraçãocorridorId (string)
integrationId (string)
utils/post_corridor_schedule_by_corridor_id_integration_by_integration_idCriar horários de corredor por integraçãocorridorId (string)
integrationId (string)
data: {
. schedule_details (array)
} (object) required
utils/put_corridor_schedule_by_corridor_id_integration_by_integration_idAtualizar horários de corredor por integraçãocorridorId (string)
integrationId (string)
data: {
. schedule_details (array)
} (object) required
utils/delete_corridor_schedule_by_corridor_id_integration_by_integration_id_by_corridor_product_schedule_idDeletar horário de corredor integraçãocorridorId (string)
integrationId (string)
corridorProductScheduleId (string)
utils/get_product_corridor_by_corridor_id_store_by_store_idListar produtos do corredor em uma lojacorridorId (string)
storeId (string)
utils/get_product_schedule_by_product_id_corridor_by_corridor_id_store_by_store_idHorários de disponibilidade de produtoproductId (string)
corridorId (string)
storeId (string)
utils/post_product_schedule_by_product_id_corridor_by_corridor_id_store_by_store_idCriar horários de produtoproductId (string)
corridorId (string)
storeId (string)
data: {
. schedule_details (array)
} (object) required
utils/put_product_schedule_by_product_id_corridor_by_corridor_id_store_by_store_idAtualizar horários de produtoproductId (string)
corridorId (string)
storeId (string)
data: {
. schedule_details (array)
} (object) required
utils/delete_product_schedule_by_product_id_corridor_by_corridor_id_store_by_store_id_by_corridor_product_schedule_idDeletar horário de produtoproductId (string)
corridorId (string)
storeId (string)
corridorProductScheduleId (string)
utils/get_sku_corridor_by_corridor_id_integration_by_integration_idListar SKUs por corredor e integraçãocorridorId (string)
integrationId (string)
utils/get_sku_schedule_by_sku_corridor_by_corridor_id_integration_by_integration_idHorários de disponibilidade de SKUsku (string)
corridorId (string)
integrationId (string)
utils/post_sku_schedule_by_sku_corridor_by_corridor_id_integration_by_integration_idCriar horários de SKUsku (string)
corridorId (string)
integrationId (string)
data: {
. schedule_details (array)
} (object) required
utils/put_sku_schedule_by_sku_corridor_by_corridor_id_integration_by_integration_idAtualizar horários de SKUsku (string)
corridorId (string)
integrationId (string)
data: {
. schedule_details (array)
} (object) required
utils/delete_sku_schedule_by_sku_corridor_by_corridor_id_integration_by_integration_id_by_corridor_product_schedule_idDeletar horário de SKUsku (string)
corridorId (string)
integrationId (string)
corridorProductScheduleId (string)
utils/get_menu_integration_by_integration_idRecupera o cardápio com produtos e toppings incluindo status e disponibilidade.integrationId (string)
utils/get_store_schedule_by_store_idHorários regulares da lojastoreId (string)
utils/post_store_schedule_by_store_idCriar período de horário regularstoreId (string)
data: {
. days (string)
. starts_time (string)
. ends_time (string)
} (object) required
utils/get_store_schedule_by_store_id_holidayFeriados da lojastoreId (string)
utils/post_store_schedule_by_store_id_holiday_by_holiday_day_idCriar período em feriadostoreId (string)
holidayDayId (string)
data: {
. days (string)
. starts_time (string)
. ends_time (string)
} (object) required
utils/get_store_schedule_by_store_id_specialDias especiais da lojastoreId (string)
utils/post_store_schedule_by_store_id_specialCriar dia especialstoreId (string)
data (object) required
utils/post_store_schedule_by_store_id_special_by_special_day_idCriar período em dia especialstoreId (string)
specialDayId (string)
data: {
. days (string)
. starts_time (string)
. ends_time (string)
} (object) required
utils/delete_store_schedule_by_store_id_special_by_special_day_idRemover dia especialstoreId (string)
specialDayId (string)
utils/put_store_schedule_by_store_id_by_store_schedule_idAtualizar período de horáriostoreId (string)
storeScheduleId (string)
data: {
. days (string)
. starts_time (string)
. ends_time (string)
} (object) required
utils/delete_store_schedule_by_store_id_by_store_schedule_idRemover período de horáriostoreId (string)
storeScheduleId (string)
utils/customCall 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
_headers (object)
financial/get_stores_by_store_id_storesRetorna a lista de IDs de lojas associadas às credenciais da API.storeId (string)
financial/get_stores_by_store_id_paymentsRecupera informações de pagamento agrupadas por período.storeId (string)
financial/get_stores_by_store_id_ordersRecupera pedidos com breakdown de faturamento itens, comissões, taxas, descontos.storeId (string)
financial/get_stores_by_store_id_order_adjusmentsRecupera ajustes a nível de pedido com descrições.storeId (string)
financial/get_stores_by_store_id_charged_cancellationsRecupera cancelamentos cobrados à loja com percentual e descrição.storeId (string)
financial/get_stores_by_store_id_store_adjustmentsAjustes a nível de lojastoreId (string)
financial/get_stores_by_store_id_loansRecupera deduções de parcelas de empréstimo.storeId (string)
financial/get_stores_by_store_id_debtsRecupera dívidas pendentes de períodos anteriores.storeId (string)
financial/get_stores_by_store_id_extrasRecupera cobranças por operações de marketing ads, descontos.storeId (string)
financial/get_stores_by_store_id_taxesRecupera devoluções de impostos e retenções ênfase em IRRF.storeId (string)
financial/get_stores_by_store_id_compensationsRecupera compensações por disputas atribuídas ao parceiro.storeId (string)
financial/get_stores_by_store_id_cancellationsRecupera cancelamentos de pedidos não pagos com motivos e códigos.storeId (string)
financial/get_stores_by_store_id_agreementsRecupera condições contratuais usadas para o cálculo de pagamentos.storeId (string)
financial/customCall 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
_headers (object)

Webhook Events​

This connector emits 10 events back to your workflow. To receive one, create a hook whose path is <connection-name>/<event> — the connection name you configured plus the event from the table below.

EventDescription
new-orderEvento de criação do pedido. Dispara quando um novo pedido é recebido.
new-order-scheduledNotifica quando pedidos agendados são liberados para as lojas herda o payload de NEW_ORDER.
order-event-cancelNotifica cancelamento de pedido.
order-other-eventNotifica eventos adicionais relacionados ao pedido ex.: atualização do entregador, ETA.
menu-approvedSinaliza que o cardápio foi aprovado.
menu-rejectedSinaliza que o cardápio foi rejeitado.
pingHealth-check periódico do Rappi. O endpoint deve responder 'status':'OK' em 200.
store-connectivityReporta mudanças no status de disponibilidade/conectividade da loja.
order-rt-trackingFornece dados em tempo real da localização/ETA do entregador.
store-provisioning-statusNotifica a conclusão do provisionamento/despovoamento em lote das lojas.