Skip to content
NimlesNimlesNimles Docs

Get a product

GET
/api/tenant/{tenantId}/Products/{id}
curl --request GET \
  --url https://api.nimles.com/pim/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/Products/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid
tenantId
required
string format: uuid

Your tenant id.

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
fields
object
key
additional properties
string
data
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
relations
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
name
string
nullable
entityId
required
string format: uuid
entityType
required
string
>= 1 characters
relationType
required
string
>= 1 characters
tenantId
string format: uuid
nullable
resourceGroupId
string format: uuid
nullable
creatorId
string format: uuid
nullable
createdDate
string format: date-time
nullable
version
integer format: int32
nullable
lastModified
string format: date-time
nullable
organizationId
string format: uuid
nullable
vehicleId
string format: uuid
publishedDate
string format: date-time
nullable
productType
required
string
nullable
status
required
string
nullable
uniqueName
string
nullable
tags
Array<string>
nullable
listImage
string format: uuid
inventory
object
stockAvailability
string
nullable
nextDeliveryDate
string format: date-time
nullable
numberOfDaysUntilNextDeliveryMin
integer format: int32
nullable
numberOfDaysUntilNextDeliveryMax
integer format: int32
nullable
id
string format: uuid
imageIds
Array<string>
nullable
productGroupIds
Array<string>
nullable
properties
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
productPropertyId
string format: uuid
stringValue
string
nullable
numberValue
number format: double
nullable
value
nullable
values
Array
nullable
publisherId
string format: uuid
nullable
packages
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
weight
number format: double
height
number format: double
length
number format: double
width
number format: double
diameter
number format: double
nullable
quantity
integer format: int32
nullable
gtin
string
nullable
sku
string
nullable
mpn
string
nullable
condition
string
nullable
color
string
nullable
size
string
nullable
sizeType
string
nullable
sizeSystem
string
nullable
minEnergyEfficiencyClass
string
nullable
maxEnergyEfficiencyClass
string
nullable
prices
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
netPrice
number format: double
nullable
grossPrice
number format: double
nullable
vatRate
integer format: int32
nullable
quantityThreshold
integer format: int32
nullable
overridesAll
boolean
nullable
currency
string
nullable
listPrice
number format: double
nullable
purchasePrice
number format: double
nullable
variants
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
name
string
nullable
nameLocalized
object
key
additional properties
string
longName
string
nullable
longNameLocalized
object
key
additional properties
string
additionalName
string
nullable
additionalNameLocalized
object
key
additional properties
string
summary
string
nullable
summaryLocalized
object
key
additional properties
string
description
string
nullable
descriptionLocalized
object
key
additional properties
string
manufacturer
string
nullable
showInLists
boolean
tags
Array<string>
nullable
imageIds
Array<string>
nullable
properties
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
productPropertyId
string format: uuid
stringValue
string
nullable
numberValue
number format: double
nullable
value
nullable
values
Array
nullable
gtin
string
nullable
sku
string
nullable
mpn
string
nullable
condition
string
nullable
color
string
nullable
size
string
nullable
sizeType
string
nullable
sizeSystem
string
nullable
minEnergyEfficiencyClass
string
nullable
maxEnergyEfficiencyClass
string
nullable
listPrice
number format: double
nullable
purchasePrice
number format: double
nullable
price
number format: double
nullable
netPrice
number format: double
nullable
grossPrice
number format: double
nullable
vatRate
integer format: int32
nullable
startDate
string format: date-time
nullable
endDate
string format: date-time
nullable
duration
integer format: int64
nullable
packages
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
weight
number format: double
height
number format: double
length
number format: double
width
number format: double
diameter
number format: double
nullable
quantity
integer format: int32
nullable
prices
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
netPrice
number format: double
nullable
grossPrice
number format: double
nullable
vatRate
integer format: int32
nullable
quantityThreshold
integer format: int32
nullable
overridesAll
boolean
nullable
currency
string
nullable
fits
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
brand
string
nullable
model
string
nullable
startYear
integer format: int32
nullable
endYear
integer format: int32
nullable
ageGroup
string
nullable
gender
string
nullable
attribute1
string
nullable
attribute2
string
nullable
attribute3
string
nullable
shipping
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
deliveryTypeId
string format: uuid
nullable
label
string
nullable
weight
number format: double
nullable
length
number format: double
nullable
width
number format: double
nullable
height
number format: double
nullable
inventory
object
stockAvailability
string
nullable
nextDeliveryDate
string format: date-time
nullable
numberOfDaysUntilNextDeliveryMin
integer format: int32
nullable
numberOfDaysUntilNextDeliveryMax
integer format: int32
nullable
id
string format: uuid
status
string
nullable
uniqueName
string
nullable
multiPack
number format: double
name
string
nullable
nameLocalized
object
key
additional properties
string
longName
string
nullable
longNameLocalized
object
key
additional properties
string
additionalName
string
nullable
additionalNameLocalized
object
key
additional properties
string
summary
string
nullable
summaryLocalized
object
key
additional properties
string
description
string
nullable
descriptionLocalized
object
key
additional properties
string
duration
integer format: int64
nullable
manufacturer
string
nullable
price
number format: double
nullable
netPrice
number format: double
nullable
grossPrice
number format: double
nullable
vatRate
integer format: int32
nullable
isGrossPrice
boolean
startDate
string format: date-time
nullable
endDate
string format: date-time
nullable
fits
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
brand
string
nullable
model
string
nullable
startYear
integer format: int32
nullable
endYear
integer format: int32
nullable
ageGroup
string
nullable
gender
string
nullable
attribute1
string
nullable
attribute2
string
nullable
attribute3
string
nullable
shipping
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
deliveryTypeId
string format: uuid
nullable
label
string
nullable
weight
number format: double
nullable
length
number format: double
nullable
width
number format: double
nullable
height
number format: double
nullable

