Operaciones de la API Financial.

Devuelve una lista de pagos filtrados por tienda y por período de pago con información del comerciante y detalles de cada pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v1/stores/{store_id}/payments

{COUNTRY_DOMAIN}: Este es tu dominio país Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuesta	JSON
Requisitos de autenticación	Token

Parámetros

Este endpoint admite los siguientes parámetros:

Parámetro	Path	Query	Descripción
store_id	X		El identificador único de la tienda solicitada.
page_number		X	Número de páginas que desea obtener
page_size		X	El tamaño máximo de entradas en respuestas paginadas
payment_id:eq		X	El payment_id debe ser igual a su valor
expected_execution_date:gte		X	El expected_execution_date debe ser mayor o igual a su valor
expect_execution_date:lte		X	El confirmed_payment_date debe ser menor o igual a su valor
confirmed_payment_date:gte		X	El confirmed_payment_date debe ser mayor o igual a su valor
confirmed_payment_date:lte		X	El confirmed_payment_date debe ser menor o igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/payments

este es un ejemplo de la solicitud:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/payments");

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");

try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) {
  StringBuilder response = new StringBuilder();
  String responseLine;
  while ((responseLine = br.readLine()) != null) {
    response.append(responseLine.trim());
  }
  System.out.println("Response body: " + response.toString());
}
System.out.println("Response Code : " + connection.getResponseCode());

Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{
  "page_number": 1,
  "page_size": 10,
  "order_by": "string",
  "order_type": "string",
  "total_pages": 0,
  "total_entries": 0,
  "entries": [
    {
      "id": 1000,
      "status": "string",
      "period_date_start": "2023-11-07T22:02:47.009Z",
      "period_date_end": "2023-11-07T22:02:47.009Z",
      "expected_execution_date": "2023-11-07T22:02:47.009Z",
      "confirmed_payment_date": "2023-11-07T22:02:47.009Z",
      "total_amount": 0,
      "payment_reference": "string",
      "frequecy_type": "string",
      "frequecy_type_descripcion": "string",
      "balance_request_id": "string",
      "bank_account": {
        "bank_name": "string",
        "account_number": "string",
        "bank_code": "string",
        "account_type": "string",
        "ispb": "string",
        "document": {
          "identification_type": "string",
          "identification_number": "string",
          "holder_name": "string"
        }
      },
      "consolidated_stores": [1000]
    }
  ]
}

Devuelve una lista de pedidos por pago o por tienda y un período de pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v1/stores/{store_id}/orders

{COUNTRY_DOMAIN}: Este es tu dominio país Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuesta	JSON
Requisitos de autenticación	Token

Parámetros

Este endpoint admite los siguientes parámetros:

Parámetro	Path	Query	Descripción
store_id	X		El identificador único de la tienda solicitada.
page_number		X	Número de páginas que desea obtener
page_size		X	El tamaño máximo de entradas en respuestas paginadas.
order_date:gte		X	El order_date debe ser mayor o igual a su valor
order_date:lte		X	El order_date debe ser menor o igual a su valor
order_status:eq		X	El order_status debe ser igual a su valor
payment_id:eq		X	El payment_id debe ser igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/orders

este es un ejemplo de la solicitud:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/orders");

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");

try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) {
  StringBuilder response = new StringBuilder();
  String responseLine;
  while ((responseLine = br.readLine()) != null) {
    response.append(responseLine.trim());
  }
  System.out.println("Response body: " + response.toString());
}
System.out.println("Response Code : " + connection.getResponseCode());

Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{
  "page_number": 1,
  "page_size": 10,
  "order_by": "string",
  "order_type": "string",
  "total_pages": 0,
  "total_entries": 0,
  "entries": [
    {
      "id": 0,
      "payment_id": 0,
      "order_date": "2023-11-07T23:01:44.394Z",
      "store_id": 0,
      "store_name": "string",
      "store_type": "string",
      "order_status": "string",
      "payment_method": "string",
      "is_prime": "string",
      "items": [
        {
          "name": "string",
          "units": "string"
        }
      ],
      "amount": 0,
      "billing": {
        "total_order": 0,
        "comission_product": 0,
        "cofins": 0,
        "pis": 0,
        "iss": 0,
        "income_tax": 0,
        "compensation": 0,
        "discount_by_marketplace_in_cash": 0,
        "total_order_whim": 0,
        "free_shipping": 0,
        "other_discounts": 0,
        "meal_voucher": 0,
        "marketplace_fee_no_cash": 0,
        "global_offer_coupon": 0,
        "paid_by_user": 0,
        "commission_whim": 0,
        "rappi_credits_cash_back": 0,
        "service_fee": 0,
        "shipping_partner_no_limit": 0,
        "shipping_partner_limit": 0,
        "marketplace_charge": 0
      }
    }
  ]
}

Devuelve una lista de ajustes de pedidos por pago o por tienda y un período de pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v1/stores/{store_id}/order_adjusments

{COUNTRY_DOMAIN}: Este es tu dominio país Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuesta	JSON
Requisitos de autenticación	Token

Parámetros

Este endpoint admite los siguientes parámetros:

Parámetro	Path	Query	Descripción
store_id	X		El identificador único de la tienda solicitada.
page_number		X	Número de páginas que desea obtener
page_size		X	El tamaño máximo de entradas en respuestas paginadas
order_date:gte		X	El order_date debe ser mayor o igual a su valor
order_date:lte		X	El order_date debe ser menor o igual a su valor
order_status:eq		X	El order_status debe ser igual a su valor
payment_id:eq		X	El payment_id debe ser igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint.:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/order_adjusments

este es un ejemplo de la solicitud:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/order_adjusments");

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");

try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) {
  StringBuilder response = new StringBuilder();
  String responseLine;
  while ((responseLine = br.readLine()) != null) {
    response.append(responseLine.trim());
  }
  System.out.println("Response body: " + response.toString());
}
System.out.println("Response Code : " + connection.getResponseCode());

Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{
  "page_number": 1,
  "page_size": 10,
  "order_by": "string",
  "order_type": "string",
  "total_pages": 0,
  "total_entries": 0,
  "entries": [
    {
      "id": 0,
      "payment_id": 0,
      "order_date": "2023-11-07T23:03:55.722Z",
      "store_id": 0,
      "store_name": "string",
      "store_type": "string",
      "order_status": "string",
      "payment_method": "string",
      "is_prime": "string",
      "items": [
        {
          "name": "string",
          "units": "string"
        }
      ],
      "amount": 0,
      "billing": {
        "total_order": 0,
        "comission_product": 0,
        "cofins": 0,
        "pis": 0,
        "iss": 0,
        "income_tax": 0,
        "compensation": 0,
        "discount_by_marketplace_in_cash": 0,
        "total_order_whim": 0,
        "free_shipping": 0,
        "other_discounts": 0,
        "meal_voucher": 0,
        "marketplace_fee_no_cash": 0,
        "global_offer_coupon": 0,
        "paid_by_user": 0,
        "commission_whim": 0,
        "rappi_credits_cash_back": 0,
        "service_fee": 0,
        "shipping_partner_no_limit": 0,
        "shipping_partner_limit": 0,
        "marketplace_charge": 0
      },
      "descriptionAdjustment": "string"
    }
  ]
}

Devuelve una lista de cancelaciones (pedidos) y su detalle por pago o por tienda y un periodo de pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v1/stores/{store_id}/charged_cancellations

{COUNTRY_DOMAIN}: Este es tu dominio país Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuesta	JSON
Requisitos de autenticación	Token

