inventory

Create an inventory custom field

Creates a custom field for inventory items in the studio the API key is issued for. The name must not already be used by a tag category or location category in the studio.

POST

/v1/inventory/custom-fields

curl --request POST \
  --url https://api.beamdynamics.io/v1/inventory/custom-fields \
  --header 'beam-api-key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "currencyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "defaultValue": "<string>",
  "description": "<string>",
  "isSearchable": true,
  "isUnique": true,
  "name": "<string>",
  "selectValues": [
    {
      "order": 123,
      "value": "<string>"
    }
  ],
  "type": "text"
}
'

{
  "customField": {
    "createdAt": "<string>",
    "currencyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "defaultValue": "<string>",
    "description": "<string>",
    "entityType": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "isSearchable": true,
    "isUnique": true,
    "name": "<string>",
    "selectableValues": [
      {
        "customFieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "order": 123,
        "parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "value": "<string>"
      }
    ],
    "type": "text",
    "updatedAt": "<string>"
  }
}

Authorizations

beam-api-keystringheaderrequired

Body

currencyIdstring | null

defaultValuestring | null

descriptionstring | null

isSearchableboolean

isUniquebooleanrequired

namestringrequired

Minimum string length: 1

selectValuesobject[]

Show child attributes

typeenum<string>required

Available options: text, select, description, date, email, number, checkbox, url, currency, signature, hyperlink

Response

The created custom field

customFieldobjectrequired

Show child attributes

Still need help? Ask the team