Raw schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 190,
"description": "Name, max 190 characters."
},
"type": {
"type": "string",
"enum": [
"item",
"folder"
],
"description": "item = trackable stock; folder = a container."
},
"parent_id": {
"description": "Folder to create it in. Omit/null = root.",
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"price": {
"description": "Unit price.",
"type": [
"number",
"null"
]
},
"quantity": {
"description": "How many you have.",
"type": [
"number",
"null"
]
},
"min_quantity": {
"description": "Minimum level; a Quantity alert can fire when stock reaches it.",
"type": [
"number",
"null"
]
},
"notes": {
"description": "Free-text notes.",
"type": [
"string",
"null"
]
},
"tags": {
"description": "Tag names, e.g. [\"furniture\", \"used\"].",
"type": "array",
"items": {
"type": "string"
}
},
"custom_attribute_values": {
"description": "Custom field values. Look up ids with sortly_list_custom_fields first.",
"type": "array",
"items": {
"type": "object",
"properties": {
"custom_attribute_id": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"description": "Custom field id, from sortly_list_custom_fields."
},
"value": {
"description": "Value to store; null clears it.",
"type": [
"string",
"null"
]
}
},
"required": [
"custom_attribute_id",
"value"
]
}
},
"label_url": {
"description": "Value encoded in the primary QR code / barcode.",
"type": [
"string",
"null"
]
},
"label_url_type": {
"description": "Symbology of the primary code.",
"anyOf": [
{
"type": "string",
"enum": [
"org.gs1.UPC-E",
"org.iso.Code39",
"org.iso.Code39Mod43",
"org.gs1.EAN-13",
"org.gs1.EAN-8",
"com.intermec.Code93",
"org.iso.Code128",
"org.iso.PDF417",
"org.iso.Aztec",
"org.iso.QRCode",
"org.ansi.Interleaved2of5",
"org.iso.DataMatrix",
"com.sortly.textEntry"
]
},
{
"type": "null"
}
]
},
"label_url_extra": {
"description": "Value encoded in the secondary code.",
"type": [
"string",
"null"
]
},
"label_url_extra_type": {
"description": "Symbology of the secondary code.",
"anyOf": [
{
"type": "string",
"enum": [
"org.gs1.UPC-E",
"org.iso.Code39",
"org.iso.Code39Mod43",
"org.gs1.EAN-13",
"org.gs1.EAN-8",
"com.intermec.Code93",
"org.iso.Code128",
"org.iso.PDF417",
"org.iso.Aztec",
"org.iso.QRCode",
"org.ansi.Interleaved2of5",
"org.iso.DataMatrix",
"com.sortly.textEntry"
]
},
{
"type": "null"
}
]
},
"photo_ids": {
"description": "Ids of photos already in the account to attach.",
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"measured_quantity": {
"description": "For items measured in something other than units.",
"type": "object",
"properties": {
"value": {
"type": "number",
"description": "The measured amount."
},
"type": {
"type": "string",
"enum": [
"weight",
"length",
"volume",
"area",
"count"
],
"description": "Kind of measurement; set on create only."
},
"name": {
"type": "string",
"enum": [
"lbs",
"g",
"kg",
"oz",
"yd",
"cm",
"ft",
"in",
"m",
"gal",
"ml",
"l",
"ft3",
"in3",
"ft2",
"in2",
"units"
],
"description": "The unit, e.g. kg, ft, l, units (see sortly_list_units)."
}
},
"required": [
"value",
"type",
"name"
]
}
},
"required": [
"name",
"type"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}