Parámetros

Este endpoint admite los siguientes parámetros:

Parámetro	Path	Query	Descripción
store_id	X		El identificador único de la tienda solicitada.
page_number		X	Número de páginas que desea obtener
page_size		X	El tamaño máximo de entradas en respuestas paginadas
payment_id:eq		X	El payment_id debe ser igual a su valor
order_date:gte		X	El order_date debe ser mayor o igual a su valor
order_date:lte		X	El order_date debe ser menor o igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/charged_cancellations

este es un ejemplo de la solicitud:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/charged_cancellations");

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");

try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) {
  StringBuilder response = new StringBuilder();
  String responseLine;
  while ((responseLine = br.readLine()) != null) {
    response.append(responseLine.trim());
  }
  System.out.println("Response body: " + response.toString());
}
System.out.println("Response Code : " + connection.getResponseCode());

Ejemplo de Respuesta

Este es un ejemplo de la respuesta.:

{
  "page_number": 1,
  "page_size": 10,
  "order_by": "string",
  "order_type": "string",
  "total_pages": 0,
  "total_entries": 0,
  "entries": [
    {
      "id": 0,
      "payment_id": 0,
      "order_date": "2023-11-07T23:09:48.153Z",
      "store_id": 0,
      "store_name": "string",
      "store_type": "string",
      "order_status": "string",
      "payment_method": "string",
      "is_prime": "string",
      "items": [
        {
          "name": "string",
          "units": "string"
        }
      ],
      "amount": 0,
      "billing": {
        "total_order": 0,
        "comission_product": 0,
        "cofins": 0,
        "pis": 0,
        "iss": 0,
        "income_tax": 0,
        "compensation": 0,
        "discount_by_marketplace_in_cash": 0,
        "total_order_whim": 0,
        "free_shipping": 0,
        "other_discounts": 0,
        "meal_voucher": 0,
        "marketplace_fee_no_cash": 0,
        "global_offer_coupon": 0,
        "paid_by_user": 0,
        "commission_whim": 0,
        "rappi_credits_cash_back": 0,
        "service_fee": 0,
        "shipping_partner_no_limit": 0,
        "shipping_partner_limit": 0,
        "marketplace_charge": 0
      },
      "cancellatioPercentage": "string",
      "descriptionCancellation": "string",
      "cancellation_code": "string",
      "cancellation_description": "string"
    }
  ]
}

Devuelve una lista de ajustes de tienda por pago o por tienda y un período de pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v1/stores/{store_id}/store_adjustments

{COUNTRY_DOMAIN}: Este es tu dominio país Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuesta	JSON
Requisitos de autenticación	Token

Parámetros

Este endpoint admite los siguientes parámetros:

Parámetro	Path	Query	Descripción
store_id	X		El identificador único de la tienda solicitada.
page_number		X	Número de páginas que desea obtener
page_size		X	El tamaño máximo de entradas en respuestas paginadas.
payment_id:eq		X	El payment_id debe ser igual a su valor
created_at:gte		X	El created_at debe ser mayor o igual a su valor
created_at:lte		X	El created_at debe ser menor o igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/store_adjustments

este es un ejemplo de la solicitud:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/store_adjustments");

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");

try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) {
  StringBuilder response = new StringBuilder();
  String responseLine;
  while ((responseLine = br.readLine()) != null) {
    response.append(responseLine.trim());
  }
  System.out.println("Response body: " + response.toString());
}
System.out.println("Response Code : " + connection.getResponseCode());

Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{
  "page_number": 1,
  "page_size": 10,
  "order_by": "string",
  "order_type": "string",
  "total_pages": 0,
  "total_entries": 0,
  "entries": [
    {
      "id": 0,
      "description": "string",
      "amount": 0,
      "created_at": "2023-11-07",
      "payment_id": 0,
      "store_id": 0,
      "description_reason": "string"
    }
  ]
}

Devuelve una lista de cuotas de préstamos por pago o por tienda y un período de pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v1/stores/{store_id}/loans

{COUNTRY_DOMAIN}: Este es tu dominio país Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuesta	JSON
Requisitos de autenticación	Token

Parámetros

Este endpoint admite los siguientes parámetros:

Parámetro	Path	Query	Descripción
store_id	X		El identificador único de la tienda solicitada
page_number		X	Número de páginas que desea obtener
page_size		X	El tamaño máximo de entradas en respuestas paginadas
payment_id:eq		X	El payment_id debe ser igual a su valor
created_at:gte		X	El created_at debe ser mayor o igual a su valor
created_at:lte		X	El created_at debe ser menor o igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/loans

este es un ejemplo de la solicitud:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/loans");

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");

try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) {
  StringBuilder response = new StringBuilder();
  String responseLine;
  while ((responseLine = br.readLine()) != null) {
    response.append(responseLine.trim());
  }
  System.out.println("Response body: " + response.toString());
}
System.out.println("Response Code : " + connection.getResponseCode());

Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{
  "page_number": 1,
  "page_size": 10,
  "order_by": "string",
  "order_type": "string",
  "total_pages": 0,
  "total_entries": 0,
  "entries": [
    {
      "id": 0,
      "description_type": "string",
      "balance": 0,
      "frequency": 0,
      "created_at": "2023-11-07",
      "currency": "string",
      "disbursement_date": "2023-11-07",
      "disbursement_amount": 0,
      "deadline": "2023-11-07",
      "reason": "string",
      "stores": ["string"],
      "type": "string",
      "installment_amount": 0,
      "installment_percentage": 0,
      "lastCollection_date": "2023-11-07",
      "amortization": "string",
      "installments": {
        "installment_amount": 0,
        "installment_created_at": "2023-11-07",
        "store_id": 0,
        "payment_id": 0
      }
    }
  ]
}

Devuelve información de deudas pendientes de periodos pasados por pago o por tienda y un periodo de pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v1/stores/{store_id}/debts

{COUNTRY_DOMAIN}: Este es tu dominio país de Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuesta	JSON
Requisitos de autenticación	Token

Parámetros

Este endpoint admite los siguientes parámetros:

Parámetro	Path	Query	Descripción
store_id	X		El identificador único de la tienda solicitada
page_number		X	Número de páginas que desea obtener
page_size		X	El tamaño máximo de entradas en respuestas paginadas
payment_id:eq		X	The payment_id debe ser igual a su valor
created_at:gte		X	The created_at debe ser mayor o igual a su valor
created_at:lte		X	The created_at debe ser menor o igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/debts

este es un ejemplo de la solicitud:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/debts");

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");

try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) {
  StringBuilder response = new StringBuilder();
  String responseLine;
  while ((responseLine = br.readLine()) != null) {
    response.append(responseLine.trim());
  }
  System.out.println("Response body: " + response.toString());
}
System.out.println("Response Code : " + connection.getResponseCode());

Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{
  "page_number": 1,
  "page_size": 10,
  "order_by": "string",
  "order_type": "string",
  "total_pages": 0,
  "total_entries": 0,
  "entries": [
    {
      "id": 0,
      "description": "string",
      "payment_debt": 0,
      "payment_paid": 0,
      "store_id": "string",
      "amount": 0,
      "created_at": "2023-11-07"
    }
  ]
}

Devuelve un listado de cargos extras (tarifas, descuentos, otros) por pago o por tienda y un periodo de pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v1/stores/{store_id}/extras

{COUNTRY_DOMAIN}: Este es tu dominio país de Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuesta	JSON
Requisitos de autenticación	Token

