Corridor schedules by integration 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:

ResourceDescription
GET corridor/integration/{integrationId}Returns the collection of corridors for the store
GET corridor/schedule/{corridorId}/integration/{integrationId}Returns the corridor schedules configured for the store
POST corridor/schedule/{corridorId}/integration/{integrationId}Create corridor schedules for the store
PUT corridor/schedule/{corridorId}/integration/{integrationId}Update corridor schedules for the store
DELETE corridor/schedule/{corridorId}/integration/{integrationId}/{corridorProductScheduleId}Use this endpoint to delete corridor schedules configured for the store.

GET corridor/integration/{integrationId}

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/integration/{integrationId}

Sample Request

This is an example of an API request using this endpoint:

GET https://microservices.dev.rappi.com/api/rest-ops-utils/corridor/integration/888

This is an example of the request:

URL url = new URL("https://microservices.dev.rappi.com/api/rest-ops-utils/corridor/integration/888"); 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 formatsJSON
Authentication requirementsToken

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", "integrationId": "888" }, { "id": 321, "name": "Bebidas Frias", "description": "Corredor Bebidas Frias", "integrationId": "888" } ]

This table describes the objects contained in the response example:

Response ObjectObject Description
id
integer
Identifier of the corridor.
name
string
Name of the corridor.
description
string
Description of the corridor .
integrationId
string
Identifier of the store that contains the corridor. (The parent store identifier in case of child store request)

GET corridor/schedule/{corridorId}/integration/{integrationId}

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}/integration/{integrationId}

  • {COUNTRY_DOMAIN}: Your Rappi Country Domain. See the list of Country Domains.
  • {integrationId}: This is the identifier of your store.
  • {corridorId}: This is the identifier of the corridor.

Endpoint Properties

This resource has the following properties:

Response formatsJSON
Authentication requirementsToken

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/integration/888

This is an example of the request:

URL url = new URL("https://microservices.dev.rappi.com/api/rest-ops-utils/corridor/schedule/321/integration/888"); 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, "integration_id": "888", "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 ObjectObject Description
corridor_id
integer
Identifier of the corridor.
integration_id
string
Identifier of your 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}/integration/{integrationId}

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}/integration/{integrationId}

  • {COUNTRY_DOMAIN}: Your Rappi Country Domain. See the list of Country Domains.
  • {integrationId}: This is the identifier of your store.
  • {corridorId}: This is the identifier of the corridor.

Endpoint Properties

This resource has the following properties:

Response formatsJSON
Request body requirementsJSON
Authentication requirementsToken

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/integration/888

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/integration/888"); 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:

AttributesRequirementDescription
schedule_details
array of objects
requiredList of the schedules for the given corridor.
schedule_details.days
string
requiredDays of the schedule. Days of the week: "mon,tue,wed,thu,fri,sat,sun", Holidays: "hol".
schedule_details.starts_time
strings
requiredA specific time where the corridor begins to be available for users. 24 hour format HH:mm:ss
schedule_details.ends_time
strings
requiredA 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, "integration_id": "888", "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 ObjectObject Description
corridor_id
integer
Identifier of the corridor.
integration_id
string
Identifier of your 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}/integration/{integrationId}

  • {COUNTRY_DOMAIN}: Your Rappi Country Domain. See the list of Country Domains.
  • {integrationId}: This is the identifier of your store.
  • {corridorId}: This is the identifier of the corridor.

Endpoint Properties

This resource has the following properties:

Response formatsJSON
Request body requirementsJSON
Authentication requirementsToken

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/integration/888

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/integration/888"); 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:

AttributesRequirementDescription
schedule_details
array of objects
requiredList of the schedules for the given corridor.
schedule_details.id
integer
requiredIdentifier of the corridor schedule.
schedule_details.days
string
requiredDays of the schedule. Days of the week: "mon,tue,wed,thu,fri,sat,sun", Holidays: "hol".
schedule_details.starts_time
strings
requiredA specific time where the corridor begins to be available for users. 24 hour format HH:mm:ss
schedule_details.ends_time
strings
requiredA 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, "integration_id": "888", "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 ObjectObject Description
corridor_id
integer
Identifier of the corridor.
integration_id
integer
Identifier of your 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}/integration/{integrationId}/{corridorProductScheduleId}

Use this endpoint to delete 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}/integration/{integrationId}/{corridorProductScheduleId}

  • {COUNTRY_DOMAIN}: Your Rappi Country Domain. See the list of Country Domains.
  • {corridorProductScheduleId}: This is the identifier of the corridor schedule.
  • {integrationId}: This is the identifier of your store.
  • {corridorId}: This is the identifier of the corridor.

Endpoint Properties

This resource has the following properties:

Response formatsJSON
Authentication requirementsToken

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:

DELETE https://microservices.dev.rappi.com/api/rest-ops-utils/corridor/schedule/321/integration/888/254

This is an example of the request:

URL url = new URL("https://microservices.dev.rappi.com/api/rest-ops-utils/corridor/schedule/321/integration/888/254"); 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"); 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, "integration_id": "888", "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 ObjectObject Description
corridor_id
integer
Identifier of the corridor.
integration_id
string
Identifier of your 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