bulk items

Update a bulk item

Updates an existing bulk item.

PATCH

/v1/bulk-items/{id}

Update a bulk item

curl --request PATCH \
  --url https://api.beamdynamics.io/v1/bulk-items/{id} \
  --header 'beam-api-key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "attributes": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "customFields": {},
  "manufacturer": "<string>",
  "maxQuantity": 123,
  "minQuantity": 123,
  "model": "<string>",
  "name": "<string>",
  "purchasedDate": "2023-11-07T05:31:56Z",
  "purchasedPrice": 123,
  "quantity": 1,
  "restockQuantity": 123,
  "tags": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

{
  "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

Body

attributesstring[]

customFieldsobject

manufacturerstring

maxQuantityinteger

Required range: 1 <= x

minQuantityinteger

Required range: 1 <= x

modelstring

namestring

Minimum string length: 1

purchasedDatestring

purchasedPricenumber

quantityintegerdefault:1

Required range: 1 <= x

restockQuantityinteger

Required range: 1 <= x

tagsstring[]

Response

The updated bulk item

bulkItemobjectrequired

Show child attributes

Still need help? Ask the team