Parámetros

Este endpoint admite los siguientes parámetros:

Parámetro	Path	Query	Descripción
store_id	X		El identificador único de la tienda solicitada
page_number		X	Número de páginas que desea obtener
page_size		X	El tamaño máximo de entradas en respuestas paginadas
payment_id:eq		X	The payment_id debe ser igual a su valor
created_at:gte		X	The created_at debe ser mayor o igual a su valor
created_at:lte		X	The created_at debe ser menor o igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/extras

este es un ejemplo de la solicitud:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/extras");

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");

try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) {
  StringBuilder response = new StringBuilder();
  String responseLine;
  while ((responseLine = br.readLine()) != null) {
    response.append(responseLine.trim());
  }
  System.out.println("Response body: " + response.toString());
}
System.out.println("Response Code : " + connection.getResponseCode());

Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{
  "page_number": 1,
  "page_size": 10,
  "order_by": "string",
  "order_type": "string",
  "total_pages": 0,
  "total_entries": 0,
  "entries": [
    {
      "id": 0,
      "reason": "string",
      "description": "string",
      "amount": 0,
      "store_id": 0,
      "payment_id": 0,
      "created_at": "2023-11-07"
    }
  ]
}

Devuelve una lista de impuestos por pago o por tienda y un período de pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v1/stores/{store_id}/taxes

{COUNTRY_DOMAIN}: Este es tu dominio país de Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuesta	JSON
Requisitos de autenticación	Token

Parámetros

Este endpoint admite los siguientes parámetros:

Parámetro	Path	Query	Descripción
store_id	X		El identificador único de la tienda solicitada
page_number		X	Número de páginas que desea obtener
page_size		X	El tamaño máximo de entradas en respuestas paginadas
payment_id:eq		X	El payment_id debe ser igual a su valor
created_at:gte		X	El created_at debe ser mayor o igual a su valor
created_at:lte		X	El created_at debe ser menor o igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/taxes

este es un ejemplo de la solicitud:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/taxes");

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");

try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) {
  StringBuilder response = new StringBuilder();
  String responseLine;
  while ((responseLine = br.readLine()) != null) {
    response.append(responseLine.trim());
  }
  System.out.println("Response body: " + response.toString());
}
System.out.println("Response Code : " + connection.getResponseCode());

Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{
  "page_number": 1,
  "page_size": 10,
  "order_by": "string",
  "order_type": "string",
  "total_pages": 0,
  "total_entries": 0,
  "entries": [
    {
      "id": 0,
      "reason": "string",
      "description": "string",
      "amount": 0,
      "store_id": 0,
      "payment_id": 0,
      "created_at": "2023-11-07",
      "flow_name": "string"
    }
  ]
}

Devuelve una lista de compensaciones y su detalle por pago o por tienda y un periodo de pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v1/stores/{store_id}/compensations

{COUNTRY_DOMAIN}: Este es tu dominio país de Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuesta	JSON
Requisitos de autenticación	Token

Parámetros

Este endpoint admite los siguientes parámetros:

Parámetro	Path	Query	Descripción
store_id	X		El identificador único de la tienda solicitada
page_number		X	Número de páginas que desea obtener
page_size		X	El tamaño máximo de entradas en respuestas paginadas
created_at:gte		X	El created_at debe ser mayor o igual a su valor
created_at:lte		X	El created_at debe ser menor o igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/compensations

este es un ejemplo de la solicitud:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/compensations");

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");

try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) {
  StringBuilder response = new StringBuilder();
  String responseLine;
  while ((responseLine = br.readLine()) != null) {
    response.append(responseLine.trim());
  }
  System.out.println("Response body: " + response.toString());
}
System.out.println("Response Code : " + connection.getResponseCode());

Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{
  "page_number": 1,
  "page_size": 10,
  "order_by": "string",
  "order_type": "string",
  "total_pages": 0,
  "total_entries": 0,
  "entries": [
    {
      "id": 0,
      "payment_id": 0,
      "order_date": "2023-11-07",
      "store_id": 0,
      "store_name": "string",
      "store_type": "string",
      "order_status": "string",
      "amount": 0,
      "comments": "string",
      "created_at": "2023-11-07",
      "order_id": 0,
      "product_ids": [
        {
          "product_id": 0,
          "units": "string"
        }
      ],
      "reason": "string"
    }
  ]
}

Devuelve una lista de cancelaciones (pedidos) por tienda y un período de pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v1/stores/{store_id}/cancellations

{COUNTRY_DOMAIN}: Este es tu dominio país de Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuesta	JSON
Requisitos de autenticación	Token

Parámetros

Este endpoint admite los siguientes parámetros:

Parámetro	Path	Query	Descripción
store_id	X		El identificador único de la tienda solicitada
page_number		X	Número de páginas que desea obtener
page_size		X	El tamaño máximo de entradas en respuestas paginadas
cancellation_date:gte		X	El cancellation_date debe ser mayor o igual a su valor
cancellation_date:lte		X	El cancellation_date debe ser menor o igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/cancellations

este es un ejemplo de la solicitud:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/cancellations");

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");

try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) {
  StringBuilder response = new StringBuilder();
  String responseLine;
  while ((responseLine = br.readLine()) != null) {
    response.append(responseLine.trim());
  }
  System.out.println("Response body: " + response.toString());
}
System.out.println("Response Code : " + connection.getResponseCode());

Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{
  "page_number": 1,
  "page_size": 10,
  "order_by": "string",
  "order_type": "string",
  "total_pages": 0,
  "total_entries": 0,
  "entries": [
    {
      "order_id": 0,
      "cancellation_date": "2023-11-07T23:35:38.537Z",
      "order_date": "2023-11-07T23:35:38.537Z",
      "store_id": 0,
      "store_name": "string",
      "store_type": "string",
      "order_status": "string",
      "payment_method": "string",
      "cancellation_code": "string",
      "cancellation_description": "string",
      "amount": 0,
      "is_prime": "string"
    }
  ]
}

Devuelve información sobre las condiciones del contrato que subyacen a los importes cobrados por cada concepto dentro de un pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v1/stores/{store_id}/agreements

{COUNTRY_DOMAIN}: Este es tu dominio país de Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuesta	JSON
Requisitos de autenticación	Token

Parámetros

Este endpoint admite los siguientes parámetros:

Parámetro	Path	Query	Descripción
store_id	X		El identificador único de la tienda solicitada
page_number		X	Número de páginas que desea obtener
page_size		X	El tamaño máximo de entradas en respuestas paginadas
created_at:gte		X	El created_at debe ser mayor o igual a su valor
created_at:lte		X	El created_at debe ser menor o igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/agreements

este es un ejemplo de la solicitud:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v1/stores/1234/agreements");

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");

