Rhino-Rack REST API Documentation

Welcome to the Rhino-Rack REST API documentation. Here you’ll find details about our API and a complete list of available endpoints. If you have any problems or requests please contact digital-support@rhinorack.com.au at any time.

Access

HTTP Basic Authentication

Methods

[ Jump to Models ]

Products

Vehicles

Products

get /{culture}/v1/categories

(categories)

Path parameters

culture (required)

Path Parameter — the culture required

Return type

ListOfCategories

Example data

Content-Type: application/json

{
  "categories" : [ {
    "children" : [ {
      "children" : [ {
        "imageUrl" : "imageUrl",
        "title" : "title",
        "categoryId" : "categoryId"
      }, {
        "imageUrl" : "imageUrl",
        "title" : "title",
        "categoryId" : "categoryId"
      } ],
      "imageUrl" : "imageUrl",
      "title" : "title",
      "categoryId" : "categoryId"
    }, {
      "children" : [ {
        "imageUrl" : "imageUrl",
        "title" : "title",
        "categoryId" : "categoryId"
      }, {
        "imageUrl" : "imageUrl",
        "title" : "title",
        "categoryId" : "categoryId"
      } ],
      "imageUrl" : "imageUrl",
      "title" : "title",
      "categoryId" : "categoryId"
    } ],
    "imageUrl" : "imageUrl",
    "title" : "title",
    "categoryId" : "categoryId"
  }, {
    "children" : [ {
      "children" : [ {
        "imageUrl" : "imageUrl",
        "title" : "title",
        "categoryId" : "categoryId"
      }, {
        "imageUrl" : "imageUrl",
        "title" : "title",
        "categoryId" : "categoryId"
      } ],
      "imageUrl" : "imageUrl",
      "title" : "title",
      "categoryId" : "categoryId"
    }, {
      "children" : [ {
        "imageUrl" : "imageUrl",
        "title" : "title",
        "categoryId" : "categoryId"
      }, {
        "imageUrl" : "imageUrl",
        "title" : "title",
        "categoryId" : "categoryId"
      } ],
      "imageUrl" : "imageUrl",
      "title" : "title",
      "categoryId" : "categoryId"
    } ],
    "imageUrl" : "imageUrl",
    "title" : "title",
    "categoryId" : "categoryId"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

OK (successfully authenticated) ListOfCategories

401

Authentication information is missing or invalid

default

Unexpected error

get /{culture}/v1/product_search

(productSearch)

Path parameters

culture (required)

Path Parameter — the culture required

Query parameters

query (required)

Query Parameter — the query term required , min 2 characters

Return type

ListOfAllSearchResults

Example data

Content-Type: application/json

{
  "product_search" : [ {
    "shortDescription" : "shortDescription",
    "title" : "title",
    "stockCode" : "stockCode",
    "defaultImage" : "defaultImage"
  }, {
    "shortDescription" : "shortDescription",
    "title" : "title",
    "stockCode" : "stockCode",
    "defaultImage" : "defaultImage"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

OK (successfully authenticated) ListOfAllSearchResults

401

Authentication information is missing or invalid

422

Unprocessable Entry Exception

default

Unexpected error

get /{culture}/v1/products

(products)

Path parameters

culture (required)

Path Parameter — the culture required

Query parameters

codes (optional)

Query Parameter — comma delimited list of stockcodes

categories (optional)

Query Parameter — comma delimited list of categories UUIDs

page (optional)

Query Parameter — pagination index default: 1

Return type

ListOfProducts

Example data

Content-Type: application/json

{
  "products" : [ {
    "first_page_url" : "first_page_url",
    "path" : "path",
    "per_page" : 5,
    "total" : 7,
    "data" : [ {
      "productFeatures" : "productFeatures",
      "components" : [ {
        "qty" : 6,
        "stockCode" : "stockCode"
      }, {
        "qty" : 6,
        "stockCode" : "stockCode"
      } ],
      "price" : "price",
      "shortDescription" : "shortDescription",
      "categories" : [ "categories", "categories" ],
      "title" : "title",
      "specifications" : { },
      "stockCode" : "stockCode",
      "defaultImage" : "defaultImage"
    }, {
      "productFeatures" : "productFeatures",
      "components" : [ {
        "qty" : 6,
        "stockCode" : "stockCode"
      }, {
        "qty" : 6,
        "stockCode" : "stockCode"
      } ],
      "price" : "price",
      "shortDescription" : "shortDescription",
      "categories" : [ "categories", "categories" ],
      "title" : "title",
      "specifications" : { },
      "stockCode" : "stockCode",
      "defaultImage" : "defaultImage"
    } ],
    "last_page" : 5,
    "last_page_url" : "last_page_url",
    "next_page_url" : "next_page_url",
    "from" : 1,
    "to" : 2,
    "prev_page_url" : "prev_page_url",
    "current_page" : 0
  }, {
    "first_page_url" : "first_page_url",
    "path" : "path",
    "per_page" : 5,
    "total" : 7,
    "data" : [ {
      "productFeatures" : "productFeatures",
      "components" : [ {
        "qty" : 6,
        "stockCode" : "stockCode"
      }, {
        "qty" : 6,
        "stockCode" : "stockCode"
      } ],
      "price" : "price",
      "shortDescription" : "shortDescription",
      "categories" : [ "categories", "categories" ],
      "title" : "title",
      "specifications" : { },
      "stockCode" : "stockCode",
      "defaultImage" : "defaultImage"
    }, {
      "productFeatures" : "productFeatures",
      "components" : [ {
        "qty" : 6,
        "stockCode" : "stockCode"
      }, {
        "qty" : 6,
        "stockCode" : "stockCode"
      } ],
      "price" : "price",
      "shortDescription" : "shortDescription",
      "categories" : [ "categories", "categories" ],
      "title" : "title",
      "specifications" : { },
      "stockCode" : "stockCode",
      "defaultImage" : "defaultImage"
    } ],
    "last_page" : 5,
    "last_page_url" : "last_page_url",
    "next_page_url" : "next_page_url",
    "from" : 1,
    "to" : 2,
    "prev_page_url" : "prev_page_url",
    "current_page" : 0
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

OK (successfully authenticated) ListOfProducts

401

Authentication information is missing or invalid

default

Unexpected error

Vehicles

get /{culture}/v1/all_vehicles

(allVehicles)

Path parameters

culture (required)

Path Parameter — the culture required

Return type

ListOfAllVehicles

Example data

Content-Type: application/json

{
  "manufacturers" : [ {
    "models" : [ {
      "modelId" : "modelId",
      "vehicles" : [ {
        "doors" : 0,
        "bodyType" : "bodyType",
        "endDate" : "endDate",
        "model" : "model",
        "attributes" : "attributes",
        "vehicleId" : "vehicleId",
        "title" : "title",
        "startDate" : "startDate",
        "products" : "products"
      }, {
        "doors" : 0,
        "bodyType" : "bodyType",
        "endDate" : "endDate",
        "model" : "model",
        "attributes" : "attributes",
        "vehicleId" : "vehicleId",
        "title" : "title",
        "startDate" : "startDate",
        "products" : "products"
      } ],
      "title" : "title"
    }, {
      "modelId" : "modelId",
      "vehicles" : [ {
        "doors" : 0,
        "bodyType" : "bodyType",
        "endDate" : "endDate",
        "model" : "model",
        "attributes" : "attributes",
        "vehicleId" : "vehicleId",
        "title" : "title",
        "startDate" : "startDate",
        "products" : "products"
      }, {
        "doors" : 0,
        "bodyType" : "bodyType",
        "endDate" : "endDate",
        "model" : "model",
        "attributes" : "attributes",
        "vehicleId" : "vehicleId",
        "title" : "title",
        "startDate" : "startDate",
        "products" : "products"
      } ],
      "title" : "title"
    } ],
    "manufacturerId" : "manufacturerId",
    "title" : "title"
  }, {
    "models" : [ {
      "modelId" : "modelId",
      "vehicles" : [ {
        "doors" : 0,
        "bodyType" : "bodyType",
        "endDate" : "endDate",
        "model" : "model",
        "attributes" : "attributes",
        "vehicleId" : "vehicleId",
        "title" : "title",
        "startDate" : "startDate",
        "products" : "products"
      }, {
        "doors" : 0,
        "bodyType" : "bodyType",
        "endDate" : "endDate",
        "model" : "model",
        "attributes" : "attributes",
        "vehicleId" : "vehicleId",
        "title" : "title",
        "startDate" : "startDate",
        "products" : "products"
      } ],
      "title" : "title"
    }, {
      "modelId" : "modelId",
      "vehicles" : [ {
        "doors" : 0,
        "bodyType" : "bodyType",
        "endDate" : "endDate",
        "model" : "model",
        "attributes" : "attributes",
        "vehicleId" : "vehicleId",
        "title" : "title",
        "startDate" : "startDate",
        "products" : "products"
      }, {
        "doors" : 0,
        "bodyType" : "bodyType",
        "endDate" : "endDate",
        "model" : "model",
        "attributes" : "attributes",
        "vehicleId" : "vehicleId",
        "title" : "title",
        "startDate" : "startDate",
        "products" : "products"
      } ],
      "title" : "title"
    } ],
    "manufacturerId" : "manufacturerId",
    "title" : "title"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

OK (successfully authenticated) ListOfAllVehicles

401

Authentication information is missing or invalid

default

Unexpected error

get /{culture}/v1/vehicles/manufacturers

(manufacturers)

Path parameters

culture (required)

Path Parameter — the culture required

Return type

ListOfManufacturers

Example data

Content-Type: application/json

{
  "manufacturers" : [ {
    "manufacturerId" : "manufacturerId",
    "title" : "title",
    "logoUrl" : "logoUrl"
  }, {
    "manufacturerId" : "manufacturerId",
    "title" : "title",
    "logoUrl" : "logoUrl"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

OK (successfully authenticated) ListOfManufacturers

401

Authentication information is missing or invalid

default

Unexpected error

get /{culture}/v1/vehicles/models

(models)

Path parameters

culture (required)

Path Parameter — the culture required

Query parameters

manufacturerId (required)

Query Parameter — the manufacturer UUID required

Return type

ListOfModels

Example data

Content-Type: application/json

{
  "models" : [ {
    "modelId" : "modelId",
    "title" : "title"
  }, {
    "modelId" : "modelId",
    "title" : "title"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

OK (successfully authenticated) ListOfModels

401

Authentication information is missing or invalid

404

not found Exception

422

Unprocessable Entry Exception

default

Unexpected error

get /{culture}/v1/vehicles/vehicles

(vehicles)

Path parameters

culture (required)

Path Parameter — the culture required

Query parameters

modelId (required)

Query Parameter — the model UUID required

Return type

ListOfVehicles

Example data

Content-Type: application/json

{
  "vehicles" : [ {
    "doors" : 0,
    "bodyType" : "bodyType",
    "endDate" : "endDate",
    "model" : "model",
    "attributes" : "attributes",
    "title" : "title",
    "startDate" : "startDate",
    "products" : "products"
  }, {
    "doors" : 0,
    "bodyType" : "bodyType",
    "endDate" : "endDate",
    "model" : "model",
    "attributes" : "attributes",
    "title" : "title",
    "startDate" : "startDate",
    "products" : "products"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

OK (successfully authenticated) ListOfVehicles

401

Authentication information is missing or invalid

404

not found Exception

422

Unprocessable Entry Exception

default

Unexpected error

Models

[ Jump to Methods ]

`Cultures` Up

`Exception` Up

message (optional)

String

errors (optional)

Object

`ListOfAllSearchResults` Up

product_search (optional)

array[ListOfAllSearchResults_product_search]

`ListOfAllSearchResults_product_search` Up

stockCode (optional)

String The product stockcode.

title (optional)

String The product name.

defaultImage (optional)

String The product image url.

shortDescription (optional)

String The product description.

`ListOfAllVehicles` Up

manufacturers (optional)

array[ListOfAllVehicles_manufacturers]

`ListOfAllVehicles_manufacturers` Up

manufacturerId (optional)

String The manufacturer UUID.

title (optional)

String The model name.

models (optional)

array[ListOfAllVehicles_models] List of models for this manufacturer.

`ListOfAllVehicles_models` Up

modelId (optional)

String Model UUID

title (optional)

String Model name

vehicles (optional)

array[ListOfAllVehicles_vehicles] List of Vehicles for this Model

`ListOfAllVehicles_vehicles` Up

vehicleId (optional)

String The vehicle UUID.

title (optional)

String The vehicle name.

model (optional)

String The vehicle model.

doors (optional)

Integer The vehicle door num.

bodyType (optional)

String The vehicle body trype.

attributes (optional)

String The vehicle attributes.

startDate (optional)

String The vehicle start date.

endDate (optional)

String The vehicle end date.

products (optional)

String The vehicle's roof rack's stockcodes and load rates.

`ListOfCategories` Up

categories (optional)

array[ListOfCategories_categories]

`ListOfCategories_categories` Up

categoryId (optional)

String Category UUID

title (optional)

String Category name

imageUrl (optional)

String Category image url

children (optional)

array[ListOfCategories_children_1]

`ListOfCategories_children` Up

categoryId (optional)

String Category UUID

title (optional)

String Category name

imageUrl (optional)

String Category image url

`ListOfCategories_children_1` Up

categoryId (optional)

String Category UUID

title (optional)

String Category name

imageUrl (optional)

String Category image url

children (optional)

array[ListOfCategories_children]

`ListOfManufacturers` Up

manufacturers (optional)

array[ListOfManufacturers_manufacturers]

`ListOfManufacturers_manufacturers` Up

manufacturerId (optional)

String The manufacturer UUID.

title (optional)

String The manufacturer name.

logoUrl (optional)

String The log url.

`ListOfModels` Up

models (optional)

array[ListOfModels_models]

`ListOfModels_models` Up

modelId (optional)

String The model UUID.

title (optional)

String The model name.

`ListOfProducts` Up

products (optional)

array[ListOfProducts_products]

`ListOfProducts_components` Up

stockCode (optional)

String The product part stockcode.

qty (optional)

Integer The number product parts in package.

`ListOfProducts_data` Up

stockCode (optional)

String The product stock code.

title (optional)

String The product name.

shortDescription (optional)

String The product outline.

productFeatures (optional)

String The product long outline.

defaultImage (optional)

String The product main image url.

price (optional)

String The product price.

components (optional)

array[ListOfProducts_components] The product list of parts.

categories (optional)

array[String] The product category list.

specifications (optional)

Object The product's specs.

`ListOfProducts_products` Up

current_page (optional)

Integer The pagination index

data (optional)

array[ListOfProducts_data]

first_page_url (optional)

String The pagination first page url

from (optional)

Integer The pagination start index

last_page (optional)

Integer The pagination lat page index

last_page_url (optional)

String The pagination last page url]

next_page_url (optional)

String The pagination next page url

path (optional)

String The pagination path

per_page (optional)

Integer The pagination per page

prev_page_url (optional)

String The pagination prev page url

to (optional)

Integer The pagination lastpage index

total (optional)

Integer The pagination total

`ListOfVehicles` Up

vehicles (optional)

array[ListOfVehicles_vehicles]

`ListOfVehicles_vehicles` Up

title (optional)

String The vehicle name.

model (optional)

String The vehicle model.

doors (optional)

Integer The vehicle door num.

bodyType (optional)

String The vehicle body trype.

attributes (optional)

String The vehicle attributes.

startDate (optional)

String The vehicle start date.

endDate (optional)

String The vehicle end date.

products (optional)

String The vehicle's roof rack's stockcodes and load rates.

Rhino-Rack REST API Documentation

Access

Methods

Table of Contents

Products

Vehicles

Products

Path parameters

Return type

Example data

Produces

Responses

200

401

default

Path parameters

Query parameters

Return type

Example data

Produces

Responses

200

401

422

default

Path parameters

Query parameters

Return type

Example data

Produces

Responses

200

401

default

Vehicles

Path parameters

Return type

Example data

Produces

Responses

200

401

default

Path parameters

Return type

Example data

Produces

Responses

200

401

default

Path parameters

Query parameters

Return type

Example data

Produces

Responses

200

401

404

422

default

Path parameters

Query parameters

Return type

Example data

Produces

Responses

200

401

404

422

default

Models

Table of Contents

Cultures Up

Exception Up

ListOfAllSearchResults Up

ListOfAllSearchResults_product_search Up

ListOfAllVehicles Up

`Cultures` Up

`Exception` Up

`ListOfAllSearchResults` Up

`ListOfAllSearchResults_product_search` Up

`ListOfAllVehicles` Up

`ListOfAllVehicles_manufacturers` Up

`ListOfAllVehicles_models` Up

`ListOfAllVehicles_vehicles` Up

`ListOfCategories` Up

`ListOfCategories_categories` Up

`ListOfCategories_children` Up

`ListOfCategories_children_1` Up

`ListOfManufacturers` Up

`ListOfManufacturers_manufacturers` Up

`ListOfModels` Up

`ListOfModels_models` Up

`ListOfProducts` Up

`ListOfProducts_components` Up

`ListOfProducts_data` Up

`ListOfProducts_products` Up

`ListOfVehicles` Up

`ListOfVehicles_vehicles` Up