Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Roadsync product API

Product operations (company)

Roadsync product API is one of 18 APIs that Roadsync publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include product. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 2 operations across 1 path, and defines 11 schemas. It is described by OpenAPI 3.0.1, at version 1.8.45.

Requests are made against a single base URL, https://client-api.staging.roadsync.com/{basePath}.

2 operations 1 paths 11 schemas 1 GET1 OPTIONS

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.8.45
Base URL
https://api.roadsync.app/rspay/v1
Authentication
API Key, HTTP Bearer
License
Copyright (c) 2020, RoadSync Inc.
Resource Areas
1

Authentication & Security 2

Roadsync product API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (api_key). It accepts HTTP bearer tokens (JWT) (session_token). By default, every request must be authenticated.

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 OPTIONS. Each is listed below with its method, path, parameters, and response codes.

product 2

Product operations (company)

GET
/product/list
Retrieve a list of products for a location
product_list_get 1 param → 200401403404429500default
OPTIONS
/product/list
product_list_options → 200401403404429500default

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are Product (12 properties), Problem (5 properties), AccountingProduct (2 properties), CodeMessage (2 properties). Each schema is shown below with its type and property counts.

CodeMessage
object
A generic error object generally used for 500 responses
2 properties 2 required
CodeEnum
string
ProductSelectType
string
Message
string
ProductType
string
Problem
object
5 properties
Product
object
12 properties
FeatureType
string
HashedId
string
AccountingProduct
object
2 properties
ProductListResponse

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

roadsync-product-api-openapi.yml Raw ↑

Other APIs Roadsync publishes across the network.

Roadsync authenticated API
Roadsync brokers API
Roadsync department API
Roadsync directory API
Roadsync eta API
Roadsync funding sources API
Roadsync invoice API
Roadsync loads API
Roadsync location API
Roadsync payables API
Roadsync payees API
Roadsync payment API