{"openapi":"3.1.0","info":{"title":"API v1","description":"An API for managing your inventory. Authentication is required for all endpoints using either API keys (prefixed with `sk_`) or JWT tokens. API keys can be generated from the dashboard: Settings > API.","version":"1.0.0"},"servers":[{"url":"https://assetblaze.com/api/v1"}],"security":[{"apiKeyAuth":[]},{"jwtAuth":[]}],"paths":{"/categories":{"get":{"operationId":"getGetManyCategories","summary":"GET getManyCategories","tags":["Category"],"parameters":[{"name":"orderBy","in":"query","required":false},{"name":"orderDirection","in":"query","required":false},{"name":"lastModifiedAt","in":"query","required":false}],"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryGetManyFlatResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/categories/all":{"get":{"operationId":"getGetManyCategoriesAll","summary":"GET getManyCategoriesAll","tags":["Category"],"parameters":[{"name":"orderBy","in":"query","required":false},{"name":"orderDirection","in":"query","required":false},{"name":"lastModifiedAt","in":"query","required":false}],"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryGetManyFlatResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/custom-fields":{"get":{"operationId":"getGetManyCustomFields","summary":"GET getManyCustomFields","tags":["Custom Field"],"parameters":[{"name":"ids","in":"query","required":false},{"name":"orderBy","in":"query","required":false},{"name":"orderDirection","in":"query","required":false},{"name":"lastModifiedAt","in":"query","required":false}],"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldGetManyResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/custom-fields/all":{"get":{"operationId":"getGetManyCustomFieldsAll","summary":"GET getManyCustomFieldsAll","tags":["Custom Field"],"parameters":[{"name":"ids","in":"query","required":false},{"name":"orderBy","in":"query","required":false},{"name":"orderDirection","in":"query","required":false},{"name":"lastModifiedAt","in":"query","required":false}],"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldGetManyResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/suppliers":{"get":{"operationId":"getGetManyPaginatedSuppliers","summary":"GET getManyPaginatedSuppliers","tags":["Supplier"],"parameters":[{"name":"ids","in":"query","required":false},{"name":"bulkOperationId","in":"query","required":false},{"name":"lastModifiedAt","in":"query","required":false},{"name":"keyword","in":"query","required":false},{"name":"orderDirection","in":"query","required":false},{"name":"limit","in":"query","required":false},{"name":"previous","in":"query","required":false},{"name":"next","in":"query","required":false},{"name":"orderBy","in":"query","required":false}],"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierGetManyPaginatedResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}},"post":{"operationId":"createCreateOneSupplier","summary":"POST createOneSupplier","tags":["Supplier"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierCreateOneRequest"}}}},"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierGetOneResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/suppliers/{id}":{"get":{"operationId":"getGetOneSupplier","summary":"GET getOneSupplier","tags":["Supplier"],"parameters":[{"name":"id","in":"path","required":true}],"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierGetOneResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}},"put":{"operationId":"updateUpdateOneSupplier","summary":"PUT updateOneSupplier","tags":["Supplier"],"parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierUpdateOneRequest"}}}},"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierGetOneResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}},"delete":{"operationId":"deleteDeleteOneSupplier","summary":"DELETE deleteOneSupplier","tags":["Supplier"],"parameters":[{"name":"id","in":"path","required":true}],"responses":{"204":{"description":"The resource was deleted successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/suppliers/{id}/image":{"post":{"operationId":"createSetImageForSupplier","summary":"POST setImageForSupplier","tags":["Supplier"],"parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierSetImageRequest"}}}},"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}},"delete":{"operationId":"deleteDeleteImageFromSupplier","summary":"DELETE deleteImageFromSupplier","tags":["Supplier"],"parameters":[{"name":"id","in":"path","required":true}],"responses":{"204":{"description":"The resource was deleted successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/suppliers/upload-url":{"post":{"operationId":"createSupplierImageUploadUrl","summary":"POST supplierImageUploadUrl","tags":["Supplier"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierImageUploadUrlRequest"}}}},"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierImageUploadUrlResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}},"put":{"operationId":"updateSupplierImageUploadCallback","summary":"PUT supplierImageUploadCallback","tags":["Supplier"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierImageUploadCallbackRequest"}}}},"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierImageUploadCallbackResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/item-workspace-custom-field-values":{"get":{"operationId":"getGetManyPaginatedItemWorkspaceCustomFieldValues","summary":"GET getManyPaginatedItemWorkspaceCustomFieldValues","tags":["Item","Workspace"],"parameters":[{"name":"itemId","in":"query","required":false},{"name":"workspaceId","in":"query","required":false},{"name":"customFieldId","in":"query","required":false},{"name":"itemIds","in":"query","required":false},{"name":"workspaceIds","in":"query","required":false},{"name":"lastModifiedAt","in":"query","required":false},{"name":"orderDirection","in":"query","required":false},{"name":"limit","in":"query","required":false},{"name":"previous","in":"query","required":false},{"name":"next","in":"query","required":false}],"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemWorkspaceCustomFieldValueGetManyPaginatedResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/items":{"get":{"operationId":"getGetManyItems","summary":"GET getManyItems","tags":["Item"],"parameters":[{"name":"name","in":"query","required":false},{"name":"q","in":"query","required":false},{"name":"keyword","in":"query","required":false},{"name":"workspaceId","in":"query","required":false},{"name":"tagId","in":"query","required":false},{"name":"tagIds","in":"query","required":false},{"name":"minPrice","in":"query","required":false},{"name":"maxPrice","in":"query","required":false},{"name":"minCost","in":"query","required":false},{"name":"maxCost","in":"query","required":false},{"name":"minQuantity","in":"query","required":false},{"name":"maxQuantity","in":"query","required":false},{"name":"locationId","in":"query","required":false},{"name":"locationIds","in":"query","required":false},{"name":"categoryId","in":"query","required":false},{"name":"categoryIds","in":"query","required":false},{"name":"supplierId","in":"query","required":false},{"name":"supplierIds","in":"query","required":false},{"name":"catalogNumber","in":"query","required":false},{"name":"itemTypes","in":"query","required":false},{"name":"trackInventory","in":"query","required":false},{"name":"bulkOperationId","in":"query","required":false},{"name":"filterType","in":"query","required":false},{"name":"lastModifiedAt","in":"query","required":false},{"name":"isArchived","in":"query","required":false},{"name":"variantViewMode","in":"query","required":false},{"name":"parentItemId","in":"query","required":false},{"name":"orderDirection","in":"query","required":false},{"name":"limit","in":"query","required":false},{"name":"previous","in":"query","required":false},{"name":"next","in":"query","required":false},{"name":"orderBy","in":"query","required":false},{"name":"includeOutOfStockAtLocation","in":"query","required":false}],"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemGetManyResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}},"post":{"operationId":"createCreateOneItem","summary":"POST createOneItem","tags":["Item"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemCreateOneRequest"}}}},"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemCreateOneResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/items/bulk":{"post":{"operationId":"createCreateManyItems","summary":"POST createManyItems","tags":["Item"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemCreateManyRequest"}}}},"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemCreateManyResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/items/paginated":{"get":{"operationId":"getGetManyPaginatedItems","summary":"GET getManyPaginatedItems","tags":["Item"],"parameters":[{"name":"name","in":"query","required":false},{"name":"q","in":"query","required":false},{"name":"keyword","in":"query","required":false},{"name":"workspaceId","in":"query","required":false},{"name":"tagId","in":"query","required":false},{"name":"tagIds","in":"query","required":false},{"name":"minPrice","in":"query","required":false},{"name":"maxPrice","in":"query","required":false},{"name":"minCost","in":"query","required":false},{"name":"maxCost","in":"query","required":false},{"name":"minQuantity","in":"query","required":false},{"name":"maxQuantity","in":"query","required":false},{"name":"locationId","in":"query","required":false},{"name":"locationIds","in":"query","required":false},{"name":"categoryId","in":"query","required":false},{"name":"categoryIds","in":"query","required":false},{"name":"supplierId","in":"query","required":false},{"name":"supplierIds","in":"query","required":false},{"name":"catalogNumber","in":"query","required":false},{"name":"itemTypes","in":"query","required":false},{"name":"trackInventory","in":"query","required":false},{"name":"bulkOperationId","in":"query","required":false},{"name":"filterType","in":"query","required":false},{"name":"lastModifiedAt","in":"query","required":false},{"name":"isArchived","in":"query","required":false},{"name":"variantViewMode","in":"query","required":false},{"name":"parentItemId","in":"query","required":false},{"name":"orderDirection","in":"query","required":false},{"name":"limit","in":"query","required":false},{"name":"previous","in":"query","required":false},{"name":"next","in":"query","required":false},{"name":"orderBy","in":"query","required":false},{"name":"includeOutOfStockAtLocation","in":"query","required":false}],"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemGetManyPaginatedResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/items/{id}":{"get":{"operationId":"getGetOneItem","summary":"GET getOneItem","tags":["Item"],"parameters":[{"name":"id","in":"path","required":true}],"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemGetOneResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}},"put":{"operationId":"updateUpdateOneItem","summary":"PUT updateOneItem","tags":["Item"],"parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemUpdateOneRequest"}}}},"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemExpandedResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"422":{"description":"The update was refused, and nothing was written. `message` names why, e.g. error.unitOfMeasure.stockingUnitChangeFeatureDisabled: the update changes the Stocking Unit (`unitOfMeasureId`) while the unitOfMeasure feature is off. A refusal about open documents or quantities names them in `params`.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}},"delete":{"operationId":"deleteDeleteOneItem","summary":"DELETE deleteOneItem","tags":["Item"],"parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemDeleteOneRequest"}}}},"responses":{"204":{"description":"The resource was deleted successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/items/delete":{"post":{"operationId":"createDeleteManyItem","summary":"POST deleteManyItem","tags":["Item"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemDeleteManyRequest"}}}},"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemDeleteManyResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/items/archive":{"post":{"operationId":"createArchiveManyItem","summary":"POST archiveManyItem","tags":["Item"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemArchiveManyRequest"}}}},"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemArchiveManyResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/items/{id}/archive":{"post":{"operationId":"createArchiveOneItem","summary":"POST archiveOneItem","tags":["Item"],"parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemArchiveOneRequest"}}}},"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/items/{id}/images":{"post":{"operationId":"createAddImagesToItem","summary":"POST addImagesToItem","tags":["Item"],"parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemAddImagesRequest"}}}},"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/items/{id}/images/deletions":{"post":{"operationId":"deleteDeleteImagesFromItem","summary":"DELETE deleteImagesFromItem","tags":["Item"],"parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemDeleteImagesRequest"}}}},"responses":{"204":{"description":"The resource was deleted successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/items/{id}/images/ordering":{"post":{"operationId":"updateReorderImagesForItem","summary":"PUT reorderImagesForItem","tags":["Item"],"parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemReorderImagesRequest"}}}},"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/items/{id}/tags":{"put":{"operationId":"updateUpdateTagsForItem","summary":"PUT updateTagsForItem","tags":["Item"],"parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemUpdateTagsRequest"}}}},"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemExpandedResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/items/{id}/quantity":{"put":{"operationId":"updateUpdateQuantityForItem","summary":"PUT updateQuantityForItem","tags":["Item"],"parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemUpdateQuantityRequest"}}}},"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/items/{id}/quantity/relocations":{"put":{"operationId":"updateMoveQuantityForItem","summary":"PUT moveQuantityForItem","tags":["Item"],"parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemMoveQuantityRequest"}}}},"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/items/{id}/variants":{"get":{"operationId":"getGetItemVariants","summary":"GET getItemVariants","tags":["Item Variants"],"parameters":[{"name":"id","in":"path","required":true}],"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemVariantsResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}},"post":{"operationId":"createGenerateItemVariants","summary":"POST generateItemVariants","tags":["Item Variants"],"parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateVariantsRequest"}}}},"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemVariantsResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/items/{id}/aggregates":{"get":{"operationId":"getGetParentAggregates","summary":"GET getParentAggregates","tags":["Item Variants"],"parameters":[{"name":"id","in":"path","required":true}],"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParentAggregatesResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/items/{id}/enable-variants":{"post":{"operationId":"createEnableVariants","summary":"POST enableVariants","tags":["Item Variants"],"parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnableVariantsRequest"}}}},"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/items/upload-url":{"post":{"operationId":"createItemImageUploadUrl","summary":"POST itemImageUploadUrl","tags":["Item"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemImageUploadUrlRequest"}}}},"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemImageUploadUrlResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}},"put":{"operationId":"updateItemImageUploadCallback","summary":"PUT itemImageUploadCallback","tags":["Item"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemImageUploadCallbackRequest"}}}},"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemImageUploadCallbackResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/locations":{"get":{"operationId":"getGetManyLocations","summary":"GET getManyLocations","tags":["Location"],"parameters":[{"name":"ids","in":"query","required":false},{"name":"orderBy","in":"query","required":false},{"name":"orderDirection","in":"query","required":false},{"name":"lastModifiedAt","in":"query","required":false},{"name":"parentId","in":"query","required":false},{"name":"topLevelOnly","in":"query","required":false},{"name":"includeParents","in":"query","required":false},{"name":"isArchived","in":"query","required":false},{"name":"forceAll","in":"query","required":false}],"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationGetManyResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/locations/all":{"get":{"operationId":"getGetManyLocationsAll","summary":"GET getManyLocationsAll","tags":["Location"],"parameters":[{"name":"ids","in":"query","required":false},{"name":"orderBy","in":"query","required":false},{"name":"orderDirection","in":"query","required":false},{"name":"lastModifiedAt","in":"query","required":false},{"name":"parentId","in":"query","required":false},{"name":"topLevelOnly","in":"query","required":false},{"name":"includeParents","in":"query","required":false},{"name":"isArchived","in":"query","required":false},{"name":"forceAll","in":"query","required":false}],"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationGetManyResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/workspaces":{"get":{"operationId":"getGetManyWorkspaces","summary":"GET getManyWorkspaces","tags":["Workspace"],"parameters":[{"name":"ids","in":"query","required":false},{"name":"tagIds","in":"query","required":false},{"name":"locationIds","in":"query","required":false},{"name":"bulkOperationId","in":"query","required":false},{"name":"lastModifiedAt","in":"query","required":false},{"name":"workspaceTypeIds","in":"query","required":false},{"name":"withinLocationId","in":"query","required":false},{"name":"keyword","in":"query","required":false},{"name":"orderDirection","in":"query","required":false},{"name":"limit","in":"query","required":false},{"name":"previous","in":"query","required":false},{"name":"next","in":"query","required":false},{"name":"orderBy","in":"query","required":false}],"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceGetManyResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}},"post":{"operationId":"createCreateOneWorkspace","summary":"POST createOneWorkspace","tags":["Workspace"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceCreateOneRequest"}}}},"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceGetOneResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/workspaces/paginated":{"get":{"operationId":"getGetManyPaginatedWorkspaces","summary":"GET getManyPaginatedWorkspaces","tags":["Workspace"],"parameters":[{"name":"ids","in":"query","required":false},{"name":"tagIds","in":"query","required":false},{"name":"locationIds","in":"query","required":false},{"name":"bulkOperationId","in":"query","required":false},{"name":"lastModifiedAt","in":"query","required":false},{"name":"workspaceTypeIds","in":"query","required":false},{"name":"withinLocationId","in":"query","required":false},{"name":"keyword","in":"query","required":false},{"name":"orderDirection","in":"query","required":false},{"name":"limit","in":"query","required":false},{"name":"previous","in":"query","required":false},{"name":"next","in":"query","required":false},{"name":"orderBy","in":"query","required":false}],"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceGetManyPaginatedResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/workspaces/{id}":{"get":{"operationId":"getGetOneWorkspace","summary":"GET getOneWorkspace","tags":["Workspace"],"parameters":[{"name":"expand","in":"query","required":false},{"name":"id","in":"path","required":true}],"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceGetOneResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}},"put":{"operationId":"updateUpdateOneWorkspace","summary":"PUT updateOneWorkspace","tags":["Workspace"],"parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceUpdateOneRequest"}}}},"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceGetOneResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}},"delete":{"operationId":"deleteDeleteOneWorkspace","summary":"DELETE deleteOneWorkspace","tags":["Workspace"],"parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceDeleteOneRequest"}}}},"responses":{"204":{"description":"The resource was deleted successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/workspaces/{id}/items":{"post":{"operationId":"createAddItemsToWorkspace","summary":"POST addItemsToWorkspace","tags":["Workspace","Item"],"parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceAddItemsRequest"}}}},"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/workspaces/{id}/items/link":{"post":{"operationId":"createLinkItemsToWorkspace","summary":"POST linkItemsToWorkspace","tags":["Workspace","Item"],"parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceAddItemsRequest"}}}},"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/workspaces/{id}/items/create":{"post":{"operationId":"createCreateOneOrManyItemsInWorkspace","summary":"POST createOneOrManyItemsInWorkspace","tags":["Workspace","Item"],"parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ItemInWorkspaceCreateOneRequest"},{"$ref":"#/components/schemas/ItemInWorkspaceCreateManyRequest"}]}}}},"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ItemInWorkspaceResponse"},{"type":"array","items":{"$ref":"#/components/schemas/ItemInWorkspaceResponse"}}]}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/workspaces/{id}/items/create/bulk":{"post":{"operationId":"createCreateManyItemsInWorkspace","summary":"POST createManyItemsInWorkspace","tags":["Workspace","Item"],"parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemInWorkspaceCreateManyRequest"}}}},"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ItemInWorkspaceResponse"}}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/workspaces/{id}/items/{itemId}":{"get":{"operationId":"getGetOneItemInWorkspace","summary":"GET getOneItemInWorkspace","tags":["Workspace","Item"],"parameters":[{"name":"id","in":"path","required":true},{"name":"itemId","in":"path","required":true}],"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemInWorkspaceResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}},"put":{"operationId":"updateUpdateOneItemInWorkspace","summary":"PUT updateOneItemInWorkspace","tags":["Workspace","Item"],"parameters":[{"name":"id","in":"path","required":true},{"name":"itemId","in":"path","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceUpdateOneItemRequest"}}}},"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemInWorkspaceResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/workspaces/{id}/items/deletions":{"post":{"operationId":"createDeleteItemsFromWorkspace","summary":"POST deleteItemsFromWorkspace","tags":["Workspace","Item"],"parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceDeleteItemsRequest"}}}},"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/workspaces/{id}/images":{"post":{"operationId":"createSetImageForWorkspace","summary":"POST setImageForWorkspace","tags":["Workspace"],"parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceSetImageRequest"}}}},"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}},"delete":{"operationId":"deleteDeleteImageFromWorkspace","summary":"DELETE deleteImageFromWorkspace","tags":["Workspace"],"parameters":[{"name":"id","in":"path","required":true}],"responses":{"204":{"description":"The resource was deleted successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/workspaces/{id}/tags":{"put":{"operationId":"updateUpdateTagsForWorkspace","summary":"PUT updateTagsForWorkspace","tags":["Workspace"],"parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceUpdateTagsRequest"}}}},"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceGetOneResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/workspaces/upload-url":{"post":{"operationId":"createWorkspaceImageUploadUrl","summary":"POST workspaceImageUploadUrl","tags":["Workspace"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceImageUploadUrlRequest"}}}},"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceImageUploadUrlResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}},"put":{"operationId":"updateWorkspaceImageUploadCallback","summary":"PUT workspaceImageUploadCallback","tags":["Workspace"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceImageUploadCallbackRequest"}}}},"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceImageUploadCallbackResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/workspaces/deletions":{"post":{"operationId":"deleteDeleteManyWorkspaces","summary":"DELETE deleteManyWorkspaces","tags":["Workspace"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceDeleteManyRequest"}}}},"responses":{"204":{"description":"The resource was deleted successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/workspace-types":{"get":{"operationId":"getGetManyWorkspaceTypes","summary":"GET getManyWorkspaceTypes","tags":["Workspace Type"],"parameters":[{"name":"ids","in":"query","required":false},{"name":"orderBy","in":"query","required":false},{"name":"orderDirection","in":"query","required":false},{"name":"lastModifiedAt","in":"query","required":false}],"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceTypeGetManyResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/deleted-entities":{"get":{"operationId":"getGetManyDeletedEntities","summary":"GET getManyDeletedEntities","tags":["Deleted Entity"],"parameters":[{"name":"type","in":"query","required":false},{"name":"lastModifiedAt","in":"query","required":false},{"name":"orderDirection","in":"query","required":false},{"name":"limit","in":"query","required":false},{"name":"previous","in":"query","required":false},{"name":"next","in":"query","required":false},{"name":"orderBy","in":"query","required":false}],"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletedEntityGetManyResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/goods-receipts":{"get":{"operationId":"getGetManyPaginatedGoodsReceipts","summary":"GET getManyPaginatedGoodsReceipts","tags":["Goods receipts"],"parameters":[{"name":"status","in":"query","required":false},{"name":"sourceId","in":"query","required":false},{"name":"withinLocationId","in":"query","required":false},{"name":"receivedBy","in":"query","required":false},{"name":"receivedFrom","in":"query","required":false},{"name":"receivedTo","in":"query","required":false},{"name":"keyword","in":"query","required":false},{"name":"limit","in":"query","required":false},{"name":"previous","in":"query","required":false},{"name":"next","in":"query","required":false},{"name":"orderDirection","in":"query","required":false}],"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoodsReceiptGetManyPaginatedResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}},"post":{"operationId":"createPostGoodsReceipt","summary":"POST postGoodsReceipt","tags":["Goods receipts"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"sourceType":{"type":"string","enum":["purchase_order","transfer","manufacturing_order","blind"],"default":"purchase_order"},"sourceId":{"type":"string","minLength":1,"default":""},"locationId":{"type":"string","minLength":1,"default":""},"effectiveDate":{"type":"string"},"idempotencyKey":{"type":"string","minLength":1,"default":""},"note":{"type":["string","null"],"default":null},"lines":{"type":"array","items":{"type":"object","properties":{"sourceLineId":{"type":"string","minLength":1,"default":""},"qtyAccepted":{"type":"number","minimum":0,"default":0},"qtyRejected":{"type":"number","minimum":0,"default":0},"rejectReason":{"type":["string","null"],"enum":["damaged","wrong_item","quality","short_shipped","other",null],"default":null},"unitOfMeasureId":{"type":["string","null"],"default":null},"serialNumbers":{"type":"array","items":{"type":"string","minLength":1,"default":""},"default":[]},"batchNumber":{"type":["string","null"],"default":null},"note":{"type":["string","null"],"default":null},"closeLine":{"type":"boolean","default":false}},"required":["sourceLineId"]},"minItems":1}},"required":["sourceId","locationId","idempotencyKey","lines"]}}}},"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoodsReceiptConfirmationResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/goods-receipts/{id}":{"get":{"operationId":"getGetOneGoodsReceipt","summary":"GET getOneGoodsReceipt","tags":["Goods receipts"],"parameters":[{"name":"id","in":"path","required":true}],"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrichedGoodsReceiptResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/goods-receipts/{id}/reverse":{"post":{"operationId":"createReverseGoodsReceipt","summary":"POST reverseGoodsReceipt","tags":["Goods receipts"],"parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"note":{"type":"string","minLength":1}},"required":["note"]}}}},"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoodsReceiptConfirmationResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/receiving/orders":{"get":{"operationId":"getGetReceivableOrders","summary":"GET getReceivableOrders","tags":["Receiving"],"parameters":[{"name":"keyword","in":"query","required":false},{"name":"limit","in":"query","required":false},{"name":"previous","in":"query","required":false},{"name":"next","in":"query","required":false},{"name":"orderDirection","in":"query","required":false}],"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceivableOrdersGetManyPaginatedResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/receiving/orders/{id}":{"get":{"operationId":"getGetReceivableOrder","summary":"GET getReceivableOrder","tags":["Receiving"],"parameters":[{"name":"id","in":"path","required":true}],"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReceivableOrderResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/receiving/resolve-scan":{"post":{"operationId":"createResolveReceivingScan","summary":"POST resolveReceivingScan","tags":["Receiving"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolveScanRequest"}}}},"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolveScanResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/scan/resolve":{"post":{"operationId":"createResolveUniversalScan","summary":"POST resolveUniversalScan","tags":["Scanning"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanResolutionRequest"}}}},"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanResolution"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/me/capabilities":{"get":{"operationId":"getGetMeCapabilities","summary":"GET getMeCapabilities","tags":["Me"],"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeCapabilitiesResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/stock-counts":{"get":{"operationId":"getGetManyPaginatedStockCounts","summary":"GET getManyPaginatedStockCounts","tags":["StockCount"],"parameters":[{"name":"status","in":"query","required":false},{"name":"scNumber","in":"query","required":false},{"name":"location","in":"query","required":false},{"name":"locationIds","in":"query","required":false},{"name":"supplierIds","in":"query","required":false},{"name":"itemId","in":"query","required":false},{"name":"itemIds","in":"query","required":false},{"name":"createdByUserId","in":"query","required":false},{"name":"startedByUserId","in":"query","required":false},{"name":"createdAtFrom","in":"query","required":false},{"name":"createdAtTo","in":"query","required":false},{"name":"finalizedAtFrom","in":"query","required":false},{"name":"finalizedAtTo","in":"query","required":false},{"name":"keyword","in":"query","required":false},{"name":"limit","in":"query","required":false},{"name":"previous","in":"query","required":false},{"name":"next","in":"query","required":false},{"name":"orderBy","in":"query","required":false},{"name":"orderDirection","in":"query","required":false}],"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockCountGetManyPaginatedResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}},"post":{"operationId":"createCreateOneStockCount","summary":"POST createOneStockCount","tags":["StockCount"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockCountCreateOneRequest"}}}},"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockCountGetOneResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/stock-counts/active-locks":{"get":{"operationId":"getGetActiveStockCountLocks","summary":"GET getActiveStockCountLocks","tags":["StockCount"],"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockCountActiveLocksResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/stock-counts/{id}":{"get":{"operationId":"getGetOneStockCount","summary":"GET getOneStockCount","tags":["StockCount"],"parameters":[{"name":"id","in":"path","required":true}],"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockCountGetOneResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}},"delete":{"operationId":"deleteDeleteOneStockCount","summary":"DELETE deleteOneStockCount","tags":["StockCount"],"parameters":[{"name":"id","in":"path","required":true}],"responses":{"204":{"description":"The resource was deleted successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/stock-counts/{id}/start":{"post":{"operationId":"createStartOneStockCount","summary":"POST startOneStockCount","tags":["StockCount"],"parameters":[{"name":"id","in":"path","required":true}],"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockCountGetOneResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/stock-counts/{id}/submit":{"post":{"operationId":"createSubmitOneStockCount","summary":"POST submitOneStockCount","tags":["StockCount"],"parameters":[{"name":"id","in":"path","required":true}],"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockCountGetOneResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/stock-counts/{id}/cancel":{"post":{"operationId":"createCancelOneStockCount","summary":"POST cancelOneStockCount","tags":["StockCount"],"parameters":[{"name":"id","in":"path","required":true}],"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockCountGetOneResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/stock-counts/{id}/cancel-counting":{"post":{"operationId":"createCancelCountingForStockCount","summary":"POST cancelCountingForStockCount","tags":["StockCount"],"parameters":[{"name":"id","in":"path","required":true}],"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockCountGetOneResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/stock-counts/{id}/review":{"post":{"operationId":"createOpenReviewForStockCount","summary":"POST openReviewForStockCount","tags":["StockCount"],"parameters":[{"name":"id","in":"path","required":true}],"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockCountGetOneResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/stock-counts/{id}/finalize":{"post":{"operationId":"createFinalizeOneStockCount","summary":"POST finalizeOneStockCount","tags":["StockCount"],"parameters":[{"name":"id","in":"path","required":true}],"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockCountGetOneResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/stock-counts/{id}/finalization-error":{"delete":{"operationId":"deleteClearFinalizationErrorForStockCount","summary":"DELETE clearFinalizationErrorForStockCount","tags":["StockCount"],"parameters":[{"name":"id","in":"path","required":true}],"responses":{"204":{"description":"The resource was deleted successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/stock-counts/{id}/lines/{lineId}/count":{"put":{"operationId":"updateSetLineCountForStockCount","summary":"PUT setLineCountForStockCount","tags":["StockCount"],"parameters":[{"name":"id","in":"path","required":true},{"name":"lineId","in":"path","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockCountSetLineCountRequest"}}}},"responses":{"200":{"description":"The request was successful.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockCountGetOneResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/stock-counts/{id}/lines/{lineId}/approve":{"post":{"operationId":"createApproveLineForStockCount","summary":"POST approveLineForStockCount","tags":["StockCount"],"parameters":[{"name":"id","in":"path","required":true},{"name":"lineId","in":"path","required":true}],"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockCountGetOneResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/stock-counts/{id}/lines/{lineId}/reject":{"post":{"operationId":"createRejectLineForStockCount","summary":"POST rejectLineForStockCount","tags":["StockCount"],"parameters":[{"name":"id","in":"path","required":true},{"name":"lineId","in":"path","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockCountRejectLineRequest"}}}},"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockCountGetOneResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/stock-counts/{id}/lines/{lineId}/request-recount":{"post":{"operationId":"createRequestRecountForStockCountLine","summary":"POST requestRecountForStockCountLine","tags":["StockCount"],"parameters":[{"name":"id","in":"path","required":true},{"name":"lineId","in":"path","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockCountRequestRecountRequest"}}}},"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockCountGetOneResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/stock-counts/{id}/lines/{lineId}/recount":{"post":{"operationId":"createRecountStockCountLine","summary":"POST recountStockCountLine","tags":["StockCount"],"parameters":[{"name":"id","in":"path","required":true},{"name":"lineId","in":"path","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockCountRecountLineRequest"}}}},"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockCountGetOneResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}},"/stock-counts/{id}/lines/resolve-scan":{"post":{"operationId":"createResolveScanForStockCount","summary":"POST resolveScanForStockCount","tags":["StockCount"],"parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockCountResolveScanRequest"}}}},"responses":{"201":{"description":"The resource was created successfully.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StockCountResolveScanResponse"}}}},"400":{"description":"The request was invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"401":{"description":"The user is not authorized to perform the action.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"409":{"description":"The resource already exists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}},"500":{"description":"An unexpected error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"error":{},"params":{"type":"object","additionalProperties":{}}},"required":["message"]}}}}}}}},"webhooks":{"api_key.created":{"post":{"operationId":"api_key.created","summary":"An API key was created","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyCreatedEvent"}}}},"responses":{}}},"api_key.deleted":{"post":{"operationId":"api_key.deleted","summary":"An API key was deleted","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyDeletedEvent"}}}},"responses":{}}},"category.created":{"post":{"operationId":"category.created","summary":"A category was created","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryCreatedEvent"}}}},"responses":{}}},"category.updated":{"post":{"operationId":"category.updated","summary":"A category was updated. The update might include changes to the category name, \n    the associated custom fields or if the category was linked to a different parent.","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryUpdatedEvent"}}}},"responses":{}}},"category.deleted":{"post":{"operationId":"category.deleted","summary":"A category was deleted","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryDeletedEvent"}}}},"responses":{}}},"custom_field.created":{"post":{"operationId":"custom_field.created","summary":"A custom field was created","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldCreatedEvent"}}}},"responses":{}}},"custom_field.updated":{"post":{"operationId":"custom_field.updated","summary":"A custom field was updated, possibly changing the name, type, default value(s), options, or the required flag","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldUpdatedEvent"}}}},"responses":{}}},"custom_field.deleted":{"post":{"operationId":"custom_field.deleted","summary":"A custom field was deleted","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldDeletedEvent"}}}},"responses":{}}},"item.created":{"post":{"operationId":"item.created","summary":"An item was created","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemCreatedEvent"}}}},"responses":{}}},"item.created_bulk":{"post":{"operationId":"item.created_bulk","summary":"Multiple items were created. This is most likely to happen during a CSV import.","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemCreatedBulkEvent"}}}},"responses":{}}},"item.updated":{"post":{"operationId":"item.updated","summary":"An item was updated, possibly changing its name, description, asset ID, \n  barcode, min level, cost, price, quantity, category, any custom field's value, tags, supplier or images.","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemUpdatedEvent"}}}},"responses":{}}},"item.updated_bulk":{"post":{"operationId":"item.updated_bulk","summary":"Multiple items were updated","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemUpdatedBulkEvent"}}}},"responses":{}}},"item.deleted":{"post":{"operationId":"item.deleted","summary":"An item was deleted","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemDeletedEvent"}}}},"responses":{}}},"item.deleted_bulk":{"post":{"operationId":"item.deleted_bulk","summary":"Multiple items were deleted, most commonly via the multi-select and delete functionality","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemDeletedBulkEvent"}}}},"responses":{}}},"item.variant_created":{"post":{"operationId":"item.variant_created","summary":"A variant item was created for a parent item","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemVariantCreatedEvent"}}}},"responses":{}}},"item.variants_generated":{"post":{"operationId":"item.variants_generated","summary":"Multiple variants were generated for a parent item in a single operation","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemVariantsGeneratedEvent"}}}},"responses":{}}},"item.variants_enabled":{"post":{"operationId":"item.variants_enabled","summary":"Variants were enabled on an existing item, converting it to a parent item","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemVariantsEnabledEvent"}}}},"responses":{}}},"item.variants_disabled":{"post":{"operationId":"item.variants_disabled","summary":"Variants were disabled on a parent item, archiving all its variants","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemVariantsDisabledEvent"}}}},"responses":{}}},"location.created":{"post":{"operationId":"location.created","summary":"A location was created","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationCreatedEvent"}}}},"responses":{}}},"location.updated":{"post":{"operationId":"location.updated","summary":"A location was updated. The update might include changes to the name, code, address details, billing or shipping addresses","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationUpdatedEvent"}}}},"responses":{}}},"location.deleted":{"post":{"operationId":"location.deleted","summary":"A location was deleted","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationDeletedEvent"}}}},"responses":{}}},"tax_rate.created":{"post":{"operationId":"tax_rate.created","summary":"A tax rate was created","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRateCreatedEvent"}}}},"responses":{}}},"tax_rate.updated":{"post":{"operationId":"tax_rate.updated","summary":"A tax rate was updated. The update might include changes in name, primary and/or secondary details, or if it became the default one","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRateUpdatedEvent"}}}},"responses":{}}},"tax_rate.deleted":{"post":{"operationId":"tax_rate.deleted","summary":"A tax rate was deleted","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxRateDeletedEvent"}}}},"responses":{}}},"purchase_order.created":{"post":{"operationId":"purchase_order.created","summary":"A purchase order was created","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrderCreatedEvent"}}}},"responses":{}}},"purchase_order.updated":{"post":{"operationId":"purchase_order.updated","summary":"A purchase order was updated. The update might include changes in the PO status, items, supplier associated, shipping and/or billing addresses' details.","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrderUpdatedEvent"}}}},"responses":{}}},"purchase_order.deleted":{"post":{"operationId":"purchase_order.deleted","summary":"A purchase order was deleted","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseOrderDeletedEvent"}}}},"responses":{}}},"sale_order.created":{"post":{"operationId":"sale_order.created","summary":"A sale order was created","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleOrderCreatedEvent"}}}},"responses":{}}},"sale_order.updated":{"post":{"operationId":"sale_order.updated","summary":"A sale order was updated. The update might include changes in the SO status, items, discounts, tax, contact details, \n    shipping and/or billing addresses, issue/due/order dates, tax rate, invoice note, paid amount","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleOrderUpdatedEvent"}}}},"responses":{}}},"sale_order.deleted":{"post":{"operationId":"sale_order.deleted","summary":"A sale order was deleted","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleOrderDeletedEvent"}}}},"responses":{}}},"sale_order.updated_bulk":{"post":{"operationId":"sale_order.updated_bulk","summary":"Multiple sale orders were updated. This is usually done by a job, marking the sales orders as overdue","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaleOrderUpdatesBulkEvent"}}}},"responses":{}}},"proforma_order.created":{"post":{"operationId":"proforma_order.created","summary":"A proforma order was created","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProformaOrderCreatedEvent"}}}},"responses":{}}},"proforma_order.updated":{"post":{"operationId":"proforma_order.updated","summary":"A proforma order was updated. The update might include changes in the status, items, discounts, tax, contact details, \n    shipping and/or billing addresses, issue/due dates, tax, payment terms, total amount","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProformaOrderUpdatedEvent"}}}},"responses":{}}},"proforma_order.deleted":{"post":{"operationId":"proforma_order.deleted","summary":"A proforma order was deleted","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProformaOrderDeletedEvent"}}}},"responses":{}}},"proforma_order.updated_bulk":{"post":{"operationId":"proforma_order.updated_bulk","summary":"Multiple proforma orders were updated. This is usually done by a job, marking the proformas orders as overdue","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProformaOrderUpdatesBulkEvent"}}}},"responses":{}}},"credit_note.created":{"post":{"operationId":"credit_note.created","summary":"A credit note was created","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditNoteCreatedEvent"}}}},"responses":{}}},"credit_note.updated":{"post":{"operationId":"credit_note.updated","summary":"A credit note was updated. The update might include changes in the status, issue date, total amount or contact information","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditNoteUpdatedEvent"}}}},"responses":{}}},"credit_note.deleted":{"post":{"operationId":"credit_note.deleted","summary":"A credit note was deleted","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditNoteDeletedEvent"}}}},"responses":{}}},"supplier.created":{"post":{"operationId":"supplier.created","summary":"A supplier was created","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierCreatedEvent"}}}},"responses":{}}},"supplier.created_bulk":{"post":{"operationId":"supplier.created_bulk","summary":"Multiple suppliers were created, most commonly via a CSV import","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierCreatedBulkEvent"}}}},"responses":{}}},"supplier.updated":{"post":{"operationId":"supplier.updated","summary":"A supplier was updated. The update might include changes in the name, code, address, contact details, notes, currency, lead time, discount or tax info","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierUpdatedEvent"}}}},"responses":{}}},"supplier.deleted":{"post":{"operationId":"supplier.deleted","summary":"A supplier was deleted","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierDeletedEvent"}}}},"responses":{}}},"tag.created":{"post":{"operationId":"tag.created","summary":"A tag was created","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagCreatedEvent"}}}},"responses":{}}},"tag.updated":{"post":{"operationId":"tag.updated","summary":"A tag was updated. Updates may include changes to the tag name only","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagUpdatedEvent"}}}},"responses":{}}},"tag.deleted":{"post":{"operationId":"tag.deleted","summary":"A tag was deleted","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagDeletedEvent"}}}},"responses":{}}},"workspace.created":{"post":{"operationId":"workspace.created","summary":"A workspace was created","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceCreatedEvent"}}}},"responses":{}}},"workspace.updated":{"post":{"operationId":"workspace.updated","summary":"A workspace was updated. The update includes changes to the workspace name, description, location, tags or image.","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceUpdatedEvent"}}}},"responses":{}}},"workspace.deleted":{"post":{"operationId":"workspace.deleted","summary":"A workspace was deleted","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceDeletedEvent"}}}},"responses":{}}},"workspace.deleted_bulk":{"post":{"operationId":"workspace.deleted_bulk","summary":"Multiple workspaces were deleted, most commonly via the multi-select and delete functionality","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceDeletedBulkEvent"}}}},"responses":{}}},"workspace.items.updated":{"post":{"operationId":"workspace.items.updated","summary":"Items in a workspace were updated - this happens when an item is added to or deleted from the workspace or moved to another workspace","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceItemsUpdatedEvent"}}}},"responses":{}}},"workspace_item.updated":{"post":{"operationId":"workspace_item.updated","summary":"Workspace item was updated","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceItemUpdatedEvent"}}}},"responses":{}}},"workspace_item.updated_bulk":{"post":{"operationId":"workspace_item.updated_bulk","summary":"Many items were updated in a workspace, that includes the workspace custom fields. This is a bulk operation so you could get the updated items by querying the API with the bulk_operation ID in the query parameters","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceItemUpdatedBulkEvent"}}}},"responses":{}}},"customer.created":{"post":{"operationId":"customer.created","summary":"Customer was created","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerCreatedEvent"}}}},"responses":{}}},"customer.updated":{"post":{"operationId":"customer.updated","summary":"Customer was updated","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerUpdatedEvent"}}}},"responses":{}}},"customer.deleted":{"post":{"operationId":"customer.deleted","summary":"Customer was deleted","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerDeletedEvent"}}}},"responses":{}}},"supplier_catalog_item.created":{"post":{"operationId":"supplier_catalog_item.created","summary":"Supplier catalog item was created","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierCatalogItemCreatedEvent"}}}},"responses":{}}},"supplier_catalog_item.created_bulk":{"post":{"operationId":"supplier_catalog_item.created_bulk","summary":"Supplier catalog items were created in bulk (via import)","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierCatalogItemCreatedBulkEvent"}}}},"responses":{}}},"supplier_catalog_item.updated":{"post":{"operationId":"supplier_catalog_item.updated","summary":"Supplier catalog item was updated","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierCatalogItemUpdatedEvent"}}}},"responses":{}}},"supplier_catalog_item.deleted":{"post":{"operationId":"supplier_catalog_item.deleted","summary":"Supplier catalog item was deleted","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierCatalogItemDeletedEvent"}}}},"responses":{}}},"supplier_catalog_item.discontinued":{"post":{"operationId":"supplier_catalog_item.discontinued","summary":"Supplier catalog item was discontinued","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierCatalogItemDiscontinuedEvent"}}}},"responses":{}}},"supplier_catalog_item.catalog_number_updated":{"post":{"operationId":"supplier_catalog_item.catalog_number_updated","summary":"Supplier catalog item's catalog number was updated","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplierCatalogItemCatalogNumberUpdatedEvent"}}}},"responses":{}}},"workspace_type.created":{"post":{"operationId":"workspace_type.created","summary":"Workspace type was created","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceTypeCreatedEvent"}}}},"responses":{}}},"workspace_type.updated":{"post":{"operationId":"workspace_type.updated","summary":"Workspace type was updated","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceTypeUpdatedEvent"}}}},"responses":{}}},"workspace_type.deleted":{"post":{"operationId":"workspace_type.deleted","summary":"Workspace type was deleted","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceTypeDeletedEvent"}}}},"responses":{}}},"workspace_item.created":{"post":{"operationId":"workspace_item.created","summary":"Workspace item was created","tags":["webhooks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceItemCreatedEvent"}}}},"responses":{}}}},"components":{"securitySchemes":{"apiKeyAuth":{"type":"http","scheme":"bearer","description":"API key authentication. Keys must be prefixed with `sk_` and passed in the Authorization header like so: `Authorization: Bearer sk_my-api-key`."},"jwtAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token authentication. Tokens must be passed in the Authorization header."}},"schemas":{"CategoryGetManyFlatResponse":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"customFieldIds":{"type":"array","items":{"type":"string"}},"parentCategoryId":{"type":["string","null"]},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","customFieldIds","parentCategoryId","createdAt","updatedAt"]},"description":"Get list of Categories with aggregated custom fields from parent categories.","example":[{"id":"c1574b87-68d6-448a-ac18-4a5f0e68d534","name":"Category 1","customFieldIds":["b09ce6cd-76f5-4113-895c-0f36ae7365c6"],"parentCategoryId":null,"createdAt":"2026-11-20T21:12:08.186Z","updatedAt":"2026-11-20T21:12:08.186Z"},{"id":"c1574b87-68d6-448a-ac18-4a5f0e68d535","name":"Category 2","customFieldIds":["b09ce6cd-76f5-4113-895c-0f36ae7365c6","b09ce6cd-76f5-4113-895c-0f36ae7365c7"],"parentCategoryId":"c1574b87-68d6-448a-ac18-4a5f0e68d534","createdAt":"2026-11-20T21:12:08.186Z","updatedAt":"2026-11-20T21:12:08.186Z"}]},"CustomFieldGetManyResponse":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""},"type":{"type":"string","enum":["short-text","long-text","integer","decimal","date","datetime","time","boolean","select","multiselect","barcode"]},"options":{"type":"array","items":{"type":"string","minLength":1,"default":""}},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"required":{"type":"boolean","default":false},"code":{"type":["string","null"]},"system":{"type":"boolean"},"unique":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","type","required","createdAt","updatedAt"]},"description":"Get many custom fields","example":[{"id":"b09ce6cd-76f5-4113-895c-0f36ae7365c6","name":"Custom Field 1","type":"short-text","createdAt":"2026-11-20T21:12:08.200Z","updatedAt":"2026-11-20T21:12:08.200Z"},{"id":"b09ce6cd-76f5-4113-895c-0f36ae7365c7","name":"Custom Field 2","type":"multiselect","options":["Option 1","Option 2"],"defaultValue":["Option 1"],"createdAt":"2026-11-20T21:12:08.200Z","updatedAt":"2026-11-20T21:12:08.200Z"}]},"ItemGetManyResponse":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"assetId":{"type":"string","minLength":1,"default":""},"name":{"type":"string"},"price":{"type":"integer"},"cost":{"type":"integer"},"groupId":{"type":"string"},"attributes":{"type":"array","items":{"type":"string"}},"locationQuantities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""},"code":{"type":["string","null"],"minLength":1,"default":""},"ancestorIds":{"type":"array","items":{"type":"string","minLength":1,"default":""}},"quantity":{"type":"number"},"reservedQuantity":{"type":"number"},"cost":{"type":"number","minimum":0},"backorderedQuantity":{"type":"integer"}},"required":["id","name","ancestorIds","quantity"]}},"minLevel":{"type":["number","null"]},"restockTargetLevel":{"type":["number","null"]},"locationLevels":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"default":""},"minLevel":{"type":["number","null"]},"restockTargetLevel":{"type":["number","null"]}},"required":["locationId"]},"default":[]},"category":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"customFieldValues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"type":{"type":"string","enum":["short-text","long-text","integer","decimal","date","datetime","time","boolean","select","multiselect","barcode"]},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"required":{"type":"boolean","default":false},"code":{"type":["string","null"]},"system":{"type":"boolean"}},"required":["id","name","type","required"]}},"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":["string","null"]},"originalUrl":{"type":"string"}},"required":["url"]}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""}},"required":["id","name"]}},"workspaceIds":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"barcode":{"type":["object","null"],"properties":{"value":{"type":"string","minLength":1},"type":{"type":"string","enum":["BARCODE","QRCODE"]}},"required":["value","type"]},"clientCorrelationId":{"type":["string","null"]},"costingMethod":{"type":"string","enum":["average","fifo","lifo"]},"itemType":{"type":"string","enum":["component","build","service"],"default":"component"},"replenishmentMethod":{"type":"string","enum":["buy","make"],"default":"buy"},"trackInventory":{"type":"boolean"},"traceabilityType":{"type":"string","enum":["none","serial","batch"],"default":"none"},"serialNumberFormat":{"type":["string","null"]},"unitOfMeasureId":{"type":["string","null"],"description":"The Stocking Unit: the unit every quantity, cost and price of the item is stated in. No unit means Unit. An update may change it to a unit of the same category, or to the item's current Secondary Unit, and either converts the stock, cost and price - the price only when the update omits it (see price). Changing to the Secondary Unit swaps the two units and inverts the factor: 2 Units per kg becomes 0.5 kg per Unit. Any other unit is refused. Changing it requires the unitOfMeasure feature: with it off, a different unit is refused with error.unitOfMeasure.stockingUnitChangeFeatureDisabled and nothing is written, while the current unit sent back unchanged is accepted."},"secondaryUnit":{"type":["object","null"],"properties":{"unitOfMeasureId":{"type":"string","minLength":1},"factor":{"type":"number","description":"The Secondary Unit Factor: how many stocking units one Secondary Unit equals, stored at 6 decimal places. Stock in the Secondary Unit is quantity / factor."},"unitOfMeasure":{"oneOf":[{"$ref":"#/components/schemas/UnitOfMeasure"},{"type":"null"}]}},"required":["unitOfMeasureId","factor","unitOfMeasure"],"description":"The Secondary Unit, a Measure Unit from another category than the Stocking Unit, with its factor. Null for an item without one, or when the unitOfMeasure feature is off."},"weightValue":{"type":["number","null"]},"weightUnit":{"type":["string","null"],"enum":["kg","lb","oz","g",null]},"lockVersion":{"type":"integer","default":0},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"archivedAt":{"type":"string"},"preventDeletingError":{"type":"string","enum":["error.items.deleteOne.hasSaleOrders","error.items.deleteOne.hasPurchaseOrders","error.items.deleteOne.hasTransactionsError","error.items.deleteOne.hasBom","error.items.deleteOne.hasManufacturingOrders","error.items.deleteOne.hasStockCounts"]},"hasVariants":{"type":"boolean"},"parentItemId":{"type":"string"},"variantSchema":{"type":"object","properties":{"customFieldIds":{"type":"array","items":{"type":"string","minLength":1,"default":""},"minItems":1},"allowedValues":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"string","minLength":1,"default":""},"values":{"type":"array","items":{"type":"string"}}},"required":["customFieldId","values"]}},"excludedCombinations":{"type":"array","items":{"type":"array","items":{"type":"string"}}}},"required":["customFieldIds","allowedValues"]},"variantValues":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"string","minLength":1,"default":""},"customFieldName":{"type":"string","minLength":1,"default":""},"value":{"type":"string"}},"required":["customFieldId","customFieldName","value"]}},"descriptionOverride":{"type":"boolean"},"imagesOverride":{"type":"boolean"},"bomOverride":{"type":"string","enum":["inherit","modified","custom"]},"suppliersOverride":{"type":"string","enum":["inherit","modified","custom"]},"insufficientInventoryPolicy":{"type":["string","null"],"enum":["disallow_order","warn_and_allow_backorder","allow_backorder",null]},"workspaceCustomFieldValues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"type":{"type":"string","enum":["short-text","long-text","integer","decimal","date","datetime","time","boolean","select","multiselect","barcode"]},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"required":{"type":"boolean","default":false},"code":{"type":["string","null"]},"system":{"type":"boolean"},"valueId":{"type":["string","null"]}},"required":["id","name","type","required"]}},"workspaceId":{"type":["string","null"]},"workspaces":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""}},"required":["id","name"]}},"quantity":{"type":"number"},"supplier":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"catalogNumber":{"type":"string"},"catalogItemId":{"type":"string"},"purchaseUnitOfMeasureId":{"type":["string","null"]},"unitsPerPurchaseUnit":{"type":["number","null"],"exclusiveMinimum":0},"isDefault":{"type":"boolean"}},"required":["id","name"]},"unitOfMeasure":{"oneOf":[{"$ref":"#/components/schemas/UnitOfMeasure"},{"type":"null"}],"description":"The Stocking Unit, resolved, and Unit when the item stores none. Null when the unitOfMeasure feature is off."}},"required":["id","assetId","name","price","cost","attributes","locationQuantities","locationLevels","customFieldValues","images","tags","workspaceIds","description","itemType","replenishmentMethod","trackInventory","secondaryUnit","lockVersion","createdAt","updatedAt","workspaceCustomFieldValues","workspaces","quantity","unitOfMeasure"]},"description":"Get many items","example":[{"id":"item_c1574b87-68d6-448a-ac18-4a5f0e68d534","assetId":"AB-123456","barcode":{"value":"3801234567891","type":"BARCODE"},"name":"Item 1","price":10,"cost":10,"trackInventory":true,"groupId":"168455faf-4539-47d0-bb77-ac814f16d8c7","attributes":["attribute 1","attribute 2"],"locationQuantities":[{"id":"loc_6da0d90b-4efa-47f8-8823-8b5a1c8220ce","name":"Location 1","code":"location-1","quantity":1,"ancestorIds":[]}],"quantity":1,"minLevel":1,"description":"Description","category":{"id":"cat_b09ce6cd-76f5-4113-895c-0f36ae7365c3","name":"Category 1"},"customFieldValues":[{"id":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c6","value":"value 1","name":"My custom field","type":"short-text","defaultValue":"","required":false}],"workspaceCustomFieldValues":[{"id":"cf_a10ce6cd-76f5-4113-895c-0f36ae7365c7","value":"value in workspace","name":"My workspace custom field","type":"short-text","defaultValue":"","required":false,"valueId":"iwcfv_b09ce6cd-76f5-4113-895c-0f36ae7365a1"}],"images":[{"url":"https://example.com/image.jpg","name":"image.jpg"}],"tags":[{"id":"tag_b09ce6cd-76f5-4113-895c-0f36ae7365a3","name":"Tag 1"}],"workspaceId":"ws_b09ce6cd-76f5-4113-895c-0f36ae7365a4","workspaceIds":["ws_b09ce6cd-76f5-4113-895c-0f36ae7365a4"],"workspaces":[{"id":"ws_b09ce6cd-76f5-4113-895c-0f36ae7365a4","name":"Workspace 1"}],"supplier":{"id":"sup_b09ce6cd-76f5-4113-895c-0f36ae7365c4","name":"Item supplier X"},"createdAt":"2026-11-20T21:12:08.367Z","updatedAt":"2026-11-20T21:12:08.367Z","archivedAt":"2026-11-20T21:12:08.367Z","preventDeletingError":"error.items.deleteOne.hasTransactionsError","unitOfMeasure":null,"secondaryUnit":null},{"id":"item_c1574b87-68d6-448a-ac18-4a5f0e68d535","name":"Item 2","assetId":"AB-123457","barcode":{"value":"3801234567892","type":"BARCODE"},"price":10,"cost":10,"trackInventory":true,"groupId":"168455faf-4539-47d0-bb77-ac814f16d8c8","attributes":["attribute 1","attribute 2"],"locationQuantities":[{"id":"loc_6da0d90b-4efa-47f8-8823-8b5a1c8220cf","name":"Location 1","code":"location-1","quantity":1,"ancestorIds":[]}],"quantity":1,"minLevel":1,"description":"Description","category":{"id":"cat_b09ce6cd-76f5-4113-895c-0f36ae7365c2","name":"Category 2"},"customFieldValues":[{"id":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c7","value":"value 2","name":"My custom field","type":"short-text","defaultValue":"","required":false}],"workspaceCustomFieldValues":[],"images":[{"url":"https://example.com/image.jpg","name":"image.jpg"}],"tags":[{"id":"tag_b09ce6cd-76f5-4113-895c-0f36ae7365a2","name":"Tag 2"}],"workspaceIds":["ws_b09ce6cd-76f5-4113-895c-0f36ae7365a4"],"workspaces":[{"id":"ws_b09ce6cd-76f5-4113-895c-0f36ae7365a4","name":"Workspace 1"}],"supplier":{"id":"sup_b09ce6cd-76f5-4113-895c-0f36ae7365c4","name":"Item supplier X"},"createdAt":"2026-11-20T21:12:08.367Z","updatedAt":"2026-11-20T21:12:08.367Z","archivedAt":"2026-11-20T21:12:08.367Z","preventDeletingError":"error.items.deleteOne.hasTransactionsError","unitOfMeasure":null,"secondaryUnit":null}]},"ItemGetManyPaginatedResponse":{"type":"object","properties":{"previous":{"type":"string"},"hasPrevious":{"type":"boolean"},"next":{"type":"string"},"hasNext":{"type":"boolean"},"totalCount":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"assetId":{"type":"string","minLength":1,"default":""},"name":{"type":"string"},"price":{"type":"integer"},"cost":{"type":"integer"},"groupId":{"type":"string"},"attributes":{"type":"array","items":{"type":"string"}},"locationQuantities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""},"code":{"type":["string","null"],"minLength":1,"default":""},"ancestorIds":{"type":"array","items":{"type":"string","minLength":1,"default":""}},"quantity":{"type":"number"},"reservedQuantity":{"type":"number"},"cost":{"type":"number","minimum":0},"backorderedQuantity":{"type":"integer"}},"required":["id","name","ancestorIds","quantity"]}},"minLevel":{"type":["number","null"]},"restockTargetLevel":{"type":["number","null"]},"locationLevels":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"default":""},"minLevel":{"type":["number","null"]},"restockTargetLevel":{"type":["number","null"]}},"required":["locationId"]},"default":[]},"category":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"customFieldValues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"type":{"type":"string","enum":["short-text","long-text","integer","decimal","date","datetime","time","boolean","select","multiselect","barcode"]},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"required":{"type":"boolean","default":false},"code":{"type":["string","null"]},"system":{"type":"boolean"}},"required":["id","name","type","required"]}},"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":["string","null"]},"originalUrl":{"type":"string"}},"required":["url"]}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""}},"required":["id","name"]}},"workspaceIds":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"barcode":{"type":["object","null"],"properties":{"value":{"type":"string","minLength":1},"type":{"type":"string","enum":["BARCODE","QRCODE"]}},"required":["value","type"]},"clientCorrelationId":{"type":["string","null"]},"costingMethod":{"type":"string","enum":["average","fifo","lifo"]},"itemType":{"type":"string","enum":["component","build","service"],"default":"component"},"replenishmentMethod":{"type":"string","enum":["buy","make"],"default":"buy"},"trackInventory":{"type":"boolean"},"traceabilityType":{"type":"string","enum":["none","serial","batch"],"default":"none"},"serialNumberFormat":{"type":["string","null"]},"unitOfMeasureId":{"type":["string","null"],"description":"The Stocking Unit: the unit every quantity, cost and price of the item is stated in. No unit means Unit. An update may change it to a unit of the same category, or to the item's current Secondary Unit, and either converts the stock, cost and price - the price only when the update omits it (see price). Changing to the Secondary Unit swaps the two units and inverts the factor: 2 Units per kg becomes 0.5 kg per Unit. Any other unit is refused. Changing it requires the unitOfMeasure feature: with it off, a different unit is refused with error.unitOfMeasure.stockingUnitChangeFeatureDisabled and nothing is written, while the current unit sent back unchanged is accepted."},"secondaryUnit":{"type":["object","null"],"properties":{"unitOfMeasureId":{"type":"string","minLength":1},"factor":{"type":"number","description":"The Secondary Unit Factor: how many stocking units one Secondary Unit equals, stored at 6 decimal places. Stock in the Secondary Unit is quantity / factor."},"unitOfMeasure":{"oneOf":[{"$ref":"#/components/schemas/UnitOfMeasure"},{"type":"null"}]}},"required":["unitOfMeasureId","factor","unitOfMeasure"],"description":"The Secondary Unit, a Measure Unit from another category than the Stocking Unit, with its factor. Null for an item without one, or when the unitOfMeasure feature is off."},"weightValue":{"type":["number","null"]},"weightUnit":{"type":["string","null"],"enum":["kg","lb","oz","g",null]},"lockVersion":{"type":"integer","default":0},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"archivedAt":{"type":"string"},"preventDeletingError":{"type":"string","enum":["error.items.deleteOne.hasSaleOrders","error.items.deleteOne.hasPurchaseOrders","error.items.deleteOne.hasTransactionsError","error.items.deleteOne.hasBom","error.items.deleteOne.hasManufacturingOrders","error.items.deleteOne.hasStockCounts"]},"hasVariants":{"type":"boolean"},"parentItemId":{"type":"string"},"variantSchema":{"type":"object","properties":{"customFieldIds":{"type":"array","items":{"type":"string","minLength":1,"default":""},"minItems":1},"allowedValues":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"string","minLength":1,"default":""},"values":{"type":"array","items":{"type":"string"}}},"required":["customFieldId","values"]}},"excludedCombinations":{"type":"array","items":{"type":"array","items":{"type":"string"}}}},"required":["customFieldIds","allowedValues"]},"variantValues":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"string","minLength":1,"default":""},"customFieldName":{"type":"string","minLength":1,"default":""},"value":{"type":"string"}},"required":["customFieldId","customFieldName","value"]}},"descriptionOverride":{"type":"boolean"},"imagesOverride":{"type":"boolean"},"bomOverride":{"type":"string","enum":["inherit","modified","custom"]},"suppliersOverride":{"type":"string","enum":["inherit","modified","custom"]},"insufficientInventoryPolicy":{"type":["string","null"],"enum":["disallow_order","warn_and_allow_backorder","allow_backorder",null]},"quantity":{"type":"number"},"supplier":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"catalogNumber":{"type":"string"},"catalogItemId":{"type":"string"},"purchaseUnitOfMeasureId":{"type":["string","null"]},"unitsPerPurchaseUnit":{"type":["number","null"],"exclusiveMinimum":0},"isDefault":{"type":"boolean"}},"required":["id","name"]},"workspaceCustomFieldValues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"type":{"type":"string","enum":["short-text","long-text","integer","decimal","date","datetime","time","boolean","select","multiselect","barcode"]},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"required":{"type":"boolean","default":false},"code":{"type":["string","null"]},"system":{"type":"boolean"},"valueId":{"type":["string","null"]}},"required":["id","name","type","required"]}},"unitOfMeasure":{"oneOf":[{"$ref":"#/components/schemas/UnitOfMeasure"},{"type":"null"}],"description":"The Stocking Unit, resolved, and Unit when the item stores none. Null when the unitOfMeasure feature is off."}},"required":["id","assetId","name","price","cost","attributes","locationQuantities","locationLevels","customFieldValues","images","tags","workspaceIds","description","itemType","replenishmentMethod","trackInventory","secondaryUnit","lockVersion","createdAt","updatedAt","quantity","workspaceCustomFieldValues","unitOfMeasure"]}}},"required":["hasPrevious","hasNext","totalCount","results"],"description":"Get many items paginated","example":{"hasPrevious":true,"previous":"previous-token","hasNext":true,"next":"next-token","totalCount":100,"results":[{"id":"item_c1574b87-68d6-448a-ac18-4a5f0e68d534","assetId":"AB-123456","barcode":{"value":"3801234567891","type":"BARCODE"},"name":"Item 1","price":10,"cost":10,"trackInventory":true,"groupId":"168455faf-4539-47d0-bb77-ac814f16d8c7","attributes":["attribute 1","attribute 2"],"locationQuantities":[{"id":"loc_6da0d90b-4efa-47f8-8823-8b5a1c8220ce","name":"Location 1","code":"location-1","quantity":1,"ancestorIds":[]}],"quantity":1,"minLevel":1,"description":"Description","category":{"id":"cat_b09ce6cd-76f5-4113-895c-0f36ae7365c3","name":"Category 1"},"customFieldValues":[{"id":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c6","value":"value 1","name":"My custom field","type":"short-text","defaultValue":"","required":false}],"workspaceCustomFieldValues":[{"id":"cf_a10ce6cd-76f5-4113-895c-0f36ae7365c7","value":"value in workspace","name":"My workspace custom field","type":"short-text","defaultValue":"","required":false,"valueId":null}],"images":[{"url":"https://example.com/image.jpg","name":"image.jpg"}],"tags":[{"id":"tag_b09ce6cd-76f5-4113-895c-0f36ae7365a3","name":"Tag 1"}],"workspaceIds":["ws_b09ce6cd-76f5-4113-895c-0f36ae7365a4"],"supplier":{"id":"sup_b09ce6cd-76f5-4113-895c-0f36ae7365c4","name":"Item supplier X"},"createdAt":"2026-11-20T21:12:08.367Z","updatedAt":"2026-11-20T21:12:08.367Z","archivedAt":"2026-11-20T21:12:08.367Z","preventDeletingError":"error.items.deleteOne.hasTransactionsError","unitOfMeasure":null,"secondaryUnit":null},{"id":"item_c1574b87-68d6-448a-ac18-4a5f0e68d535","name":"Item 2","assetId":"AB-123457","barcode":{"value":"3801234567892","type":"BARCODE"},"price":10,"cost":10,"trackInventory":true,"groupId":"168455faf-4539-47d0-bb77-ac814f16d8c8","attributes":["attribute 1","attribute 2"],"locationQuantities":[{"id":"loc_6da0d90b-4efa-47f8-8823-8b5a1c8220cf","name":"Location 1","code":"location-1","quantity":1,"ancestorIds":[]}],"quantity":1,"minLevel":1,"description":"Description","category":{"id":"cat_b09ce6cd-76f5-4113-895c-0f36ae7365c2","name":"Category 2"},"customFieldValues":[{"id":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c7","value":"value 2","name":"My custom field","type":"short-text","defaultValue":"","required":false}],"workspaceCustomFieldValues":[],"images":[{"url":"https://example.com/image.jpg","name":"image.jpg"}],"tags":[{"id":"tag_b09ce6cd-76f5-4113-895c-0f36ae7365a2","name":"Tag 2"}],"workspaceIds":["ws_b09ce6cd-76f5-4113-895c-0f36ae7365a4"],"supplier":{"id":"sup_b09ce6cd-76f5-4113-895c-0f36ae7365c4","name":"Item supplier X"},"createdAt":"2026-11-20T21:12:08.367Z","updatedAt":"2026-11-20T21:12:08.367Z","archivedAt":"2026-11-20T21:12:08.367Z","preventDeletingError":"error.items.deleteOne.hasTransactionsError","unitOfMeasure":null,"secondaryUnit":null}]}},"ItemGetOneResponse":{"type":"object","properties":{"id":{"type":"string"},"assetId":{"type":"string","minLength":1,"default":""},"name":{"type":"string"},"price":{"type":"integer"},"cost":{"type":"integer"},"groupId":{"type":"string"},"attributes":{"type":"array","items":{"type":"string"}},"locationQuantities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""},"code":{"type":["string","null"],"minLength":1,"default":""},"ancestorIds":{"type":"array","items":{"type":"string","minLength":1,"default":""}},"quantity":{"type":"number"},"reservedQuantity":{"type":"number"},"cost":{"type":"number","minimum":0},"backorderedQuantity":{"type":"integer"}},"required":["id","name","ancestorIds","quantity"]}},"minLevel":{"type":["number","null"]},"restockTargetLevel":{"type":["number","null"]},"locationLevels":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"default":""},"minLevel":{"type":["number","null"]},"restockTargetLevel":{"type":["number","null"]}},"required":["locationId"]},"default":[]},"category":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"customFieldValues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"type":{"type":"string","enum":["short-text","long-text","integer","decimal","date","datetime","time","boolean","select","multiselect","barcode"]},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"required":{"type":"boolean","default":false},"code":{"type":["string","null"]},"system":{"type":"boolean"}},"required":["id","name","type","required"]}},"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":["string","null"]},"originalUrl":{"type":"string"}},"required":["url"]}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""}},"required":["id","name"]}},"workspaceIds":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"barcode":{"type":["object","null"],"properties":{"value":{"type":"string","minLength":1},"type":{"type":"string","enum":["BARCODE","QRCODE"]}},"required":["value","type"]},"clientCorrelationId":{"type":["string","null"]},"costingMethod":{"type":"string","enum":["average","fifo","lifo"]},"itemType":{"type":"string","enum":["component","build","service"],"default":"component"},"replenishmentMethod":{"type":"string","enum":["buy","make"],"default":"buy"},"trackInventory":{"type":"boolean"},"traceabilityType":{"type":"string","enum":["none","serial","batch"],"default":"none"},"serialNumberFormat":{"type":["string","null"]},"unitOfMeasureId":{"type":["string","null"],"description":"The Stocking Unit: the unit every quantity, cost and price of the item is stated in. No unit means Unit. An update may change it to a unit of the same category, or to the item's current Secondary Unit, and either converts the stock, cost and price - the price only when the update omits it (see price). Changing to the Secondary Unit swaps the two units and inverts the factor: 2 Units per kg becomes 0.5 kg per Unit. Any other unit is refused. Changing it requires the unitOfMeasure feature: with it off, a different unit is refused with error.unitOfMeasure.stockingUnitChangeFeatureDisabled and nothing is written, while the current unit sent back unchanged is accepted."},"secondaryUnit":{"type":["object","null"],"properties":{"unitOfMeasureId":{"type":"string","minLength":1},"factor":{"type":"number","description":"The Secondary Unit Factor: how many stocking units one Secondary Unit equals, stored at 6 decimal places. Stock in the Secondary Unit is quantity / factor."},"unitOfMeasure":{"oneOf":[{"$ref":"#/components/schemas/UnitOfMeasure"},{"type":"null"}]}},"required":["unitOfMeasureId","factor","unitOfMeasure"],"description":"The Secondary Unit, a Measure Unit from another category than the Stocking Unit, with its factor. Null for an item without one, or when the unitOfMeasure feature is off."},"weightValue":{"type":["number","null"]},"weightUnit":{"type":["string","null"],"enum":["kg","lb","oz","g",null]},"lockVersion":{"type":"integer","default":0},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"archivedAt":{"type":"string"},"preventDeletingError":{"type":"string","enum":["error.items.deleteOne.hasSaleOrders","error.items.deleteOne.hasPurchaseOrders","error.items.deleteOne.hasTransactionsError","error.items.deleteOne.hasBom","error.items.deleteOne.hasManufacturingOrders","error.items.deleteOne.hasStockCounts"]},"hasVariants":{"type":"boolean"},"parentItemId":{"type":"string"},"variantSchema":{"type":"object","properties":{"customFieldIds":{"type":"array","items":{"type":"string","minLength":1,"default":""},"minItems":1},"allowedValues":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"string","minLength":1,"default":""},"values":{"type":"array","items":{"type":"string"}}},"required":["customFieldId","values"]}},"excludedCombinations":{"type":"array","items":{"type":"array","items":{"type":"string"}}}},"required":["customFieldIds","allowedValues"]},"variantValues":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"string","minLength":1,"default":""},"customFieldName":{"type":"string","minLength":1,"default":""},"value":{"type":"string"}},"required":["customFieldId","customFieldName","value"]}},"descriptionOverride":{"type":"boolean"},"imagesOverride":{"type":"boolean"},"bomOverride":{"type":"string","enum":["inherit","modified","custom"]},"suppliersOverride":{"type":"string","enum":["inherit","modified","custom"]},"insufficientInventoryPolicy":{"type":["string","null"],"enum":["disallow_order","warn_and_allow_backorder","allow_backorder",null]},"workspaceCustomFieldValues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"type":{"type":"string","enum":["short-text","long-text","integer","decimal","date","datetime","time","boolean","select","multiselect","barcode"]},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"required":{"type":"boolean","default":false},"code":{"type":["string","null"]},"system":{"type":"boolean"},"valueId":{"type":["string","null"]}},"required":["id","name","type","required"]}},"workspaceId":{"type":["string","null"]},"prevItemId":{"type":["string","null"]},"nextItemId":{"type":["string","null"]},"quantity":{"type":"number"},"supplier":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"catalogNumber":{"type":"string"},"catalogItemId":{"type":"string"},"purchaseUnitOfMeasureId":{"type":["string","null"]},"unitsPerPurchaseUnit":{"type":["number","null"],"exclusiveMinimum":0},"isDefault":{"type":"boolean"}},"required":["id","name"]},"unitOfMeasure":{"oneOf":[{"$ref":"#/components/schemas/UnitOfMeasure"},{"type":"null"}],"description":"The Stocking Unit, resolved, and Unit when the item stores none. Null when the unitOfMeasure feature is off."}},"required":["id","assetId","name","price","cost","attributes","locationQuantities","locationLevels","customFieldValues","images","tags","workspaceIds","description","itemType","replenishmentMethod","trackInventory","secondaryUnit","lockVersion","createdAt","updatedAt","workspaceCustomFieldValues","prevItemId","nextItemId","quantity","unitOfMeasure"],"description":"Get one item","example":{"id":"item_c1574b87-68d6-448a-ac18-4a5f0e68d534","assetId":"AB-123456","barcode":{"value":"3801234567891","type":"BARCODE"},"name":"Item 1","price":10,"cost":10,"trackInventory":true,"groupId":"168455faf-4539-47d0-bb77-ac814f16d8c7","attributes":["attribute 1","attribute 2"],"locationQuantities":[{"id":"loc_6da0d90b-4efa-47f8-8823-8b5a1c8220ce","name":"Location 1","code":"location-1","quantity":1,"ancestorIds":[]}],"quantity":1,"minLevel":1,"description":"Description","category":{"id":"cat_b09ce6cd-76f5-4113-895c-0f36ae7365c3","name":"Category 1"},"customFieldValues":[{"id":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c6","value":"value 1","name":"My custom field","type":"short-text","defaultValue":"","required":false}],"workspaceCustomFieldValues":[{"id":"cf_a10ce6cd-76f5-4113-895c-0f36ae7365c7","value":"value in workspace","name":"My workspace custom field","type":"short-text","defaultValue":"","required":false,"valueId":"iwcfv_a10ce6cd-76f5-4113-895c-0f36ae7365c7"}],"images":[{"url":"https://example.com/image.jpg","name":"image.jpg"}],"tags":[{"id":"tag_b09ce6cd-76f5-4113-895c-0f36ae7365a3","name":"Tag 1"}],"workspaceIds":["ws_b09ce6cd-76f5-4113-895c-0f36ae7365a4"],"supplier":{"id":"sup_b09ce6cd-76f5-4113-895c-0f36ae7365c4","name":"Item supplier X"},"createdAt":"2026-11-20T21:12:08.368Z","updatedAt":"2026-11-20T21:12:08.368Z","archivedAt":"2026-11-20T21:12:08.368Z","preventDeletingError":"error.items.deleteOne.hasTransactionsError","nextItemId":null,"prevItemId":null,"unitOfMeasureId":"system:m","unitOfMeasure":{"id":"system:m","name":"Meter","symbol":"m","category":"length","conversionFactor":1,"decimalPlaces":3},"secondaryUnit":{"unitOfMeasureId":"system:kg","factor":0.25,"unitOfMeasure":{"id":"system:kg","name":"Kilogram","symbol":"kg","category":"weight","conversionFactor":1,"decimalPlaces":3}}}},"ItemCreateOneResponse":{"type":"object","properties":{"id":{"type":"string"},"assetId":{"type":"string","minLength":1,"default":""},"name":{"type":"string"},"price":{"type":"integer"},"cost":{"type":"integer"},"groupId":{"type":"string"},"attributes":{"type":"array","items":{"type":"string"}},"locationQuantities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""},"code":{"type":["string","null"],"minLength":1,"default":""},"ancestorIds":{"type":"array","items":{"type":"string","minLength":1,"default":""}},"quantity":{"type":"number"},"reservedQuantity":{"type":"number"},"cost":{"type":"number","minimum":0},"backorderedQuantity":{"type":"integer"}},"required":["id","name","ancestorIds","quantity"]}},"minLevel":{"type":["number","null"]},"restockTargetLevel":{"type":["number","null"]},"locationLevels":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"default":""},"minLevel":{"type":["number","null"]},"restockTargetLevel":{"type":["number","null"]}},"required":["locationId"]},"default":[]},"category":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"customFieldValues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"type":{"type":"string","enum":["short-text","long-text","integer","decimal","date","datetime","time","boolean","select","multiselect","barcode"]},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"required":{"type":"boolean","default":false},"code":{"type":["string","null"]},"system":{"type":"boolean"}},"required":["id","name","type","required"]}},"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":["string","null"]},"originalUrl":{"type":"string"}},"required":["url"]}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""}},"required":["id","name"]}},"workspaceIds":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"barcode":{"type":["object","null"],"properties":{"value":{"type":"string","minLength":1},"type":{"type":"string","enum":["BARCODE","QRCODE"]}},"required":["value","type"]},"clientCorrelationId":{"type":["string","null"]},"costingMethod":{"type":"string","enum":["average","fifo","lifo"]},"itemType":{"type":"string","enum":["component","build","service"],"default":"component"},"replenishmentMethod":{"type":"string","enum":["buy","make"],"default":"buy"},"trackInventory":{"type":"boolean"},"traceabilityType":{"type":"string","enum":["none","serial","batch"],"default":"none"},"serialNumberFormat":{"type":["string","null"]},"unitOfMeasureId":{"type":["string","null"]},"secondaryUnit":{"type":["object","null"],"properties":{"unitOfMeasureId":{"type":"string","minLength":1},"factor":{"type":"number"}},"required":["unitOfMeasureId","factor"]},"weightValue":{"type":["number","null"]},"weightUnit":{"type":["string","null"],"enum":["kg","lb","oz","g",null]},"lockVersion":{"type":"integer","default":0},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"archivedAt":{"type":"string"},"preventDeletingError":{"type":"string","enum":["error.items.deleteOne.hasSaleOrders","error.items.deleteOne.hasPurchaseOrders","error.items.deleteOne.hasTransactionsError","error.items.deleteOne.hasBom","error.items.deleteOne.hasManufacturingOrders","error.items.deleteOne.hasStockCounts"]},"hasVariants":{"type":"boolean"},"parentItemId":{"type":"string"},"variantSchema":{"type":"object","properties":{"customFieldIds":{"type":"array","items":{"type":"string","minLength":1,"default":""},"minItems":1},"allowedValues":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"string","minLength":1,"default":""},"values":{"type":"array","items":{"type":"string"}}},"required":["customFieldId","values"]}},"excludedCombinations":{"type":"array","items":{"type":"array","items":{"type":"string"}}}},"required":["customFieldIds","allowedValues"]},"variantValues":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"string","minLength":1,"default":""},"customFieldName":{"type":"string","minLength":1,"default":""},"value":{"type":"string"}},"required":["customFieldId","customFieldName","value"]}},"descriptionOverride":{"type":"boolean"},"imagesOverride":{"type":"boolean"},"bomOverride":{"type":"string","enum":["inherit","modified","custom"]},"suppliersOverride":{"type":"string","enum":["inherit","modified","custom"]},"insufficientInventoryPolicy":{"type":["string","null"],"enum":["disallow_order","warn_and_allow_backorder","allow_backorder",null]},"workspaceCustomFieldValues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"type":{"type":"string","enum":["short-text","long-text","integer","decimal","date","datetime","time","boolean","select","multiselect","barcode"]},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"required":{"type":"boolean","default":false},"code":{"type":["string","null"]},"system":{"type":"boolean"},"valueId":{"type":["string","null"]}},"required":["id","name","type","required"]}},"workspaceId":{"type":["string","null"]},"prevItemId":{"type":["string","null"]},"nextItemId":{"type":["string","null"]},"quantity":{"type":"number"},"supplier":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"catalogNumber":{"type":"string"},"catalogItemId":{"type":"string"},"purchaseUnitOfMeasureId":{"type":["string","null"]},"unitsPerPurchaseUnit":{"type":["number","null"],"exclusiveMinimum":0},"isDefault":{"type":"boolean"}},"required":["id","name"]}},"required":["id","assetId","name","price","cost","attributes","locationQuantities","locationLevels","customFieldValues","images","tags","workspaceIds","description","itemType","replenishmentMethod","trackInventory","lockVersion","createdAt","updatedAt","workspaceCustomFieldValues","prevItemId","nextItemId","quantity"],"description":"The created item"},"UnitOfMeasure":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"symbol":{"type":["string","null"]},"category":{"type":"string","enum":["unit","weight","volume","length","surface","work_time"]},"conversionFactor":{"type":"number","description":"How many of its category's base unit one of this unit equals"},"decimalPlaces":{"type":"integer","description":"The precision quantities in this unit are stated at"}},"required":["id","name","category","conversionFactor","decimalPlaces"],"description":"A unit of measure"},"ItemDeleteManyResponse":{"type":"number","description":"Returns total number of deleted items","example":55},"ItemArchiveManyResponse":{"type":"number","description":"Returns total number of archived items","example":55},"ItemCreateOneRequest":{"type":"object","properties":{"assetId":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1},"price":{"type":"number","default":0},"cost":{"type":"number","default":0},"locationQuantities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"cost":{"type":"number","minimum":0},"quantity":{"type":"number","minimum":0}},"required":["id","quantity"]},"default":[]},"minLevel":{"anyOf":[{"type":"number","exclusiveMinimum":0},{"type":"string","const":""},{"type":"null"}],"default":null,"description":"The minimum stock level, stated in the Stocking Unit. It may have decimals - 2.5 for an item in kg - and is stored at the unit's precision (its decimalPlaces), so an item in Units stores 2.5 as 3. Positive; null or empty for none."},"restockTargetLevel":{"anyOf":[{"type":"number","exclusiveMinimum":0},{"type":"string","const":""},{"type":"null"}],"default":null,"description":"The level a restock brings the stock back to, stated in the Stocking Unit. Like minLevel it may have decimals and is stored at the unit's precision, and it must be above minLevel. When only that rounding makes the two equal, the target is stored one step above (2.0001 and 2.0004 kg become 2 and 2.001). Positive; null or empty for none."},"locationLevels":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"default":""},"minLevel":{"type":["number","null"]},"restockTargetLevel":{"type":["number","null"]}},"required":["locationId"]}},"categoryId":{"type":["string","null"]},"customFieldValues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]}},"required":["id"]}},"description":{"type":"string","default":""},"tags":{"type":"array","items":{"type":"string","minLength":1,"default":""},"default":[]},"barcode":{"type":["object","null"],"properties":{"value":{"type":"string","minLength":1},"type":{"type":"string","enum":["BARCODE","QRCODE"]}},"required":["value","type"]},"clientCorrelationId":{"type":["string","null"]},"workspaceId":{"type":["string","null"]},"costingMethod":{"type":"string","enum":["average","fifo","lifo"]},"itemType":{"type":"string","enum":["component","build","service"],"default":"component"},"replenishmentMethod":{"type":"string","enum":["buy","make"],"default":"buy"},"traceabilityType":{"type":"string","enum":["none","serial","batch"],"default":"none"},"serialNumberFormat":{"type":["string","null"]},"unitOfMeasureId":{"type":["string","null"]},"weightValue":{"type":["number","null"]},"weightUnit":{"type":["string","null"],"enum":["kg","lb","oz","g",null]},"supplierId":{"type":"string"}},"required":["name","customFieldValues","supplierId"],"description":"Create one item","example":{"name":"Item 1","assetId":"AB-123456","barcode":{"value":"380123456789","type":"BARCODE"},"locationQuantities":[{"id":"loc_6da0d90b-4efa-47f8-8823-8b5a1c8220ce","quantity":1,"cost":6.8}],"price":10.5,"cost":6.8,"minLevel":1,"description":"Description","categoryId":"cat_b09ce6cd-76f5-4113-895c-0f36ae7365c3","customFieldValues":[{"id":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c6","value":"value 1"}],"supplierId":"sup_b09ce6cd-76f5-4113-895c-0f36ae7365c4","tags":["Tag 1","Tag 2"],"itemType":"component"}},"ItemCreateManyRequest":{"type":"array","items":{"type":"object","properties":{"assetId":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1},"price":{"type":"number","default":0},"cost":{"type":"number","default":0},"locationQuantities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"cost":{"type":"number","minimum":0},"quantity":{"type":"number","minimum":0}},"required":["id","quantity"]},"default":[]},"minLevel":{"anyOf":[{"type":"number","exclusiveMinimum":0},{"type":"string","const":""},{"type":"null"}],"default":null,"description":"The minimum stock level, stated in the Stocking Unit. It may have decimals - 2.5 for an item in kg - and is stored at the unit's precision (its decimalPlaces), so an item in Units stores 2.5 as 3. Positive; null or empty for none."},"restockTargetLevel":{"anyOf":[{"type":"number","exclusiveMinimum":0},{"type":"string","const":""},{"type":"null"}],"default":null,"description":"The level a restock brings the stock back to, stated in the Stocking Unit. Like minLevel it may have decimals and is stored at the unit's precision, and it must be above minLevel. When only that rounding makes the two equal, the target is stored one step above (2.0001 and 2.0004 kg become 2 and 2.001). Positive; null or empty for none."},"locationLevels":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"default":""},"minLevel":{"type":["number","null"]},"restockTargetLevel":{"type":["number","null"]}},"required":["locationId"]}},"categoryId":{"type":["string","null"]},"supplierIds":{"type":"array","items":{"type":"string"},"default":[]},"customFieldValues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]}},"required":["id"]}},"description":{"type":"string","default":""},"tags":{"type":"array","items":{"type":"string","minLength":1,"default":""},"default":[]},"barcode":{"type":["object","null"],"properties":{"value":{"type":"string","minLength":1},"type":{"type":"string","enum":["BARCODE","QRCODE"]}},"required":["value","type"]},"clientCorrelationId":{"type":["string","null"]},"workspaceId":{"type":["string","null"]},"costingMethod":{"type":"string","enum":["average","fifo","lifo"]},"itemType":{"type":"string","enum":["component","build","service"],"default":"component"},"replenishmentMethod":{"type":"string","enum":["buy","make"],"default":"buy"},"traceabilityType":{"type":"string","enum":["none","serial","batch"],"default":"none"},"serialNumberFormat":{"type":["string","null"]},"unitOfMeasureId":{"type":["string","null"]},"weightValue":{"type":["number","null"]},"weightUnit":{"type":["string","null"],"enum":["kg","lb","oz","g",null]}},"required":["name","customFieldValues"]},"minItems":1,"maxItems":2500,"description":"Create multiple items in bulk","example":[{"name":"Item 1","assetId":"AB-123456","clientCorrelationId":"550e8400-e29b-41d4-a716-446655440000","locationQuantities":[{"id":"loc_6da0d90b-4efa-47f8-8823-8b5a1c8220ce","quantity":10,"cost":6.8}],"customFieldValues":[{"id":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c6","value":"value 1"}],"price":10.5,"cost":6.8,"categoryId":"cat_b09ce6cd-76f5-4113-895c-0f36ae7365c3","tags":["Tag 1"],"itemType":"component"},{"name":"Item 2","clientCorrelationId":"550e8400-e29b-41d4-a716-446655440001","locationQuantities":[{"id":"loc_6da0d90b-4efa-47f8-8823-8b5a1c8220ce","quantity":5}],"customFieldValues":[{"id":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c6","value":"value 2"}],"price":15,"cost":8,"itemType":"build"}]},"ItemCreateManyResponse":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"assetId":{"type":"string","minLength":1,"default":""},"name":{"type":"string"},"price":{"type":"integer"},"cost":{"type":"integer"},"groupId":{"type":"string"},"attributes":{"type":"array","items":{"type":"string"}},"locationQuantities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""},"code":{"type":["string","null"],"minLength":1,"default":""},"ancestorIds":{"type":"array","items":{"type":"string","minLength":1,"default":""}},"quantity":{"type":"number"},"reservedQuantity":{"type":"number"},"cost":{"type":"number","minimum":0},"backorderedQuantity":{"type":"integer"}},"required":["id","name","ancestorIds","quantity"]}},"minLevel":{"type":["number","null"]},"restockTargetLevel":{"type":["number","null"]},"locationLevels":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"default":""},"minLevel":{"type":["number","null"]},"restockTargetLevel":{"type":["number","null"]}},"required":["locationId"]},"default":[]},"category":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"suppliers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"catalogNumber":{"type":"string"},"catalogItemId":{"type":"string"},"purchaseUnitOfMeasureId":{"type":["string","null"]},"unitsPerPurchaseUnit":{"type":["number","null"],"exclusiveMinimum":0},"isDefault":{"type":"boolean"}},"required":["id","name"]}},"customFieldValues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"type":{"type":"string","enum":["short-text","long-text","integer","decimal","date","datetime","time","boolean","select","multiselect","barcode"]},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"required":{"type":"boolean","default":false},"code":{"type":["string","null"]},"system":{"type":"boolean"}},"required":["id","name","type","required"]}},"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":["string","null"]},"originalUrl":{"type":"string"}},"required":["url"]}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""}},"required":["id","name"]}},"workspaceIds":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"barcode":{"type":["object","null"],"properties":{"value":{"type":"string","minLength":1},"type":{"type":"string","enum":["BARCODE","QRCODE"]}},"required":["value","type"]},"clientCorrelationId":{"type":["string","null"]},"costingMethod":{"type":"string","enum":["average","fifo","lifo"]},"itemType":{"type":"string","enum":["component","build","service"],"default":"component"},"replenishmentMethod":{"type":"string","enum":["buy","make"],"default":"buy"},"trackInventory":{"type":"boolean"},"traceabilityType":{"type":"string","enum":["none","serial","batch"],"default":"none"},"serialNumberFormat":{"type":["string","null"]},"unitOfMeasureId":{"type":["string","null"]},"secondaryUnit":{"type":["object","null"],"properties":{"unitOfMeasureId":{"type":"string","minLength":1},"factor":{"type":"number"}},"required":["unitOfMeasureId","factor"]},"weightValue":{"type":["number","null"]},"weightUnit":{"type":["string","null"],"enum":["kg","lb","oz","g",null]},"lockVersion":{"type":"integer","default":0},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"archivedAt":{"type":"string"},"preventDeletingError":{"type":"string","enum":["error.items.deleteOne.hasSaleOrders","error.items.deleteOne.hasPurchaseOrders","error.items.deleteOne.hasTransactionsError","error.items.deleteOne.hasBom","error.items.deleteOne.hasManufacturingOrders","error.items.deleteOne.hasStockCounts"]},"hasVariants":{"type":"boolean"},"parentItemId":{"type":"string"},"variantSchema":{"type":"object","properties":{"customFieldIds":{"type":"array","items":{"type":"string","minLength":1,"default":""},"minItems":1},"allowedValues":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"string","minLength":1,"default":""},"values":{"type":"array","items":{"type":"string"}}},"required":["customFieldId","values"]}},"excludedCombinations":{"type":"array","items":{"type":"array","items":{"type":"string"}}}},"required":["customFieldIds","allowedValues"]},"variantValues":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"string","minLength":1,"default":""},"customFieldName":{"type":"string","minLength":1,"default":""},"value":{"type":"string"}},"required":["customFieldId","customFieldName","value"]}},"descriptionOverride":{"type":"boolean"},"imagesOverride":{"type":"boolean"},"bomOverride":{"type":"string","enum":["inherit","modified","custom"]},"suppliersOverride":{"type":"string","enum":["inherit","modified","custom"]},"insufficientInventoryPolicy":{"type":["string","null"],"enum":["disallow_order","warn_and_allow_backorder","allow_backorder",null]},"quantity":{"type":"number"},"supplier":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"catalogNumber":{"type":"string"},"catalogItemId":{"type":"string"},"purchaseUnitOfMeasureId":{"type":["string","null"]},"unitsPerPurchaseUnit":{"type":["number","null"],"exclusiveMinimum":0},"isDefault":{"type":"boolean"}},"required":["id","name"]},"workspaceCustomFieldValues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"type":{"type":"string","enum":["short-text","long-text","integer","decimal","date","datetime","time","boolean","select","multiselect","barcode"]},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"required":{"type":"boolean","default":false},"code":{"type":["string","null"]},"system":{"type":"boolean"},"valueId":{"type":["string","null"]}},"required":["id","name","type","required"]}}},"required":["id","assetId","name","price","cost","attributes","locationQuantities","locationLevels","suppliers","customFieldValues","images","tags","workspaceIds","description","itemType","replenishmentMethod","trackInventory","lockVersion","createdAt","updatedAt","quantity","workspaceCustomFieldValues"]},"description":"Bulk created items"},"ItemExpandedResponse":{"type":"object","properties":{"id":{"type":"string"},"assetId":{"type":"string","minLength":1,"default":""},"name":{"type":"string"},"price":{"type":"integer"},"cost":{"type":"integer"},"groupId":{"type":"string"},"attributes":{"type":"array","items":{"type":"string"}},"locationQuantities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""},"code":{"type":["string","null"],"minLength":1,"default":""},"ancestorIds":{"type":"array","items":{"type":"string","minLength":1,"default":""}},"quantity":{"type":"number"},"reservedQuantity":{"type":"number"},"cost":{"type":"number","minimum":0},"backorderedQuantity":{"type":"integer"}},"required":["id","name","ancestorIds","quantity"]}},"minLevel":{"type":["number","null"]},"restockTargetLevel":{"type":["number","null"]},"locationLevels":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"default":""},"minLevel":{"type":["number","null"]},"restockTargetLevel":{"type":["number","null"]}},"required":["locationId"]},"default":[]},"category":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"customFieldValues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"type":{"type":"string","enum":["short-text","long-text","integer","decimal","date","datetime","time","boolean","select","multiselect","barcode"]},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"required":{"type":"boolean","default":false},"code":{"type":["string","null"]},"system":{"type":"boolean"}},"required":["id","name","type","required"]}},"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":["string","null"]},"originalUrl":{"type":"string"}},"required":["url"]}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""}},"required":["id","name"]}},"workspaceIds":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"barcode":{"type":["object","null"],"properties":{"value":{"type":"string","minLength":1},"type":{"type":"string","enum":["BARCODE","QRCODE"]}},"required":["value","type"]},"clientCorrelationId":{"type":["string","null"]},"costingMethod":{"type":"string","enum":["average","fifo","lifo"]},"itemType":{"type":"string","enum":["component","build","service"],"default":"component"},"replenishmentMethod":{"type":"string","enum":["buy","make"],"default":"buy"},"trackInventory":{"type":"boolean"},"traceabilityType":{"type":"string","enum":["none","serial","batch"],"default":"none"},"serialNumberFormat":{"type":["string","null"]},"unitOfMeasureId":{"type":["string","null"]},"secondaryUnit":{"type":["object","null"],"properties":{"unitOfMeasureId":{"type":"string","minLength":1},"factor":{"type":"number"}},"required":["unitOfMeasureId","factor"]},"weightValue":{"type":["number","null"]},"weightUnit":{"type":["string","null"],"enum":["kg","lb","oz","g",null]},"lockVersion":{"type":"integer","default":0},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"archivedAt":{"type":"string"},"preventDeletingError":{"type":"string","enum":["error.items.deleteOne.hasSaleOrders","error.items.deleteOne.hasPurchaseOrders","error.items.deleteOne.hasTransactionsError","error.items.deleteOne.hasBom","error.items.deleteOne.hasManufacturingOrders","error.items.deleteOne.hasStockCounts"]},"hasVariants":{"type":"boolean"},"parentItemId":{"type":"string"},"variantSchema":{"type":"object","properties":{"customFieldIds":{"type":"array","items":{"type":"string","minLength":1,"default":""},"minItems":1},"allowedValues":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"string","minLength":1,"default":""},"values":{"type":"array","items":{"type":"string"}}},"required":["customFieldId","values"]}},"excludedCombinations":{"type":"array","items":{"type":"array","items":{"type":"string"}}}},"required":["customFieldIds","allowedValues"]},"variantValues":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"string","minLength":1,"default":""},"customFieldName":{"type":"string","minLength":1,"default":""},"value":{"type":"string"}},"required":["customFieldId","customFieldName","value"]}},"descriptionOverride":{"type":"boolean"},"imagesOverride":{"type":"boolean"},"bomOverride":{"type":"string","enum":["inherit","modified","custom"]},"suppliersOverride":{"type":"string","enum":["inherit","modified","custom"]},"insufficientInventoryPolicy":{"type":["string","null"],"enum":["disallow_order","warn_and_allow_backorder","allow_backorder",null]},"quantity":{"type":"number"},"supplier":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"catalogNumber":{"type":"string"},"catalogItemId":{"type":"string"},"purchaseUnitOfMeasureId":{"type":["string","null"]},"unitsPerPurchaseUnit":{"type":["number","null"],"exclusiveMinimum":0},"isDefault":{"type":"boolean"}},"required":["id","name"]},"workspaceCustomFieldValues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"type":{"type":"string","enum":["short-text","long-text","integer","decimal","date","datetime","time","boolean","select","multiselect","barcode"]},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"required":{"type":"boolean","default":false},"code":{"type":["string","null"]},"system":{"type":"boolean"},"valueId":{"type":["string","null"]}},"required":["id","name","type","required"]}}},"required":["id","assetId","name","price","cost","attributes","locationQuantities","locationLevels","customFieldValues","images","tags","workspaceIds","description","itemType","replenishmentMethod","trackInventory","lockVersion","createdAt","updatedAt","quantity","workspaceCustomFieldValues"],"description":"Item with category and custom fields.","example":{"id":"c1574b87-68d6-448a-ac18-4a5f0e68d534","assetId":"AB-123456","barcode":{"value":"380123456789","type":"BARCODE"},"name":"Item 1","price":10,"cost":10,"trackInventory":true,"groupId":"168455faf-4539-47d0-bb77-ac814f16d8c7","attributes":["attribute 1","attribute 2"],"locationQuantities":[{"id":"loc_6da0d90b-4efa-47f8-8823-8b5a1c8220ce","name":"Location 1","code":"location-1","quantity":1,"ancestorIds":[]}],"quantity":1,"minLevel":1,"description":"Description","category":{"id":"cat_b09ce6cd-76f5-4113-895c-0f36ae7365c3","name":"Category 1"},"customFieldValues":[{"id":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c6","value":"value 1","name":"My custom field","type":"short-text","defaultValue":"","required":false}],"workspaceCustomFieldValues":[{"id":"cf_a10ce6cd-76f5-4113-895c-0f36ae7365c7","value":"value in workspace","name":"My workspace custom field","type":"short-text","defaultValue":"","required":false,"valueId":"iwcfv_a10ce6cd-76f5-4113-895c-0f36ae7365c7"}],"images":[{"url":"https://example.com/image.jpg","name":"image.jpg"}],"tags":[{"id":"tag_b09ce6cd-76f5-4113-895c-0f36ae7365a3","name":"Tag 1"}],"workspaceIds":["ws_b09ce6cd-76f5-4113-895c-0f36ae7365a4","ws_b09ce6cd-76f5-4113-895c-0f36ae7365a5"],"supplier":{"id":"sup_b09ce6cd-76f5-4113-895c-0f36ae7365c4","name":"Item supplier X"},"createdAt":"2026-11-20T21:12:08.368Z","updatedAt":"2026-11-20T21:12:08.368Z","archivedAt":"2026-11-20T21:12:08.368Z","preventDeletingError":"error.items.deleteOne.hasTransactionsError"}},"ItemUpdateOneRequest":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"assetId":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1},"price":{"type":"number","description":"The selling price per Stocking Unit. Omit it to keep the stored price. A price sent is stored exactly as sent, stated in the unit the item ends in - even when it equals the stored one. When the update also changes the Stocking Unit, an omitted price is rescaled with it (2.00 a Unit becomes 24.00 a Dozen), while a price sent is not: sending the stored 2.00 with a change to Dozen keeps 2.00 a Dozen."},"cost":{"type":"number"},"minLevel":{"anyOf":[{"type":"number","exclusiveMinimum":0},{"type":"string","const":""},{"type":"null"}],"default":null,"description":"The minimum stock level, stated in the Stocking Unit. It may have decimals - 2.5 for an item in kg - and is stored at the unit's precision (its decimalPlaces), so an item in Units stores 2.5 as 3. Positive; null or empty for none."},"restockTargetLevel":{"anyOf":[{"type":"number","exclusiveMinimum":0},{"type":"string","const":""},{"type":"null"}],"default":null,"description":"The level a restock brings the stock back to, stated in the Stocking Unit. Like minLevel it may have decimals and is stored at the unit's precision, and it must be above minLevel. When only that rounding makes the two equal, the target is stored one step above (2.0001 and 2.0004 kg become 2 and 2.001). Positive; null or empty for none."},"categoryId":{"type":["string","null"]},"supplierLinkSettings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"isDefault":{"type":"boolean"},"purchaseUnitOfMeasureId":{"type":["string","null"]},"unitsPerPurchaseUnit":{"type":["number","null"],"exclusiveMinimum":0}},"required":["id"]}},"customFieldValues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"type":{"type":"string","enum":["short-text","long-text","integer","decimal","date","datetime","time","boolean","select","multiselect","barcode"]},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"required":{"type":"boolean","default":false},"code":{"type":["string","null"]},"system":{"type":"boolean"}},"required":["id","name","type"]}},"description":{"type":"string","default":""},"barcode":{"type":["object","null"],"properties":{"value":{"type":"string","minLength":1},"type":{"type":"string","enum":["BARCODE","QRCODE"]}},"required":["value","type"]},"costingMethod":{"type":"string","enum":["average","fifo","lifo"]},"replenishmentMethod":{"type":"string","enum":["buy","make"],"default":"buy"},"traceabilityType":{"type":"string","enum":["none","serial","batch"]},"serialNumberFormat":{"type":["string","null"]},"unitOfMeasureId":{"type":["string","null"],"description":"The Stocking Unit: the unit every quantity, cost and price of the item is stated in. No unit means Unit. An update may change it to a unit of the same category, or to the item's current Secondary Unit, and either converts the stock, cost and price - the price only when the update omits it (see price). Changing to the Secondary Unit swaps the two units and inverts the factor: 2 Units per kg becomes 0.5 kg per Unit. Any other unit is refused. Changing it requires the unitOfMeasure feature: with it off, a different unit is refused with error.unitOfMeasure.stockingUnitChangeFeatureDisabled and nothing is written, while the current unit sent back unchanged is accepted."},"secondaryUnit":{"type":["object","null"],"properties":{"unitOfMeasureId":{"type":"string","minLength":1,"description":"A Measure Unit from a category other than the Stocking Unit's"},"factor":{"type":"number","description":"The Secondary Unit Factor, which must be positive"}},"required":["unitOfMeasureId","factor"],"description":"The Secondary Unit: stock stated in a second unit from another category, e.g. a bar stocked in m weighing 4 kg per metre has Secondary Unit kg at factor 0.25. Omit it to leave it alone, send null to remove it. On a variant only the factor may differ from its parent. Requires the unitOfMeasure feature."},"weightValue":{"type":["number","null"]},"weightUnit":{"type":["string","null"],"enum":["kg","lb","oz","g",null]},"supplierId":{"type":"string"}},"required":["id","name","customFieldValues","supplierId"],"description":"Update one item","example":{"id":"item_c1574b87-68d6-448a-ac18-4a5f0e68d534","assetId":"AB-123456","barcode":{"value":"380123456789","type":"BARCODE"},"name":"Item 1","price":10,"minLevel":1,"description":"Description","categoryId":"cat_b09ce6cd-76f5-4113-895c-0f36ae7365c3","customFieldValues":[{"id":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c6","value":"value 1","name":"My custom field","type":"short-text","defaultValue":"","required":false}],"supplierId":"b09ce6cd-76f5-4113-895c-0f36ae7365c4","secondaryUnit":{"unitOfMeasureId":"system:kg","factor":0.25}}},"ItemUpdateTagsRequest":{"type":"object","properties":{"itemId":{"type":"string","minLength":1,"default":""},"tags":{"type":"array","items":{"type":"string","minLength":1,"default":""}}},"required":["itemId","tags"],"description":"Update tags for item","example":{"itemId":"item_c1574b87-68d6-448a-ac18-4a5f0e68d534","tags":["Tag 1","Tag 2"]}},"ItemDeleteOneRequest":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""}},"required":["id"],"description":"Delete one item","example":{"id":"item_c1574b87-68d6-448a-ac18-4a5f0e68d534"}},"ItemArchiveOneRequest":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""}},"required":["id"],"description":"Archive one item","example":{"id":"item_c1574b87-68d6-448a-ac18-4a5f0e68d534"}},"ItemResponse":{"type":"object","properties":{"id":{"type":"string"},"assetId":{"type":"string","minLength":1,"default":""},"name":{"type":"string"},"price":{"type":"integer"},"cost":{"type":"integer"},"groupId":{"type":"string"},"attributes":{"type":"array","items":{"type":"string"}},"locationQuantities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""},"code":{"type":["string","null"],"minLength":1,"default":""},"ancestorIds":{"type":"array","items":{"type":"string","minLength":1,"default":""}},"quantity":{"type":"number"},"reservedQuantity":{"type":"number"},"cost":{"type":"number","minimum":0},"backorderedQuantity":{"type":"integer"}},"required":["id","name","ancestorIds","quantity"]}},"minLevel":{"type":["number","null"]},"restockTargetLevel":{"type":["number","null"]},"locationLevels":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"default":""},"minLevel":{"type":["number","null"]},"restockTargetLevel":{"type":["number","null"]}},"required":["locationId"]},"default":[]},"category":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"customFieldValues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"type":{"type":"string","enum":["short-text","long-text","integer","decimal","date","datetime","time","boolean","select","multiselect","barcode"]},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"required":{"type":"boolean","default":false},"code":{"type":["string","null"]},"system":{"type":"boolean"}},"required":["id","name","type","required"]}},"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":["string","null"]},"originalUrl":{"type":"string"}},"required":["url"]}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""}},"required":["id","name"]}},"workspaceIds":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"barcode":{"type":["object","null"],"properties":{"value":{"type":"string","minLength":1},"type":{"type":"string","enum":["BARCODE","QRCODE"]}},"required":["value","type"]},"clientCorrelationId":{"type":["string","null"]},"costingMethod":{"type":"string","enum":["average","fifo","lifo"]},"itemType":{"type":"string","enum":["component","build","service"],"default":"component"},"replenishmentMethod":{"type":"string","enum":["buy","make"],"default":"buy"},"trackInventory":{"type":"boolean"},"traceabilityType":{"type":"string","enum":["none","serial","batch"],"default":"none"},"serialNumberFormat":{"type":["string","null"]},"unitOfMeasureId":{"type":["string","null"]},"secondaryUnit":{"type":["object","null"],"properties":{"unitOfMeasureId":{"type":"string","minLength":1},"factor":{"type":"number"}},"required":["unitOfMeasureId","factor"]},"weightValue":{"type":["number","null"]},"weightUnit":{"type":["string","null"],"enum":["kg","lb","oz","g",null]},"lockVersion":{"type":"integer","default":0},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"archivedAt":{"type":"string"},"preventDeletingError":{"type":"string","enum":["error.items.deleteOne.hasSaleOrders","error.items.deleteOne.hasPurchaseOrders","error.items.deleteOne.hasTransactionsError","error.items.deleteOne.hasBom","error.items.deleteOne.hasManufacturingOrders","error.items.deleteOne.hasStockCounts"]},"hasVariants":{"type":"boolean"},"parentItemId":{"type":"string"},"variantSchema":{"type":"object","properties":{"customFieldIds":{"type":"array","items":{"type":"string","minLength":1,"default":""},"minItems":1},"allowedValues":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"string","minLength":1,"default":""},"values":{"type":"array","items":{"type":"string"}}},"required":["customFieldId","values"]}},"excludedCombinations":{"type":"array","items":{"type":"array","items":{"type":"string"}}}},"required":["customFieldIds","allowedValues"]},"variantValues":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"string","minLength":1,"default":""},"customFieldName":{"type":"string","minLength":1,"default":""},"value":{"type":"string"}},"required":["customFieldId","customFieldName","value"]}},"descriptionOverride":{"type":"boolean"},"imagesOverride":{"type":"boolean"},"bomOverride":{"type":"string","enum":["inherit","modified","custom"]},"suppliersOverride":{"type":"string","enum":["inherit","modified","custom"]},"insufficientInventoryPolicy":{"type":["string","null"],"enum":["disallow_order","warn_and_allow_backorder","allow_backorder",null]},"quantity":{"type":"number"},"supplier":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"catalogNumber":{"type":"string"},"catalogItemId":{"type":"string"},"purchaseUnitOfMeasureId":{"type":["string","null"]},"unitsPerPurchaseUnit":{"type":["number","null"],"exclusiveMinimum":0},"isDefault":{"type":"boolean"}},"required":["id","name"]},"workspaceCustomFieldValues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"type":{"type":"string","enum":["short-text","long-text","integer","decimal","date","datetime","time","boolean","select","multiselect","barcode"]},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"required":{"type":"boolean","default":false},"code":{"type":["string","null"]},"system":{"type":"boolean"},"valueId":{"type":["string","null"]}},"required":["id","name","type","required"]}}},"required":["id","assetId","name","price","cost","attributes","locationQuantities","locationLevels","customFieldValues","images","tags","workspaceIds","description","itemType","replenishmentMethod","trackInventory","lockVersion","createdAt","updatedAt","quantity","workspaceCustomFieldValues"],"description":"Item","example":{"id":"item_c1574b87-68d6-448a-ac18-4a5f0e68d534","assetId":"AB-123456","barcode":{"value":"380123456789","type":"BARCODE"},"name":"Item 1","price":10,"cost":10,"trackInventory":true,"groupId":"168455faf-4539-47d0-bb77-ac814f16d8c7","attributes":["attribute 1","attribute 2"],"locationQuantities":[{"id":"loc_6da0d90b-4efa-47f8-8823-8b5a1c8220ce","quantity":1,"name":"Sofia","code":"sof","ancestorIds":[]}],"quantity":1,"minLevel":1,"description":"Description","category":{"id":"cat_b09ce6cd-76f5-4113-895c-0f36ae7365c3","name":"MyCategory"},"customFieldValues":[{"id":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c6","value":"value 1","name":"My custom field","type":"short-text","defaultValue":"","required":false}],"workspaceCustomFieldValues":[{"id":"cf_a10ce6cd-76f5-4113-895c-0f36ae7365c7","value":"value in workspace","name":"My workspace custom field","type":"short-text","defaultValue":"","required":false,"valueId":"iwcfv_a10ce6cd-76f5-4113-895c-0f36ae7365c7"}],"supplier":{"id":"sup_b09ce6cd-76f5-4113-895c-0f36ae7365c4","name":"Item supplier X"},"images":[{"url":"https://example.com/image.jpg","name":"image.jpg"}],"tags":[{"name":"Tag 1","id":"tag_b09ce6cd-76f5-4113-895c-0f36ae7365a3"}],"createdAt":"2026-11-20T21:12:08.368Z","updatedAt":"2026-11-20T21:12:08.368Z","archivedAt":"2026-11-20T21:12:08.368Z","preventDeletingError":"error.items.deleteOne.hasTransactionsError","workspaceIds":["ws_b09ce6cd-76f5-4113-895c-0f36ae7365a4","ws_b09ce6cd-76f5-4113-895c-0f36ae7365a5"]}},"ItemAddImagesRequest":{"type":"object","properties":{"itemId":{"type":"string","minLength":1,"default":""},"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":["string","null"]},"originalUrl":{"type":"string"}},"required":["url"]}}},"required":["itemId","images"],"description":"Add images to item","example":{"itemId":"item_c1574b87-68d6-448a-ac18-4a5f0e68d534","images":[{"url":"https://example.com/image1.jpg","name":"image1.jpg"},{"url":"https://example.com/image2.jpg","name":"image2.jpg"}]}},"ItemDeleteImagesRequest":{"type":"object","properties":{"itemId":{"type":"string","minLength":1,"default":""},"urls":{"type":"array","items":{"type":"string","format":"uri","minLength":1}}},"required":["itemId","urls"],"description":"Delete images from item","example":{"itemId":"item_c1574b87-68d6-448a-ac18-4a5f0e68d534","urls":["https://example.com/image1.jpg","https://example.com/image2.jpg"]}},"ItemReorderImagesRequest":{"type":"object","properties":{"itemId":{"type":"string","minLength":1,"default":""},"urls":{"type":"array","items":{"type":"string","format":"uri","minLength":1}}},"required":["itemId","urls"],"description":"Reorder images for item","example":{"itemId":"item_c1574b87-68d6-448a-ac18-4a5f0e68d534","urls":["https://example.com/image1.jpg","https://example.com/image2.jpg"]}},"ItemImageUploadUrlRequest":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"description":"Original name of the file"},"contentType":{"type":"string","minLength":1,"description":"MIME type of the file"},"contentLength":{"type":"number","exclusiveMinimum":0,"description":"Size of the file in bytes"},"clientPayload":{"type":"string","minLength":1,"description":"Client payload that will be passed back to the server. For item this is the Item ID."}},"required":["filename","contentType","contentLength","clientPayload"],"description":"Request to generate client token for item image upload","example":{"filename":"1758711981868.jpg","contentType":"image/jpeg","contentLength":12345,"clientPayload":"item_67ae8705077117576359af4c"}},"ItemImageUploadUrlResponse":{"type":"object","properties":{"presignedUrl":{"type":"string","format":"uri"},"key":{"type":"string","minLength":1},"tokenPayload":{"type":"string","minLength":1}},"required":["presignedUrl","key","tokenPayload"],"description":"Generated client token for item image upload","example":{"presignedUrl":"https://assetblaze-dev-assets.s3.eu-central-1.amazonaws.com/org_2i<...>-id=PutObject","key":"org_2iKrI1aASsDFfKiXCz7PlYvsuP/items/1758711981868-ac04c26e.jpg","tokenPayload":"blob_token_eyJvcmdJZCI6<........>jUwMDMxIn0"}},"ItemImageUploadCallbackRequest":{"type":"object","properties":{"files":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1},"filename":{"type":"string","minLength":1}},"required":["key","filename"]}},"tokenPayload":{"type":"string","minLength":1}},"required":["files","tokenPayload"],"description":"Updates the target entity with the new URLs","example":{"files":[{"key":"org_2iKrI1aASsDFfKiXCz7PlYvsuP/items/1758711981868-ac04c26e.jpg","filename":"733648.jpg"}],"tokenPayload":"blob_token_eyJvcmdJZCI6<........>jUwMDMxIn0"}},"ItemImageUploadCallbackResponse":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"}},"required":["key","url","name"]},"description":"Response after successful completion of item image upload","example":[{"key":"org_2iKrI1aASsDFfKiXCz7PlYvsuP/items/1758711981868-ac04c26e.jpg","url":"https://cdn.assetblaze.com/org_2iKrI1aASsDFfKiXCz7PlYvsuP/items/1758711981868-ac04c26e.jpg","name":"1758711981868.jpg"}]},"ItemUpdateQuantityRequest":{"type":"object","properties":{"itemId":{"type":"string"},"locationId":{"type":"string"},"quantity":{"type":"number","minimum":0},"reason":{"type":"string","enum":["broken","consumed","damaged","donated","expired","restocked","sold","stolen"]},"note":{"type":["string","null"]},"cost":{"type":["number","null"],"minimum":0},"price":{"type":["number","null"]}},"required":["itemId","locationId","quantity","reason"],"description":"Update item quantity","example":{"itemId":"item_c1574b87-68d6-448a-ac18-4a5f0e68d534","locationId":"loc_6da0d90b-4efa-47f8-8823-8b5a1c8220ce","quantity":34,"reason":"sold","note":"Sold 34 items to a new customer","cost":100,"price":200}},"ItemMoveQuantityRequest":{"type":"object","properties":{"itemId":{"type":"string"},"targetLocationId":{"type":"string"},"sourceLocationId":{"type":"string"},"quantity":{"type":"integer","exclusiveMinimum":0},"reason":{"type":["string","null"],"enum":["damaged","transfer",null]},"note":{"type":["string","null"]},"itemBatches":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"quantity":{"type":"number"}},"required":["id","quantity"]}}},"required":["itemId","targetLocationId","sourceLocationId","quantity"],"description":"Move item quantity","example":{"itemId":"item_c1574b87-68d6-448a-ac18-4a5f0e68d534","sourceLocationId":"loc_6da0d90b-4efa-47f8-8823-8b5a1c8220ce","targetLocationId":"loc_6da0d90b-4efa-47f8-8823-8b5a1c8220cf","quantity":34,"reason":"transfer","note":"Moved 34 items to our store in Varna. Originally in Sofia 6h ago."}},"TransactionResponse":{"type":"object","properties":{"id":{"type":"string"},"itemId":{"type":"string"},"targetLocationId":{"type":["string","null"]},"sourceLocationId":{"type":["string","null"]},"quantity":{"type":"number"},"change":{"type":"number"},"type":{"type":"string","enum":["quantity_update","move","revaluation","unit_conversion"]},"reason":{"type":["string","null"]},"note":{"type":["string","null"]},"user":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string","format":"email"},"fullName":{"type":"string"}},"required":["id","email","fullName"]},"createdAt":{"type":"string"},"itemBatches":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"itemBatchId":{"type":"string"},"quantity":{"type":"number"},"cost":{"type":"number"}},"required":["id","itemBatchId","quantity","cost"]}},"sourceUnitOfMeasureId":{"type":["string","null"]},"sourceQuantity":{"type":["number","null"]},"itemUnitOfMeasureId":{"type":["string","null"]}},"required":["id","itemId","quantity","change","type","user","createdAt"],"description":"Transaction","example":{"id":"tx_c1574b87-68d6-448a-ac18-4a5f0e68d534","itemId":"item_c1574b87-68d6-448a-ac18-4a5f0e68d534","targetLocationId":"loc_6da0d90b-4efa-47f8-8823-8b5a1c8220ce","sourceLocationId":"loc_6da0d90b-4efa-47f8-8823-8b5a1c8220cf","quantity":34,"change":34,"type":"move","reason":"transfer","note":"Moved 34 items to our store in Varna. Originally in Sofia 6h ago.","user":{"id":"user_c1574b87-68d6-448a-ac18-4a5f0e68d534","fullName":"John Doe","email":"johndoe@assetblaze.com"},"createdAt":"2026-11-20T21:12:08.369Z"}},"VariantValue":{"type":"object","properties":{"customFieldId":{"type":"string","minLength":1,"default":""},"customFieldName":{"type":"string","minLength":1,"default":""},"value":{"type":"string"}},"required":["customFieldId","customFieldName","value"],"description":"A specific attribute value for a variant","example":{"customFieldId":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c6","customFieldName":"Size","value":"Large"}},"VariantSchema":{"type":"object","properties":{"customFieldIds":{"type":"array","items":{"type":"string","minLength":1,"default":""},"minItems":1},"allowedValues":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"string","minLength":1,"default":""},"values":{"type":"array","items":{"type":"string"}}},"required":["customFieldId","values"]}},"excludedCombinations":{"type":"array","items":{"type":"array","items":{"type":"string"}}}},"required":["customFieldIds","allowedValues"],"description":"Schema defining which custom fields create variants","example":{"customFieldIds":["cf_b09ce6cd-76f5-4113-895c-0f36ae7365c6","cf_a10ce6cd-76f5-4113-895c-0f36ae7365c7"],"allowedValues":[{"customFieldId":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c6","values":["Small","Medium","Large"]},{"customFieldId":"cf_a10ce6cd-76f5-4113-895c-0f36ae7365c7","values":["Red","Blue","Green"]}],"excludedCombinations":[]}},"VariantCombination":{"type":"object","properties":{"values":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"string","minLength":1,"default":""},"customFieldName":{"type":"string","minLength":1,"default":""},"value":{"type":"string"}},"required":["customFieldId","customFieldName","value"]}},"assetIdSuffix":{"type":"string"},"price":{"type":"number"},"cost":{"type":"number"}},"required":["values"],"description":"A combination of variant values for creating a variant","example":{"values":[{"customFieldId":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c6","customFieldName":"Size","value":"Large"},{"customFieldId":"cf_a10ce6cd-76f5-4113-895c-0f36ae7365c7","customFieldName":"Color","value":"Red"}],"price":1500,"cost":800}},"EnableVariantsRequest":{"type":"object","properties":{"variantSchema":{"type":"object","properties":{"customFieldIds":{"type":"array","items":{"type":"string","minLength":1,"default":""},"minItems":1},"allowedValues":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"string","minLength":1,"default":""},"values":{"type":"array","items":{"type":"string"}}},"required":["customFieldId","values"]}},"excludedCombinations":{"type":"array","items":{"type":"array","items":{"type":"string"}}}},"required":["customFieldIds","allowedValues"]}},"required":["variantSchema"],"description":"Enable variants on an existing item","example":{"variantSchema":{"customFieldIds":["cf_b09ce6cd-76f5-4113-895c-0f36ae7365c6"],"allowedValues":[{"customFieldId":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c6","values":["Small","Medium","Large"]}]}}},"GenerateVariantsRequest":{"type":"object","properties":{"combinations":{"type":"array","items":{"type":"object","properties":{"values":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"string","minLength":1,"default":""},"customFieldName":{"type":"string","minLength":1,"default":""},"value":{"type":"string"}},"required":["customFieldId","customFieldName","value"]}},"assetIdSuffix":{"type":"string"},"price":{"type":"number"},"cost":{"type":"number"}},"required":["values"]}}},"required":["combinations"],"description":"Generate variants for a parent item","example":{"combinations":[{"values":[{"customFieldId":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c6","customFieldName":"Size","value":"Small"}]},{"values":[{"customFieldId":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c6","customFieldName":"Size","value":"Medium"}]},{"values":[{"customFieldId":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c6","customFieldName":"Size","value":"Large"}]}]}},"ItemVariantsResponse":{"type":"array","items":{"$ref":"#/components/schemas/ItemResponse"},"description":"List of variant items"},"ParentAggregatesResponse":{"type":"object","properties":{"totalQuantity":{"type":"number"},"totalCost":{"type":"number"},"variantCount":{"type":"number"},"lowStockVariants":{"type":"number"},"quantityByLocation":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"default":""},"locationName":{"type":"string","minLength":1,"default":""},"quantity":{"type":"number"}},"required":["locationId","locationName","quantity"]}},"quantityByAttribute":{"type":"array","items":{"type":"object","properties":{"attributeName":{"type":"string","minLength":1,"default":""},"attributeValue":{"type":"string"},"quantity":{"type":"number"}},"required":["attributeName","attributeValue","quantity"]}}},"required":["totalQuantity","totalCost","variantCount","lowStockVariants","quantityByLocation","quantityByAttribute"],"description":"Aggregated metrics for a parent item","example":{"totalQuantity":150,"totalCost":225000,"variantCount":9,"lowStockVariants":2,"quantityByLocation":[{"locationId":"loc_6da0d90b-4efa-47f8-8823-8b5a1c8220ce","locationName":"Warehouse A","quantity":100},{"locationId":"loc_6da0d90b-4efa-47f8-8823-8b5a1c8220cf","locationName":"Store B","quantity":50}],"quantityByAttribute":[{"attributeName":"Size","attributeValue":"Small","quantity":50},{"attributeName":"Size","attributeValue":"Medium","quantity":60},{"attributeName":"Size","attributeValue":"Large","quantity":40}]}},"SupplierGetManyPaginatedResponse":{"type":"object","properties":{"previous":{"type":"string"},"hasPrevious":{"type":"boolean"},"next":{"type":"string"},"hasNext":{"type":"boolean"},"totalCount":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"image":{"type":["object","null"],"properties":{"url":{"type":"string"},"name":{"type":["string","null"]},"originalUrl":{"type":"string"}},"required":["url"]},"code":{"type":["string","null"]},"addressLine1":{"type":["string","null"]},"addressLine2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"country":{"type":["string","null"]},"phone1":{"type":["string","null"]},"phone2":{"type":["string","null"]},"contactName":{"type":["string","null"]},"contactEmail":{"type":["string","null"]},"orderEmail":{"type":["string","null"]},"taxId":{"type":["string","null"]},"website":{"type":["string","null"]},"currency":{"type":["string","null"]},"notes":{"type":["string","null"]},"leadTime":{"type":["number","null"]},"paymentTerms":{"type":["number","null"]},"discounts":{"type":["number","null"]},"tax":{"type":["number","null"]},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","createdAt","updatedAt"]}}},"required":["hasPrevious","hasNext","totalCount","results"],"description":"Get many suppliers paginated","example":{"hasPrevious":true,"previous":"previous-token","hasNext":true,"next":"next-token","totalCount":100,"results":[{"id":"supplier_c1574b87-68d6-448a-ac18-4a5f0e68d534","name":"Supplier 1","image":{"url":"https://example.com/image.jpg","name":"image.jpg"},"code":"code 1","addressLine1":"123 Main St","addressLine2":null,"city":"San Francisco","state":"CA","postalCode":"94105","country":"US","phone1":"123-456-7890","phone2":"123-456-7890","contactName":"contact name","contactEmail":"contact@email.com","orderEmail":"porder@email.com","taxId":"tax-id","website":"https://example.com","currency":"EUR","notes":"test notes","leadTime":11,"paymentTerms":22,"discounts":33,"tax":44,"createdAt":"2026-11-20T21:12:08.380Z","updatedAt":"2026-11-20T21:12:08.380Z"},{"id":"supplier_c1574b87-68d6-448a-ac18-4a5f0e68d535","name":"Supplier 2","image":{"url":"https://example.com/image.jpg","name":"image.jpg"},"code":"code 1","addressLine1":"123 Main St","addressLine2":null,"city":"San Francisco","state":"CA","postalCode":"94105","country":"US","phone1":"123-456-7890","phone2":"123-456-7890","contactName":"contact name","contactEmail":"contact@email.com","orderEmail":"porder@email.com","taxId":"tax-id","website":"https://example.com","currency":"EUR","notes":"test notes","leadTime":11,"paymentTerms":22,"discounts":33,"tax":44,"createdAt":"2026-11-20T21:12:08.380Z","updatedAt":"2026-11-20T21:12:08.380Z"}]}},"SupplierGetOneResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"image":{"type":["object","null"],"properties":{"url":{"type":"string"},"name":{"type":["string","null"]},"originalUrl":{"type":"string"}},"required":["url"]},"code":{"type":["string","null"]},"addressLine1":{"type":["string","null"]},"addressLine2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"country":{"type":["string","null"]},"phone1":{"type":["string","null"]},"phone2":{"type":["string","null"]},"contactName":{"type":["string","null"]},"contactEmail":{"type":["string","null"]},"orderEmail":{"type":["string","null"]},"taxId":{"type":["string","null"]},"website":{"type":["string","null"]},"currency":{"type":["string","null"]},"notes":{"type":["string","null"]},"leadTime":{"type":["number","null"]},"paymentTerms":{"type":["number","null"]},"discounts":{"type":["number","null"]},"tax":{"type":["number","null"]},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","createdAt","updatedAt"],"description":"Get one supplier","example":{"id":"supplier_c1574b87-68d6-448a-ac18-4a5f0e68d534","name":"Supplier 1","image":{"url":"https://example.com/image.jpg","name":"image.jpg"},"code":"code 1","addressLine1":"123 Main St","addressLine2":null,"city":"San Francisco","state":"CA","postalCode":"94105","country":"US","phone1":"123-456-7890","phone2":"123-456-7890","contactName":"contact name","contactEmail":"contact@email.com","orderEmail":"porder@email.com","taxId":"tax-id","website":"https://example.com","currency":"EUR","notes":"test notes","leadTime":11,"paymentTerms":22,"discounts":33,"tax":44,"createdAt":"2026-11-20T21:12:08.380Z","updatedAt":"2026-11-20T21:12:08.380Z"}},"SupplierCreateOneRequest":{"type":"object","properties":{"name":{"type":"string"},"code":{"type":["string","null"]},"addressLine1":{"type":["string","null"]},"addressLine2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"country":{"type":["string","null"]},"phone1":{"type":["string","null"]},"phone2":{"type":["string","null"]},"contactName":{"type":["string","null"]},"contactEmail":{"type":["string","null"]},"orderEmail":{"type":["string","null"]},"taxId":{"type":["string","null"]},"website":{"type":["string","null"]},"currency":{"type":["string","null"]},"notes":{"type":["string","null"]},"leadTime":{"anyOf":[{"type":"number"},{"type":"string","const":""},{"type":"null"}],"default":null},"paymentTerms":{"anyOf":[{"type":"number"},{"type":"string","const":""},{"type":"null"}],"default":null},"discounts":{"anyOf":[{"type":"number"},{"type":"string","const":""},{"type":"null"}],"default":null},"tax":{"anyOf":[{"type":"number"},{"type":"string","const":""},{"type":"null"}],"default":null}},"required":["name"],"description":"Create one supplier","example":{"name":"Supplier 1","code":"code 1","addressLine1":"123 Main St","city":"San Francisco","state":"CA","postalCode":"94105","country":"US","phone1":"123-456-7890","contactName":"contact name","contactEmail":"contact@email.com","currency":"EUR"}},"SupplierUpdateOneRequest":{"type":"object","properties":{"id":{"type":["string","null"]},"name":{"type":"string"},"code":{"type":["string","null"]},"addressLine1":{"type":["string","null"]},"addressLine2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"postalCode":{"type":["string","null"]},"country":{"type":["string","null"]},"phone1":{"type":["string","null"]},"phone2":{"type":["string","null"]},"contactName":{"type":["string","null"]},"contactEmail":{"type":["string","null"]},"orderEmail":{"type":["string","null"]},"taxId":{"type":["string","null"]},"website":{"type":["string","null"]},"currency":{"type":["string","null"]},"notes":{"type":["string","null"]},"leadTime":{"anyOf":[{"type":"number"},{"type":"string","const":""},{"type":"null"}],"default":null},"paymentTerms":{"anyOf":[{"type":"number"},{"type":"string","const":""},{"type":"null"}],"default":null},"discounts":{"anyOf":[{"type":"number"},{"type":"string","const":""},{"type":"null"}],"default":null},"tax":{"anyOf":[{"type":"number"},{"type":"string","const":""},{"type":"null"}],"default":null}},"required":["name"],"description":"Update one supplier","example":{"id":"supplier_c1574b87-68d6-448a-ac18-4a5f0e68d534","name":"Supplier 1 Updated","code":"code 1","addressLine1":"123 Main St","city":"San Francisco","state":"CA","postalCode":"94105","country":"US","phone1":"123-456-7890","contactName":"contact name","contactEmail":"contact@email.com","currency":"EUR"}},"SupplierSetImageRequest":{"type":"object","properties":{"id":{"type":"string"},"image":{"type":["object","null"],"properties":{"url":{"type":"string"},"name":{"type":["string","null"]},"originalUrl":{"type":"string"}},"required":["url"]}},"required":["id"],"description":"Set image for supplier","example":{"id":"supplier_c1574b87-68d6-448a-ac18-4a5f0e68d534","image":{"url":"https://example.com/image1.jpg","name":"image1.jpg"}}},"SupplierImageUploadUrlRequest":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"description":"Original name of the file"},"contentType":{"type":"string","minLength":1,"description":"MIME type of the file"},"contentLength":{"type":"number","exclusiveMinimum":0,"description":"Size of the file in bytes"},"clientPayload":{"type":"string","minLength":1,"description":"Client payload that will be passed back to the server. For supplier this is the supplier ID."}},"required":["filename","contentType","contentLength","clientPayload"],"description":"Request to generate client token for supplier image upload","example":{"filename":"1758711981868.jpg","contentType":"image/jpeg","contentLength":12345,"clientPayload":"supplier_c1574b87-68d6-448a-ac18-4a5f0e68d534"}},"SupplierImageUploadUrlResponse":{"type":"object","properties":{"presignedUrl":{"type":"string","format":"uri"},"key":{"type":"string","minLength":1},"tokenPayload":{"type":"string","minLength":1}},"required":["presignedUrl","key","tokenPayload"],"description":"Generated client token for supplier image upload","example":{"presignedUrl":"https://assetblaze-dev-assets.s3.eu-central-1.amazonaws.com/org_2i<...>-id=PutObject","key":"org_2iKrI1aASsDFfKiXCz7PlYvsuP/suppliers/1758711981868-ac04c26e.jpg","tokenPayload":"blob_token_eyJvcmdJZCI6<........>jUwMDMxIn0"}},"SupplierImageUploadCallbackRequest":{"type":"object","properties":{"files":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1},"filename":{"type":"string","minLength":1}},"required":["key","filename"]}},"tokenPayload":{"type":"string","minLength":1}},"required":["files","tokenPayload"],"description":"Updates the target entity with the new URLs","example":{"files":[{"key":"org_2iKrI1aASsDFfKiXCz7PlYvsuP/suppliers/1758711981868-ac04c26e.jpg","filename":"733648.jpg"}],"tokenPayload":"blob_token_eyJvcmdJZCI6<........>jUwMDMxIn0"}},"SupplierImageUploadCallbackResponse":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"}},"required":["key","url","name"]},"description":"Response after successful completion of supplier image upload","example":[{"key":"org_2iKrI1aASsDFfKiXCz7PlYvsuP/suppliers/1758711981868-ac04c26e.jpg","url":"https://cdn.assetblaze.com/org_2iKrI1aASsDFfKiXCz7PlYvsuP/suppliers/1758711981868-ac04c26e.jpg","name":"1758711981868.jpg"}]},"LocationGetManyResponse":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":["string","null"]},"name":{"type":"string"},"description":{"type":["string","null"]},"type":{"type":["string","null"]},"address1":{"type":["string","null"]},"address2":{"type":["string","null"]},"city":{"type":["string","null"]},"zip":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]},"phone":{"type":["string","null"]},"image":{"type":["object","null"],"properties":{"url":{"type":"string"},"name":{"type":["string","null"]},"originalUrl":{"type":"string"}},"required":["url"]},"shippingAddress":{"type":["object","null"],"properties":{"address1":{"type":["string","null"]},"address2":{"type":["string","null"]},"city":{"type":["string","null"]},"zip":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]},"phone":{"type":["string","null"]},"image":{"type":["object","null"],"properties":{"url":{"type":"string"},"name":{"type":["string","null"]},"originalUrl":{"type":"string"}},"required":["url"]}}},"billingAddress":{"type":["object","null"],"properties":{"address1":{"type":["string","null"]},"address2":{"type":["string","null"]},"city":{"type":["string","null"]},"zip":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]},"phone":{"type":["string","null"]},"image":{"type":["object","null"],"properties":{"url":{"type":"string"},"name":{"type":["string","null"]},"originalUrl":{"type":"string"}},"required":["url"]}}},"ancestorIds":{"type":"array","items":{"type":"string"}},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"archivedAt":{"type":"string"}},"required":["id","name","ancestorIds","createdAt","updatedAt"]},"description":"Get many locations","example":[{"id":"c1574b87-68d6-448a-ac18-4a5f0e68d534","code":"1","name":"Location 1","address1":"123 Main St","address2":"Suite 100","city":"Springfield","state":"IL","zip":"62701","country":"USA","phone":"555-555-5555","description":"Description","type":"Office","image":{"url":"https://example.com/image.jpg","name":"image.jpg"},"ancestorIds":[],"createdAt":"2026-11-20T21:12:08.382Z","updatedAt":"2026-11-20T21:12:08.382Z","archivedAt":"2026-11-20T21:12:08.382Z"},{"id":"c1574b87-68d6-448a-ac18-4a5f0e68d535","code":"2","name":"Location 2","address1":"123 Main St","city":"Springfield","state":"IL","zip":"62701","country":"USA","phone":"555-555-5555","description":"Description","type":"Warehouse","image":{"url":"https://example.com/image.jpg","name":"image.jpg"},"ancestorIds":[],"createdAt":"2026-11-20T21:12:08.382Z","updatedAt":"2026-11-20T21:12:08.382Z","archivedAt":"2026-11-20T21:12:08.382Z"}]},"WorkspaceGetManyResponse":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"location":{"type":["object","null"],"properties":{"id":{"type":"string"},"code":{"type":["string","null"]},"name":{"type":"string"},"ancestorIds":{"type":"array","items":{"type":"string"}}},"required":["id","name","ancestorIds"]},"name":{"type":"string"},"description":{"type":"string"},"image":{"type":["object","null"],"properties":{"url":{"type":"string"},"name":{"type":["string","null"]},"originalUrl":{"type":"string"}},"required":["url"]},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""}},"required":["id","name"]}},"itemsCount":{"type":"number"},"workspaceTypeId":{"type":["string","null"],"minLength":1,"default":""},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","description","image","tags","itemsCount","createdAt","updatedAt"]},"description":"Get many workspaces","example":[{"id":"c1574b87-68d6-448a-ac18-4a5f0e68d534","name":"Workspace 1","description":"Description","image":{"url":"https://example.com/image.jpg","name":"image.jpg"},"tags":[{"id":"b09ce6cd-76f5-4113-895c-0f36ae7365a3","name":"Tag 1"}],"itemsCount":42,"location":{"id":"loc_6da0d90b-4efa-47f8-8823-8b5a1c8220ce","name":"Location 1","code":"location-1","ancestorIds":[]},"createdAt":"2026-11-20T21:12:08.381Z","updatedAt":"2026-11-20T21:12:08.381Z"},{"id":"c1574b87-68d6-448a-ac18-4a5f0e68d535","name":"Workspace 2","description":"Description","image":{"url":"https://example.com/image.jpg","name":"image.jpg"},"tags":[{"id":"b09ce6cd-76f5-4113-895c-0f36ae7365a3","name":"Tag 1"}],"itemsCount":128,"location":null,"createdAt":"2026-11-20T21:12:08.381Z","updatedAt":"2026-11-20T21:12:08.381Z"}]},"WorkspaceGetManyPaginatedResponse":{"type":"object","properties":{"previous":{"type":"string"},"hasPrevious":{"type":"boolean"},"next":{"type":"string"},"hasNext":{"type":"boolean"},"totalCount":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"location":{"type":["object","null"],"properties":{"id":{"type":"string"},"code":{"type":["string","null"]},"name":{"type":"string"},"ancestorIds":{"type":"array","items":{"type":"string"}}},"required":["id","name","ancestorIds"]},"name":{"type":"string"},"description":{"type":"string"},"image":{"type":["object","null"],"properties":{"url":{"type":"string"},"name":{"type":["string","null"]},"originalUrl":{"type":"string"}},"required":["url"]},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""}},"required":["id","name"]}},"itemsCount":{"type":"number"},"workspaceTypeId":{"type":["string","null"],"minLength":1,"default":""},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","description","image","tags","itemsCount","createdAt","updatedAt"]}}},"required":["hasPrevious","hasNext","totalCount","results"],"description":"Get many workspaces paginated","example":{"hasPrevious":true,"previous":"previous-token","hasNext":true,"next":"next-token","totalCount":100,"results":[{"id":"c1574b87-68d6-448a-ac18-4a5f0e68d534","name":"Workspace 1","description":"Description","image":{"url":"https://example.com/image.jpg","name":"image.jpg"},"tags":[{"id":"b09ce6cd-76f5-4113-895c-0f36ae7365a3","name":"Tag 1"}],"itemsCount":42,"location":{"id":"loc_6da0d90b-4efa-47f8-8823-8b5a1c8220ce","name":"Location 1","code":"location-1","ancestorIds":[]},"createdAt":"2026-11-20T21:12:08.381Z","updatedAt":"2026-11-20T21:12:08.381Z"},{"id":"c1574b87-68d6-448a-ac18-4a5f0e68d535","name":"Workspace 2","description":"Description","image":{"url":"https://example.com/image.jpg","name":"image.jpg"},"tags":[{"id":"b09ce6cd-76f5-4113-895c-0f36ae7365a3","name":"Tag 1"}],"itemsCount":128,"location":null,"createdAt":"2026-11-20T21:12:08.381Z","updatedAt":"2026-11-20T21:12:08.381Z"}]}},"WorkspaceGetOneResponse":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"location":{"type":["object","null"],"properties":{"id":{"type":"string"},"code":{"type":["string","null"]},"name":{"type":"string"},"ancestorIds":{"type":"array","items":{"type":"string"}}},"required":["id","name","ancestorIds"]},"name":{"type":"string"},"description":{"type":"string"},"image":{"type":["object","null"],"properties":{"url":{"type":"string"},"name":{"type":["string","null"]},"originalUrl":{"type":"string"}},"required":["url"]},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""}},"required":["id","name"]}},"itemsCount":{"type":"number"},"workspaceTypeId":{"type":["string","null"],"minLength":1,"default":""},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"workspaceType":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string"},"customFieldIds":{"type":"array","items":{"type":"string"}},"lockedCustomFieldIds":{"type":"array","items":{"type":"string"}},"code":{"type":["string","null"]},"system":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","customFieldIds","createdAt","updatedAt"]},"itemIds":{"type":"array","items":{"type":"string","minLength":1,"default":""}}},"required":["id","name","description","image","tags","itemsCount","createdAt","updatedAt","workspaceType"],"description":"Get one workspace","example":{"id":"c1574b87-68d6-448a-ac18-4a5f0e68d534","name":"Workspace 1","description":"Description","image":{"url":"https://example.com/image.jpg","name":"image.jpg"},"tags":[{"id":"b09ce6cd-76f5-4113-895c-0f36ae7365a3","name":"Tag 1"}],"itemsCount":42,"location":{"id":"loc_6da0d90b-4efa-47f8-8823-8b5a1c8220ce","name":"Location 1","code":"location-1","ancestorIds":[]},"workspaceTypeId":"wst_b09ce6cd-76f5-4113-895c-0f36ae7365a3","workspaceType":{"id":"wst_b09ce6cd-76f5-4113-895c-0f36ae7365a3","name":"Workspace Type 1","customFieldIds":["cf_b09ce6cd-76f5-4113-895c-0f36ae7365c6","cf_b09ce6cd-76f5-4113-895c-0f36ae7365c7"],"createdAt":"2026-11-20T21:12:08.381Z","updatedAt":"2026-11-20T21:12:08.381Z"},"createdAt":"2026-11-20T21:12:08.381Z","updatedAt":"2026-11-20T21:12:08.381Z","itemIds":["item_c1574b87-68d6-448a-ac18-4a5f0e68d534","item_c1574b87-68d6-448a-ac18-4a5f0e68d535","item_c1574b87-68d6-448a-ac18-4a5f0e68d536"]}},"WorkspaceCreateOneRequest":{"type":"object","properties":{"id":{"type":["string","null"]},"locationId":{"type":["string","null"]},"workspaceTypeId":{"type":["string","null"]},"name":{"type":"string","minLength":1},"description":{"type":"string","default":""}},"required":["name"],"description":"Create one workspace","example":{"name":"Workspace 1","description":"Description","locationId":"loc_6da0d90b-4efa-47f8-8823-8b5a1c8220ce"}},"WorkspaceUpdateOneRequest":{"type":"object","properties":{"id":{"type":["string","null"]},"locationId":{"type":["string","null"]},"workspaceTypeId":{"type":["string","null"]},"name":{"type":"string","minLength":1},"description":{"type":"string","default":""}},"required":["name"],"description":"Update one workspace","example":{"id":"c1574b87-68d6-448a-ac18-4a5f0e68d534","name":"Workspace 1","description":"Description","locationId":"loc_6da0d90b-4efa-47f8-8823-8b5a1c8220ce"}},"WorkspaceUpdateTagsRequest":{"type":"object","properties":{"workspaceId":{"type":"string","minLength":1,"default":""},"tags":{"type":"array","items":{"type":"string","minLength":1,"default":""}}},"required":["workspaceId","tags"],"description":"Update tags for workspace","example":{"workspaceId":"c1574b87-68d6-448a-ac18-4a5f0e68d534","tags":["Tag 1","Tag 2"]}},"WorkspaceDeleteManyRequest":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string","minLength":1,"default":""},"minItems":1}},"required":["ids"],"description":"Delete many workspaces","example":{"ids":["c1574b87-68d6-448a-ac18-4a5f0e68d534","c1574b87-68d6-448a-ac18-4a5f0e68d535"]}},"WorkspaceSetImageRequest":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"image":{"type":["object","null"],"properties":{"url":{"type":"string"},"name":{"type":["string","null"]},"originalUrl":{"type":"string"}},"required":["url"]}},"required":["id"],"description":"Set image for workspace","example":{"id":"c1574b87-68d6-448a-ac18-4a5f0e68d534","image":{"url":"https://example.com/image1.jpg","name":"image1.jpg"}}},"WorkspaceAddItemsRequest":{"type":"object","properties":{"workspaceId":{"type":"string","minLength":1,"default":""},"itemIds":{"type":"array","items":{"type":"string","minLength":1,"default":""}}},"required":["workspaceId","itemIds"],"description":"Add items to workspace","example":{"workspaceId":"c1574b87-68d6-448a-ac18-4a5f0e68d534","itemIds":["c1574b87-68d6-448a-ac18-4a5f0e68d534","c1574b87-68d6-448a-ac18-4a5f0e68d535"]}},"WorkspaceDeleteItemsRequest":{"type":"object","properties":{"workspaceId":{"type":"string","minLength":1,"default":""},"itemIds":{"type":"array","items":{"type":"string","minLength":1,"default":""}}},"required":["workspaceId","itemIds"],"description":"Delete items from workspace","example":{"workspaceId":"c1574b87-68d6-448a-ac18-4a5f0e68d534","itemIds":["c1574b87-68d6-448a-ac18-4a5f0e68d534","c1574b87-68d6-448a-ac18-4a5f0e68d535"]}},"WorkspaceUpdateOneItemRequest":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"assetId":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1},"price":{"type":"number"},"cost":{"type":"number"},"minLevel":{"anyOf":[{"type":"number","exclusiveMinimum":0},{"type":"string","const":""},{"type":"null"}],"default":null},"restockTargetLevel":{"anyOf":[{"type":"number","exclusiveMinimum":0},{"type":"string","const":""},{"type":"null"}],"default":null},"categoryId":{"type":["string","null"]},"supplierLinkSettings":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"isDefault":{"type":"boolean"},"purchaseUnitOfMeasureId":{"type":["string","null"]},"unitsPerPurchaseUnit":{"type":["number","null"],"exclusiveMinimum":0}},"required":["id"]}},"customFieldValues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]}},"required":["id"]}},"description":{"type":"string","default":""},"barcode":{"type":["object","null"],"properties":{"value":{"type":"string","minLength":1},"type":{"type":"string","enum":["BARCODE","QRCODE"]}},"required":["value","type"]},"costingMethod":{"type":"string","enum":["average","fifo","lifo"]},"replenishmentMethod":{"type":"string","enum":["buy","make"],"default":"buy"},"traceabilityType":{"type":"string","enum":["none","serial","batch"]},"serialNumberFormat":{"type":["string","null"]},"unitOfMeasureId":{"type":["string","null"]},"secondaryUnit":{"type":["object","null"],"properties":{"unitOfMeasureId":{"type":"string","minLength":1},"factor":{"type":"number"}},"required":["unitOfMeasureId","factor"]},"weightValue":{"type":["number","null"]},"weightUnit":{"type":["string","null"],"enum":["kg","lb","oz","g",null]},"workspaceId":{"type":"string","minLength":1,"default":""},"workspaceCustomFieldValues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]}},"required":["id"]},"default":[]},"supplierId":{"type":"string"}},"required":["id","assetId","name","customFieldValues","workspaceId","supplierId"],"description":"Update one item in workspace. The request is similar to the regular item update but includes workspace ID and workspace custom fields.","example":{"id":"item_c1574b87-68d6-448a-ac18-4a5f0e68d534","workspaceId":"c1574b87-68d6-448a-ac18-4a5f0e68d534","assetId":"AB-123456","barcode":{"value":"380123456789","type":"BARCODE"},"name":"Item 1","price":10,"minLevel":1,"description":"Description","categoryId":"cat_b09ce6cd-76f5-4113-895c-0f36ae7365c3","customFieldValues":[{"id":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c6","value":"value 1"}],"workspaceCustomFieldValues":[{"id":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c7","value":"ws value 1"},{"id":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c8","value":"ws value 2"}],"supplierId":"b09ce6cd-76f5-4113-895c-0f36ae7365c4"}},"ItemInWorkspaceResponse":{"type":"object","properties":{"id":{"type":"string"},"assetId":{"type":"string","minLength":1,"default":""},"name":{"type":"string"},"price":{"type":"integer"},"cost":{"type":"integer"},"groupId":{"type":"string"},"attributes":{"type":"array","items":{"type":"string"}},"locationQuantities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""},"code":{"type":["string","null"],"minLength":1,"default":""},"ancestorIds":{"type":"array","items":{"type":"string","minLength":1,"default":""}},"quantity":{"type":"number"},"reservedQuantity":{"type":"number"},"cost":{"type":"number","minimum":0},"backorderedQuantity":{"type":"integer"}},"required":["id","name","ancestorIds","quantity"]}},"minLevel":{"type":["number","null"]},"restockTargetLevel":{"type":["number","null"]},"locationLevels":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"default":""},"minLevel":{"type":["number","null"]},"restockTargetLevel":{"type":["number","null"]}},"required":["locationId"]},"default":[]},"category":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"customFieldValues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"type":{"type":"string","enum":["short-text","long-text","integer","decimal","date","datetime","time","boolean","select","multiselect","barcode"]},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"required":{"type":"boolean","default":false},"code":{"type":["string","null"]},"system":{"type":"boolean"}},"required":["id","name","type","required"]}},"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":["string","null"]},"originalUrl":{"type":"string"}},"required":["url"]}},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""}},"required":["id","name"]}},"workspaceIds":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"barcode":{"type":["object","null"],"properties":{"value":{"type":"string","minLength":1},"type":{"type":"string","enum":["BARCODE","QRCODE"]}},"required":["value","type"]},"clientCorrelationId":{"type":["string","null"]},"costingMethod":{"type":"string","enum":["average","fifo","lifo"]},"itemType":{"type":"string","enum":["component","build","service"],"default":"component"},"replenishmentMethod":{"type":"string","enum":["buy","make"],"default":"buy"},"trackInventory":{"type":"boolean"},"traceabilityType":{"type":"string","enum":["none","serial","batch"],"default":"none"},"serialNumberFormat":{"type":["string","null"]},"unitOfMeasureId":{"type":["string","null"]},"secondaryUnit":{"type":["object","null"],"properties":{"unitOfMeasureId":{"type":"string","minLength":1},"factor":{"type":"number"}},"required":["unitOfMeasureId","factor"]},"weightValue":{"type":["number","null"]},"weightUnit":{"type":["string","null"],"enum":["kg","lb","oz","g",null]},"lockVersion":{"type":"integer","default":0},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"archivedAt":{"type":"string"},"preventDeletingError":{"type":"string","enum":["error.items.deleteOne.hasSaleOrders","error.items.deleteOne.hasPurchaseOrders","error.items.deleteOne.hasTransactionsError","error.items.deleteOne.hasBom","error.items.deleteOne.hasManufacturingOrders","error.items.deleteOne.hasStockCounts"]},"hasVariants":{"type":"boolean"},"parentItemId":{"type":"string"},"variantSchema":{"type":"object","properties":{"customFieldIds":{"type":"array","items":{"type":"string","minLength":1,"default":""},"minItems":1},"allowedValues":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"string","minLength":1,"default":""},"values":{"type":"array","items":{"type":"string"}}},"required":["customFieldId","values"]}},"excludedCombinations":{"type":"array","items":{"type":"array","items":{"type":"string"}}}},"required":["customFieldIds","allowedValues"]},"variantValues":{"type":"array","items":{"type":"object","properties":{"customFieldId":{"type":"string","minLength":1,"default":""},"customFieldName":{"type":"string","minLength":1,"default":""},"value":{"type":"string"}},"required":["customFieldId","customFieldName","value"]}},"descriptionOverride":{"type":"boolean"},"imagesOverride":{"type":"boolean"},"bomOverride":{"type":"string","enum":["inherit","modified","custom"]},"suppliersOverride":{"type":"string","enum":["inherit","modified","custom"]},"insufficientInventoryPolicy":{"type":["string","null"],"enum":["disallow_order","warn_and_allow_backorder","allow_backorder",null]},"workspaceId":{"type":"string"},"workspaceCustomFieldValues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"type":{"type":"string","enum":["short-text","long-text","integer","decimal","date","datetime","time","boolean","select","multiselect","barcode"]},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"required":{"type":"boolean","default":false},"code":{"type":["string","null"]},"system":{"type":"boolean"},"valueId":{"type":["string","null"]}},"required":["id","name","type","required"]}},"quantity":{"type":"number"},"supplier":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"catalogNumber":{"type":"string"},"catalogItemId":{"type":"string"},"purchaseUnitOfMeasureId":{"type":["string","null"]},"unitsPerPurchaseUnit":{"type":["number","null"],"exclusiveMinimum":0},"isDefault":{"type":"boolean"}},"required":["id","name"]}},"required":["id","assetId","name","price","cost","attributes","locationQuantities","locationLevels","customFieldValues","images","tags","workspaceIds","description","itemType","replenishmentMethod","trackInventory","lockVersion","createdAt","updatedAt","workspaceId","workspaceCustomFieldValues","quantity"],"description":"Item in workspace","example":{"id":"item_c1574b87-68d6-448a-ac18-4a5f0e68d534","assetId":"AB-123456","barcode":{"value":"3801234567891","type":"BARCODE"},"name":"Item 1","price":10,"cost":10,"trackInventory":true,"groupId":"168455faf-4539-47d0-bb77-ac814f16d8c7","attributes":["attribute 1","attribute 2"],"locationQuantities":[{"id":"loc_6da0d90b-4efa-47f8-8823-8b5a1c8220ce","name":"Location 1","code":"location-1","quantity":1,"ancestorIds":[]}],"quantity":4,"minLevel":1,"description":"Description","category":{"id":"cat_b09ce6cd-76f5-4113-895c-0f36ae7365c3","name":"Category 1"},"customFieldValues":[{"id":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c6","value":"value 1","name":"My custom field","type":"short-text","defaultValue":"","required":false}],"workspaceCustomFieldValues":[{"id":"cf_a10ce6cd-76f5-4113-895c-0f36ae7365c7","value":"value in workspace","name":"My workspace custom field","type":"short-text","defaultValue":"","required":false,"valueId":"iwcfv_a10ce6cd-76f5-4113-895c-0f36ae7365c4"}],"images":[{"url":"https://example.com/image.jpg","name":"image.jpg"}],"tags":[{"id":"tag_b09ce6cd-76f5-4113-895c-0f36ae7365a3","name":"Tag 1"}],"workspaceId":"ws_b09ce6cd-76f5-4113-895c-0f36ae7365a4","workspaceIds":["ws_b09ce6cd-76f5-4113-895c-0f36ae7365a4"],"supplier":{"id":"sup_b09ce6cd-76f5-4113-895c-0f36ae7365c4","name":"Item supplier X"},"itemType":"component","createdAt":"2026-11-20T21:12:08.381Z","updatedAt":"2026-11-20T21:12:08.381Z","archivedAt":"2026-11-20T21:12:08.381Z","preventDeletingError":"error.items.deleteOne.hasTransactionsError"}},"ItemInWorkspaceCreateOneRequest":{"type":"object","properties":{"assetId":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1},"price":{"type":"number","default":0},"cost":{"type":"number","default":0},"locationQuantities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"cost":{"type":"number","minimum":0},"quantity":{"type":"number","minimum":0}},"required":["id","quantity"]},"default":[]},"minLevel":{"anyOf":[{"type":"number","exclusiveMinimum":0},{"type":"string","const":""},{"type":"null"}],"default":null},"restockTargetLevel":{"anyOf":[{"type":"number","exclusiveMinimum":0},{"type":"string","const":""},{"type":"null"}],"default":null},"locationLevels":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"default":""},"minLevel":{"type":["number","null"]},"restockTargetLevel":{"type":["number","null"]}},"required":["locationId"]}},"categoryId":{"type":["string","null"]},"customFieldValues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]}},"required":["id"]}},"description":{"type":"string","default":""},"tags":{"type":"array","items":{"type":"string","minLength":1,"default":""},"default":[]},"barcode":{"type":["object","null"],"properties":{"value":{"type":"string","minLength":1},"type":{"type":"string","enum":["BARCODE","QRCODE"]}},"required":["value","type"]},"clientCorrelationId":{"type":["string","null"]},"workspaceId":{"type":"string","minLength":1,"default":""},"costingMethod":{"type":"string","enum":["average","fifo","lifo"]},"itemType":{"type":"string","enum":["component","build","service"],"default":"component"},"replenishmentMethod":{"type":"string","enum":["buy","make"],"default":"buy"},"traceabilityType":{"type":"string","enum":["none","serial","batch"],"default":"none"},"serialNumberFormat":{"type":["string","null"]},"unitOfMeasureId":{"type":["string","null"]},"weightValue":{"type":["number","null"]},"weightUnit":{"type":["string","null"],"enum":["kg","lb","oz","g",null]},"workspaceCustomFieldValues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]}},"required":["id"]},"default":[]},"supplierId":{"type":"string"}},"required":["name","customFieldValues","workspaceId","supplierId"],"description":"Item in workspace create request","example":{"workspaceId":"c1574b87-68d6-448a-ac18-4a5f0e68d534","assetId":"AB-123456","barcode":{"value":"380123456789","type":"BARCODE"},"name":"Item 1","price":10,"cost":10,"minLevel":1,"description":"Description","categoryId":"cat_b09ce6cd-76f5-4113-895c-0f36ae7365c3","customFieldValues":[{"id":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c6","value":"value 1"}],"workspaceCustomFieldValues":[{"id":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c7","value":"ws value 1"},{"id":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c8","value":"ws value 2"}],"supplierId":"b09ce6cd-76f5-4113-895c-0f36ae7365c4","itemType":"component"}},"ItemInWorkspaceCreateManyRequest":{"type":"array","items":{"type":"object","properties":{"assetId":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1},"price":{"type":"number","default":0},"cost":{"type":"number","default":0},"locationQuantities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"cost":{"type":"number","minimum":0},"quantity":{"type":"number","minimum":0}},"required":["id","quantity"]},"default":[]},"minLevel":{"anyOf":[{"type":"number","exclusiveMinimum":0},{"type":"string","const":""},{"type":"null"}],"default":null},"restockTargetLevel":{"anyOf":[{"type":"number","exclusiveMinimum":0},{"type":"string","const":""},{"type":"null"}],"default":null},"locationLevels":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"default":""},"minLevel":{"type":["number","null"]},"restockTargetLevel":{"type":["number","null"]}},"required":["locationId"]}},"categoryId":{"type":["string","null"]},"customFieldValues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]}},"required":["id"]}},"description":{"type":"string","default":""},"tags":{"type":"array","items":{"type":"string","minLength":1,"default":""},"default":[]},"barcode":{"type":["object","null"],"properties":{"value":{"type":"string","minLength":1},"type":{"type":"string","enum":["BARCODE","QRCODE"]}},"required":["value","type"]},"clientCorrelationId":{"type":["string","null"]},"workspaceId":{"type":"string","minLength":1,"default":""},"costingMethod":{"type":"string","enum":["average","fifo","lifo"]},"itemType":{"type":"string","enum":["component","build","service"],"default":"component"},"replenishmentMethod":{"type":"string","enum":["buy","make"],"default":"buy"},"traceabilityType":{"type":"string","enum":["none","serial","batch"],"default":"none"},"serialNumberFormat":{"type":["string","null"]},"unitOfMeasureId":{"type":["string","null"]},"weightValue":{"type":["number","null"]},"weightUnit":{"type":["string","null"],"enum":["kg","lb","oz","g",null]},"workspaceCustomFieldValues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]}},"required":["id"]},"default":[]},"supplierId":{"type":"string"}},"required":["name","customFieldValues","workspaceId","supplierId"]},"minItems":1,"maxItems":2500,"description":"Create many items in a workspace at once. Limited to 2500 items per request.","example":[{"workspaceId":"c1574b87-68d6-448a-ac18-4a5f0e68d534","assetId":"AB-123456","clientCorrelationId":"550e8400-e29b-41d4-a716-446655440000","barcode":{"value":"123456","type":"BARCODE"},"name":"Item 1","price":10,"cost":10,"minLevel":1,"description":"Description","categoryId":"cat_b09ce6cd-76f5-4113-895c-0f36ae7365c3","customFieldValues":[{"id":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c6","value":"value 1"}],"workspaceCustomFieldValues":[{"id":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c7","value":"ws value 1"},{"id":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c8","value":"ws value 2"}],"supplierId":"b09ce6cd-76f5-4113-895c-0f36ae7365c4"},{"workspaceId":"c1574b87-68d6-448a-ac18-4a5f0e68d534","assetId":"AB-456789","clientCorrelationId":"550e8400-e29b-41d4-a716-446655440001","barcode":{"value":"456789","type":"BARCODE"},"name":"Item 2","price":20,"cost":15,"minLevel":1,"description":"Description","categoryId":"cat_b09ce6cd-76f5-4113-895c-0f36ae7365c3","customFieldValues":[{"id":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c6","value":"value 1"}],"workspaceCustomFieldValues":[{"id":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c7","value":"ws value 1"},{"id":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c8","value":"ws value 2"}],"supplierId":"b09ce6cd-76f5-4113-895c-0f36ae7365c4"}]},"WorkspaceImageUploadUrlRequest":{"type":"object","properties":{"filename":{"type":"string","minLength":1,"description":"Original name of the file"},"contentType":{"type":"string","minLength":1,"description":"MIME type of the file"},"contentLength":{"type":"number","exclusiveMinimum":0,"description":"Size of the file in bytes"},"clientPayload":{"type":"string","minLength":1,"description":"Client payload that will be passed back to the server. For workspace this is the workspace ID."}},"required":["filename","contentType","contentLength","clientPayload"],"description":"Request to generate client token for workspace image upload","example":{"filename":"1758711981868.jpg","contentType":"image/jpeg","contentLength":12345,"clientPayload":"ws_67ae8705077117576359af4c"}},"WorkspaceImageUploadUrlResponse":{"type":"object","properties":{"presignedUrl":{"type":"string","format":"uri"},"key":{"type":"string","minLength":1},"tokenPayload":{"type":"string","minLength":1}},"required":["presignedUrl","key","tokenPayload"],"description":"Generated client token for workspace image upload","example":{"presignedUrl":"https://assetblaze-dev-assets.s3.eu-central-1.amazonaws.com/org_2i<...>-id=PutObject","key":"org_2iKrI1aASsDFfKiXCz7PlYvsuP/workspaces/1758711981868-ac04c26e.jpg","tokenPayload":"blob_token_eyJvcmdJZCI6<........>jUwMDMxIn0"}},"WorkspaceModifiedCount":{"type":"number","description":"Number of workspaces modified","example":1},"WorkspaceImageUploadCallbackRequest":{"type":"object","properties":{"files":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1},"filename":{"type":"string","minLength":1}},"required":["key","filename"]}},"tokenPayload":{"type":"string","minLength":1}},"required":["files","tokenPayload"],"description":"Updates the target entity with the new URLs","example":{"files":[{"key":"org_2iKrI1aASsDFfKiXCz7PlYvsuP/workspaces/1758711981868-ac04c26e.jpg","filename":"733648.jpg"}],"tokenPayload":"blob_token_eyJvcmdJZCI6<........>jUwMDMxIn0"}},"WorkspaceImageUploadCallbackResponse":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"}},"required":["key","url","name"]},"description":"Response after successful completion of workspace image upload","example":[{"key":"org_2iKrI1aASsDFfKiXCz7PlYvsuP/workspaces/1758711981868-ac04c26e.jpg","url":"https://cdn.assetblaze.com/org_2iKrI1aASsDFfKiXCz7PlYvsuP/workspaces/1758711981868-ac04c26e.jpg","name":"1758711981868.jpg"}]},"ItemWorkspaceCustomFieldValueGetManyPaginatedResponse":{"type":"object","properties":{"previous":{"type":"string"},"hasPrevious":{"type":"boolean"},"next":{"type":"string"},"hasNext":{"type":"boolean"},"totalCount":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"itemId":{"type":"string","minLength":1,"default":""},"workspaceId":{"type":"string","minLength":1,"default":""},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"customField":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string","minLength":1,"default":""},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"type":{"type":"string","enum":["short-text","long-text","integer","decimal","date","datetime","time","boolean","select","multiselect","barcode"]},"defaultValue":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"}]},"required":{"type":"boolean","default":false},"code":{"type":["string","null"]},"system":{"type":"boolean"}},"required":["id","name","type","required"]}},"required":["id","itemId","workspaceId","createdAt","updatedAt","customField"]}}},"required":["hasPrevious","hasNext","totalCount","results"],"description":"Get paginated list of item workspace custom field values.","example":{"hasPrevious":true,"previous":"previous-token","hasNext":true,"next":"next-token","totalCount":100,"results":[{"id":"iwcfv_c1574b87-68d6-448a-ac18-4a5f0e68d533","itemId":"item_c1574b87-68d6-448a-ac18-4a5f0e68d534","workspaceId":"ws_c1574b87-68d6-448a-ac18-4a5f0e68d535","customField":{"id":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c6","value":"value 1","name":"My custom field","type":"short-text","defaultValue":"","required":false},"createdAt":"2026-11-20T21:12:08.382Z","updatedAt":"2026-11-20T21:12:08.382Z"},{"id":"iwcfv_c1574b87-68d6-448a-ac18-4a5f0e68d537","itemId":"item_c1574b87-68d6-448a-ac18-4a5f0e68d538","workspaceId":"ws_c1574b87-68d6-448a-ac18-4a5f0e68d539","customField":{"id":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c7","value":"value 2","name":"My other custom field","type":"short-text","defaultValue":"","required":false},"createdAt":"2026-11-20T21:12:08.382Z","updatedAt":"2026-11-20T21:12:08.382Z"}]}},"ItemWorkspaceCustomFieldValueGetManyPaginatedRequest":{"type":"object","properties":{"itemId":{"type":"string","minLength":1,"default":""},"workspaceId":{"type":"string","minLength":1,"default":""},"customFieldId":{"type":"string","minLength":1,"default":""},"itemIds":{"anyOf":[{"type":"array","items":{"type":"string","minLength":1,"default":""}},{"type":"array","items":{"type":"string","minLength":1,"default":""}}]},"workspaceIds":{"anyOf":[{"type":"array","items":{"type":"string","minLength":1,"default":""}},{"type":"array","items":{"type":"string","minLength":1,"default":""}}]},"lastModifiedAt":{"type":"string"},"orderDirection":{"type":"string","enum":["asc","desc"]},"limit":{"type":"number","minimum":1,"maximum":100},"previous":{"type":"string"},"next":{"type":"string"}},"description":"Get many item workspace custom field values paginated","example":{"itemId":"item_c1574b87-68d6-448a-ac18-4a5f0e68d534","itemIds":["item_c1574b87-68d6-448a-ac18-4a5f0e68d534","item_c1574b87-68d6-448a-ac18-4a5f0e68d535"],"workspaceId":"ws_c1574b87-68d6-448a-ac18-4a5f0e68d535","workspaceIds":["ws_c1574b87-68d6-448a-ac18-4a5f0e68d535","ws_c1574b87-68d6-448a-ac18-4a5f0e68d539"],"customFieldId":"cf_b09ce6cd-76f5-4113-895c-0f36ae7365c6","lastModifiedAt":"2026-11-20T21:12:08.382Z"}},"DeletedEntityGetManyResponse":{"type":"object","properties":{"previous":{"type":"string"},"hasPrevious":{"type":"boolean"},"next":{"type":"string"},"hasNext":{"type":"boolean"},"totalCount":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"refId":{"type":"string"},"type":{"type":"string","enum":["item","workspace","location","category","custom-field","supplier","workspace-type","workspace-custom-field","item-workspace-custom-field-value"]},"createdAt":{"type":"string"}},"required":["id","refId","type","createdAt"]}}},"required":["hasPrevious","hasNext","totalCount","results"],"description":"Get many deleted entities paginated","example":{"hasPrevious":true,"previous":"previous-token","hasNext":true,"next":"next-token","totalCount":100,"results":[{"id":"de_6808ea798f04b51bee1c7d1b","refId":"ws_6808ea748f04b51bee1c7d18","type":"workspace","createdAt":"2026-11-20T21:12:08.383Z"},{"id":"de_6808eb7e8f04b51bee1c7d21","refId":"loc_6808eb698f04b51bee1c7d1c","type":"location","createdAt":"2026-11-20T21:12:08.383Z"}]}},"StockCountGetManyPaginatedResponse":{"type":"object","properties":{"previous":{"type":"string"},"hasPrevious":{"type":"boolean"},"next":{"type":"string"},"hasNext":{"type":"boolean"},"totalCount":{"type":"number"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"scNumber":{"type":"string"},"name":{"type":"string"},"status":{"type":"string","enum":["OPEN","IN_PROGRESS","SUBMITTED","UNDER_REVIEW","COMPLETE","CANCELLED","FINALIZATION_FAILED","VOID"],"default":"OPEN"},"scope":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"default":""},"supplierIds":{"type":"array","items":{"type":"string","minLength":1,"default":""}},"itemIds":{"type":"array","items":{"type":"string","minLength":1,"default":""}},"categoryIds":{"type":"array","items":{"type":"string","minLength":1,"default":""}},"tagIds":{"type":"array","items":{"type":"string","minLength":1,"default":""}}},"required":["locationId"]},"location":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":["string","null"]},"name":{"type":"string"},"ancestorIds":{"type":"array","items":{"type":"string"}}},"required":["id","name","ancestorIds"]},"suppliers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]}},"scopeItems":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"itemNumber":{"type":"string"},"primaryImageUrl":{"type":"string"}},"required":["id","name"]}},"scopeItemsTotal":{"type":"integer"},"lines":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"itemId":{"type":"string","minLength":1,"default":""},"itemNameSnapshot":{"type":"string"},"itemNumberSnapshot":{"type":"string"},"itemPrimaryImageUrl":{"type":"string"},"locationId":{"type":"string","minLength":1,"default":""},"expectedQty":{"type":"number"},"expectedQtySnapshotAt":{"type":"string"},"countedQty":{"type":"number"},"countedAt":{"type":"string"},"countedByUserId":{"type":"string"},"lineStatus":{"type":"string","enum":["PENDING","APPROVED","REJECTED","RECOUNT_REQUESTED","RECOUNTED"]},"varianceReason":{"type":"string"},"rejectionReason":{"type":"string","enum":["MISCOUNT_SUSPECTED","DATA_ENTRY_ERROR","OUT_OF_SCOPE","OTHER"]},"rejectionNote":{"type":"string"},"recountReason":{"type":"string","enum":["SUSPECTED_MISCOUNT","PARTIAL_COUNT","ANOMALY_INVESTIGATION","OTHER"]},"recountNote":{"type":"string"},"approvedAdjustment":{"type":"number"},"approvedByUserId":{"type":"string"},"claimedByUserId":{"type":"string"}},"required":["id","itemId","itemNameSnapshot","locationId","expectedQty","expectedQtySnapshotAt","lineStatus"]},"default":[]},"findings":{"type":"string"},"finalizationError":{"type":"object","properties":{"lineId":{"type":"string","minLength":1,"default":""},"code":{"type":"string"},"message":{"type":"string"},"conflictingScNumber":{"type":"string"},"occurredAt":{"type":"string"}},"required":["lineId","code","message","occurredAt"]},"startedAt":{"type":"string"},"startedByUserId":{"type":"string"},"submittedAt":{"type":"string"},"submittedByUserId":{"type":"string"},"reviewOpenedAt":{"type":"string"},"finalizedAt":{"type":"string"},"finalizedByUserId":{"type":"string"},"cancelledAt":{"type":"string"},"cancelledByUserId":{"type":"string"},"voidedAt":{"type":"string"},"voidedByUserId":{"type":"string"},"createdBy":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string","format":"email"},"fullName":{"type":"string"}},"required":["id","email","fullName"]},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","scNumber","status","location","lines","createdAt"]}}},"required":["hasPrevious","hasNext","totalCount","results"],"description":"Get many stock counts paginated","example":{"hasPrevious":true,"previous":"previous-token","hasNext":true,"next":"next-token","totalCount":100,"results":[{"id":"sc_c1574b87-68d6-448a-ac18-4a5f0e68d534","scNumber":"SC-00001","name":"Main warehouse April 2026","status":"IN_PROGRESS","scope":{"locationId":"loc_c1574b87-68d6-448a-ac18-4a5f0e68d534","itemIds":["item_c1574b87-68d6-448a-ac18-4a5f0e68d534"],"categoryIds":[],"tagIds":[]},"location":{"id":"loc_c1574b87-68d6-448a-ac18-4a5f0e68d534","name":"Main warehouse","ancestorIds":[],"code":"MAIN"},"lines":[{"id":"scl_c1574b87-68d6-448a-ac18-4a5f0e68d534","itemId":"item_c1574b87-68d6-448a-ac18-4a5f0e68d534","itemNameSnapshot":"Widget A","itemNumberSnapshot":"WIDGET-A","locationId":"loc_c1574b87-68d6-448a-ac18-4a5f0e68d534","expectedQty":100,"expectedQtySnapshotAt":"2026-11-20T21:12:08.385Z","countedQty":98,"countedAt":"2026-11-20T21:12:08.385Z","countedByUserId":"user_counter","lineStatus":"PENDING","varianceReason":"Damage observed on 2 units"},{"id":"scl_c1574b87-68d6-448a-ac18-4a5f0e68d535","itemId":"item_c1574b87-68d6-448a-ac18-4a5f0e68d535","itemNameSnapshot":"Widget B","itemNumberSnapshot":"WIDGET-B","locationId":"loc_c1574b87-68d6-448a-ac18-4a5f0e68d534","expectedQty":50,"expectedQtySnapshotAt":"2026-11-20T21:12:08.385Z","countedQty":50,"countedAt":"2026-11-20T21:12:08.385Z","countedByUserId":"user_counter","lineStatus":"APPROVED","approvedAdjustment":0,"approvedByUserId":"user_approver"}],"startedAt":"2026-11-20T21:12:08.385Z","startedByUserId":"user_counter","createdAt":"2026-11-20T21:12:08.385Z","updatedAt":"2026-11-20T21:12:08.385Z"},{"id":"sc_c1574b87-68d6-448a-ac18-4a5f0e68d535","scNumber":"SC-00002","name":"Main warehouse April 2026","status":"COMPLETE","scope":{"locationId":"loc_c1574b87-68d6-448a-ac18-4a5f0e68d534","itemIds":["item_c1574b87-68d6-448a-ac18-4a5f0e68d534"],"categoryIds":[],"tagIds":[]},"location":{"id":"loc_c1574b87-68d6-448a-ac18-4a5f0e68d534","name":"Main warehouse","ancestorIds":[],"code":"MAIN"},"lines":[{"id":"scl_c1574b87-68d6-448a-ac18-4a5f0e68d534","itemId":"item_c1574b87-68d6-448a-ac18-4a5f0e68d534","itemNameSnapshot":"Widget A","itemNumberSnapshot":"WIDGET-A","locationId":"loc_c1574b87-68d6-448a-ac18-4a5f0e68d534","expectedQty":100,"expectedQtySnapshotAt":"2026-11-20T21:12:08.385Z","countedQty":98,"countedAt":"2026-11-20T21:12:08.385Z","countedByUserId":"user_counter","lineStatus":"PENDING","varianceReason":"Damage observed on 2 units"},{"id":"scl_c1574b87-68d6-448a-ac18-4a5f0e68d535","itemId":"item_c1574b87-68d6-448a-ac18-4a5f0e68d535","itemNameSnapshot":"Widget B","itemNumberSnapshot":"WIDGET-B","locationId":"loc_c1574b87-68d6-448a-ac18-4a5f0e68d534","expectedQty":50,"expectedQtySnapshotAt":"2026-11-20T21:12:08.385Z","countedQty":50,"countedAt":"2026-11-20T21:12:08.385Z","countedByUserId":"user_counter","lineStatus":"APPROVED","approvedAdjustment":0,"approvedByUserId":"user_approver"}],"startedAt":"2026-11-20T21:12:08.385Z","startedByUserId":"user_counter","createdAt":"2026-11-20T21:12:08.385Z","updatedAt":"2026-11-20T21:12:08.385Z"}]}},"StockCountGetOneResponse":{"type":"object","properties":{"id":{"type":"string"},"scNumber":{"type":"string"},"name":{"type":"string"},"status":{"type":"string","enum":["OPEN","IN_PROGRESS","SUBMITTED","UNDER_REVIEW","COMPLETE","CANCELLED","FINALIZATION_FAILED","VOID"],"default":"OPEN"},"scope":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"default":""},"supplierIds":{"type":"array","items":{"type":"string","minLength":1,"default":""}},"itemIds":{"type":"array","items":{"type":"string","minLength":1,"default":""}},"categoryIds":{"type":"array","items":{"type":"string","minLength":1,"default":""}},"tagIds":{"type":"array","items":{"type":"string","minLength":1,"default":""}}},"required":["locationId"]},"location":{"type":"object","properties":{"id":{"type":"string"},"code":{"type":["string","null"]},"name":{"type":"string"},"ancestorIds":{"type":"array","items":{"type":"string"}}},"required":["id","name","ancestorIds"]},"suppliers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]}},"scopeItems":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"itemNumber":{"type":"string"},"primaryImageUrl":{"type":"string"}},"required":["id","name"]}},"scopeItemsTotal":{"type":"integer"},"lines":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"itemId":{"type":"string","minLength":1,"default":""},"itemNameSnapshot":{"type":"string"},"itemNumberSnapshot":{"type":"string"},"itemPrimaryImageUrl":{"type":"string"},"locationId":{"type":"string","minLength":1,"default":""},"expectedQty":{"type":"number"},"expectedQtySnapshotAt":{"type":"string"},"countedQty":{"type":"number"},"countedAt":{"type":"string"},"countedByUserId":{"type":"string"},"lineStatus":{"type":"string","enum":["PENDING","APPROVED","REJECTED","RECOUNT_REQUESTED","RECOUNTED"]},"varianceReason":{"type":"string"},"rejectionReason":{"type":"string","enum":["MISCOUNT_SUSPECTED","DATA_ENTRY_ERROR","OUT_OF_SCOPE","OTHER"]},"rejectionNote":{"type":"string"},"recountReason":{"type":"string","enum":["SUSPECTED_MISCOUNT","PARTIAL_COUNT","ANOMALY_INVESTIGATION","OTHER"]},"recountNote":{"type":"string"},"approvedAdjustment":{"type":"number"},"approvedByUserId":{"type":"string"},"claimedByUserId":{"type":"string"}},"required":["id","itemId","itemNameSnapshot","locationId","expectedQty","expectedQtySnapshotAt","lineStatus"]},"default":[]},"findings":{"type":"string"},"finalizationError":{"type":"object","properties":{"lineId":{"type":"string","minLength":1,"default":""},"code":{"type":"string"},"message":{"type":"string"},"conflictingScNumber":{"type":"string"},"occurredAt":{"type":"string"}},"required":["lineId","code","message","occurredAt"]},"startedAt":{"type":"string"},"startedByUserId":{"type":"string"},"submittedAt":{"type":"string"},"submittedByUserId":{"type":"string"},"reviewOpenedAt":{"type":"string"},"finalizedAt":{"type":"string"},"finalizedByUserId":{"type":"string"},"cancelledAt":{"type":"string"},"cancelledByUserId":{"type":"string"},"voidedAt":{"type":"string"},"voidedByUserId":{"type":"string"},"createdBy":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string","format":"email"},"fullName":{"type":"string"}},"required":["id","email","fullName"]},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","scNumber","status","location","lines","createdAt"],"description":"Get one stock count","example":{"id":"sc_c1574b87-68d6-448a-ac18-4a5f0e68d534","scNumber":"SC-00001","name":"Main warehouse April 2026","status":"IN_PROGRESS","scope":{"locationId":"loc_c1574b87-68d6-448a-ac18-4a5f0e68d534","itemIds":["item_c1574b87-68d6-448a-ac18-4a5f0e68d534"],"categoryIds":[],"tagIds":[]},"location":{"id":"loc_c1574b87-68d6-448a-ac18-4a5f0e68d534","name":"Main warehouse","ancestorIds":[],"code":"MAIN"},"lines":[{"id":"scl_c1574b87-68d6-448a-ac18-4a5f0e68d534","itemId":"item_c1574b87-68d6-448a-ac18-4a5f0e68d534","itemNameSnapshot":"Widget A","itemNumberSnapshot":"WIDGET-A","locationId":"loc_c1574b87-68d6-448a-ac18-4a5f0e68d534","expectedQty":100,"expectedQtySnapshotAt":"2026-11-20T21:12:08.385Z","countedQty":98,"countedAt":"2026-11-20T21:12:08.385Z","countedByUserId":"user_counter","lineStatus":"PENDING","varianceReason":"Damage observed on 2 units"},{"id":"scl_c1574b87-68d6-448a-ac18-4a5f0e68d535","itemId":"item_c1574b87-68d6-448a-ac18-4a5f0e68d535","itemNameSnapshot":"Widget B","itemNumberSnapshot":"WIDGET-B","locationId":"loc_c1574b87-68d6-448a-ac18-4a5f0e68d534","expectedQty":50,"expectedQtySnapshotAt":"2026-11-20T21:12:08.385Z","countedQty":50,"countedAt":"2026-11-20T21:12:08.385Z","countedByUserId":"user_counter","lineStatus":"APPROVED","approvedAdjustment":0,"approvedByUserId":"user_approver"}],"startedAt":"2026-11-20T21:12:08.385Z","startedByUserId":"user_counter","createdAt":"2026-11-20T21:12:08.385Z","updatedAt":"2026-11-20T21:12:08.385Z"}},"StockCountActiveLocksResponse":{"type":"array","items":{"type":"object","properties":{"scNumber":{"type":"string"},"countStatus":{"type":"string","enum":["OPEN","IN_PROGRESS","SUBMITTED","UNDER_REVIEW","COMPLETE","CANCELLED","FINALIZATION_FAILED","VOID"]},"startedByUserId":{"type":"string"},"startedByUserName":{"type":"string"},"startedAt":{"type":"string"},"pairCount":{"type":"number"},"samplePairs":{"type":"array","items":{"type":"object","properties":{"itemId":{"type":"string"},"itemNumber":{"type":"string"},"itemName":{"type":"string"},"locationId":{"type":"string"},"locationName":{"type":"string"}},"required":["itemId","itemNumber","itemName","locationId","locationName"]}},"lockType":{"type":"string","enum":["WHOLE_COUNT","PER_LINE_ONLY"]},"ageMinutes":{"type":"number"}},"required":["scNumber","countStatus","startedByUserId","startedByUserName","startedAt","pairCount","samplePairs","lockType","ageMinutes"]},"description":"Active stock count locks summary, one entry per stock count currently holding ACTIVE locks","example":[{"scNumber":"SC-00001","countStatus":"IN_PROGRESS","startedByUserId":"user_counter","startedByUserName":"Jane Counter","startedAt":"2026-11-20T21:12:08.385Z","pairCount":12,"samplePairs":[{"itemId":"item_c1574b87-68d6-448a-ac18-4a5f0e68d534","itemNumber":"WIDGET-A","itemName":"Widget A","locationId":"loc_c1574b87-68d6-448a-ac18-4a5f0e68d534","locationName":"Main warehouse"}],"lockType":"WHOLE_COUNT","ageMinutes":42}]},"StockCountCreateOneRequest":{"type":"object","properties":{"name":{"type":"string"},"scope":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"default":""},"supplierIds":{"type":"array","items":{"type":"string","minLength":1,"default":""}},"itemIds":{"type":"array","items":{"type":"string","minLength":1,"default":""}},"categoryIds":{"type":"array","items":{"type":"string","minLength":1,"default":""}},"tagIds":{"type":"array","items":{"type":"string","minLength":1,"default":""}}},"required":["locationId"]}},"required":["scope"],"description":"Create one stock count. The scope picks the location plus optional item / category / tag filters.","example":{"name":"Main warehouse April 2026","scope":{"locationId":"loc_c1574b87-68d6-448a-ac18-4a5f0e68d534","itemIds":["item_c1574b87-68d6-448a-ac18-4a5f0e68d534"],"categoryIds":[],"tagIds":[]}}},"StockCountSetLineCountRequest":{"type":"object","properties":{"countedQty":{"type":"number","minimum":0},"varianceReason":{"type":"string"}},"required":["countedQty"],"description":"Set the counted quantity for a stock count line","example":{"countedQty":98,"varianceReason":"Damage observed on 2 units"}},"StockCountRejectLineRequest":{"type":"object","properties":{"rejectionReason":{"type":"string","enum":["MISCOUNT_SUSPECTED","DATA_ENTRY_ERROR","OUT_OF_SCOPE","OTHER"]},"rejectionNote":{"type":"string"}},"required":["rejectionReason"],"description":"Reject a counted line. `rejectionNote` is required when `rejectionReason` is `OTHER`.","example":{"rejectionReason":"MISCOUNT_SUSPECTED","rejectionNote":"Counter missed the bottom shelf"}},"StockCountRequestRecountRequest":{"type":"object","properties":{"recountReason":{"type":"string","enum":["SUSPECTED_MISCOUNT","PARTIAL_COUNT","ANOMALY_INVESTIGATION","OTHER"]},"recountNote":{"type":"string"}},"required":["recountReason"],"description":"Request a recount for a stock count line. `recountNote` is required when `recountReason` is `OTHER`.","example":{"recountReason":"SUSPECTED_MISCOUNT","recountNote":"Counted quantity deviates by more than 10% from expected"}},"StockCountRecountLineRequest":{"type":"object","properties":{"countedQty":{"type":"number","minimum":0},"varianceReason":{"type":"string"}},"required":["countedQty"],"description":"Submit a new counted quantity for a line that was requested to be recounted","example":{"countedQty":100,"varianceReason":"Bottom shelf items had been missed on the first count"}},"StockCountResolveScanRequest":{"type":"object","properties":{"code":{"type":"string","minLength":1}},"required":["code"],"description":"Resolve a scanned code (barcode / SKU / assetId) against an in-progress stock count","example":{"code":"AB-100"}},"StockCountResolveScanResponse":{"oneOf":[{"type":"object","properties":{"match":{"type":"string","const":"SINGLE"},"lineId":{"type":"string","minLength":1,"default":""},"itemId":{"type":"string","minLength":1,"default":""},"itemName":{"type":"string"},"expectedQty":{"type":"number"},"countedQty":{"type":["number","null"]},"matchedField":{"type":"string","enum":["ASSET_ID","BARCODE","CUSTOM_FIELD"]}},"required":["match","lineId","itemId","itemName","expectedQty","countedQty","matchedField"]},{"type":"object","properties":{"match":{"type":"string","const":"AMBIGUOUS"},"candidates":{"type":"array","items":{"type":"object","properties":{"lineId":{"type":"string","minLength":1,"default":""},"itemId":{"type":"string","minLength":1,"default":""},"itemName":{"type":"string"},"matchedField":{"type":"string","enum":["ASSET_ID","BARCODE","CUSTOM_FIELD"]}},"required":["lineId","itemId","itemName","matchedField"]}}},"required":["match","candidates"]},{"type":"object","properties":{"match":{"type":"string","const":"OUT_OF_SCOPE"},"itemId":{"type":"string","minLength":1,"default":""},"itemName":{"type":"string"},"matchedField":{"type":"string","enum":["ASSET_ID","BARCODE","CUSTOM_FIELD"]}},"required":["match","itemId","itemName","matchedField"]},{"type":"object","properties":{"match":{"type":"string","const":"NONE"}},"required":["match"]}],"description":"Outcome of a scan. Discriminated by `match`: SINGLE (one in-scope line matched), AMBIGUOUS (multiple in-scope lines matched), OUT_OF_SCOPE (item found in org but not in this count), NONE (no match).","example":{"match":"SINGLE","lineId":"scl_c1574b87-68d6-448a-ac18-4a5f0e68d534","itemId":"item_c1574b87-68d6-448a-ac18-4a5f0e68d534","itemName":"Widget A","expectedQty":100,"countedQty":null,"matchedField":"ASSET_ID"}},"GoodsReceiptGetManyPaginatedResponse":{"type":"object","properties":{"previous":{"type":"string"},"hasPrevious":{"type":"boolean"},"next":{"type":"string"},"hasNext":{"type":"boolean"},"totalCount":{"type":"number"},"results":{"type":"array","items":{"$ref":"#/components/schemas/EnrichedGoodsReceiptResponse"}}},"required":["hasPrevious","hasNext","totalCount","results"]},"ReceivableOrdersGetManyPaginatedResponse":{"type":"object","properties":{"previous":{"type":"string"},"hasPrevious":{"type":"boolean"},"next":{"type":"string"},"hasNext":{"type":"boolean"},"totalCount":{"type":"number"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ReceivableOrderSummaryResponse"}}},"required":["hasPrevious","hasNext","totalCount","results"]},"EnrichedGoodsReceiptResponse":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"receiptNumber":{"type":"string","minLength":1,"default":""},"status":{"type":"string","enum":["posted","reversed"]},"sourceType":{"type":"string","enum":["purchase_order","transfer","manufacturing_order","blind"]},"sourceId":{"type":"string","minLength":1,"default":""},"sourceNumber":{"type":"string","minLength":1,"default":""},"supplierId":{"type":["string","null"],"default":null},"supplierName":{"type":["string","null"]},"locationId":{"type":"string","minLength":1,"default":""},"locationAncestorIds":{"type":"array","items":{"type":"string"},"default":[]},"receivedBy":{"type":"string","minLength":1,"default":""},"receivedAt":{"type":"string"},"effectiveDate":{"type":"string"},"note":{"type":["string","null"],"default":null},"reversalOf":{"type":["string","null"],"default":null},"reversedByReceiptId":{"type":["string","null"],"default":null},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"lines":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"sourceLineId":{"type":"string","minLength":1,"default":""},"itemId":{"type":"string","minLength":1,"default":""},"qtyAccepted":{"type":"number","minimum":0},"qtyRejected":{"type":"number","minimum":0},"rejectReason":{"type":["string","null"],"enum":["damaged","wrong_item","quality","short_shipped","other",null],"default":null},"unitOfMeasureId":{"type":["string","null"],"default":null},"orderedUnitFactor":{"type":"number","exclusiveMinimum":0},"stockingUnitOfMeasureId":{"type":["string","null"],"default":null},"convertedQtyAccepted":{"type":"number"},"revaluedCost":{"type":["number","null"],"minimum":0,"default":null},"serialNumbers":{"type":"array","items":{"type":"string","minLength":1,"default":""},"default":[]},"batchNumber":{"type":["string","null"],"default":null},"overReceipt":{"type":"boolean","default":false},"backorderRelief":{"type":"number","minimum":0,"default":0},"returnedQuantity":{"type":"number","minimum":0,"default":0},"note":{"type":["string","null"],"default":null},"closedLine":{"type":"boolean","default":false},"itemName":{"type":["string","null"]},"unitOfMeasureName":{"type":["string","null"]},"stockingUnitOfMeasureName":{"type":["string","null"]},"appliedCost":{"type":"number"}},"required":["id","sourceLineId","itemId","qtyAccepted","qtyRejected","rejectReason","unitOfMeasureId","orderedUnitFactor","stockingUnitOfMeasureId","convertedQtyAccepted","revaluedCost","serialNumbers","batchNumber","overReceipt","backorderRelief","returnedQuantity","note","closedLine","itemName","unitOfMeasureName","stockingUnitOfMeasureName"]}},"locationName":{"type":["string","null"]},"locationAncestorNames":{"type":"array","items":{"type":"string"}},"receivedByName":{"type":["string","null"]}},"required":["id","receiptNumber","status","sourceType","sourceId","sourceNumber","supplierId","supplierName","locationId","locationAncestorIds","receivedBy","receivedAt","effectiveDate","note","reversalOf","reversedByReceiptId","createdAt","updatedAt","lines","locationName","locationAncestorNames","receivedByName"]},"GoodsReceiptConfirmationResponse":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"receiptNumber":{"type":"string","minLength":1,"default":""},"status":{"type":"string","enum":["posted","reversed"]},"receivedAt":{"type":"string"},"effectiveDate":{"type":"string"},"reversalOf":{"type":["string","null"],"default":null},"lines":{"type":"array","items":{"type":"object","properties":{"sourceLineId":{"type":"string","minLength":1,"default":""},"qtyAccepted":{"type":"number","minimum":0},"qtyRejected":{"type":"number","minimum":0},"overReceipt":{"type":"boolean","default":false}},"required":["sourceLineId","qtyAccepted","qtyRejected","overReceipt"]}}},"required":["id","receiptNumber","status","receivedAt","effectiveDate","reversalOf","lines"]},"ReceivableOrderResponse":{"type":"object","properties":{"id":{"type":"string"},"purchaseOrderId":{"type":"string"},"supplierName":{"type":"string"},"status":{"type":"string","enum":["draft","submitted","approved","ordered","received","partially_received","void"]},"shippingLocationId":{"type":"string"},"shippingLocationName":{"type":"string"},"orderedAt":{"type":"string"},"lines":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"number":{"type":["string","null"]},"orderedQuantity":{"type":"number"},"receivedQuantity":{"type":"number"},"unitOfMeasureId":{"type":"string"},"stockingUnitOfMeasureId":{"type":"string"},"orderedUnitFactor":{"type":["number","null"],"description":"Stocking units per one `unitOfMeasureId`: the Ordered Unit Factor the purchase order line copied when it was saved. The post converts with this and nothing else, so a preview must too: round `quantity × orderedUnitFactor` to the stocking unit's `decimalPlaces`, unless the line is in its stocking unit at factor 1. Null only for a line the server cannot receive until it is migrated."},"traceability":{"type":"string","enum":["none","serial","batch"]},"imageUrl":{"type":["string","null"]},"deliveryComplete":{"type":"boolean"},"sourceType":{"type":"string","enum":["inventory","catalog"]},"backorderedByLocationId":{"type":"object","additionalProperties":{"type":"number"}}},"required":["id","name","number","orderedQuantity","receivedQuantity","unitOfMeasureId","stockingUnitOfMeasureId","orderedUnitFactor","traceability","imageUrl","deliveryComplete","sourceType","backorderedByLocationId"]}},"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]}},"units":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"symbol":{"type":["string","null"]},"category":{"type":"string","enum":["unit","weight","volume","length","surface","work_time"]},"conversionFactor":{"type":"number","exclusiveMinimum":0,"deprecated":true,"description":"Deprecated for receipt previews: this is the unit's current definition, not what the order is received at. Convert with the line's `orderedUnitFactor` instead."},"decimalPlaces":{"type":"integer","minimum":0,"maximum":6},"system":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","category","conversionFactor","decimalPlaces","system"]}},"packagingUnits":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"symbol":{"type":["string","null"]},"kind":{"type":"string","const":"packaging"}},"required":["id","name","kind"]}}},"required":["id","purchaseOrderId","supplierName","status","shippingLocationId","shippingLocationName","orderedAt","lines","locations","units","packagingUnits"]},"ReceivableOrderSummaryResponse":{"type":"object","properties":{"id":{"type":"string"},"purchaseOrderId":{"type":"string"},"supplierName":{"type":"string"},"shippingLocationName":{"type":"string"},"status":{"type":"string","enum":["draft","submitted","approved","ordered","received","partially_received","void"]}},"required":["id","purchaseOrderId","supplierName","shippingLocationName","status"]},"ResolveScanRequest":{"type":"object","properties":{"code":{"type":"string","minLength":1}},"required":["code"]},"ResolveScanResponse":{"oneOf":[{"type":"object","properties":{"match":{"type":"string","const":"SINGLE"},"candidate":{"type":"object","properties":{"orderId":{"type":"string"},"purchaseOrderId":{"type":"string"},"supplierName":{"type":"string"},"shippingLocationName":{"type":"string"},"sourceLineId":{"type":"string"},"itemId":{"type":"string"},"itemName":{"type":"string"},"orderedQuantity":{"type":"number"},"receivedQuantity":{"type":"number"},"traceability":{"type":"string","enum":["none","serial","batch"]},"matchedField":{"type":"string","enum":["ASSET_ID","BARCODE","CUSTOM_FIELD"]}},"required":["orderId","purchaseOrderId","supplierName","shippingLocationName","sourceLineId","itemId","itemName","orderedQuantity","receivedQuantity","traceability","matchedField"]}},"required":["match","candidate"]},{"type":"object","properties":{"match":{"type":"string","const":"CANDIDATES"},"candidates":{"type":"array","items":{"type":"object","properties":{"orderId":{"type":"string"},"purchaseOrderId":{"type":"string"},"supplierName":{"type":"string"},"shippingLocationName":{"type":"string"},"sourceLineId":{"type":"string"},"itemId":{"type":"string"},"itemName":{"type":"string"},"orderedQuantity":{"type":"number"},"receivedQuantity":{"type":"number"},"traceability":{"type":"string","enum":["none","serial","batch"]},"matchedField":{"type":"string","enum":["ASSET_ID","BARCODE","CUSTOM_FIELD"]}},"required":["orderId","purchaseOrderId","supplierName","shippingLocationName","sourceLineId","itemId","itemName","orderedQuantity","receivedQuantity","traceability","matchedField"]}}},"required":["match","candidates"]},{"type":"object","properties":{"match":{"type":"string","const":"NOT_ON_ANY_ORDER"},"item":{"type":"object","properties":{"itemId":{"type":"string"},"itemName":{"type":"string"},"matchedField":{"type":"string","enum":["ASSET_ID","BARCODE","CUSTOM_FIELD"]}},"required":["itemId","itemName","matchedField"]}},"required":["match","item"]},{"type":"object","properties":{"match":{"type":"string","const":"NONE"}},"required":["match"]}]},"MeCapabilitiesResponse":{"type":"object","properties":{"experiments":{"type":"object","properties":{"showStockCount":{"type":"boolean"}},"required":["showStockCount"]},"permissions":{"type":"array","items":{"type":"string"}},"featureSettings":{"type":"object","properties":{"receiving":{"type":"object","properties":{"overReceiptPolicy":{"type":"string","enum":["block","warn","allow"]},"overReceiptTolerancePercent":{"type":"number"},"underDeliveryTolerancePercent":{"type":"number"}},"required":["overReceiptPolicy","overReceiptTolerancePercent","underDeliveryTolerancePercent"]}},"required":["receiving"]}},"required":["experiments","permissions","featureSettings"]},"ScanResolutionRequest":{"type":"object","properties":{"code":{"type":"string","minLength":1}},"required":["code"]},"ScanResolution":{"oneOf":[{"type":"object","properties":{"match":{"type":"string","const":"SINGLE"},"target":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"RECEIVING"},"orderId":{"type":"string"},"purchaseOrderId":{"type":"string"},"supplierName":{"type":"string"},"shippingLocationName":{"type":"string"},"sourceLineId":{"type":"string"},"itemId":{"type":"string"},"itemName":{"type":"string"},"orderedQuantity":{"type":"number"},"receivedQuantity":{"type":"number"},"traceability":{"type":"string","enum":["none","serial","batch"]},"matchedField":{"type":"string","enum":["ASSET_ID","BARCODE","CUSTOM_FIELD"]}},"required":["kind","orderId","purchaseOrderId","supplierName","shippingLocationName","sourceLineId","itemId","itemName","orderedQuantity","receivedQuantity","traceability","matchedField"]},{"type":"object","properties":{"kind":{"type":"string","const":"STOCK_COUNT"},"countId":{"type":"string"},"scNumber":{"type":"string"},"locationName":{"type":"string"},"lineId":{"type":"string"},"itemId":{"type":"string"},"itemName":{"type":"string"},"matchedField":{"type":"string","enum":["ASSET_ID","BARCODE","CUSTOM_FIELD"]}},"required":["kind","countId","scNumber","locationName","lineId","itemId","itemName","matchedField"]}]}},"required":["match","target"]},{"type":"object","properties":{"match":{"type":"string","const":"CANDIDATES"},"targets":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"RECEIVING"},"orderId":{"type":"string"},"purchaseOrderId":{"type":"string"},"supplierName":{"type":"string"},"shippingLocationName":{"type":"string"},"sourceLineId":{"type":"string"},"itemId":{"type":"string"},"itemName":{"type":"string"},"orderedQuantity":{"type":"number"},"receivedQuantity":{"type":"number"},"traceability":{"type":"string","enum":["none","serial","batch"]},"matchedField":{"type":"string","enum":["ASSET_ID","BARCODE","CUSTOM_FIELD"]}},"required":["kind","orderId","purchaseOrderId","supplierName","shippingLocationName","sourceLineId","itemId","itemName","orderedQuantity","receivedQuantity","traceability","matchedField"]},{"type":"object","properties":{"kind":{"type":"string","const":"STOCK_COUNT"},"countId":{"type":"string"},"scNumber":{"type":"string"},"locationName":{"type":"string"},"lineId":{"type":"string"},"itemId":{"type":"string"},"itemName":{"type":"string"},"matchedField":{"type":"string","enum":["ASSET_ID","BARCODE","CUSTOM_FIELD"]}},"required":["kind","countId","scNumber","locationName","lineId","itemId","itemName","matchedField"]}]}}},"required":["match","targets"]},{"type":"object","properties":{"match":{"type":"string","const":"ITEM_ONLY"},"item":{"type":"object","properties":{"itemId":{"type":"string"},"itemName":{"type":"string"},"matchedField":{"type":"string","enum":["ASSET_ID","BARCODE","CUSTOM_FIELD"]}},"required":["itemId","itemName","matchedField"]}},"required":["match","item"]},{"type":"object","properties":{"match":{"type":"string","const":"NONE"}},"required":["match"]}]},"ItemDeleteManyRequest":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string","minLength":1,"default":""},"minItems":1,"maxItems":100}},"required":["ids"],"description":"Delete many items","example":{"ids":["item_c1574b87-68d6-448a-ac18-4a5f0e68d534"]}},"ItemArchiveManyRequest":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string","minLength":1,"default":""},"minItems":1,"maxItems":100}},"required":["ids"],"description":"Archive many items","example":{"ids":["item_c1574b87-68d6-448a-ac18-4a5f0e68d534"]}},"WorkspaceDeleteOneRequest":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""}},"required":["id"],"description":"Delete one workspace","example":{"id":"c1574b87-68d6-448a-ac18-4a5f0e68d534"}},"WorkspaceTypeGetManyResponse":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"default":""},"name":{"type":"string"},"customFieldIds":{"type":"array","items":{"type":"string"}},"lockedCustomFieldIds":{"type":"array","items":{"type":"string"}},"code":{"type":["string","null"]},"system":{"type":"boolean"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","name","customFieldIds","createdAt","updatedAt"]},"description":"Get many workspace types","example":[{"id":"wst_b09ce6cd76f54113895c0f36ae7365c6","name":"Project Workspace","customFieldIds":["cf_b09ce6cd76f54113895c0f36ae7365c7"],"createdAt":"2026-11-20T21:12:08.392Z","updatedAt":"2026-11-20T21:12:08.392Z"},{"id":"wst_b09ce6cd76f54113895c0f36ae7365c8","name":"Sales Workspace","customFieldIds":["cf_b09ce6cd76f54113895c0f36ae7365c9"],"createdAt":"2026-11-20T21:12:08.392Z","updatedAt":"2026-11-20T21:12:08.392Z"}]},"ApiKeyCreatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"api_key"},"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["standard","restricted"]},"permissions":{"anyOf":[{"type":"array","items":{"type":"string","enum":["alerts:manage","feature_settings:manage","api:manage","billing:manage","categories:manage","categories:read","company_details:manage","custom_fields:manage","custom_fields:read","workspace_types:manage","workspace_types:read","dashboards:manage","export_import:manage","items_locations:manage","items_locations:read","items:manage","labels:manage","locations:manage","locations:read","permissions:manage","customers:manage","customers:read","purchase_orders:manage","purchase_orders:read","sale_orders:manage","sale_orders:read","proforma_orders:manage","proforma_orders:read","credit_notes:manage","credit_notes:read","reports:manage","suppliers:manage","tags:manage","users:manage","webhooks:manage","workspaces:manage","shipments:manage","shipments:read","quotes:manage","quotes:read","serial_numbers:manage","units_of_measure:manage","units_of_measure:read","stockCounts:count","stockCounts:approve","document_templates:manage","integrations:manage","receiving:manage","receiving:read","period_lock:manage","quantity_increase:manage","quantity_decrease:manage","quantity_move:manage"]}},{"type":"array","maxItems":1,"minItems":1,"prefixItems":[{"type":"string","const":"*"}]}]},"created_at":{"type":"number"},"expires_at":{"type":["number","null"]}},"required":["object","id","name","type","permissions","created_at","expires_at"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"api_key.created","timestamp":1736382331594,"data":{"object":"api_key","id":"api_677f177b44a6261be88bfeb4","name":"My API Key","type":"standard","permissions":["*"],"created_at":1736382331594,"expires_at":1736383331594}}]},"ApiKeyDeletedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"api_key"},"id":{"type":"string"}},"required":["object","id"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"api_key.deleted","timestamp":1736382331594,"data":{"object":"api_key","id":"api_677f177b44a6261be88bfeb4"}}]},"CategoryCreatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"category"},"id":{"type":"string"},"name":{"type":"string"},"custom_field_ids":{"type":"array","items":{"type":"string"}},"parent_category_id":{"type":["string","null"]}},"required":["object","id","name","custom_field_ids","parent_category_id"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"category.created","timestamp":1736382331594,"data":{"object":"category","id":"cat_677f177b44a6261be88bfeb4","name":"My Category","custom_field_ids":[],"parent_category_id":"cat_676574fbc89194908efd92ab"}}]},"CategoryUpdatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"category"},"id":{"type":"string"},"name":{"type":"string"},"custom_field_ids":{"type":"array","items":{"type":"string"}},"parent_category_id":{"type":["string","null"]}},"required":["object","id","name","custom_field_ids","parent_category_id"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"category.updated","timestamp":1736382331594,"data":{"object":"category","id":"cat_677f177b44a6261be88bfeb4","name":"My Category","custom_field_ids":[],"parent_category_id":"cat_676574fbc89194908efd92ab"}}]},"CategoryDeletedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"category"},"id":{"type":"string"}},"required":["object","id"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"category.deleted","timestamp":1736382331594,"data":{"object":"category","id":"cat_677f177b44a6261be88bfeb4"}}]},"CustomFieldCreatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"custom_field"},"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["short-text","long-text","integer","decimal","date","datetime","time","boolean","select","multiselect","barcode"]},"options":{"type":["array","null"],"items":{"type":"string"}},"default_value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"required":["object","id","name","type","options","default_value"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"custom_field.created","timestamp":1736382331594,"data":{"object":"custom_field","id":"cf_677f177b44a6261be88bfeb4","name":"My Custom Field","type":"short-text","options":null,"default_value":"My default value"}},{"object":"event","type":"custom_field.created","timestamp":1736382331594,"data":{"object":"custom_field","id":"cf_677f177b44a6261be88bfeb4","name":"My Custom Field","type":"multiselect","options":["Option 1","Option 2","Option 3"],"default_value":["Option 1"]}},{"object":"event","type":"custom_field.created","timestamp":1736382331594,"data":{"object":"custom_field","id":"cf_677f177b44a6261be88bfeb4","name":"My Custom Field","type":"select","options":["Option 1","Option 2","Option 3"],"default_value":"Option 1"}}]},"CustomFieldUpdatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"custom_field"},"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["short-text","long-text","integer","decimal","date","datetime","time","boolean","select","multiselect","barcode"]},"options":{"type":["array","null"],"items":{"type":"string"}},"default_value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]}},"required":["object","id","name","type","options","default_value"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"custom_field.updated","timestamp":1736382331594,"data":{"object":"custom_field","id":"cf_677f177b44a6261be88bfeb4","name":"My Text Field","type":"short-text","options":null,"default_value":"My default value"}},{"object":"event","type":"custom_field.updated","timestamp":1736382331594,"data":{"object":"custom_field","id":"cf_677f177b44a6261be88bfeb4","name":"My Multiselect Field","type":"multiselect","options":["Option 1","Option 2","Option 3"],"default_value":["Option 1"]}},{"object":"event","type":"custom_field.updated","timestamp":1736382331594,"data":{"object":"custom_field","id":"cf_677f177b44a6261be88bfeb4","name":"My Select Field","type":"select","options":["Option 1","Option 2","Option 3"],"default_value":"Option 1"}}]},"CustomFieldDeletedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"custom_field"},"id":{"type":"string"}},"required":["object","id"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"custom_field.deleted","timestamp":1736382331594,"data":{"object":"custom_field","id":"cf_677f177b44a6261be88bfeb4"}}]},"ItemCreatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"item"},"id":{"type":"string"},"asset_id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"price":{"type":"number"},"cost":{"type":"number"},"min_level":{"type":["number","null"]},"quantity":{"type":"integer"},"location_quantities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"quantity":{"type":"integer"},"reserved_quantity":{"type":"integer"},"name":{"type":"string"},"code":{"type":["string","null"]}},"required":["id","quantity","name","code"]}},"tags":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","const":"tag"},"id":{"type":"string"},"name":{"type":"string"}},"required":["object","id","name"]}},"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":["string","null"]}},"required":["url","name"]}},"custom_field_values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["short-text","long-text","integer","decimal","date","datetime","time","boolean","select","multiselect","barcode"]},"value":{},"default_value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]},"required":{"type":"boolean"}},"required":["id","name","type","default_value","required"]}},"suppliers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"default":[]},"category":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"barcode":{"type":["object","null"],"properties":{"value":{"type":"string","minLength":1,"default":""},"type":{"type":"string","enum":["BARCODE","QRCODE"]}},"required":["value","type"]},"archived_at":{"type":"string"}},"required":["object","id","asset_id","name","description","price","cost","min_level","quantity","location_quantities","tags","images","custom_field_values","category","barcode"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"item.created","timestamp":1736382331594,"data":{"object":"item","id":"item_677f177b44a6261be88bfeb4","name":"My Item","description":"My description","asset_id":"0001234","barcode":{"type":"BARCODE","value":"1234567890"},"min_level":5,"cost":100,"price":200,"quantity":10,"location_quantities":[{"id":"loc_677f177b44a6261be88bfeb4","quantity":5,"name":"My Location 1","code":"my-location-1"},{"id":"loc_677f177b44a6261be88bfeb5","quantity":5,"name":"My Location 2","code":null}],"category":{"id":"cat_676574fbc89194908efd92ab","name":"My Category"},"custom_field_values":[{"id":"cf_676574fbc89194908efd92ab","value":"My value","name":"My CF short text","type":"short-text","required":false,"default_value":null},{"id":"cf_676574fbc89194908efd92ac","value":["Option 1"],"name":"My CF multi-select","type":"multiselect","required":false,"default_value":null},{"id":"cf_676574fbc89194908efd92ad","value":"Option 1","name":"My CF select","type":"select","required":false,"default_value":null}],"tags":[{"object":"tag","id":"tag_676574fbc89194908efd92ab","name":"My Tag"}],"suppliers":[{"id":"sup_676574fbc89194908efd92ab","name":"My Supplier"}],"images":[{"url":"https://example.com/image1.jpg","name":"Image 1"}]}}]},"ItemCreatedBulkEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"bulk_operation"},"id":{"type":"string"}},"required":["object","id"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"item.created_bulk","timestamp":1736382331594,"data":{"object":"bulk_operation","id":"bulk_677f177b44a6261be88bfeb4"}}]},"ItemUpdatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"item"},"id":{"type":"string"},"asset_id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"price":{"type":"number"},"cost":{"type":"number"},"min_level":{"type":["number","null"]},"quantity":{"type":"integer"},"location_quantities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"quantity":{"type":"integer"},"reserved_quantity":{"type":"integer"},"name":{"type":"string"},"code":{"type":["string","null"]}},"required":["id","quantity","name","code"]}},"tags":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","const":"tag"},"id":{"type":"string"},"name":{"type":"string"}},"required":["object","id","name"]}},"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":["string","null"]}},"required":["url","name"]}},"custom_field_values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["short-text","long-text","integer","decimal","date","datetime","time","boolean","select","multiselect","barcode"]},"value":{},"default_value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]},"required":{"type":"boolean"}},"required":["id","name","type","default_value","required"]}},"suppliers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"default":[]},"category":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"barcode":{"type":["object","null"],"properties":{"value":{"type":"string","minLength":1,"default":""},"type":{"type":"string","enum":["BARCODE","QRCODE"]}},"required":["value","type"]},"archived_at":{"type":"string"}},"required":["object","id","asset_id","name","description","price","cost","min_level","quantity","location_quantities","tags","images","custom_field_values","category","barcode"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"item.updated","timestamp":1736382331594,"data":{"object":"item","id":"item_677f177b44a6261be88bfeb4","name":"My Item","description":"My description","asset_id":"0001234","barcode":{"type":"BARCODE","value":"1234567890"},"min_level":5,"cost":100,"price":200,"quantity":10,"location_quantities":[{"id":"loc_677f177b44a6261be88bfeb4","quantity":5,"name":"My Location 1","code":"my-location-1"},{"id":"loc_677f177b44a6261be88bfeb5","quantity":5,"name":"My Location 2","code":null}],"category":{"id":"cat_676574fbc89194908efd92ab","name":"My Category"},"custom_field_values":[{"id":"cf_676574fbc89194908efd92ab","value":"My value","name":"My CF short text","type":"short-text","required":false,"default_value":null},{"id":"cf_676574fbc89194908efd92ac","value":["Option 1"],"name":"My CF multi-select","type":"multiselect","required":false,"default_value":null},{"id":"cf_676574fbc89194908efd92ad","value":"Option 1","name":"My CF select","type":"select","required":false,"default_value":null}],"tags":[{"object":"tag","id":"tag_676574fbc89194908efd92ab","name":"My Tag"}],"suppliers":[{"id":"sup_676574fbc89194908efd92ab","name":"My Category"}],"images":[{"url":"https://example.com/image1.jpg","name":"Image 1"}]}}]},"ItemUpdatedBulkEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"bulk_operation"},"id":{"type":"string"}},"required":["object","id"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"item.updated_bulk","timestamp":1736382331594,"data":{"object":"bulk_operation","id":"bulk_677f177b44a6261be88bfeb4"}}]},"ItemDeletedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"item"},"id":{"type":"string"}},"required":["object","id"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"item.deleted","timestamp":1736382331594,"data":{"object":"item","id":"item_677f177b44a6261be88bfeb4"}}]},"ItemDeletedBulkEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"list"},"ids":{"type":"array","items":{"type":"string"}}},"required":["object","ids"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"item.deleted_bulk","timestamp":1736382331594,"data":{"object":"list","ids":["item_677f177b44a6261be88bfeb4","item_677f177b44a6261be88bfeb5"]}}]},"ItemVariantCreatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"item_variant"},"id":{"type":"string"},"asset_id":{"type":"string"},"name":{"type":"string"},"parent_item_id":{"type":"string"},"parent_asset_id":{"type":"string"},"variant_values":{"type":"array","items":{"type":"object","properties":{"custom_field_id":{"type":"string"},"custom_field_name":{"type":"string"},"value":{"type":"string"}},"required":["custom_field_id","custom_field_name","value"]}},"price":{"type":"number"},"cost":{"type":"number"}},"required":["object","id","asset_id","name","parent_item_id","parent_asset_id","variant_values","price","cost"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"item.variant_created","timestamp":1736382331594,"data":{"object":"item_variant","id":"item_677f177b44a6261be88bfeb5","asset_id":"TSHIRT-BLK-L","name":"T-Shirt - Black / Large","parent_item_id":"item_677f177b44a6261be88bfeb4","parent_asset_id":"TSHIRT","variant_values":[{"custom_field_id":"cf_676574fbc89194908efd92ab","custom_field_name":"Color","value":"Black"},{"custom_field_id":"cf_676574fbc89194908efd92ac","custom_field_name":"Size","value":"Large"}],"price":2500,"cost":1000}}]},"ItemVariantsGeneratedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"item_variants"},"parent_item_id":{"type":"string"},"parent_asset_id":{"type":"string"},"variant_count":{"type":"integer"},"variant_ids":{"type":"array","items":{"type":"string"}}},"required":["object","parent_item_id","parent_asset_id","variant_count","variant_ids"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"item.variants_generated","timestamp":1736382331594,"data":{"object":"item_variants","parent_item_id":"item_677f177b44a6261be88bfeb4","parent_asset_id":"TSHIRT","variant_count":6,"variant_ids":["item_677f177b44a6261be88bfeb5","item_677f177b44a6261be88bfeb6","item_677f177b44a6261be88bfeb7","item_677f177b44a6261be88bfeb8","item_677f177b44a6261be88bfeb9","item_677f177b44a6261be88bfeba"]}}]},"ItemVariantsEnabledEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"item"},"id":{"type":"string"},"asset_id":{"type":"string"},"name":{"type":"string"},"variant_schema":{"type":"object","properties":{"custom_field_ids":{"type":"array","items":{"type":"string"}}},"required":["custom_field_ids"]}},"required":["object","id","asset_id","name","variant_schema"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"item.variants_enabled","timestamp":1736382331594,"data":{"object":"item","id":"item_677f177b44a6261be88bfeb4","asset_id":"TSHIRT","name":"T-Shirt","variant_schema":{"custom_field_ids":["cf_676574fbc89194908efd92ab","cf_676574fbc89194908efd92ac"]}}}]},"ItemVariantsDisabledEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"item"},"id":{"type":"string"},"asset_id":{"type":"string"},"name":{"type":"string"},"archived_variant_count":{"type":"integer"}},"required":["object","id","asset_id","name","archived_variant_count"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"item.variants_disabled","timestamp":1736382331594,"data":{"object":"item","id":"item_677f177b44a6261be88bfeb4","asset_id":"TSHIRT","name":"T-Shirt","archived_variant_count":6}}]},"LocationCreatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"address_line_1":{"type":["string","null"]},"address_line_2":{"type":["string","null"]},"city":{"type":["string","null"]},"zip":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]},"phone":{"type":["string","null"]},"object":{"type":"string","const":"location"},"id":{"type":"string"},"code":{"type":["string","null"]},"name":{"type":"string"},"description":{"type":["string","null"]},"image":{"type":["object","null"],"properties":{"url":{"type":"string"},"name":{"type":["string","null"]}},"required":["url","name"]},"type":{"type":["string","null"]},"ancestor_ids":{"type":["array","null"],"items":{"type":"string"}},"shipping_address":{"type":["object","null"],"properties":{"address_line_1":{"type":["string","null"]},"address_line_2":{"type":["string","null"]},"city":{"type":["string","null"]},"zip":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]},"phone":{"type":["string","null"]}},"required":["address_line_1","address_line_2","city","zip","state","country","phone"]},"billing_address":{"type":["object","null"],"properties":{"address_line_1":{"type":["string","null"]},"address_line_2":{"type":["string","null"]},"city":{"type":["string","null"]},"zip":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]},"phone":{"type":["string","null"]}},"required":["address_line_1","address_line_2","city","zip","state","country","phone"]},"archived_at":{"type":"string"}},"required":["address_line_1","address_line_2","city","zip","state","country","phone","object","id","code","name","description","image","type","ancestor_ids","shipping_address","billing_address"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"location.created","timestamp":1736382331594,"data":{"object":"location","id":"loc_677f177b44a6261be88bfeb4","ancestor_ids":["loc_677f177b44a6261be88bfeb5"],"name":"My Location","code":"my-location","description":"My description","image":{"url":"https://example.com/image1.jpg","name":"Image 1"},"type":"storage","address_line_1":"123 Main St","address_line_2":null,"city":"San Francisco","state":"CA","zip":"94105","country":"US","phone":"123-456-7890","shipping_address":{"address_line_1":"123 Main St","address_line_2":null,"city":"San Francisco","state":"CA","zip":"94105","country":"US","phone":"123-456-7890"},"billing_address":{"address_line_1":"123 Main St","address_line_2":null,"city":"San Francisco","state":"CA","zip":"94105","country":"US","phone":"123-456-7890"}}}]},"LocationUpdatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"address_line_1":{"type":["string","null"]},"address_line_2":{"type":["string","null"]},"city":{"type":["string","null"]},"zip":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]},"phone":{"type":["string","null"]},"object":{"type":"string","const":"location"},"id":{"type":"string"},"code":{"type":["string","null"]},"name":{"type":"string"},"description":{"type":["string","null"]},"image":{"type":["object","null"],"properties":{"url":{"type":"string"},"name":{"type":["string","null"]}},"required":["url","name"]},"type":{"type":["string","null"]},"ancestor_ids":{"type":["array","null"],"items":{"type":"string"}},"shipping_address":{"type":["object","null"],"properties":{"address_line_1":{"type":["string","null"]},"address_line_2":{"type":["string","null"]},"city":{"type":["string","null"]},"zip":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]},"phone":{"type":["string","null"]}},"required":["address_line_1","address_line_2","city","zip","state","country","phone"]},"billing_address":{"type":["object","null"],"properties":{"address_line_1":{"type":["string","null"]},"address_line_2":{"type":["string","null"]},"city":{"type":["string","null"]},"zip":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]},"phone":{"type":["string","null"]}},"required":["address_line_1","address_line_2","city","zip","state","country","phone"]},"archived_at":{"type":"string"}},"required":["address_line_1","address_line_2","city","zip","state","country","phone","object","id","code","name","description","image","type","ancestor_ids","shipping_address","billing_address"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"location.updated","timestamp":1736382331594,"data":{"object":"location","id":"loc_677f177b44a6261be88bfeb4","ancestor_ids":["loc_677f177b44a6261be88bfeb5"],"name":"My Location","code":"my-location","description":"My description","image":{"url":"https://example.com/image1.jpg","name":"Image 1"},"type":"storage","address_line_1":"123 Main St","address_line_2":null,"city":"San Francisco","state":"CA","zip":"94105","country":"US","phone":"123-456-7890","shipping_address":{"address_line_1":"123 Main St","address_line_2":null,"city":"San Francisco","state":"CA","zip":"94105","country":"US","phone":"123-456-7890"},"billing_address":{"address_line_1":"123 Main St","address_line_2":null,"city":"San Francisco","state":"CA","zip":"94105","country":"US","phone":"123-456-7890"}}}]},"LocationDeletedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"location"},"id":{"type":"string"}},"required":["object","id"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"location.deleted","timestamp":1736382331594,"data":{"object":"location","id":"loc_677f177b44a6261be88bfeb4"}}]},"TaxRateCreatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"tax_rate"},"id":{"type":"string"},"name":{"type":"string"},"primary":{"type":"object","properties":{"name":{"type":"string"},"rate":{"type":"number"},"is_shipping":{"type":"boolean"}},"required":["name","rate","is_shipping"]},"secondary":{"type":"object","properties":{"name":{"type":"string"},"rate":{"type":"number"},"is_shipping":{"type":"boolean"}},"required":["name","rate","is_shipping"]},"is_default":{"type":"boolean"}},"required":["object","id","name","primary","is_default"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"tax_rate.created","timestamp":1736382331594,"data":{"object":"tax_rate","id":"tr_677f177b44a6261be88bfeb4","name":"user name","primary":{"name":"primary name","rate":5,"is_shipping":false},"secondary":{"name":"secondary name","rate":3,"is_shipping":true},"is_default":false}}]},"TaxRateUpdatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"tax_rate"},"id":{"type":"string"},"name":{"type":"string"},"primary":{"type":"object","properties":{"name":{"type":"string"},"rate":{"type":"number"},"is_shipping":{"type":"boolean"}},"required":["name","rate","is_shipping"]},"secondary":{"type":"object","properties":{"name":{"type":"string"},"rate":{"type":"number"},"is_shipping":{"type":"boolean"}},"required":["name","rate","is_shipping"]},"is_default":{"type":"boolean"}},"required":["object","id","name","primary","is_default"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"tax_rate.updated","timestamp":1736382331594,"data":{"object":"tax_rate","id":"tr_677f177b44a6261be88bfeb4","name":"user name","primary":{"name":"primary name","rate":5,"is_shipping":false},"secondary":{"name":"secondary name","rate":3,"is_shipping":true},"is_default":false}}]},"TaxRateDeletedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"tax_rate"},"id":{"type":"string"}},"required":["object","id"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"tax_rate.deleted","timestamp":1736382331594,"data":{"object":"tax_rate","id":"tr_677f177b44a6261be88bfeb4"}}]},"PurchaseOrderCreatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"purchase_order"},"id":{"type":"string"},"purchase_order_id":{"type":"string"},"status":{"type":"string","enum":["draft","submitted","approved","ordered","received","partially_received","void"]},"ordered_date":{"type":"string"},"submitted_by":{"type":"string"},"expected_date":{"type":"string"},"invoice_ref_number":{"type":"string"},"discounts":{"type":["number","null"]},"tax":{"type":["number","null"]},"shipping":{"type":["number","null"]},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"number":{"type":["string","null"]},"quantity":{"type":"number","exclusiveMinimum":0},"cost":{"type":"number","minimum":0},"sourceType":{"type":"string","enum":["inventory","catalog"]},"catalogItemId":{"type":["string","null"]},"supplierId":{"type":["string","null"]},"unitOfMeasureId":{"type":["string","null"]},"orderedUnitFactor":{"type":"number","exclusiveMinimum":0},"parentItemId":{"type":["string","null"]},"variantValues":{"type":["array","null"],"items":{"type":"object","properties":{"customFieldId":{"type":"string","minLength":1,"default":""},"customFieldName":{"type":"string","minLength":1,"default":""},"value":{"type":"string"}},"required":["customFieldId","customFieldName","value"]}},"deliveryComplete":{"type":["boolean","null"]}},"required":["id","name","quantity","cost"]}},"supplier_id":{"type":"string"},"supplier_address":{"type":"object","properties":{"address_line_1":{"type":["string","null"]},"address_line_2":{"type":["string","null"]},"city":{"type":["string","null"]},"zip":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]}},"required":["address_line_1","address_line_2","city","zip","state","country"]},"shipping_location_id":{"type":"string"},"shipping_address":{"type":"object","properties":{"address_line_1":{"type":["string","null"]},"address_line_2":{"type":["string","null"]},"city":{"type":["string","null"]},"zip":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]}},"required":["address_line_1","address_line_2","city","zip","state","country"]},"billing_location_d":{"type":"string"},"billing_address":{"type":"object","properties":{"address_line_1":{"type":["string","null"]},"address_line_2":{"type":["string","null"]},"city":{"type":["string","null"]},"zip":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]}},"required":["address_line_1","address_line_2","city","zip","state","country"]},"billing_same_as_shipping":{"type":"boolean"}},"required":["object","id","purchase_order_id","status","items","supplier_id","supplier_address","shipping_location_id","shipping_address","billing_location_d","billing_address","billing_same_as_shipping"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"purchase_order.created","timestamp":1736382331594,"data":{"object":"purchase_order","id":"po_677f177b44a6261be88bfeb4","purchase_order_id":"purchase-order-1","status":"draft","ordered_date":"2025-01-01T00:00:00.000Z","submitted_by":"user name","expected_date":"2025-01-02T00:00:00.000Z","discounts":10,"tax":5,"shipping":2000,"items":[],"supplier_id":"sup_677f177b44a6261be88bfeb4","supplier_address":{"address_line_1":"123 Main St","address_line_2":null,"city":"San Francisco","state":"CA","zip":"94105","country":"US"},"shipping_location_id":"loc_677f177b44a6261be88bfeb4","shipping_address":{"address_line_1":"123 Main St","address_line_2":null,"city":"San Francisco","state":"CA","zip":"94105","country":"US"},"billing_location_d":"loc_677f177b44a6261be88bfeb4","billing_address":{"address_line_1":"123 Main St","address_line_2":null,"city":"San Francisco","state":"CA","zip":"94105","country":"US"},"billing_same_as_shipping":true}}]},"PurchaseOrderUpdatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"purchase_order"},"id":{"type":"string"},"purchase_order_id":{"type":"string"},"status":{"type":"string","enum":["draft","submitted","approved","ordered","received","partially_received","void"]},"ordered_date":{"type":"string"},"submitted_by":{"type":"string"},"expected_date":{"type":"string"},"invoice_ref_number":{"type":"string"},"discounts":{"type":["number","null"]},"tax":{"type":["number","null"]},"shipping":{"type":["number","null"]},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"number":{"type":["string","null"]},"quantity":{"type":"number","exclusiveMinimum":0},"cost":{"type":"number","minimum":0},"sourceType":{"type":"string","enum":["inventory","catalog"]},"catalogItemId":{"type":["string","null"]},"supplierId":{"type":["string","null"]},"unitOfMeasureId":{"type":["string","null"]},"orderedUnitFactor":{"type":"number","exclusiveMinimum":0},"parentItemId":{"type":["string","null"]},"variantValues":{"type":["array","null"],"items":{"type":"object","properties":{"customFieldId":{"type":"string","minLength":1,"default":""},"customFieldName":{"type":"string","minLength":1,"default":""},"value":{"type":"string"}},"required":["customFieldId","customFieldName","value"]}},"deliveryComplete":{"type":["boolean","null"]}},"required":["id","name","quantity","cost"]}},"supplier_id":{"type":"string"},"supplier_address":{"type":"object","properties":{"address_line_1":{"type":["string","null"]},"address_line_2":{"type":["string","null"]},"city":{"type":["string","null"]},"zip":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]}},"required":["address_line_1","address_line_2","city","zip","state","country"]},"shipping_location_id":{"type":"string"},"shipping_address":{"type":"object","properties":{"address_line_1":{"type":["string","null"]},"address_line_2":{"type":["string","null"]},"city":{"type":["string","null"]},"zip":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]}},"required":["address_line_1","address_line_2","city","zip","state","country"]},"billing_location_d":{"type":"string"},"billing_address":{"type":"object","properties":{"address_line_1":{"type":["string","null"]},"address_line_2":{"type":["string","null"]},"city":{"type":["string","null"]},"zip":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]}},"required":["address_line_1","address_line_2","city","zip","state","country"]},"billing_same_as_shipping":{"type":"boolean"}},"required":["object","id","purchase_order_id","status","items","supplier_id","supplier_address","shipping_location_id","shipping_address","billing_location_d","billing_address","billing_same_as_shipping"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"purchase_order.updated","timestamp":1736382331594,"data":{"object":"purchase_order","id":"po_677f177b44a6261be88bfeb4","purchase_order_id":"purchase-order-1","status":"draft","ordered_date":"2025-01-01T00:00:00.000Z","submitted_by":"user name","expected_date":"2025-01-02T00:00:00.000Z","discounts":10,"tax":5,"shipping":2000,"items":[],"supplier_id":"sup_677f177b44a6261be88bfeb4","supplier_address":{"address_line_1":"123 Main St","address_line_2":null,"city":"San Francisco","state":"CA","zip":"94105","country":"US"},"shipping_location_id":"loc_677f177b44a6261be88bfeb4","shipping_address":{"address_line_1":"123 Main St","address_line_2":null,"city":"San Francisco","state":"CA","zip":"94105","country":"US"},"billing_location_d":"loc_677f177b44a6261be88bfeb4","billing_address":{"address_line_1":"123 Main St","address_line_2":null,"city":"San Francisco","state":"CA","zip":"94105","country":"US"},"billing_same_as_shipping":true}}]},"PurchaseOrderDeletedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"purchase_order"},"id":{"type":"string"}},"required":["object","id"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"purchase_order.deleted","timestamp":1736382331594,"data":{"object":"purchase_order","id":"po_677f177b44a6261be88bfeb4"}}]},"SaleOrderCreatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"sale_order"},"id":{"type":"string"},"sale_order_id":{"type":"string"},"customer_id":{"type":"string"},"status":{"type":"string","enum":["draft","issued","paid","partially_paid","overdue","cancelled"]},"location_id":{"type":"string"},"issued_date":{"type":"string"},"order_date":{"type":"string"},"due_date":{"type":"string"},"discounts":{"type":["number","null"]},"tax":{"type":["number","null"]},"tax_rate_id":{"type":"string"},"shipping":{"type":["number","null"]},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"quantity":{"type":"number","exclusiveMinimum":0},"price":{"type":"number","minimum":0},"unitOfMeasureId":{"type":["string","null"]},"parentItemId":{"type":["string","null"]},"variantValues":{"type":["array","null"],"items":{"type":"object","properties":{"customFieldId":{"type":"string","minLength":1,"default":""},"customFieldName":{"type":"string","minLength":1,"default":""},"value":{"type":"string"}},"required":["customFieldId","customFieldName","value"]}},"allocatedQuantity":{"type":"integer"},"backorderedQuantity":{"type":"integer"}},"required":["id","name","quantity","price"]}},"paid_amount":{"type":["number","null"]},"name":{"type":"string"},"contact_name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"invoice_note":{"type":"string"},"shipping_address":{"type":"string"},"billing_address":{"type":"string"},"payment_terms":{"type":"number"},"total_amount":{"type":"number"},"balance_amount":{"type":"number"},"payments":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"method":{"type":"string","enum":["cash","check","credit_card","bank_transfer","store_credit","other"]},"ref":{"type":"string"},"remark":{"type":"string"},"amount":{"type":"number"}},"required":["date","method","amount"]}}},"required":["object","id","sale_order_id","status","items","name","total_amount","balance_amount"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"sale_order.created","timestamp":1736382331594,"data":{"object":"sale_order","id":"so_677f177b44a6261be88bfeb4","sale_order_id":"sale-order-1","customer_id":"customer-1","status":"draft","issued_date":"2025-01-01T00:00:00.000Z","order_date":"2025-01-01T00:00:00.000Z","due_date":"2025-01-01T00:00:00.000Z","discounts":10,"tax":5,"tax_rate_id":"123456789","shipping":2000,"items":[],"paid_amount":1000,"name":"user name","contact_name":"contact name","email":"user@email.com","phone":"0000000","invoice_note":"note text","shipping_address":"San Francisco 123 Main St","billing_address":"San Francisco 123 Main St","payment_terms":5,"total_amount":1000,"balance_amount":0,"payments":[]}}]},"SaleOrderUpdatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"sale_order"},"id":{"type":"string"},"sale_order_id":{"type":"string"},"customer_id":{"type":"string"},"status":{"type":"string","enum":["draft","issued","paid","partially_paid","overdue","cancelled"]},"location_id":{"type":"string"},"issued_date":{"type":"string"},"order_date":{"type":"string"},"due_date":{"type":"string"},"discounts":{"type":["number","null"]},"tax":{"type":["number","null"]},"tax_rate_id":{"type":"string"},"shipping":{"type":["number","null"]},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"quantity":{"type":"number","exclusiveMinimum":0},"price":{"type":"number","minimum":0},"unitOfMeasureId":{"type":["string","null"]},"parentItemId":{"type":["string","null"]},"variantValues":{"type":["array","null"],"items":{"type":"object","properties":{"customFieldId":{"type":"string","minLength":1,"default":""},"customFieldName":{"type":"string","minLength":1,"default":""},"value":{"type":"string"}},"required":["customFieldId","customFieldName","value"]}},"allocatedQuantity":{"type":"integer"},"backorderedQuantity":{"type":"integer"}},"required":["id","name","quantity","price"]}},"paid_amount":{"type":["number","null"]},"name":{"type":"string"},"contact_name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"invoice_note":{"type":"string"},"shipping_address":{"type":"string"},"billing_address":{"type":"string"},"payment_terms":{"type":"number"},"total_amount":{"type":"number"},"balance_amount":{"type":"number"},"payments":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string"},"method":{"type":"string","enum":["cash","check","credit_card","bank_transfer","store_credit","other"]},"ref":{"type":"string"},"remark":{"type":"string"},"amount":{"type":"number"}},"required":["date","method","amount"]}}},"required":["object","id","sale_order_id","status","items","name","total_amount","balance_amount"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"sale_order.updated","timestamp":1736382331594,"data":{"object":"sale_order","id":"so_677f177b44a6261be88bfeb4","sale_order_id":"sale-order-1","customer_id":"customer-1","status":"draft","issued_date":"2025-01-01T00:00:00.000Z","order_date":"2025-01-01T00:00:00.000Z","due_date":"2025-01-01T00:00:00.000Z","discounts":10,"tax":5,"tax_rate_id":"123456789","shipping":2000,"items":[],"paid_amount":1000,"name":"user name","contact_name":"contact name","email":"user@email.com","phone":"0000000","invoice_note":"note text","shipping_address":"San Francisco 123 Main St","billing_address":"San Francisco 123 Main St","payment_terms":5,"total_amount":1000,"balance_amount":0,"payments":[]}}]},"SaleOrderDeletedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"sale_order"},"id":{"type":"string"}},"required":["object","id"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"sale_order.deleted","timestamp":1736382331594,"data":{"object":"sale_order","id":"so_677f177b44a6261be88bfeb4"}}]},"SaleOrderUpdatesBulkEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"bulk_operation"},"id":{"type":"string"}},"required":["object","id"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"sale_order.updated_bulk","timestamp":1736382331594,"data":{"object":"bulk_operation","id":"bulk_677f177b44a6261be88bfeb4"}}]},"ProformaOrderCreatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"proforma_order"},"id":{"type":"string"},"proforma_order_id":{"type":"string"},"customer_id":{"type":"string"},"status":{"type":"string","enum":["draft","issued","overdue","converted","void"]},"location_id":{"type":"string"},"issued_date":{"type":"string"},"due_date":{"type":"string"},"discounts":{"type":["number","null"]},"tax":{"type":["number","null"]},"tax_rate_id":{"type":"string"},"shipping":{"type":["number","null"]},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"quantity":{"type":"number","exclusiveMinimum":0},"price":{"type":"number","minimum":1},"unitOfMeasureId":{"type":["string","null"]}},"required":["id","name","quantity","price"]}},"paid_amount":{"type":["number","null"]},"name":{"type":"string"},"contact_name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"invoice_note":{"type":"string"},"shipping_address":{"type":"string"},"billing_address":{"type":"string"},"payment_terms":{"type":"number"},"total_amount":{"type":"number"}},"required":["object","id","proforma_order_id","status","items","name","total_amount"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"proforma_order.created","timestamp":1736382331594,"data":{"object":"proforma_order","id":"pro_677f177b44a6261be88bfeb4","proforma_order_id":"proforma-order-1","customer_id":"customer-1","status":"draft","issued_date":"2025-01-01T00:00:00.000Z","due_date":"2025-01-01T00:00:00.000Z","discounts":10,"tax":5,"tax_rate_id":"123456789","shipping":2000,"items":[],"name":"user name","contact_name":"contact name","email":"user@email.com","phone":"0000000","invoice_note":"note text","shipping_address":"San Francisco 123 Main St","billing_address":"San Francisco 123 Main St","payment_terms":5,"total_amount":1000}}]},"ProformaOrderUpdatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"proforma_order"},"id":{"type":"string"},"proforma_order_id":{"type":"string"},"customer_id":{"type":"string"},"status":{"type":"string","enum":["draft","issued","overdue","converted","void"]},"location_id":{"type":"string"},"issued_date":{"type":"string"},"due_date":{"type":"string"},"discounts":{"type":["number","null"]},"tax":{"type":["number","null"]},"tax_rate_id":{"type":"string"},"shipping":{"type":["number","null"]},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"quantity":{"type":"number","exclusiveMinimum":0},"price":{"type":"number","minimum":1},"unitOfMeasureId":{"type":["string","null"]}},"required":["id","name","quantity","price"]}},"paid_amount":{"type":["number","null"]},"name":{"type":"string"},"contact_name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"invoice_note":{"type":"string"},"shipping_address":{"type":"string"},"billing_address":{"type":"string"},"payment_terms":{"type":"number"},"total_amount":{"type":"number"}},"required":["object","id","proforma_order_id","status","items","name","total_amount"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"proforma_order.updated","timestamp":1736382331594,"data":{"object":"proforma_order","id":"pro_677f177b44a6261be88bfeb4","proforma_order_id":"proforma-order-1","customer_id":"customer-1","status":"draft","issued_date":"2025-01-01T00:00:00.000Z","due_date":"2025-01-01T00:00:00.000Z","discounts":10,"tax":5,"tax_rate_id":"123456789","shipping":2000,"items":[],"name":"user name","contact_name":"contact name","email":"user@email.com","phone":"0000000","invoice_note":"note text","shipping_address":"San Francisco 123 Main St","billing_address":"San Francisco 123 Main St","payment_terms":5,"total_amount":1000}}]},"ProformaOrderDeletedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"proforma_order"},"id":{"type":"string"}},"required":["object","id"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"proforma_order.deleted","timestamp":1736382331594,"data":{"object":"proforma_order","id":"pro_677f177b44a6261be88bfeb4"}}]},"ProformaOrderUpdatesBulkEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"bulk_operation"},"id":{"type":"string"}},"required":["object","id"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"proforma_order.updated_bulk","timestamp":1736382331594,"data":{"object":"bulk_operation","id":"bulk_677f177b44a6261be88bfeb4"}}]},"CreditNoteCreatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"credit_note"},"id":{"type":"string"},"credit_note_id":{"type":"string"},"status":{"type":"string","enum":["draft","issued","cancelled"]},"issued_date":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"note":{"type":"string"},"total_amount":{"type":"number"}},"required":["object","id","credit_note_id","status","name","total_amount"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"credit_note.created","timestamp":1736382331594,"data":{"object":"credit_note","id":"cn_677f177b44a6261be88bfeb4","credit_note_id":"credit-note-1","status":"draft","issued_date":"2025-01-01T00:00:00.000Z","name":"user name","email":"user@email.com","phone":"0000000","note":"note","total_amount":1000}}]},"CreditNoteUpdatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"credit_note"},"id":{"type":"string"},"credit_note_id":{"type":"string"},"status":{"type":"string","enum":["draft","issued","cancelled"]},"issued_date":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"note":{"type":"string"},"total_amount":{"type":"number"}},"required":["object","id","credit_note_id","status","name","total_amount"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"credit_note.updated","timestamp":1736382331594,"data":{"object":"credit_note","id":"cn_677f177b44a6261be88bfeb4","credit_note_id":"credit-note-1","status":"draft","issued_date":"2025-01-01T00:00:00.000Z","name":"user name","email":"user@email.com","phone":"0000000","note":"note","total_amount":1000}}]},"CreditNoteDeletedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"credit_note"},"id":{"type":"string"}},"required":["object","id"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"credit_note.deleted","timestamp":1736382331594,"data":{"object":"credit_note","id":"cn_677f177b44a6261be88bfeb4"}}]},"SupplierCreatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"supplier"},"id":{"type":"string"},"name":{"type":"string"},"code":{"type":["string","null"]},"address_line_1":{"type":["string","null"]},"address_line_2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"postal_code":{"type":["string","null"]},"country":{"type":["string","null"]},"phone_1":{"type":["string","null"]},"phone_2":{"type":["string","null"]},"contact_name":{"type":["string","null"]},"contact_email":{"type":["string","null"]},"order_email":{"type":["string","null"]},"tax_id":{"type":["string","null"]},"website":{"type":["string","null"]},"currency":{"type":["string","null"]},"notes":{"type":["string","null"]},"lead_time":{"type":["number","null"]},"payment_terms":{"type":["number","null"]},"discounts":{"type":["number","null"]},"tax":{"type":["number","null"]}},"required":["object","id","name","code","address_line_1","address_line_2","city","state","postal_code","country","phone_1","phone_2","contact_name","contact_email","order_email","tax_id","website","currency","notes","lead_time","payment_terms","discounts","tax"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"supplier.created","timestamp":1736382331594,"data":{"object":"supplier","id":"sup_677f177b44a6261be88bfeb4","name":"My Supplier","code":"my-supplier","address_line_1":"123 Main St","address_line_2":null,"city":"San Francisco","state":"CA","postal_code":"94105","country":"US","phone_1":"123-456-7890","phone_2":null,"order_email":"order@assetblaze.com","contact_email":"contact@assetblaze.com","contact_name":"John Doe","website":"https://example.com","currency":"USD","discounts":null,"notes":"My notes","lead_time":5,"payment_terms":30,"tax":0,"tax_id":"123456789"}}]},"SupplierCreatedBulkEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"bulk_operation"},"id":{"type":"string"}},"required":["object","id"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"supplier.created_bulk","timestamp":1736382331594,"data":{"object":"bulk_operation","id":"bulk_677f177b44a6261be88bfeb4"}}]},"SupplierUpdatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"supplier"},"id":{"type":"string"},"name":{"type":"string"},"code":{"type":["string","null"]},"address_line_1":{"type":["string","null"]},"address_line_2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"postal_code":{"type":["string","null"]},"country":{"type":["string","null"]},"phone_1":{"type":["string","null"]},"phone_2":{"type":["string","null"]},"contact_name":{"type":["string","null"]},"contact_email":{"type":["string","null"]},"order_email":{"type":["string","null"]},"tax_id":{"type":["string","null"]},"website":{"type":["string","null"]},"currency":{"type":["string","null"]},"notes":{"type":["string","null"]},"lead_time":{"type":["number","null"]},"payment_terms":{"type":["number","null"]},"discounts":{"type":["number","null"]},"tax":{"type":["number","null"]}},"required":["object","id","name","code","address_line_1","address_line_2","city","state","postal_code","country","phone_1","phone_2","contact_name","contact_email","order_email","tax_id","website","currency","notes","lead_time","payment_terms","discounts","tax"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"supplier.updated","timestamp":1736382331594,"data":{"object":"supplier","id":"sup_677f177b44a6261be88bfeb4","name":"My Supplier","code":"my-supplier","address_line_1":"123 Main St","address_line_2":null,"city":"San Francisco","state":"CA","postal_code":"94105","country":"US","phone_1":"123-456-7890","phone_2":null,"order_email":"order@assetblaze.com","contact_email":"contact@assetblaze.com","contact_name":"John Doe","website":"https://example.com","currency":"USD","discounts":null,"notes":"My notes","lead_time":5,"payment_terms":30,"tax":0,"tax_id":"123456789"}}]},"SupplierDeletedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"supplier"},"id":{"type":"string"}},"required":["object","id"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"supplier.deleted","timestamp":1736382331594,"data":{"object":"supplier","id":"sup_677f177b44a6261be88bfeb4"}}]},"TagCreatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"tag"},"id":{"type":"string"},"name":{"type":"string"}},"required":["object","id","name"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"tag.created","timestamp":1736382331594,"data":{"object":"tag","id":"tag_677f177b44a6261be88bfeb4","name":"My Tag"}}]},"TagUpdatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"tag"},"id":{"type":"string"},"name":{"type":"string"}},"required":["object","id","name"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"tag.updated","timestamp":1736382331594,"data":{"object":"tag","id":"tag_677f177b44a6261be88bfeb4","name":"My Tag"}}]},"TagDeletedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"tag"},"id":{"type":"string"}},"required":["object","id"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"tag.deleted","timestamp":1736382331594,"data":{"object":"tag","id":"tag_677f177b44a6261be88bfeb4"}}]},"WorkspaceCreatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"workspace"},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"tags":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","const":"tag"},"id":{"type":"string"},"name":{"type":"string"}},"required":["object","id","name"]}},"image":{"type":["object","null"],"properties":{"url":{"type":"string"},"name":{"type":["string","null"]}},"required":["url","name"]},"location":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"code":{"type":["string","null"]}},"required":["id","name","code"]}},"required":["object","id","name","description","tags","image","location"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"workspace.created","timestamp":1736382331594,"data":{"object":"workspace","id":"ws_677f177b44a6261be88bfeb4","name":"My Workspace","description":"My description","location":{"id":"loc_677f177b44a6261be88bfeb4","name":"My Location","code":"my-location"},"tags":[{"object":"tag","id":"tag_676574fbc89194908efd92ab","name":"My Tag"}],"image":{"url":"https://example.com/image1.jpg","name":"Image 1"}}}]},"WorkspaceUpdatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"workspace"},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"tags":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","const":"tag"},"id":{"type":"string"},"name":{"type":"string"}},"required":["object","id","name"]}},"image":{"type":["object","null"],"properties":{"url":{"type":"string"},"name":{"type":["string","null"]}},"required":["url","name"]},"location":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"code":{"type":["string","null"]}},"required":["id","name","code"]}},"required":["object","id","name","description","tags","image","location"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"workspace.updated","timestamp":1736382331594,"data":{"object":"workspace","id":"ws_677f177b44a6261be88bfeb4","name":"My Workspace","description":"My description","location":{"id":"loc_677f177b44a6261be88bfeb4","name":"My Location","code":"my-location"},"tags":[{"object":"tag","id":"tag_676574fbc89194908efd92ab","name":"My Tag"}],"image":{"url":"https://example.com/image1.jpg","name":"Image 1"}}}]},"WorkspaceDeletedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"workspace"},"id":{"type":"string"}},"required":["object","id"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"workspace.deleted","timestamp":1736382331594,"data":{"object":"workspace","id":"ws_677f177b44a6261be88bfeb4"}}]},"WorkspaceDeletedBulkEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"list"},"ids":{"type":"array","items":{"type":"string"}}},"required":["object","ids"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"workspace.deleted_bulk","timestamp":1736382331594,"data":{"object":"list","ids":["ws_677f177b44a6261be88bfeb4","ws_677f177b44a6261be88bfeb5"]}}]},"WorkspaceItemsUpdatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"workspace"},"id":{"type":"string"}},"required":["object","id"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"workspace.items.updated","timestamp":1736382331594,"data":{"object":"workspace","id":"ws_677f177b44a6261be88bfeb4"}}]},"WorkspaceItemUpdatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"id":{"type":"string"},"asset_id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"price":{"type":"number"},"cost":{"type":"number"},"min_level":{"type":["number","null"]},"quantity":{"type":"integer"},"location_quantities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"quantity":{"type":"integer"},"reserved_quantity":{"type":"integer"},"name":{"type":"string"},"code":{"type":["string","null"]}},"required":["id","quantity","name","code"]}},"tags":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","const":"tag"},"id":{"type":"string"},"name":{"type":"string"}},"required":["object","id","name"]}},"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":["string","null"]}},"required":["url","name"]}},"custom_field_values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["short-text","long-text","integer","decimal","date","datetime","time","boolean","select","multiselect","barcode"]},"value":{},"default_value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]},"required":{"type":"boolean"}},"required":["id","name","type","default_value","required"]}},"suppliers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"default":[]},"category":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"barcode":{"type":["object","null"],"properties":{"value":{"type":"string","minLength":1,"default":""},"type":{"type":"string","enum":["BARCODE","QRCODE"]}},"required":["value","type"]},"archived_at":{"type":"string"},"object":{"type":"string","const":"workspace_item"},"workspace_custom_field_values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["short-text","long-text","integer","decimal","date","datetime","time","boolean","select","multiselect","barcode"]},"value":{},"default_value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]},"required":{"type":"boolean"}},"required":["id","name","type","default_value","required"]}},"workspace":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]}},"required":["id","asset_id","name","description","price","cost","min_level","quantity","location_quantities","tags","images","custom_field_values","category","barcode","object","workspace_custom_field_values","workspace"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"workspace_item.updated","timestamp":1736382331594,"data":{"object":"workspace_item","id":"item_677f177b44a6261be88bfeb4","name":"My Item","description":"My description","asset_id":"0001234","barcode":{"type":"BARCODE","value":"1234567890"},"min_level":5,"cost":100,"price":200,"quantity":10,"location_quantities":[{"id":"loc_677f177b44a6261be88bfeb4","quantity":5,"name":"My Location 1","code":"my-location-1"},{"id":"loc_677f177b44a6261be88bfeb5","quantity":5,"name":"My Location 2","code":null}],"category":{"id":"cat_676574fbc89194908efd92ab","name":"My Category"},"custom_field_values":[{"id":"cf_676574fbc89194908efd92ab","value":"My value","name":"My CF short text","type":"short-text","required":false,"default_value":null},{"id":"cf_676574fbc89194908efd92ac","value":["Option 1"],"name":"My CF multi-select","type":"multiselect","required":false,"default_value":null},{"id":"cf_676574fbc89194908efd92ad","value":"Option 1","name":"My CF select","type":"select","required":false,"default_value":null}],"workspace_custom_field_values":[{"id":"cf_676574fbc89194908efd92ae","value":"My value","name":"My WS CF short text","type":"short-text","required":false,"default_value":null},{"id":"cf_676574fbc89194908efd92af","value":"Very long text","name":"My WS CF long text","type":"long-text","required":false,"default_value":null}],"workspace":{"id":"ws_677f177b44a6261be88bfeb4","name":"My Workspace"},"tags":[{"object":"tag","id":"tag_676574fbc89194908efd92ab","name":"My Tag"}],"suppliers":[{"id":"sup_676574fbc89194908efd92ab","name":"My Category"}],"images":[{"url":"https://example.com/image1.jpg","name":"Image 1"}]}}]},"WorkspaceItemUpdatedBulkEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"bulk_operation"},"id":{"type":"string"},"workspace":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]}},"required":["object","id","workspace"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"workspace_item.updated_bulk","timestamp":1736382331594,"data":{"object":"bulk_operation","id":"bulk_677f177b44a6261be88bfeb4","workspace":{"name":"My workspace","id":"ws_677f177b44a6261be88bfeb4"}}}]},"CustomerCreatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"customer"},"id":{"type":"string"},"customer_id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"contact_name":{"type":"string"},"website":{"type":"string"},"tax_number":{"type":"string"},"is_company":{"type":"boolean"},"billing_address":{"type":"object","properties":{"address_line_1":{"type":["string","null"]},"address_line_2":{"type":["string","null"]},"city":{"type":["string","null"]},"zip":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]}},"required":["address_line_1","address_line_2","city","zip","state","country"]},"shipping_address":{"type":"object","properties":{"address_line_1":{"type":["string","null"]},"address_line_2":{"type":["string","null"]},"city":{"type":["string","null"]},"zip":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]}},"required":["address_line_1","address_line_2","city","zip","state","country"]},"currency":{"type":"string","enum":["AFN","ALL","DZD","USD","EUR","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","BTN","BOB","BAM","BWP","BRL","BND","BIF","KHR","CAD","CVE","KYD","XAF","CLP","CNY","COP","KMF","CDF","CRC","HRK","CUP","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FJD","GMD","GEL","GHS","GTQ","GNF","GYD","HTG","HNL","HUF","ISK","INR","IDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LVL","LBP","LSL","LRD","LYD","CHF","LTL","LUF","MGA","MWK","MYR","MVR","MTL","MUR","MXN","MDL","MNT","MAD","MZN","MMK","NAD","NPR","ANG","NZD","NIO","NGN","NOK","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","SHP","WST","STN","SAR","RSD","SCR","SLL","SGD","SBD","SOS","ZAR","SSP","LKR","SDG","SRD","SEK","SYP","TWD","TJS","TZS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","GBP","UYU","UZS","VUV","VES","VND","YER","ZMW","ZWL","SLE","ZWG"]},"discounts":{"type":["number","null"]},"payment_terms":{"type":["number","null"]},"payment_method":{"type":"string","enum":["credit_card","bank_transfer","pay_pal"]},"tax_rate_id":{"type":"string"},"balance_amount":{"type":"number"},"total_amount":{"type":"number"},"credit":{"type":"number"},"notes":{"type":"string"}},"required":["object","id","name","billing_address","shipping_address"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"customer.created","timestamp":1736382331594,"data":{"object":"customer","id":"cus_677f177b44a6261be88bfeb4","customer_id":"CUST_10001","name":"Test Customer 01","email":"test-customer-01@assetblaze.com","phone":"+1 123 456 789","contact_name":"Nikola Tesla","website":"assetblaze.com","tax_number":"1234567899112","is_company":false,"billing_address":{"address_line_1":"30 Main str","address_line_2":"Apt. 42, Floor 88","city":"NY","zip":"10001","state":"NY","country":"US"},"shipping_address":{"address_line_1":"30 Main str","address_line_2":"Apt. 42, Floor 88","city":"NY","zip":"10001","state":"NY","country":"US"},"currency":"USD","discounts":10,"payment_terms":30,"payment_method":"credit_card","tax_rate_id":"tr_677f177b44a6261be88bfeb4","balance_amount":1200,"total_amount":4480,"credit":0,"notes":"Test notes"}}]},"CustomerUpdatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"customer"},"id":{"type":"string"},"customer_id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"contact_name":{"type":"string"},"website":{"type":"string"},"tax_number":{"type":"string"},"is_company":{"type":"boolean"},"billing_address":{"type":"object","properties":{"address_line_1":{"type":["string","null"]},"address_line_2":{"type":["string","null"]},"city":{"type":["string","null"]},"zip":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]}},"required":["address_line_1","address_line_2","city","zip","state","country"]},"shipping_address":{"type":"object","properties":{"address_line_1":{"type":["string","null"]},"address_line_2":{"type":["string","null"]},"city":{"type":["string","null"]},"zip":{"type":["string","null"]},"state":{"type":["string","null"]},"country":{"type":["string","null"]}},"required":["address_line_1","address_line_2","city","zip","state","country"]},"currency":{"type":"string","enum":["AFN","ALL","DZD","USD","EUR","AOA","XCD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","BDT","BBD","BYN","BZD","XOF","BMD","BTN","BOB","BAM","BWP","BRL","BND","BIF","KHR","CAD","CVE","KYD","XAF","CLP","CNY","COP","KMF","CDF","CRC","HRK","CUP","CZK","DKK","DJF","DOP","EGP","SVC","ERN","SZL","ETB","FJD","GMD","GEL","GHS","GTQ","GNF","GYD","HTG","HNL","HUF","ISK","INR","IDR","IRR","IQD","ILS","JMD","JPY","JOD","KZT","KES","KPW","KRW","KWD","KGS","LAK","LVL","LBP","LSL","LRD","LYD","CHF","LTL","LUF","MGA","MWK","MYR","MVR","MTL","MUR","MXN","MDL","MNT","MAD","MZN","MMK","NAD","NPR","ANG","NZD","NIO","NGN","NOK","OMR","PKR","PAB","PGK","PYG","PEN","PHP","PLN","QAR","RON","RUB","RWF","SHP","WST","STN","SAR","RSD","SCR","SLL","SGD","SBD","SOS","ZAR","SSP","LKR","SDG","SRD","SEK","SYP","TWD","TJS","TZS","THB","TOP","TTD","TND","TRY","TMT","UGX","UAH","AED","GBP","UYU","UZS","VUV","VES","VND","YER","ZMW","ZWL","SLE","ZWG"]},"discounts":{"type":["number","null"]},"payment_terms":{"type":["number","null"]},"payment_method":{"type":"string","enum":["credit_card","bank_transfer","pay_pal"]},"tax_rate_id":{"type":"string"},"balance_amount":{"type":"number"},"total_amount":{"type":"number"},"credit":{"type":"number"},"notes":{"type":"string"}},"required":["object","id","name","billing_address","shipping_address"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"customer.updated","timestamp":1736382331594,"data":{"object":"customer","id":"cus_677f177b44a6261be88bfeb4","customer_id":"CUST_10001","name":"Test Customer 01","email":"test-customer-01@assetblaze.com","phone":"+1 123 456 789","contact_name":"Nikola Tesla","website":"assetblaze.com","tax_number":"1234567899112","is_company":false,"billing_address":{"address_line_1":"30 Main str","address_line_2":"Apt. 42, Floor 88","city":"NY","zip":"10001","state":"NY","country":"US"},"shipping_address":{"address_line_1":"30 Main str","address_line_2":"Apt. 42, Floor 88","city":"NY","zip":"10001","state":"NY","country":"US"},"currency":"USD","discounts":10,"payment_terms":30,"payment_method":"credit_card","tax_rate_id":"tr_677f177b44a6261be88bfeb4","balance_amount":1200,"total_amount":4480,"credit":0,"notes":"Test notes"}}]},"CustomerDeletedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"customer"},"id":{"type":"string"}},"required":["object","id"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"customer.deleted","timestamp":1736382331594,"data":{"object":"customer","id":"cus_677f177b44a6261be88bfeb4"}}]},"SupplierCatalogItemCreatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"supplier_catalog_item"},"id":{"type":"string"},"supplier_id":{"type":"string"},"catalog_number":{"type":"string"},"name":{"type":"string"},"status":{"type":"string","enum":["active","inactive","discontinued"]},"description":{"type":["string","null"]},"cost":{"type":["number","null"]},"upc":{"type":["string","null"]},"sku":{"type":["string","null"]}},"required":["object","id","supplier_id","catalog_number","name","status","description","cost","upc","sku"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"supplier_catalog_item.created","timestamp":1736382331594,"data":{"object":"supplier_catalog_item","id":"sci_677f177b44a6261be88bfeb4","supplier_id":"sup_677f177b44a6261be88bfeb4","catalog_number":"CAT-123445","name":"Steel pipe 10","status":"active","description":"High quality steel","cost":100400000000,"upc":"0123456789012","sku":"ABCD 0123-4567"}}]},"SupplierCatalogItemCreatedBulkEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"bulk_operation"},"id":{"type":"string"}},"required":["object","id"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"supplier_catalog_item.created_bulk","timestamp":1736382331594,"data":{"object":"bulk_operation","id":"bulk_677f177b44a6261be88bfeb4"}}]},"SupplierCatalogItemUpdatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"supplier_catalog_item"},"id":{"type":"string"},"supplier_id":{"type":"string"},"catalog_number":{"type":"string"},"name":{"type":"string"},"status":{"type":"string","enum":["active","inactive","discontinued"]},"description":{"type":["string","null"]},"cost":{"type":["number","null"]},"upc":{"type":["string","null"]},"sku":{"type":["string","null"]}},"required":["object","id","supplier_id","catalog_number","name","status","description","cost","upc","sku"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"supplier_catalog_item.updated","timestamp":1736382331594,"data":{"object":"supplier_catalog_item","id":"sci_677f177b44a6261be88bfeb4","supplier_id":"sup_677f177b44a6261be88bfeb4","catalog_number":"CAT-123445","name":"Steel pipe 10","status":"active","description":"High quality steel","cost":100400000000,"upc":"0123456789012","sku":"ABCD 0123-4567"}}]},"SupplierCatalogItemDeletedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"supplier_catalog_item"},"id":{"type":"string"},"supplier_id":{"type":"string"}},"required":["object","id","supplier_id"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"supplier_catalog_item.deleted","timestamp":1736382331594,"data":{"object":"supplier_catalog_item","id":"sci_677f177b44a6261be88bfeb4","supplier_id":"sup_677f177b44a6261be88bfeb4"}}]},"SupplierCatalogItemDiscontinuedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"supplier_catalog_item"},"id":{"type":"string"},"supplier_id":{"type":"string"},"catalog_number":{"type":"string"},"name":{"type":"string"},"status":{"type":"string","enum":["active","inactive","discontinued"]},"description":{"type":["string","null"]},"cost":{"type":["number","null"]},"upc":{"type":["string","null"]},"sku":{"type":["string","null"]}},"required":["object","id","supplier_id","catalog_number","name","status","description","cost","upc","sku"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"supplier_catalog_item.discontinued","timestamp":1736382331594,"data":{"object":"supplier_catalog_item","id":"sci_677f177b44a6261be88bfeb4","supplier_id":"sup_677f177b44a6261be88bfeb4","catalog_number":"CAT-123445","name":"Steel pipe 10","status":"active","description":"High quality steel","cost":100400000000,"upc":"0123456789012","sku":"ABCD 0123-4567"}}]},"SupplierCatalogItemCatalogNumberUpdatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"supplier_catalog_item"},"id":{"type":"string"},"supplier_id":{"type":"string"},"catalog_number":{"type":"string"},"name":{"type":"string"},"status":{"type":"string","enum":["active","inactive","discontinued"]},"description":{"type":["string","null"]},"cost":{"type":["number","null"]},"upc":{"type":["string","null"]},"sku":{"type":["string","null"]},"previous_catalog_number":{"type":"string"}},"required":["object","id","supplier_id","catalog_number","name","status","description","cost","upc","sku","previous_catalog_number"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"supplier_catalog_item.catalog_number_updated","timestamp":1736382331594,"data":{"object":"supplier_catalog_item","id":"sci_677f177b44a6261be88bfeb4","supplier_id":"sup_677f177b44a6261be88bfeb4","catalog_number":"CAT-123445","previous_catalog_number":"CAT-123446","name":"Steel pipe 10","status":"active","description":"High quality steel","cost":100400000000,"upc":"0123456789012","sku":"ABCD 0123-4567"}}]},"WorkspaceTypeCreatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"workspace_type"},"id":{"type":"string"},"name":{"type":"string"},"custom_field_ids":{"type":"array","items":{"type":"string"}}},"required":["object","id","name","custom_field_ids"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"workspace_type.created","timestamp":1736382331594,"data":{"object":"workspace_type","id":"wst_676574fbc89194908efd92af","name":"Auction","custom_field_ids":["cf_676574fbc89194908efd92ab","cf_676574fbc89194908efd92ac"]}}]},"WorkspaceTypeUpdatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"workspace_type"},"id":{"type":"string"},"name":{"type":"string"},"custom_field_ids":{"type":"array","items":{"type":"string"}}},"required":["object","id","name","custom_field_ids"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"workspace_type.updated","timestamp":1736382331594,"data":{"object":"workspace_type","id":"wst_676574fbc89194908efd92af","name":"Auction","custom_field_ids":["cf_676574fbc89194908efd92ab","cf_676574fbc89194908efd92ac"]}}]},"WorkspaceTypeDeletedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"object":{"type":"string","const":"workspace_type"},"id":{"type":"string"}},"required":["object","id"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"workspace_type.deleted","timestamp":1736382331594,"data":{"object":"workspace_type","id":"wst_677f177b44a6261be88bfeb4"}}]},"WorkspaceItemCreatedEvent":{"type":"object","properties":{"object":{"type":"string","const":"event"},"timestamp":{"type":"number"},"type":{"type":"string","enum":["alert.created","alert.updated","alert.deleted","alert.triggered","api_key.created","api_key.deleted","category.created","category.updated","category.deleted","custom_field.created","custom_field.updated","custom_field.deleted","item.created","item.updated","item.deleted","item.created_bulk","item.updated_bulk","item.deleted_bulk","item.variant_created","item.variants_generated","item.variants_enabled","item.variants_disabled","location.created","location.updated","location.deleted","tax_rate.created","tax_rate.updated","tax_rate.deleted","customer.created","customer.updated","customer.deleted","purchase_order.created","purchase_order.updated","purchase_order.deleted","sale_order.created","sale_order.updated","sale_order.deleted","sale_order.updated_bulk","proforma_order.created","proforma_order.updated","proforma_order.deleted","proforma_order.updated_bulk","quote.created","quote.updated","quote.deleted","quote.updated_bulk","credit_note.created","credit_note.updated","credit_note.deleted","supplier.created","supplier.created_bulk","supplier.updated","supplier.deleted","supplier_catalog_item.created","supplier_catalog_item.created_bulk","supplier_catalog_item.updated","supplier_catalog_item.deleted","supplier_catalog_item.discontinued","supplier_catalog_item.catalog_number_updated","tag.created","tag.updated","tag.deleted","workspace.created","workspace.updated","workspace.deleted","workspace.deleted_bulk","workspace_type.created","workspace_type.updated","workspace_type.deleted","workspace_item.created","workspace_item.updated","workspace_item.updated_bulk","workspace_item.created_bulk","workspace.items.updated"]},"data":{"type":"object","properties":{"id":{"type":"string"},"asset_id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"price":{"type":"number"},"cost":{"type":"number"},"min_level":{"type":["number","null"]},"quantity":{"type":"integer"},"location_quantities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"quantity":{"type":"integer"},"reserved_quantity":{"type":"integer"},"name":{"type":"string"},"code":{"type":["string","null"]}},"required":["id","quantity","name","code"]}},"tags":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","const":"tag"},"id":{"type":"string"},"name":{"type":"string"}},"required":["object","id","name"]}},"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":["string","null"]}},"required":["url","name"]}},"custom_field_values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["short-text","long-text","integer","decimal","date","datetime","time","boolean","select","multiselect","barcode"]},"value":{},"default_value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]},"required":{"type":"boolean"}},"required":["id","name","type","default_value","required"]}},"suppliers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"default":[]},"category":{"type":["object","null"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"barcode":{"type":["object","null"],"properties":{"value":{"type":"string","minLength":1,"default":""},"type":{"type":"string","enum":["BARCODE","QRCODE"]}},"required":["value","type"]},"archived_at":{"type":"string"},"object":{"type":"string","const":"workspace_item"},"workspace_custom_field_values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["short-text","long-text","integer","decimal","date","datetime","time","boolean","select","multiselect","barcode"]},"value":{},"default_value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"type":"null"},{"type":"null"}]},"required":{"type":"boolean"}},"required":["id","name","type","default_value","required"]}},"workspace":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]}},"required":["id","asset_id","name","description","price","cost","min_level","quantity","location_quantities","tags","images","custom_field_values","category","barcode","object","workspace_custom_field_values","workspace"]}},"required":["object","timestamp","type","data"],"examples":[{"object":"event","type":"workspace_item.created","timestamp":1736382331594,"data":{"object":"workspace_item","id":"item_677f177b44a6261be88bfeb4","name":"My Item","description":"My description","asset_id":"0001234","barcode":{"type":"BARCODE","value":"1234567890"},"min_level":5,"cost":100,"price":200,"quantity":10,"location_quantities":[{"id":"loc_677f177b44a6261be88bfeb4","quantity":5,"name":"My Location 1","code":"my-location-1"},{"id":"loc_677f177b44a6261be88bfeb5","quantity":5,"name":"My Location 2","code":null}],"category":{"id":"cat_676574fbc89194908efd92ab","name":"My Category"},"custom_field_values":[{"id":"cf_676574fbc89194908efd92ab","value":"My value","name":"My CF short text","type":"short-text","required":false,"default_value":null},{"id":"cf_676574fbc89194908efd92ac","value":["Option 1"],"name":"My CF multi-select","type":"multiselect","required":false,"default_value":null},{"id":"cf_676574fbc89194908efd92ad","value":"Option 1","name":"My CF select","type":"select","required":false,"default_value":null}],"workspace_custom_field_values":[{"id":"cf_676574fbc89194908efd92ae","value":"My value","name":"My WS CF short text","type":"short-text","required":false,"default_value":null},{"id":"cf_676574fbc89194908efd92af","value":"Very long text","name":"My WS CF long text","type":"long-text","required":false,"default_value":null}],"workspace":{"id":"ws_677f177b44a6261be88bfeb4","name":"My Workspace"},"tags":[{"object":"tag","id":"tag_676574fbc89194908efd92ab","name":"My Tag"}],"suppliers":[{"id":"sup_676574fbc89194908efd92ab","name":"My Category"}],"images":[{"url":"https://example.com/image1.jpg","name":"Image 1"}]}}]}}}}