Example generated

{
  "data": {
    "fields": {
      "additionalProperty": {
        "value": "example",
        "valueType": "example"
      }
    },
    "accessibility": "example",
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "relations": [
      {
        "fields": {
          "additionalProperty": {
            "value": "example",
            "valueType": "example"
          }
        },
        "accessibility": "example",
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "name": "example",
        "entityId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "entityType": "example",
        "relationType": "example"
      }
    ],
    "tenantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "resourceGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "creatorId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "createdDate": "2026-04-15T12:00:00Z",
    "version": 1,
    "lastModified": "2026-04-15T12:00:00Z",
    "organizationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "vehicleId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "publishedDate": "2026-04-15T12:00:00Z",
    "productType": "example",
    "status": "example",
    "uniqueName": "example",
    "tags": [
      "example"
    ],
    "listImage": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "inventory": {
      "stockAvailability": "example",
      "nextDeliveryDate": "2026-04-15T12:00:00Z",
      "numberOfDaysUntilNextDeliveryMin": 1,
      "numberOfDaysUntilNextDeliveryMax": 1,
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    },
    "imageIds": [
      "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    ],
    "productGroupIds": [
      "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    ],
    "properties": [
      {
        "fields": {
          "additionalProperty": {
            "value": "example",
            "valueType": "example"
          }
        },
        "accessibility": "example",
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "productPropertyId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "stringValue": "example",
        "numberValue": 1,
        "value": "example",
        "values": [
          "example"
        ]
      }
    ],
    "publisherId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "packages": [
      {
        "fields": {
          "additionalProperty": {
            "value": "example",
            "valueType": "example"
          }
        },
        "accessibility": "example",
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "weight": 1,
        "height": 1,
        "length": 1,
        "width": 1,
        "diameter": 1,
        "quantity": 1
      }
    ],
    "gtin": "example",
    "sku": "example",
    "mpn": "example",
    "condition": "example",
    "color": "example",
    "size": "example",
    "sizeType": "example",
    "sizeSystem": "example",
    "minEnergyEfficiencyClass": "example",
    "maxEnergyEfficiencyClass": "example",
    "prices": [
      {
        "fields": {
          "additionalProperty": {
            "value": "example",
            "valueType": "example"
          }
        },
        "accessibility": "example",
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "netPrice": 1,
        "grossPrice": 1,
        "vatRate": 1,
        "quantityThreshold": 1,
        "overridesAll": true,
        "currency": "example"
      }
    ],
    "listPrice": 1,
    "purchasePrice": 1,
    "variants": [
      {
        "fields": {
          "additionalProperty": {
            "value": "example",
            "valueType": "example"
          }
        },
        "accessibility": "example",
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "name": "example",
        "nameLocalized": {
          "additionalProperty": "example"
        },
        "longName": "example",
        "longNameLocalized": {
          "additionalProperty": "example"
        },
        "additionalName": "example",
        "additionalNameLocalized": {
          "additionalProperty": "example"
        },
        "summary": "example",
        "summaryLocalized": {
          "additionalProperty": "example"
        },
        "description": "example",
        "descriptionLocalized": {
          "additionalProperty": "example"
        },
        "manufacturer": "example",
        "showInLists": true,
        "tags": [
          "example"
        ],
        "imageIds": [
          "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
        ],
        "properties": [
          {
            "fields": {
              "additionalProperty": {
                "value": "example",
                "valueType": "example"
              }
            },
            "accessibility": "example",
            "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
            "productPropertyId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
            "stringValue": "example",
            "numberValue": 1,
            "value": "example",
            "values": [
              "example"
            ]
          }
        ],
        "gtin": "example",
        "sku": "example",
        "mpn": "example",
        "condition": "example",
        "color": "example",
        "size": "example",
        "sizeType": "example",
        "sizeSystem": "example",
        "minEnergyEfficiencyClass": "example",
        "maxEnergyEfficiencyClass": "example",
        "listPrice": 1,
        "purchasePrice": 1,
        "price": 1,
        "netPrice": 1,
        "grossPrice": 1,
        "vatRate": 1,
        "startDate": "2026-04-15T12:00:00Z",
        "endDate": "2026-04-15T12:00:00Z",
        "duration": 1,
        "packages": [
          {
            "fields": {
              "additionalProperty": {
                "value": "example",
                "valueType": "example"
              }
            },
            "accessibility": "example",
            "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
            "weight": 1,
            "height": 1,
            "length": 1,
            "width": 1,
            "diameter": 1,
            "quantity": 1
          }
        ],
        "prices": [
          {
            "fields": {
              "additionalProperty": {
                "value": "example",
                "valueType": "example"
              }
            },
            "accessibility": "example",
            "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
            "netPrice": 1,
            "grossPrice": 1,
            "vatRate": 1,
            "quantityThreshold": 1,
            "overridesAll": true,
            "currency": "example"
          }
        ],
        "fits": [
          {
            "fields": {
              "additionalProperty": {
                "value": "example",
                "valueType": "example"
              }
            },
            "accessibility": "example",
            "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
            "brand": "example",
            "model": "example",
            "startYear": 1,
            "endYear": 1,
            "ageGroup": "example",
            "gender": "example",
            "attribute1": "example",
            "attribute2": "example",
            "attribute3": "example"
          }
        ],
        "shipping": {
          "fields": {
            "additionalProperty": {
              "value": "example",
              "valueType": "example"
            }
          },
          "accessibility": "example",
          "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
          "deliveryTypeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
          "label": "example",
          "weight": 1,
          "length": 1,
          "width": 1,
          "height": 1
        },
        "inventory": {
          "stockAvailability": "example",
          "nextDeliveryDate": "2026-04-15T12:00:00Z",
          "numberOfDaysUntilNextDeliveryMin": 1,
          "numberOfDaysUntilNextDeliveryMax": 1,
          "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
        },
        "status": "example",
        "uniqueName": "example",
        "multiPack": 1
      }
    ],
    "name": "example",
    "nameLocalized": {
      "additionalProperty": "example"
    },
    "longName": "example",
    "longNameLocalized": {
      "additionalProperty": "example"
    },
    "additionalName": "example",
    "additionalNameLocalized": {
      "additionalProperty": "example"
    },
    "summary": "example",
    "summaryLocalized": {
      "additionalProperty": "example"
    },
    "description": "example",
    "descriptionLocalized": {
      "additionalProperty": "example"
    },
    "duration": 1,
    "manufacturer": "example",
    "price": 1,
    "netPrice": 1,
    "grossPrice": 1,
    "vatRate": 1,
    "isGrossPrice": true,
    "startDate": "2026-04-15T12:00:00Z",
    "endDate": "2026-04-15T12:00:00Z",
    "fits": [
      {
        "fields": {
          "additionalProperty": {
            "value": "example",
            "valueType": "example"
          }
        },
        "accessibility": "example",
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "brand": "example",
        "model": "example",
        "startYear": 1,
        "endYear": 1,
        "ageGroup": "example",
        "gender": "example",
        "attribute1": "example",
        "attribute2": "example",
        "attribute3": "example"
      }
    ],
    "shipping": {
      "fields": {
        "additionalProperty": {
          "value": "example",
          "valueType": "example"
        }
      },
      "accessibility": "example",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "deliveryTypeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "label": "example",
      "weight": 1,
      "length": 1,
      "width": 1,
      "height": 1
    }
  }
}

401

Section titled “401”

Unauthorized: no bearer token, or one that is expired or not for this API.

403

Section titled “403”

Forbidden: the caller holds no role that allows this action at this scope. The body is empty, or a problem whose detail names the action.

Media typeapplication/json

An RFC 9457 problem.

object
detail
string
nullable
instance
string
nullable
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

404

Section titled “404”

Not found: no such item in the tenant.

Media typeapplication/problem+json

An RFC 9457 problem.

object
detail
string
nullable
instance
string
nullable
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}