Corridor schedules by store ID
Use the Utils resource to manage the Schedules configured in your stores.
The following table describes the different contents of the Schedules Utils resource:
Resource | Description |
---|---|
GET corridor/store/{storeId} | Returns the collection of corridors for the store |
GET corridor/schedule/{corridorId}/store/{storeId} | Returns the corridor schedules configured for the store |
POST corridor/schedule/{corridorId}/store/{storeId} | Create corridor schedules for the store |
PUT corridor/schedule/{corridorId}/store/{storeId} | Update corridor schedules for the store |
DELETE corridor/schedule/{corridorId}/store/{storeId}/{corridorProductScheduleId} | Delete corridor schedules for the store |
GET corridor/store/{storeId}
Use this endpoint to retrieve the collections of corridors configured for your store.
Endpoint URL
Use this URL to make a request with this endpoint:
https://{COUNTRY_DOMAIN}/api/rest-ops-utils/corridor/store/{storeId}
{COUNTRY_DOMAIN}
: Your Rappi Country Domain. See the list of Country Domains.{storeId}
: This is the identifier of your store.
Sample Request
This is an example of an API request using this endpoint:
GET https://microservices.dev.rappi.com/api/rest-ops-utils/corridor/store/999
This is an example of the request:
URL url = new URL("https://microservices.dev.rappi.com/api/rest-ops-utils/corridor/store/999"); 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());
Endpoint Properties
This resource has the following properties:
Response formats | JSON |
Authentication requirements | Token |
Parameters
This endpoint does not permit additional parameters.
Status Codes
These are the possible status codes of the response for this endpoint:
Sample Response
This is an example of the response:
[ { "id": 123, "name": "Bebidas Calientes", "description": "Corredor Bebidas Calientes", "storeId": 999 }, { "id": 321, "name": "Bebidas Frias", "description": "Corredor Bebidas Frias", "storeId": 999 } ]
This table describes the objects contained in the response example:
Response Object | Object Description |
---|---|
id integer | Identifier of the corridor. |
name string | Name of the corridor. |
description string | Description of the corridor . |
storeId integer | Identifier of the store that contains the corridor. (The parent store identifier in case of child store request) |
GET corridor/schedule/{corridorId}/store/{storeId}
Use this endpoint to obtain corridor schedules configured for the store.
Endpoint URL
Use this URL to make a request with this endpoint:
https://{COUNTRY_DOMAIN}/api/rest-ops-utils/corridor/schedule/{corridorId}/store/{storeId}
{COUNTRY_DOMAIN}
: Your Rappi Country Domain. See the list of Country Domains.{storeId}
: This is the identifier of your store.{corridorId}
: This is the identifier of the corridor.
Endpoint Properties
This resource has the following properties:
Response formats | JSON |
Authentication requirements | Token |
Parameters
This endpoint does not permit additional parameters.
Status Codes
These are the possible status codes of the response for this endpoint:
Sample Request
This is an example of an API request using this endpoint:
GET https://microservices.dev.rappi.com/api/rest-ops-utils/corridor/schedule/321/store/999
This is an example of the request:
URL url = new URL("https://microservices.dev.rappi.com/api/rest-ops-utils/corridor/schedule/321/store/999"); 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());
Sample Response
This is an example of the response:
{ "corridor_id": 321, "store_id": 999, "schedule_details": [ { "id": 1, "days": "mon,tue,wed,thu,fri,sat,sun,hol", "starts_time": "08:00:00", "ends_time": "20:00:00" } ] }
This table describes the objects contained in the response example:
Response Object | Object Description |
---|---|
corridor_id integer | Identifier of the corridor. |
store_id integer | Identifier of the store. (The parent store identifier in case of child store request) |
schedule_details array of objects | List of the schedules where corridor must be available. |
schedule_details.id integer | Identifier of the corridor schedule. |
schedule_details.days string | Days of the schedule. Days of the week: "mon,tue,wed,thu,fri,sat,sun", Holidays: "hol". |
schedule_details.starts_time string | A specific time where the corridor begins to be available for users. 24 hour format HH:mm:ss |
schedule_details.ends_time string | A specific time where the corridor becomes unavailable for users. 24 hour format HH:mm:ss |
POST corridor/schedule/{corridorId}/store/{storeId}
Use this endpoint to create schedules for your corridors in the store.
Endpoint URL
Use this URL to make a request with this endpoint:
https://{COUNTRY_DOMAIN}/api/rest-ops-utils/corridor/schedule/{corridorId}/store/{storeId}
{COUNTRY_DOMAIN}
: Your Rappi Country Domain. See the list of Country Domains.{storeId}
: This is the identifier of your store.{corridorId}
: This is the identifier of the corridor.
Endpoint Properties
This resource has the following properties:
Response formats | JSON |
Request body requirements | JSON |
Authentication requirements | Token |
Parameters
This endpoint does not permit additional parameters.
Status Codes
These are the possible status codes of the response for this endpoint:
Sample Request
This is an example of an API request using this endpoint:
POST https://microservices.dev.rappi.com/api/rest-ops-utils/corridor/schedule/123/store/999
This is an example of the request:
{ "schedule_details": [ { "days": "mon,tue,wed,thu,fri,sat,sun", "starts_time": "08:00:00", "ends_time": "20:00:00" }, { "days": "hol", "starts_time": "13:00:00", "ends_time": "22:00:00" } ] }
URL url = new URL("https://microservices.dev.rappi.com/api/rest-ops-utils/corridor/schedule/123/store/999"); HttpURLConnection connection = (HttpURLConnection) url.openConnection(); connection.setRequestMethod("POST"); 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"); connection.setDoOutput(true); String jsonInputString = "{\n" + " \"schedule_details\": [\n" + " {\n" + " \"days\": \"mon,tue,wed,thu,fri,sat,sun\",\n" + " \"starts_time\": \"08:00:00\",\n" + " \"ends_time\": \"20:00:00\"\n" + " },\n" + " {\n" + " \"days\": \"hol\",\n" + " \"starts_time\": \"13:00:00\",\n" + " \"ends_time\": \"22:00:00\"\n" + " }\n" + " ]\n" + "}"; try (OutputStream os = connection.getOutputStream()) { byte[] input = jsonInputString.getBytes(StandardCharsets.UTF_8); os.write(input, 0, input.length); } 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());
This table describes the attributes that the JSON
of your request requires:
Attributes | Requirement | Description |
---|---|---|
schedule_details array of objects | required | List of the schedules for the given corridor. |
schedule_details.days string | required | Days of the schedule. Days of the week: "mon,tue,wed,thu,fri,sat,sun", Holidays: "hol". |
schedule_details.starts_time strings | required | A specific time where the corridor begins to be available for users. 24 hour format HH:mm:ss |
schedule_details.ends_time strings | required | A specific time where the corridor becomes unavailable for users. 24 hour format HH:mm:ss |
Sample Response
This is an example of the response:
{ "corridor_id": 123, "store_id": 999, "schedule_details": [ { "id": 2, "days": "mon,tue,wed,thu,fri,sat,sun", "starts_time": "08:00:00", "ends_time": "20:00:00" }, { "id": 3, "days": "hol", "starts_time": "13:00:00", "ends_time": "22:00:00" } ] }
This table describes the objects contained in the response example:
Response Object | Object Description |
---|---|
corridor_id integer | Identifier of the corridor. |
store_id integer | Identifier of the store. (The parent store identifier in case of child store request) |
schedule_details array of objects | List of the schedules where corridor must be available. |
schedule_details.id integer | Identifier of the corridor schedule. |
schedule_details.days string | Days of the schedule. Days of the week: "mon,tue,wed,thu,fri,sat,sun", Holidays: "hol". |
schedule_details.starts_time string | A specific time where the corridor begins to be available for users. 24 hour format HH:mm:ss |
schedule_details.ends_time string | A specific time where the corridor becomes unavailable for users. 24 hour format HH:mm:ss |
PUT corridor/schedule/{corridorId}/store/{storeId}
Use this endpoint to update schedules for your corridors in the store.
Endpoint URL
Use this URL to make a request with this endpoint:
https://{COUNTRY_DOMAIN}api/rest-ops-utils/corridor/schedule/{corridorId}/store/{storeId}
{COUNTRY_DOMAIN}
: Your Rappi Country Domain. See the list of Country Domains.{storeId}
: This is the identifier of your store.{corridorId}
: This is the identifier of the corridor.
Endpoint Properties
This resource has the following properties:
Response formats | JSON |
Request body requirements | JSON |
Authentication requirements | Token |
Parameters
This endpoint does not permit additional parameters.
Status Codes
These are the possible status codes of the response for this endpoint:
Sample Request
This is an example of an API request using this endpoint:
PUT https://microservices.dev.rappi.com/api/rest-ops-utils/corridor/schedule/123/store/999
This is an example of the request:
{ "schedule_details": [ { "id": 2, "days": "mon,tue,wed,thu,fri,sat,sun", "starts_time": "10:00:00", "ends_time": "16:00:00" } ] }
URL url = new URL("https://microservices.dev.rappi.com/api/rest-ops-utils/corridor/schedule/123/store/999"); HttpURLConnection connection = (HttpURLConnection) url.openConnection(); connection.setRequestMethod("PUT"); 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"); connection.setDoOutput(true); String jsonInputString = "{\n" + " \"schedule_details\": [\n" + " {\n" + " \"id\": 2,\n" + " \"days\": \"mon,tue,wed,thu,fri,sat,sun\",\n" + " \"starts_time\": \"10:00:00\",\n" + " \"ends_time\": \"16:00:00\"\n" + " }\n" + " ]\n" + "}"; try (OutputStream os = connection.getOutputStream()) { byte[] input = jsonInputString.getBytes(StandardCharsets.UTF_8); os.write(input, 0, input.length); } 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());
This table describes the attributes that the JSON
of your request requires:
Attributes | Requirement | Description |
---|---|---|
schedule_details array of objects | required | List of the schedules for the given corridor. |
schedule_details.id integer | required | Identifier of the corridor schedule. |
schedule_details.days string | required | Days of the schedule. Days of the week: "mon,tue,wed,thu,fri,sat,sun", Holidays: "hol". |
schedule_details.starts_time strings | required | A specific time where the corridor begins to be available for users. 24 hour format HH:mm:ss |
schedule_details.ends_time strings | required | A specific time where the corridor becomes unavailable for users. 24 hour format HH:mm:ss |
Sample Response
This is an example of the response:
{ "corridor_id": 123, "store_id": 999, "schedule_details": [ { "id": 2, "days": "mon,tue,wed,thu,fri,sat,sun", "starts_time": "10:00:00", "ends_time": "16:00:00" } ] }
This table describes the objects contained in the response example:
Response Object | Object Description |
---|---|
corridor_id integer | Identifier of the corridor. |
store_id integer | Identifier of the store. (The parent store identifier in case of child store request) |
schedule_details array of objects | List of the schedules where corridor must be available. |
schedule_details.id integer | Identifier of the corridor schedule. |
schedule_details.days string | Days of the schedule. Days of the week: "mon,tue,wed,thu,fri,sat,sun", Holidays: "hol". |
schedule_details.starts_time string | A specific time where the corridor begins to be available for users. 24 hour format HH:mm:ss |
schedule_details.ends_time string | A specific time where the corridor becomes unavailable for users. 24 hour format HH:mm:ss |
DELETE corridor/schedule/{corridorId}/store/{storeId}/{corridorProductScheduleId}
Use this endpoint to delete schedules for your corridors in the store.
Endpoint URL
Use this URL to make a request with this endpoint:
https://{COUNTRY_DOMAIN}api/rest-ops-utils/corridor/schedule/{corridorId}/store/{storeId}/{corridorProductScheduleId}
{COUNTRY_DOMAIN}
: Your Rappi Country Domain. See the list of Country Domains.{corridorProductScheduleId}
: This is the identifier of the corridor schedule.{storeId}
: This is the identifier of your store.{corridorId}
: This is the identifier of the corridor.
Endpoint Properties
This resource has the following properties:
Response formats | JSON |
Authentication requirements | Token |
Parameters
This endpoint does not permit additional parameters.
Status Codes
These are the possible status codes of the response for this endpoint:
Sample Request
This is an example of an API request using this endpoint:
PUT https://microservices.dev.rappi.com/api/rest-ops-utils/corridor/schedule/123/store/999/2541
URL url = new URL("https://microservices.dev.rappi.com/api/rest-ops-utils/corridor/schedule/123/store/999/2541"); HttpURLConnection connection = (HttpURLConnection) url.openConnection(); connection.setRequestMethod("DELETE"); 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"); connection.setDoOutput(true); 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());
Sample Response
This is an example of the response:
{ "corridor_id": 123, "store_id": 999, "schedule_details": [ { "id": 2, "days": "mon,tue,wed,thu,fri,sat,sun", "starts_time": "10:00:00", "ends_time": "16:00:00" } ] }
This table describes the objects contained in the response example:
Response Object | Object Description |
---|---|
corridor_id integer | Identifier of the corridor. |
store_id integer | Identifier of the store. (The parent store identifier in case of child store request) |
schedule_details array of objects | List of corridor schedules that are still available |
schedule_details.id integer | Identifier of the corridor schedule. |
schedule_details.days string | Days of the schedule. Days of the week: "mon,tue,wed,thu,fri,sat,sun", Holidays: "hol". |
schedule_details.starts_time string | A specific time where the corridor begins to be available for users. 24 hour format HH:mm:ss |
schedule_details.ends_time string | A specific time where the corridor becomes unavailable for users. 24 hour format HH:mm:ss |