try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) {
  StringBuilder response = new StringBuilder();
  String responseLine;
  while ((responseLine = br.readLine()) != null) {
    response.append(responseLine.trim());
  }
  System.out.println("Response body: " + response.toString());
}
System.out.println("Response Code : " + connection.getResponseCode());

Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{
  "page_number": 1,
  "page_size": 10,
  "order_by": "string",
  "order_type": "string",
  "total_pages": 0,
  "total_entries": 0,
  "entries": [
    {
      "contracted_plan": "string",
      "application_fnfo": {
        "name": "string",
        "document_number": "string",
        "corporate_name": "string",
        "state_registration": "string",
        "municipal_registration": "string",
        "address": {
          "country": "string",
          "state": "string",
          "city": "string",
          "district": "string",
          "street": "string",
          "number": "string",
          "zipCode": "string",
          "complement": "string",
          "reference": "string"
        },
        "contact_fnfo": {
          "contact_email": "user@example.com",
          "contact_phone": "string",
          "contact_name": "string"
        }
      },
      "store_info": {
        "store_id": "string",
        "type": "string",
        "document": "string",
        "name": "string",
        "corporate_name": "string",
        "is_marketplace": true,
        "address": {
          "city": "string"
        }
      },
      "contract_info": {
        "frequency_type": "string",
        "contract_term": {
          "start_date": "2023-11-07",
          "end_date": "2023-11-07"
        }
      },
      "conditions": [
        {
          "name": "string",
          "commision": "string"
        }
      ]
    }
  ]
}

Devuelve una lista de pagos filtrados por tienda y por período de pago con información del comerciante y detalles de cada pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v2/stores/{store_id}/payments

{COUNTRY_DOMAIN}: Este es tu dominio país Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuesta	JSON
Requisitos de autenticación	Token

Parámetros

Este endpoint admite los siguientes parámetros:

Parámetro	Path	Query	Descripción
store_id	X		El identificador único de la tienda solicitada.
page_number		X	Número de páginas que desea obtener
page_size		X	El tamaño máximo de entradas en respuestas paginadas
payment_id:eq		X	El payment_id debe ser igual a su valor
expected_execution_date:gte		X	El expected_execution_date debe ser mayor o igual a su valor
expect_execution_date:lte		X	El confirmed_payment_date debe ser menor o igual a su valor
confirmed_payment_date:gte		X	El confirmed_payment_date debe ser mayor o igual a su valor
confirmed_payment_date:lte		X	El confirmed_payment_date debe ser menor o igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v2/stores/1234/payments

este es un ejemplo de la solicitud:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v2/stores/1234/payments");

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");

try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) {
  StringBuilder response = new StringBuilder();
  String responseLine;
  while ((responseLine = br.readLine()) != null) {
    response.append(responseLine.trim());
  }
  System.out.println("Response body: " + response.toString());
}
System.out.println("Response Code : " + connection.getResponseCode());

Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{
  "page_number": 1,
  "page_size": 10,
  "order_by": "string",
  "order_type": "string",
  "total_pages": 0,
  "total_entries": 0,
  "entries": [
    {
      "id": 1000,
      "status": "string",
      "period_date_start": "2023-11-07T22:02:47.009Z",
      "period_date_end": "2023-11-07T22:02:47.009Z",
      "expected_execution_date": "2023-11-07T22:02:47.009Z",
      "confirmed_payment_date": "2023-11-07T22:02:47.009Z",
      "total_amount": 0,
      "payment_reference": "string",
      "frequecy_type": "string",
      "frequecy_type_descripcion": "string",
      "balance_request_id": "string",
      "bank_account": {
        "bank_name": "string",
        "account_number": "string",
        "bank_code": "string",
        "account_type": "string",
        "ispb": "string",
        "document": {
          "identification_type": "string",
          "identification_number": "string",
          "holder_name": "string"
        }
      },
      "consolidated_stores": [1000]
    }
  ]
}

Campos de Respuesta

Campo	Tipo	Descripción
id	integer	Identificador único del pago
status	string	Estado del pago
period_date_start	datetime	Fecha de inicio del período de pago
period_date_end	datetime	Fecha de fin del período de pago
expected_execution_date	datetime	Fecha esperada de ejecución del pago
confirmed_payment_date	datetime	Fecha confirmada del pago
total_amount	number	Monto total del pago
payment_reference	string	Referencia del pago
frequecy_type	string	Tipo de frecuencia de pago
frequecy_type_descripcion	string	Descripción del tipo de frecuencia
balance_request_id	string	ID de la solicitud de balance
bank_account	object	Información de la cuenta bancaria
bank_account.bank_name	string	Nombre del banco
bank_account.account_number	string	Número de cuenta
bank_account.bank_code	string	Código del banco
bank_account.account_type	string	Tipo de cuenta
bank_account.ispb	string	Código ISPB (Brasil)
bank_account.document.identification_type	string	Tipo de documento de identificación
bank_account.document.identification_number	string	Número de documento
bank_account.document.holder_name	string	Nombre del titular
consolidated_stores	array	Lista de tiendas consolidadas en el pago

Devuelve una lista de pedidos por pago o por tienda y un período de pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v2/stores/{store_id}/orders

{COUNTRY_DOMAIN}: Este es tu dominio país Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuesta	JSON
Requisitos de autenticación	Token

Parámetros

Este endpoint admite los siguientes parámetros:

Parámetro	Path	Query	Descripción
store_id	X		El identificador único de la tienda solicitada.
page_number		X	Número de páginas que desea obtener
page_size		X	El tamaño máximo de entradas en respuestas paginadas.
order_date:gte		X	El order_date debe ser mayor o igual a su valor
order_date:lte		X	El order_date debe ser menor o igual a su valor
order_status:eq		X	El order_status debe ser igual a su valor
payment_id:eq		X	El payment_id debe ser igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v2/stores/1234/orders

este es un ejemplo de la solicitud:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v2/stores/1234/orders");

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");

try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) {
  StringBuilder response = new StringBuilder();
  String responseLine;
  while ((responseLine = br.readLine()) != null) {
    response.append(responseLine.trim());
  }
  System.out.println("Response body: " + response.toString());
}
System.out.println("Response Code : " + connection.getResponseCode());

Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{
  "page_number": 1,
  "page_size": 10,
  "order_by": "string",
  "order_type": "string",
  "total_pages": 0,
  "total_entries": 0,
  "entries": [
    {
      "id": 0,
      "payment_id": 0,
      "order_date": "2023-11-07T23:01:44.394Z",
      "store_id": 0,
      "store_name": "string",
      "store_type": "string",
      "order_status": "string",
      "payment_method": "string",
      "is_prime": "string",
      "items": [
        {
          "name": "string",
          "units": "string"
        }
      ],
      "amount": 0,
      "billing": {
        "total_order": 0,
        "comission_product": 0,
        "cofins": 0,
        "pis": 0,
        "iss": 0,
        "income_tax": 0,
        "compensation": 0,
        "discount_by_marketplace_in_cash": 0,
        "total_order_whim": 0,
        "free_shipping": 0,
        "other_discounts": 0,
        "meal_voucher": 0,
        "marketplace_fee_no_cash": 0,
        "global_offer_coupon": 0,
        "paid_by_user": 0,
        "commission_whim": 0,
        "rappi_credits_cash_back": 0,
        "service_fee": 0,
        "shipping_partner_no_limit": 0,
        "shipping_partner_limit": 0,
        "marketplace_charge": 0
      }
    }
  ]
}

Campos de Respuesta

