API docs by Redocly

Repzo API - Route (1.0.0)

Download OpenAPI specification:Download

OpenAPI specification for Repzo Route endpoints.

Find routes

query Parameters
object

Query parameters for filtering routes

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "next_page_url": "string",
  • "prev_page_url": "string",
  • "path": "string"
}

Create a route

Request Body schema: application/json
name
required
string

Name of the route

rep_id
required
string

ID of the assigned rep

day
required
string
Enum: "sat" "sun" "mon" "tue" "wed" "thu" "fri"

Day of the week for the route

Array of objects

List of clients on this route

disabled
boolean

Whether the route is disabled

object

Integration metadata

company_namespace
required
Array of strings

Company namespaces

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "rep_id": "string",
  • "day": "sat",
  • "clients": [
    ],
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "rep_id": "string",
  • "day": "sat",
  • "clients": [
    ],
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get a route by ID

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "rep_id": "string",
  • "day": "sat",
  • "clients": [
    ],
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Update a route

path Parameters
id
required
string
Request Body schema: application/json
name
string

Name of the route

rep_id
string

ID of the assigned rep

day
string
Enum: "sat" "sun" "mon" "tue" "wed" "thu" "fri"

Day of the week for the route

Array of objects

List of clients on this route

disabled
boolean

Whether the route is disabled

object

Integration metadata

company_namespace
Array of strings

Company namespaces

_id
string

Unique identifier for the route

createdAt
string <date-time>

Creation timestamp

updatedAt
string <date-time>

Last update timestamp

__v
number

Version number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "rep_id": "string",
  • "day": "sat",
  • "clients": [
    ],
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "_id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "rep_id": "string",
  • "day": "sat",
  • "clients": [
    ],
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Remove a route

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "name": "string",
  • "rep_id": "string",
  • "day": "sat",
  • "clients": [
    ],
  • "disabled": true,
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}