products

Get a product

Returns a single product.

GET

/v1/products/{id}

Get a product

curl --request GET \
  --url https://api.beamdynamics.io/v1/products/{id} \
  --header 'beam-api-key: <api-key>'

{
  "product": {
    "bundles": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "category": {
      "color": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "countryOfOrigin": "<string>",
    "createdAt": "<string>",
    "customFields": {},
    "description": "<string>",
    "dimensions": [
      {
        "depth": 123,
        "dimensionUnitId": "<string>",
        "dimensionUnitName": "<string>",
        "height": 123,
        "id": "<string>",
        "weight": 123,
        "weightUnitId": "<string>",
        "weightUnitName": "<string>",
        "width": 123
      }
    ],
    "id": "<string>",
    "imageUrl": "<string>",
    "isActive": true,
    "manufacturer": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "modelNumber": "<string>",
    "name": "<string>",
    "productCode": "<string>",
    "productId": "<string>",
    "rentalRate": 123,
    "rentalRateType": "daily",
    "replacementCost": 123,
    "retailPrice": 123,
    "stockQnt": 123,
    "stockType": "serializable",
    "studioId": "<string>",
    "studioManufacturerId": "<string>",
    "tags": [
      {
        "description": "<string>",
        "id": "<string>",
        "name": "<string>",
        "tagCategory": {
          "color": "<string>",
          "description": "<string>",
          "id": "<string>",
          "name": "<string>"
        }
      }
    ],
    "totalAccessories": 123,
    "totalSubstitutions": 123,
    "updatedAt": "<string>",
    "url": "<string>",
    "wontMatchReason": "accessory"
  }
}

Authorizations

beam-api-keystringheaderrequired

Path Parameters

idstringrequired

Response

The product

productobjectrequired

Show child attributes

Still need help? Ask the team