Campo	Tipo	Descripción
id	integer	Identificador único de la orden
payment_id	integer	ID del pago asociado
order_date	datetime	Fecha de la orden
store_id	integer	ID de la tienda
store_name	string	Nombre de la tienda
store_type	string	Tipo de tienda
order_status	string	Estado de la orden
payment_method	string	Método de pago utilizado
is_prime	string	Indica si la orden es de un usuario Prime
items	array	Lista de productos de la orden
items[].name	string	Nombre del producto
items[].units	string	Cantidad de unidades
amount	number	Monto de la orden
billing.total_order	number	Total de la orden
billing.comission_product	number	Comisión por producto
billing.cofins	number	Impuesto COFINS (Brasil)
billing.pis	number	Impuesto PIS (Brasil)
billing.iss	number	Impuesto ISS (Brasil)
billing.income_tax	number	Impuesto sobre la renta
billing.compensation	number	Compensación aplicada
billing.discount_by_marketplace_in_cash	number	Descuento del marketplace en efectivo
billing.total_order_whim	number	Total de la orden Whim
billing.free_shipping	number	Envío gratis aplicado
billing.other_discounts	number	Otros descuentos
billing.meal_voucher	number	Vale de comida
billing.marketplace_fee_no_cash	number	Comisión del marketplace (no efectivo)
billing.global_offer_coupon	number	Cupón de oferta global
billing.paid_by_user	number	Monto pagado por el usuario
billing.commission_whim	number	Comisión Whim
billing.rappi_credits_cash_back	number	Cashback en créditos Rappi
billing.service_fee	number	Tarifa de servicio
billing.shipping_partner_no_limit	number	Envío del partner sin límite
billing.shipping_partner_limit	number	Envío del partner con límite
billing.marketplace_charge	number	Cargo del marketplace

Devuelve una lista de ajustes de pedidos por pago o por tienda y un período de pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v2/stores/{store_id}/order_adjusments

{COUNTRY_DOMAIN}: Este es tu dominio país Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuesta	JSON
Requisitos de autenticación	Token

Parámetros

Este endpoint admite los siguientes parámetros:

Parámetro	Path	Query	Descripción
store_id	X		El identificador único de la tienda solicitada.
page_number		X	Número de páginas que desea obtener
page_size		X	El tamaño máximo de entradas en respuestas paginadas
order_date:gte		X	El order_date debe ser mayor o igual a su valor
order_date:lte		X	El order_date debe ser menor o igual a su valor
order_status:eq		X	El order_status debe ser igual a su valor
payment_id:eq		X	El payment_id debe ser igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint.:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v2/stores/1234/order_adjusments

este es un ejemplo de la solicitud:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v2/stores/1234/order_adjusments");

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");

try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) {
  StringBuilder response = new StringBuilder();
  String responseLine;
  while ((responseLine = br.readLine()) != null) {
    response.append(responseLine.trim());
  }
  System.out.println("Response body: " + response.toString());
}
System.out.println("Response Code : " + connection.getResponseCode());

Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{
  "page_number": 1,
  "page_size": 10,
  "order_by": "string",
  "order_type": "string",
  "total_pages": 0,
  "total_entries": 0,
  "entries": [
    {
      "id": 0,
      "payment_id": 0,
      "order_date": "2023-11-07T23:03:55.722Z",
      "store_id": 0,
      "store_name": "string",
      "store_type": "string",
      "order_status": "string",
      "payment_method": "string",
      "is_prime": "string",
      "items": [
        {
          "name": "string",
          "units": "string"
        }
      ],
      "amount": 0,
      "billing": {
        "total_order": 0,
        "comission_product": 0,
        "cofins": 0,
        "pis": 0,
        "iss": 0,
        "income_tax": 0,
        "compensation": 0,
        "discount_by_marketplace_in_cash": 0,
        "total_order_whim": 0,
        "free_shipping": 0,
        "other_discounts": 0,
        "meal_voucher": 0,
        "marketplace_fee_no_cash": 0,
        "global_offer_coupon": 0,
        "paid_by_user": 0,
        "commission_whim": 0,
        "rappi_credits_cash_back": 0,
        "service_fee": 0,
        "shipping_partner_no_limit": 0,
        "shipping_partner_limit": 0,
        "marketplace_charge": 0
      },
      "descriptionAdjustment": "string"
    }
  ]
}

Campos de Respuesta

Campo	Tipo	Descripción
id	integer	Identificador único de la orden
payment_id	integer	ID del pago asociado
order_date	datetime	Fecha de la orden
store_id	integer	ID de la tienda
store_name	string	Nombre de la tienda
store_type	string	Tipo de tienda
order_status	string	Estado de la orden
payment_method	string	Método de pago utilizado
is_prime	string	Indica si la orden es de un usuario Prime
items	array	Lista de productos de la orden
items[].name	string	Nombre del producto
items[].units	string	Cantidad de unidades
amount	number	Monto de la orden
billing.total_order	number	Total de la orden
billing.comission_product	number	Comisión por producto
billing.cofins	number	Impuesto COFINS (Brasil)
billing.pis	number	Impuesto PIS (Brasil)
billing.iss	number	Impuesto ISS (Brasil)
billing.income_tax	number	Impuesto sobre la renta
billing.compensation	number	Compensación aplicada
billing.discount_by_marketplace_in_cash	number	Descuento del marketplace en efectivo
billing.total_order_whim	number	Total de la orden Whim
billing.free_shipping	number	Envío gratis aplicado
billing.other_discounts	number	Otros descuentos
billing.meal_voucher	number	Vale de comida
billing.marketplace_fee_no_cash	number	Comisión del marketplace (no efectivo)
billing.global_offer_coupon	number	Cupón de oferta global
billing.paid_by_user	number	Monto pagado por el usuario
billing.commission_whim	number	Comisión Whim
billing.rappi_credits_cash_back	number	Cashback en créditos Rappi
billing.service_fee	number	Tarifa de servicio
billing.shipping_partner_no_limit	number	Envío del partner sin límite
billing.shipping_partner_limit	number	Envío del partner con límite
billing.marketplace_charge	number	Cargo del marketplace
descriptionAdjustment	string	Descripción del ajuste aplicado a la orden

Devuelve una lista de cancelaciones (pedidos) y su detalle por pago o por tienda y un periodo de pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v2/stores/{store_id}/charged_cancellations

{COUNTRY_DOMAIN}: Este es tu dominio país Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuesta	JSON
Requisitos de autenticación	Token

Parámetros

Este endpoint admite los siguientes parámetros:

Parámetro	Path	Query	Descripción
store_id	X		El identificador único de la tienda solicitada.
page_number		X	Número de páginas que desea obtener
page_size		X	El tamaño máximo de entradas en respuestas paginadas
payment_id:eq		X	El payment_id debe ser igual a su valor
order_date:gte		X	El order_date debe ser mayor o igual a su valor
order_date:lte		X	El order_date debe ser menor o igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v2/stores/1234/charged_cancellations

este es un ejemplo de la solicitud:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v2/stores/1234/charged_cancellations");

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");

try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) {
  StringBuilder response = new StringBuilder();
  String responseLine;
  while ((responseLine = br.readLine()) != null) {
    response.append(responseLine.trim());
  }
  System.out.println("Response body: " + response.toString());
}
System.out.println("Response Code : " + connection.getResponseCode());

Ejemplo de Respuesta

Este es un ejemplo de la respuesta.:

