bulk items

Create a bulk item

Creates a new bulk item.

POST

/v1/bulk-items

Create a bulk item

curl --request POST \
  --url https://api.beamdynamics.io/v1/bulk-items \
  --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"
  ]
}
'

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

Body

attributesstring[]

customFieldsobject

manufacturerstring

maxQuantityinteger

Required range: 1 <= x

minQuantityinteger

Required range: 1 <= x

modelstring

namestringrequired

Minimum string length: 1

purchasedDatestring

purchasedPricenumber

quantityintegerdefault:1

Required range: 1 <= x

restockQuantityinteger

Required range: 1 <= x

tagsstring[]

Response

The created bulk item

attributesstring[]required

customFieldsobjectrequired

idstringrequired

manufacturerstring | nullrequired

maxQuantitynumber | nullrequired

minQuantitynumber | nullrequired

modelstring | nullrequired

namestring | nullrequired

purchasedDatestring | nullrequired

purchasedPricenumber | nullrequired

quantitynumber | nullrequired

restockQuantitynumber | nullrequired

studioIdstring | nullrequired

tagsobject[] | nullrequired

Show child attributes

urlstringrequired

Still need help? Ask the team