Get a list of available rental products

get/rental-products
SecuritybearerAuth
Request
query Parameters
page
required
integer <int32> (PageParam) >= 1

Page of results to show

Example: page=1
pageSize
required
integer <int32> (ResultsPerPageParam) [ 1 .. 1000 ]

Results to return per page

Example: pageSize=100
sort
string (SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fields
string (FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
productType
string (StringFilterParam)

Filter by product type

Example: productType=xyz | in:x,y | like:xyz
name
string (StringFilterParam)

Filter by product name

Example: name=xyz | in:x,y | like:xyz
availableFrom
string (DateFilterParam)

Filter by available from date

Example: availableFrom=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
availableTo
string (DateFilterParam)

Filter by available to date

Example: availableTo=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
nominalCode
string (StringFilterParam)

Filter by nominal code

Example: nominalCode=xyz | in:x,y | like:xyz
supplierId
string (IdFilterParam)

Filter by supplier identifier

Example: supplierId=0
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

Response samples
application/json
[
  • {
    • "id": 1,
    • "rentalProductCategoryId": 1,
    • "productType": "PRODUCT",
    • "name": "string",
    • "invoicePresentationName": "string",
    • "parentRentalProductId": 1,
    • "supplierId": 0,
    • "supplierProductNames": [
      • "string"
      ],
    • "taxBandId": 1,
    • "availableFrom": "2019-08-24",
    • "nominalCode": "string",
    • "availableTo": "2019-08-24",
    • "doNotProRate": false,
    • "additionalProductReferenceRequired": false,
    • "additionalProductReferenceFormat": "[a-zA-Z0-9]{4,15}",
    • "linkedUsageProductId": 1,
    • "productReferenceRequired": false,
    • "productReferenceFormat": ".*",
    • "productReferenceMayBeDDIRange": false,
    • "generateWhenParentCreated": false,
    • "customFields": [
      • {
        • "id": 1,
        • "label": "string",
        • "value": "string"
        }
      ]
    }
]