{
  "page_number": 1,
  "page_size": 10,
  "order_by": "string",
  "order_type": "string",
  "total_pages": 0,
  "total_entries": 0,
  "entries": [
    {
      "id": 0,
      "payment_id": 0,
      "order_date": "2023-11-07T23:09:48.153Z",
      "store_id": 0,
      "store_name": "string",
      "store_type": "string",
      "order_status": "string",
      "payment_method": "string",
      "is_prime": "string",
      "items": [
        {
          "name": "string",
          "units": "string"
        }
      ],
      "amount": 0,
      "billing": {
        "total_order": 0,
        "comission_product": 0,
        "cofins": 0,
        "pis": 0,
        "iss": 0,
        "income_tax": 0,
        "compensation": 0,
        "discount_by_marketplace_in_cash": 0,
        "total_order_whim": 0,
        "free_shipping": 0,
        "other_discounts": 0,
        "meal_voucher": 0,
        "marketplace_fee_no_cash": 0,
        "global_offer_coupon": 0,
        "paid_by_user": 0,
        "commission_whim": 0,
        "rappi_credits_cash_back": 0,
        "service_fee": 0,
        "shipping_partner_no_limit": 0,
        "shipping_partner_limit": 0,
        "marketplace_charge": 0
      },
      "cancellatioPercentage": "string",
      "descriptionCancellation": "string",
      "cancellation_code": "string",
      "cancellation_description": "string"
    }
  ]
}

Campos de Respuesta

Campo	Tipo	Descripción
id	integer	Identificador único de la orden
payment_id	integer	ID del pago asociado
order_date	datetime	Fecha de la orden
store_id	integer	ID de la tienda
store_name	string	Nombre de la tienda
store_type	string	Tipo de tienda
order_status	string	Estado de la orden
payment_method	string	Método de pago utilizado
is_prime	string	Indica si la orden es de un usuario Prime
items	array	Lista de productos de la orden
items[].name	string	Nombre del producto
items[].units	string	Cantidad de unidades
amount	number	Monto de la orden
billing.total_order	number	Total de la orden
billing.comission_product	number	Comisión por producto
billing.cofins	number	Impuesto COFINS (Brasil)
billing.pis	number	Impuesto PIS (Brasil)
billing.iss	number	Impuesto ISS (Brasil)
billing.income_tax	number	Impuesto sobre la renta
billing.compensation	number	Compensación aplicada
billing.discount_by_marketplace_in_cash	number	Descuento del marketplace en efectivo
billing.total_order_whim	number	Total de la orden Whim
billing.free_shipping	number	Envío gratis aplicado
billing.other_discounts	number	Otros descuentos
billing.meal_voucher	number	Vale de comida
billing.marketplace_fee_no_cash	number	Comisión del marketplace (no efectivo)
billing.global_offer_coupon	number	Cupón de oferta global
billing.paid_by_user	number	Monto pagado por el usuario
billing.commission_whim	number	Comisión Whim
billing.rappi_credits_cash_back	number	Cashback en créditos Rappi
billing.service_fee	number	Tarifa de servicio
billing.shipping_partner_no_limit	number	Envío del partner sin límite
billing.shipping_partner_limit	number	Envío del partner con límite
billing.marketplace_charge	number	Cargo del marketplace
cancellatioPercentage	string	Porcentaje de cancelación cobrado
descriptionCancellation	string	Descripción de la cancelación
cancellation_code	string	Código de la cancelación
cancellation_description	string	Descripción del código de cancelación

Devuelve una lista de ajustes de tienda por pago o por tienda y un período de pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v2/stores/{store_id}/store_adjustments

{COUNTRY_DOMAIN}: Este es tu dominio país Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuesta	JSON
Requisitos de autenticación	Token

Parámetros

Este endpoint admite los siguientes parámetros:

Parámetro	Path	Query	Descripción
store_id	X		El identificador único de la tienda solicitada.
page_number		X	Número de páginas que desea obtener
page_size		X	El tamaño máximo de entradas en respuestas paginadas.
payment_id:eq		X	El payment_id debe ser igual a su valor
created_at:gte		X	El created_at debe ser mayor o igual a su valor
created_at:lte		X	El created_at debe ser menor o igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v2/stores/1234/store_adjustments

este es un ejemplo de la solicitud:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v2/stores/1234/store_adjustments");

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");

try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) {
  StringBuilder response = new StringBuilder();
  String responseLine;
  while ((responseLine = br.readLine()) != null) {
    response.append(responseLine.trim());
  }
  System.out.println("Response body: " + response.toString());
}
System.out.println("Response Code : " + connection.getResponseCode());

Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{
  "page_number": 1,
  "page_size": 10,
  "order_by": "string",
  "order_type": "string",
  "total_pages": 0,
  "total_entries": 0,
  "entries": [
    {
      "id": 0,
      "description": "string",
      "amount": 0,
      "created_at": "2023-11-07",
      "payment_id": 0,
      "store_id": 0,
      "description_reason": "string"
    }
  ]
}

Campos de Respuesta

Campo	Tipo	Descripción
id	integer	Identificador único del ajuste
description	string	Descripción del ajuste
amount	number	Monto del ajuste
created_at	date	Fecha de creación
payment_id	integer	ID del pago asociado
store_id	integer	ID de la tienda
description_reason	string	Razón del ajuste

Devuelve una lista de cuotas de préstamos por pago o por tienda y un período de pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v2/stores/{store_id}/loans

{COUNTRY_DOMAIN}: Este es tu dominio país Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuesta	JSON
Requisitos de autenticación	Token

Parámetros

Este endpoint admite los siguientes parámetros:

Parámetro	Path	Query	Descripción
store_id	X		El identificador único de la tienda solicitada
page_number		X	Número de páginas que desea obtener
page_size		X	El tamaño máximo de entradas en respuestas paginadas
payment_id:eq		X	El payment_id debe ser igual a su valor
created_at:gte		X	El created_at debe ser mayor o igual a su valor
created_at:lte		X	El created_at debe ser menor o igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v2/stores/1234/loans

este es un ejemplo de la solicitud:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v2/stores/1234/loans");

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");

try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) {
  StringBuilder response = new StringBuilder();
  String responseLine;
  while ((responseLine = br.readLine()) != null) {
    response.append(responseLine.trim());
  }
  System.out.println("Response body: " + response.toString());
}
System.out.println("Response Code : " + connection.getResponseCode());

Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{
  "page_number": 1,
  "page_size": 10,
  "order_by": "string",
  "order_type": "string",
  "total_pages": 0,
  "total_entries": 0,
  "entries": [
    {
      "id": 0,
      "description_type": "string",
      "balance": 0,
      "frequency": 0,
      "created_at": "2023-11-07",
      "currency": "string",
      "disbursement_date": "2023-11-07",
      "disbursement_amount": 0,
      "deadline": "2023-11-07",
      "reason": "string",
      "stores": ["string"],
      "type": "string",
      "installment_amount": 0,
      "installment_percentage": 0,
      "lastCollection_date": "2023-11-07",
      "amortization": "string",
      "installments": {
        "installment_amount": 0,
        "installment_created_at": "2023-11-07",
        "store_id": 0,
        "payment_id": 0
      }
    }
  ]
}

Campos de Respuesta

Campo	Tipo	Descripción
id	integer	Identificador único del préstamo
description_type	string	Tipo de préstamo
balance	number	Saldo pendiente
frequency	integer	Frecuencia de cobro
created_at	date	Fecha de creación
currency	string	Moneda
disbursement_date	date	Fecha de desembolso
disbursement_amount	number	Monto desembolsado
deadline	date	Fecha límite de pago
reason	string	Razón del préstamo
stores	array	Tiendas asociadas al préstamo
type	string	Tipo
installment_amount	number	Monto de la cuota
installment_percentage	number	Porcentaje de la cuota
lastCollection_date	date	Fecha del último cobro
amortization	string	Tipo de amortización
installments.installment_amount	number	Monto de cada cuota
installments.installment_created_at	date	Fecha de creación de la cuota
installments.store_id	integer	ID de la tienda de la cuota
installments.payment_id	integer	ID del pago de la cuota

