Products | Rentals

Get rental products by the id of the source product

post/api/Rentals/GetRentalProductsBySource

Request

  • Base URL: https://api.omnium.no (the document declares no server; this is the origin it was published from)
  • URL: https://api.omnium.no/api/Rentals/GetRentalProductsBySource
  • Auth: API key in header Authorization

Request body

sourceProductSkuIdsstring[] nullable

The source products SKU IDs to find rental products from

storeIdstring nullable

When set only retrieves rental products from the given store.

storeIdsstring[] nullable

When set only retrieves rental products from the given stores. Leave empty to retrieve from all stores.

Response

Rental products found and returned

idstring nullable

Product unique ID

productIdstring nullable

Product ID

skuIdstring nullable

Product SKU ID

eanstring nullable

EAN code

gtinsstring[] nullable

GTIN codes

namestring nullable

Product name

alternativeProductNamestring nullable

Alternative product name

mainImageUrlstring nullable

Product image url

isActiveboolean

True if product is active. False if it should be hidden from customers.

isSkuboolean

True if product is stock keeping unit / product or variant that can be sold

isBundleboolean

True if product is a bundle of other products (unlike package, price is sum of components)

isPackageboolean

True if product is package of other products (unlike bundle, price is specified for package)

isBackorderboolean

If true, the product have no reorder level, and will usually not be in stock

isRentalboolean

If true, the product is available for rental

rentalSourceProductIdstring nullable

The SKU ID of the original product this rental product was created from

catalogstring nullable

Catalog name

catalogNodesstring[] nullable

Catalog nodes (if multiple)

marketIdsstring[] nullable

Market IDs

expectedDeliveryDatestring date-time nullable

Total inventory quantity for all warehouses

costnumber

Product net cost

costInDefaultCurrencynumber nullable

Product cost in default currency

supplierSkuIdstring nullable

External product ID from supplier

supplierNamestring nullable

Name of main product supplier

supplierIdstring nullable

Main supplier ID

averageRatingnumber double

Average rating for product

ratingCountinteger

Number of ratings for the product

brandstring nullable

Product brand

colorstring nullable

Product color

genderstring nullable

Product gender

seasonstring nullable

Product season

countryOfOriginstring nullable

Product country of origin

sizeTypestring nullable

Product size type

weightnumber double nullable

Product weight in kilograms (kg)

unitstring nullable

Product unit, used for describing what unit the quantities are in

sizestring nullable

Product size

parentIdstring nullable

Product parent ID

categoryIdsstring[] nullable

List of category IDs

mainCategoryIdstring nullable

Main category id

mainCategoryNamestring nullable

Main category name

tagsstring[] nullable

List of product tags

shortDescriptionstring nullable

Short product description

productTypestring nullable

Product type which product will inherit properties from

descriptionstring nullable

Product description

specificationstring nullable

Product specification

isMainProductVariantboolean

If true, this variant should represent the product in flattened variant lists

publishedstring date-time nullable

Published datetime.

stopPublishedstring date-time nullable

Product activation end date. Can be null

promotionIdsstring[] nullable

Promotions associated with the product

isVirtualboolean nullable

If true the product inventory status is ignored. Inventory for these products will not be taken into account nor affected by workflow or order management.

storeIdsstring[] nullable

List of available store IDs. If not set, the product will be available for all stores.

leadTimeinteger nullable

Lead time in days

supplierLeadTimeinteger nullable

Supplier lead time in days

sortIndexinteger nullable

Calculated - Used for manual sorting of products (SortIndexBase + SortIndexBoost)

sortIndexBaseinteger nullable

Used for manual sorting of products

sortIndexBoostinteger nullable

Used for manual sorting of products

modifiedstring date-time nullable

Used for manual sorting of products

discontinuedstring date-time nullable

Product discontinuation date. If discontinued date has passed, it should not be reordered from supplier

Changes

No recorded changes to this operation across all 1 revision of this API.