bulk items

Get a bulk item

Returns a single bulk item.

GET

/v1/bulk-items/{id}

Get a bulk item

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

{
  "bulkItem": {
    "attributes": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "customFields": {},
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "manufacturer": "<string>",
    "maxQuantity": 123,
    "minQuantity": 123,
    "model": "<string>",
    "name": "<string>",
    "purchasedDate": "2023-11-07T05:31:56Z",
    "purchasedPrice": 123,
    "quantity": 123,
    "restockQuantity": 123,
    "studioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tags": [
      {
        "color": "<string>",
        "description": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "tagCategoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "url": "<string>"
  }
}

Authorizations

beam-api-keystringheaderrequired

Path Parameters

idstringrequired

Response

The bulk item

bulkItemobjectrequired

Show child attributes

Still need help? Ask the team