Devuelve información de deudas pendientes de periodos pasados por pago o por tienda y un periodo de pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v2/stores/{store_id}/debts

{COUNTRY_DOMAIN}: Este es tu dominio país de Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuesta	JSON
Requisitos de autenticación	Token

Parámetros

Este endpoint admite los siguientes parámetros:

Parámetro	Path	Query	Descripción
store_id	X		El identificador único de la tienda solicitada
page_number		X	Número de páginas que desea obtener
page_size		X	El tamaño máximo de entradas en respuestas paginadas
payment_id:eq		X	The payment_id debe ser igual a su valor
created_at:gte		X	The created_at debe ser mayor o igual a su valor
created_at:lte		X	The created_at debe ser menor o igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v2/stores/1234/debts

este es un ejemplo de la solicitud:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v2/stores/1234/debts");

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");

try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) {
  StringBuilder response = new StringBuilder();
  String responseLine;
  while ((responseLine = br.readLine()) != null) {
    response.append(responseLine.trim());
  }
  System.out.println("Response body: " + response.toString());
}
System.out.println("Response Code : " + connection.getResponseCode());

Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{
  "page_number": 1,
  "page_size": 10,
  "order_by": "string",
  "order_type": "string",
  "total_pages": 0,
  "total_entries": 0,
  "entries": [
    {
      "id": 0,
      "description": "string",
      "payment_debt": 0,
      "payment_paid": 0,
      "store_id": "string",
      "amount": 0,
      "created_at": "2023-11-07"
    }
  ]
}

Campos de Respuesta

Campo	Tipo	Descripción
id	integer	Identificador único de la deuda
description	string	Descripción de la deuda
payment_debt	number	Monto de la deuda
payment_paid	number	Monto pagado de la deuda
store_id	string	ID de la tienda
amount	number	Monto total
created_at	date	Fecha de creación

Devuelve un listado de cargos extras (tarifas, descuentos, otros) por pago o por tienda y un periodo de pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v2/stores/{store_id}/extras

{COUNTRY_DOMAIN}: Este es tu dominio país de Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuesta	JSON
Requisitos de autenticación	Token

Parámetros

Este endpoint admite los siguientes parámetros:

Parámetro	Path	Query	Descripción
store_id	X		El identificador único de la tienda solicitada
page_number		X	Número de páginas que desea obtener
page_size		X	El tamaño máximo de entradas en respuestas paginadas
payment_id:eq		X	The payment_id debe ser igual a su valor
created_at:gte		X	The created_at debe ser mayor o igual a su valor
created_at:lte		X	The created_at debe ser menor o igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v2/stores/1234/extras

este es un ejemplo de la solicitud:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v2/stores/1234/extras");

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");

try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) {
  StringBuilder response = new StringBuilder();
  String responseLine;
  while ((responseLine = br.readLine()) != null) {
    response.append(responseLine.trim());
  }
  System.out.println("Response body: " + response.toString());
}
System.out.println("Response Code : " + connection.getResponseCode());

Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{
  "page_number": 1,
  "page_size": 10,
  "order_by": "string",
  "order_type": "string",
  "total_pages": 0,
  "total_entries": 0,
  "entries": [
    {
      "id": 0,
      "reason": "string",
      "description": "string",
      "amount": 0,
      "store_id": 0,
      "payment_id": 0,
      "created_at": "2023-11-07"
    }
  ]
}

Campos de Respuesta

Campo	Tipo	Descripción
id	integer	Identificador único del cargo extra
reason	string	Razón del cargo
description	string	Descripción del cargo
amount	number	Monto del cargo
store_id	integer	ID de la tienda
payment_id	integer	ID del pago asociado
created_at	date	Fecha de creación

Devuelve una lista de impuestos por pago o por tienda y un período de pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v2/stores/{store_id}/taxes

{COUNTRY_DOMAIN}: Este es tu dominio país de Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuesta	JSON
Requisitos de autenticación	Token

Parámetros

Este endpoint admite los siguientes parámetros:

Parámetro	Path	Query	Descripción
store_id	X		El identificador único de la tienda solicitada
page_number		X	Número de páginas que desea obtener
page_size		X	El tamaño máximo de entradas en respuestas paginadas
payment_id:eq		X	El payment_id debe ser igual a su valor
created_at:gte		X	El created_at debe ser mayor o igual a su valor
created_at:lte		X	El created_at debe ser menor o igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v2/stores/1234/taxes

este es un ejemplo de la solicitud:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v2/stores/1234/taxes");

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");

try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) {
  StringBuilder response = new StringBuilder();
  String responseLine;
  while ((responseLine = br.readLine()) != null) {
    response.append(responseLine.trim());
  }
  System.out.println("Response body: " + response.toString());
}
System.out.println("Response Code : " + connection.getResponseCode());

Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{
  "page_number": 1,
  "page_size": 10,
  "order_by": "string",
  "order_type": "string",
  "total_pages": 0,
  "total_entries": 0,
  "entries": [
    {
      "id": 0,
      "reason": "string",
      "description": "string",
      "amount": 0,
      "store_id": 0,
      "payment_id": 0,
      "created_at": "2023-11-07",
      "flow_name": "string"
    }
  ]
}

Campos de Respuesta

Campo	Tipo	Descripción
id	integer	Identificador único del impuesto
reason	string	Razón del impuesto
description	string	Descripción del impuesto
amount	number	Monto del impuesto
store_id	integer	ID de la tienda
payment_id	integer	ID del pago asociado
created_at	date	Fecha de creación
flow_name	string	Nombre del flujo/concepto fiscal

Devuelve una lista de compensaciones y su detalle por pago o por tienda y un periodo de pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v2/stores/{store_id}/compensations

{COUNTRY_DOMAIN}: Este es tu dominio país de Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuesta	JSON
Requisitos de autenticación	Token

Parámetros

Este endpoint admite los siguientes parámetros:

Parámetro	Path	Query	Descripción
store_id	X		El identificador único de la tienda solicitada
page_number		X	Número de páginas que desea obtener
page_size		X	El tamaño máximo de entradas en respuestas paginadas
created_at:gte		X	El created_at debe ser mayor o igual a su valor
created_at:lte		X	El created_at debe ser menor o igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v2/stores/1234/compensations

este es un ejemplo de la solicitud:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v2/stores/1234/compensations");

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");

try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) {
  StringBuilder response = new StringBuilder();
  String responseLine;
  while ((responseLine = br.readLine()) != null) {
    response.append(responseLine.trim());
  }
  System.out.println("Response body: " + response.toString());
}
System.out.println("Response Code : " + connection.getResponseCode());

Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{
  "page_number": 1,
  "page_size": 10,
  "order_by": "string",
  "order_type": "string",
  "total_pages": 0,
  "total_entries": 0,
  "entries": [
    {
      "id": 0,
      "payment_id": 0,
      "order_date": "2023-11-07",
      "store_id": 0,
      "store_name": "string",
      "store_type": "string",
      "order_status": "string",
      "amount": 0,
      "comments": "string",
      "created_at": "2023-11-07",
      "order_id": 0,
      "product_ids": [
        {
          "product_id": 0,
          "units": "string"
        }
      ],
      "reason": "string"
    }
  ]
}

Campos de Respuesta

Campo	Tipo	Descripción
id	integer	Identificador único de la compensación
payment_id	integer	ID del pago asociado
order_date	date	Fecha de la orden
store_id	integer	ID de la tienda
store_name	string	Nombre de la tienda
store_type	string	Tipo de tienda
order_status	string	Estado de la orden
amount	number	Monto de la compensación
comments	string	Comentarios
created_at	date	Fecha de creación
order_id	integer	ID de la orden asociada
product_ids[].product_id	integer	ID del producto
product_ids[].units	string	Unidades del producto
reason	string	Razón de la compensación

Devuelve una lista de cancelaciones (pedidos) por tienda y un período de pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v2/stores/{store_id}/cancellations

{COUNTRY_DOMAIN}: Este es tu dominio país de Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuesta	JSON
Requisitos de autenticación	Token

Parámetros

Este endpoint admite los siguientes parámetros:

Parámetro	Path	Query	Descripción
store_id	X		El identificador único de la tienda solicitada
page_number		X	Número de páginas que desea obtener
page_size		X	El tamaño máximo de entradas en respuestas paginadas
cancellation_date:gte		X	El cancellation_date debe ser mayor o igual a su valor
cancellation_date:lte		X	El cancellation_date debe ser menor o igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v2/stores/1234/cancellations

este es un ejemplo de la solicitud:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v2/stores/1234/cancellations");

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");

try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) {
  StringBuilder response = new StringBuilder();
  String responseLine;
  while ((responseLine = br.readLine()) != null) {
    response.append(responseLine.trim());
  }
  System.out.println("Response body: " + response.toString());
}
System.out.println("Response Code : " + connection.getResponseCode());

Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{
  "page_number": 1,
  "page_size": 10,
  "order_by": "string",
  "order_type": "string",
  "total_pages": 0,
  "total_entries": 0,
  "entries": [
    {
      "order_id": 0,
      "cancellation_date": "2023-11-07T23:35:38.537Z",
      "order_date": "2023-11-07T23:35:38.537Z",
      "store_id": 0,
      "store_name": "string",
      "store_type": "string",
      "order_status": "string",
      "payment_method": "string",
      "cancellation_code": "string",
      "cancellation_description": "string",
      "amount": 0,
      "is_prime": "string"
    }
  ]
}

Campos de Respuesta

Campo	Tipo	Descripción
order_id	integer	ID de la orden cancelada
cancellation_date	datetime	Fecha de la cancelación
order_date	datetime	Fecha original de la orden
store_id	integer	ID de la tienda
store_name	string	Nombre de la tienda
store_type	string	Tipo de tienda
order_status	string	Estado de la orden
payment_method	string	Método de pago
cancellation_code	string	Código de cancelación
cancellation_description	string	Descripción de la cancelación
amount	number	Monto de la cancelación
is_prime	string	Si la orden era de un usuario Prime

Devuelve información sobre las condiciones del contrato que subyacen a los importes cobrados por cada concepto dentro de un pago.

Endpoint URL

Utilice esta URL para realizar una consulta con este endpoint:

https://{COUNTRY_DOMAIN}/restaurants/finance/v2/stores/{store_id}/agreements

{COUNTRY_DOMAIN}: Este es tu dominio país de Rappi. Ver la lista de Dominios de Países.

Propiedades del Endpoint

Este recurso tiene las siguientes propiedades:

Formatos de respuesta	JSON
Requisitos de autenticación	Token

Parámetros

Este endpoint admite los siguientes parámetros:

Parámetro	Path	Query	Descripción
store_id	X		El identificador único de la tienda solicitada
page_number		X	Número de páginas que desea obtener
page_size		X	El tamaño máximo de entradas en respuestas paginadas
created_at:gte		X	El created_at debe ser mayor o igual a su valor
created_at:lte		X	El created_at debe ser menor o igual a su valor

Códigos de Estados

Estos son los posibles códigos de estado de la respuesta para este endpoint:

Ejemplo de Solicitud

Este es un ejemplo de una solicitud de API utilizando este endpoint:

GET https://api.dev.rappi.com/restaurants/finance/v2/stores/1234/agreements

este es un ejemplo de la solicitud:

javanodepythongo
URL url = new URL("https://api.dev.rappi.com/restaurants/finance/v2/stores/1234/agreements");

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setRequestProperty("User-Agent", "Mozilla/5.0");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("Accept", "application/json");
connection.setRequestProperty("x-authorization", "Bearer YOUR_TOKEN");

try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), StandardCharsets.UTF_8))) {
  StringBuilder response = new StringBuilder();
  String responseLine;
  while ((responseLine = br.readLine()) != null) {
    response.append(responseLine.trim());
  }
  System.out.println("Response body: " + response.toString());
}
System.out.println("Response Code : " + connection.getResponseCode());

Ejemplo de Respuesta

Este es un ejemplo de la respuesta:

{
  "page_number": 1,
  "page_size": 10,
  "order_by": "string",
  "order_type": "string",
  "total_pages": 0,
  "total_entries": 0,
  "entries": [
    {
      "contracted_plan": "string",
      "application_fnfo": {
        "name": "string",
        "document_number": "string",
        "corporate_name": "string",
        "state_registration": "string",
        "municipal_registration": "string",
        "address": {
          "country": "string",
          "state": "string",
          "city": "string",
          "district": "string",
          "street": "string",
          "number": "string",
          "zipCode": "string",
          "complement": "string",
          "reference": "string"
        },
        "contact_fnfo": {
          "contact_email": "user@example.com",
          "contact_phone": "string",
          "contact_name": "string"
        }
      },
      "store_info": {
        "store_id": "string",
        "type": "string",
        "document": "string",
        "name": "string",
        "corporate_name": "string",
        "is_marketplace": true,
        "address": {
          "city": "string"
        }
      },
      "contract_info": {
        "frequency_type": "string",
        "contract_term": {
          "start_date": "2023-11-07",
          "end_date": "2023-11-07"
        }
      },
      "conditions": [
        {
          "name": "string",
          "commision": "string"
        }
      ]
    }
  ]
}

Campos de Respuesta

Campo	Tipo	Descripción
contracted_plan	string	Plan contratado
application_fnfo.name	string	Nombre del aplicante
application_fnfo.document_number	string	Número de documento
application_fnfo.corporate_name	string	Razón social
application_fnfo.state_registration	string	Registro estatal
application_fnfo.municipal_registration	string	Registro municipal
application_fnfo.address.country	string	País
application_fnfo.address.state	string	Estado/Departamento
application_fnfo.address.city	string	Ciudad
application_fnfo.address.district	string	Distrito/Barrio
application_fnfo.address.street	string	Calle
application_fnfo.address.number	string	Número
application_fnfo.address.zipCode	string	Código postal
application_fnfo.address.complement	string	Complemento de dirección
application_fnfo.address.reference	string	Referencia
application_fnfo.contact_fnfo.contact_email	string	Email de contacto
application_fnfo.contact_fnfo.contact_phone	string	Teléfono de contacto
application_fnfo.contact_fnfo.contact_name	string	Nombre de contacto
store_info.store_id	string	ID de la tienda
store_info.type	string	Tipo de tienda
store_info.document	string	Documento de la tienda
store_info.name	string	Nombre de la tienda
store_info.corporate_name	string	Razón social de la tienda
store_info.is_marketplace	boolean	Si es marketplace
store_info.address.city	string	Ciudad de la tienda
contract_info.frequency_type	string	Tipo de frecuencia de pago
contract_info.contract_term.start_date	date	Fecha de inicio del contrato
contract_info.contract_term.end_date	date	Fecha de fin del contrato
conditions[].name	string	Nombre de la condición
conditions[].commision	string	Porcentaje de comisión