Per-item low-stock threshold. Null uses the workspace default.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Antsfield Docs","colors":{"primary":"#000000","light":"#ffffff","dark":"#000000"},"logo":{"light":"https://mintcdn.com/adiamar/89QSU7keLFLF5xC2/logos/full-logo-light.png?fit=max\u0026auto=format\u0026n=89QSU7keLFLF5xC2\u0026q=85\u0026s=88a1e16eb4ce4435b4cd6f95c20f0fbb","dark":"https://mintcdn.com/adiamar/89QSU7keLFLF5xC2/logos/full-logo-dark.png?fit=max\u0026auto=format\u0026n=89QSU7keLFLF5xC2\u0026q=85\u0026s=e02ae4c0e3ff5b6c9f0b2c75ff4c32f8","href":"https://antsfield.com"},"favicon":"https://mintcdn.com/adiamar/mHedONlAtV_uZvpx/logos/favicon-512x512.png?fit=max\u0026auto=format\u0026n=mHedONlAtV_uZvpx\u0026q=85\u0026s=509367faf60eac2db13fc86b139985aa","api":{"openapi":"https://api.antsfield.com"},"background":{"color":{"light":"#ffffff","dark":"#000000"}},"navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.antsfield.com"}},"footer":{"socials":{"twitter":"https://x.com/AntsfieldApp","website":"https://www.antsfield.com"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"adiamar","hasAudioNarration":false,"actualSubdomain":"adiamar","customDomains":["docs.antsfield.com"],"gitSource":{"type":"github","owner":"skarf4u","repo":"antsfield","deployBranch":"master","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6acbfb2884a9a6d4b94d8546","collectionId":"62d649d7-9b44-4523-a163-38cf7e9f6f65","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6acbfb2884a9a6d4b94d8546"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6acbfb2884a9a6d4b94d8546","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"API Reference","count":35},{"language":"default","tag":"Help Center","count":20},{"language":"default","tag":"Documentation","count":19},{"language":"default","tag":"Using Antsfield","count":14},{"language":"default","tag":"Items","count":10},{"language":"default","tag":"Locations","count":7},{"language":"default","tag":"Inventory","count":7},{"language":"default","tag":"SAML SSO","count":6},{"language":"default","tag":"Transfers","count":5},{"language":"default","tag":"Workspaces","count":4}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoint/retrieve-an-item","slug":"/api-reference/endpoint/retrieve-an-item","pageMetadata":{"openapi":"get /items/info","og:title":"Get item info with the Antsfield API - API Reference","title":"Retrieve an item","description":"Retrieve the info for an item.","href":"/api-reference/endpoint/retrieve-an-item"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieve the info for an item.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_components.p,{children:[`You can retrieve an item by providing the `,_jsx(_components.code,{children:`itemId`}),` as a query parameter:`]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"get /items/info","og:title":"Get item info with the Antsfield API - API Reference","title":"Retrieve an item","description":"Retrieve the info for an item.","href":"/api-reference/endpoint/retrieve-an-item"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getItemInfo","x-speakeasy-name-override":"get","summary":"Retrieve an item","description":"Retrieve the info for an item.","tags":["Items"],"security":["b0719312-8f66-4ef7-82c7-3c011e481b5b"],"parameters":["64a5bcea-09c5-4302-a9fc-7799e9717da2","f558b67c-65a7-4115-a73d-9dd7b4db0416","77c14882-47bc-4b51-a409-bb607712473a"],"responses":{"200":"993fcda5-f966-4994-9ca7-e0a2dcf9e09b","400":"2def5be7-e159-4d07-ba7c-65459e7dac30","401":"ad876753-a519-4217-a7a2-e0d3d09be538","403":"b9211097-f8d2-44e1-9cf0-4cf94e2b638a","404":"f4b355c8-de62-472f-a58f-b3e79c4de530","409":"b9c24c60-fbfb-4b3e-ac64-0484a9b0d488","410":"1e6bf4d1-aa4a-40ce-b8ff-b2f6045bcf2b","422":"e864c1e2-1004-4185-86c6-a3605366e458","429":"71b207f9-c19d-4564-9bd8-2a08eb253a23","500":"f6ccbd9c-2792-4210-9638-c731bcdb74f2"},"method":"get","type":"path","servers":["147c4611-7afc-4c3d-80f3-b0312dd47290"],"path":"/items/info","baseUrlOptions":["https://api.antsfield.com"],"title":"Retrieve an item","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"64a5bcea-09c5-4302-a9fc-7799e9717da2":{"in":"query","name":"workspaceId","description":"The ID of the workspace.","schema":{"type":"string","description":"The ID of the workspace.","example":"ws_cluuwcv0r...","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true},"f558b67c-65a7-4115-a73d-9dd7b4db0416":{"in":"query","name":"projectSlug","description":"The slug of the project. This field is deprecated – use `workspaceId` instead.","schema":{"type":"string","description":"The slug of the project. This field is deprecated – use `workspaceId` instead.","deprecated":true,"uniqueKey":"","typeLabel":"string"}},"77c14882-47bc-4b51-a409-bb607712473a":{"in":"query","name":"itemId","description":"The unique ID of the item.","schema":{"type":"string","description":"The unique ID of the item.","example":"clux0rgak00011...","uniqueKey":"","typeLabel":"string"}}},"responses":{"993fcda5-f966-4994-9ca7-e0a2dcf9e09b":{"description":"The retrieved item","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the short item.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"sku":{"type":"string","description":"The SKU of the item.","isRequired":true,"uniqueKey":"sku","typeLabel":"string"},"description":{"type":"string","description":"The item description.","isRequired":true,"uniqueKey":"description","typeLabel":"string"},"supplierId":{"oneOf":[{"type":"string","description":"The supplier ID of the item.","isRequired":true,"uniqueKey":"supplierId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The supplier ID of the item.","isRequired":true,"uniqueKey":"supplierId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"supplierId","typeLabel":"string | null"},"cost":{"oneOf":[{"type":"number","description":"The item cost. Null when the member cannot view unit cost.","isRequired":true,"uniqueKey":"cost.oneOf.0","typeLabel":"number"},{"type":"null","description":"The item cost. Null when the member cannot view unit cost.","isRequired":true,"uniqueKey":"cost.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cost","typeLabel":"number | null"},"sellPrice":{"type":"number","description":"The default sell price of the item.","isRequired":true,"uniqueKey":"sellPrice","typeLabel":"number"},"trackStock":{"type":"boolean","description":"Whether this item tracks on-hand stock. When false, the item is catalog-only.","isRequired":true,"uniqueKey":"trackStock","typeLabel":"boolean"},"tagId":{"oneOf":[{"type":"string","description":"[DEPRECATED] (use `tags` instead): The unique ID of the tag assigned to the short item.","deprecated":true,"isRequired":true,"uniqueKey":"tagId.oneOf.0","typeLabel":"string"},{"type":"null","description":"[DEPRECATED] (use `tags` instead): The unique ID of the tag assigned to the short item.","deprecated":true,"isRequired":true,"uniqueKey":"tagId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"tagId","typeLabel":"string | null"},"tags":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the tag.","isRequired":true,"uniqueKey":"tags.oneOf.0.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"The name of the tag.","isRequired":true,"uniqueKey":"tags.oneOf.0.items.[INDEX].name","typeLabel":"string"},"color":{"type":"string","enum":["red","yellow","green","blue","purple","orange","brown","gray","pink"],"description":"The color of the tag.","isRequired":true,"uniqueKey":"tags.oneOf.0.items.[INDEX].color","typeLabel":"enum\u003cstring>"}},"required":["id","name","color"],"title":"ItemTag","uniqueKey":"tags.oneOf.0.items.[INDEX]","typeLabel":"ItemTag · object"},"description":"The tags assigned to the short item.","isRequired":true,"uniqueKey":"tags.oneOf.0","typeLabel":"ItemTag · object[]"},{"type":"null","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the tag."},"name":{"type":"string","description":"The name of the tag."},"color":{"type":"string","enum":["red","yellow","green","blue","purple","orange","brown","gray","pink"],"description":"The color of the tag."}},"required":["id","name","color"],"title":"ItemTag"},"description":"The tags assigned to the short item.","isRequired":true,"uniqueKey":"tags.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"tags","typeLabel":"ItemTag · object[] | null"},"userId":{"type":"string","description":"The user ID of the creator of the short item.","isRequired":true,"uniqueKey":"userId","typeLabel":"string"},"workspaceId":{"type":"string","description":"The workspace ID of the short item.","isRequired":true,"uniqueKey":"workspaceId","typeLabel":"string"},"createdAt":{"type":"string","description":"The date and time when the short item was created.","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"The date and time when the short item was last updated.","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string"},"projectId":{"type":"string","description":"[DEPRECATED] (use workspaceId instead): The project ID of the short item.","deprecated":true,"isRequired":true,"uniqueKey":"projectId","typeLabel":"string"},"supplier":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"supplier.oneOf.0.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"supplier.oneOf.0.name","typeLabel":"string"},"email":{"oneOf":[{"type":"string","uniqueKey":"supplier.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"supplier.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"supplier.oneOf.0.email","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","uniqueKey":"supplier.oneOf.0.phone.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"supplier.oneOf.0.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"supplier.oneOf.0.phone","typeLabel":"string | null"}},"required":["id","name"],"description":"The linked supplier record.","uniqueKey":"supplier.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"oneOf":[{"type":"string"},{"type":"null"}]},"phone":{"oneOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name"],"description":"The linked supplier record.","uniqueKey":"supplier.oneOf.1","typeLabel":"null"}],"uniqueKey":"supplier","typeLabel":"object | null"},"lowStockThreshold":{"oneOf":[{"type":"integer","description":"Per-item low-stock threshold. Null uses the workspace default.","uniqueKey":"lowStockThreshold.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Per-item low-stock threshold. Null uses the workspace default.","uniqueKey":"lowStockThreshold.oneOf.1","typeLabel":"null"}],"uniqueKey":"lowStockThreshold","typeLabel":"integer | null"}},"required":["id","sku","description","supplierId","cost","sellPrice","trackStock","tagId","tags","userId","workspaceId","createdAt","updatedAt","projectId"],"title":"Item","uniqueKey":"","typeLabel":"Item · object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","sku":"\u003cstring>","description":"\u003cstring>","supplierId":"\u003cstring>","cost":123,"sellPrice":123,"trackStock":true,"tagId":"\u003cstring>","tags":[{"id":"\u003cstring>","name":"\u003cstring>","color":"red"}],"userId":"\u003cstring>","workspaceId":"\u003cstring>","createdAt":"\u003cstring>","updatedAt":"\u003cstring>","projectId":"\u003cstring>","supplier":{"id":"\u003cstring>","name":"\u003cstring>","email":"\u003cstring>","phone":"\u003cstring>"},"lowStockThreshold":123}}},"exampleType":"generated"}},"exampleType":"generated"},"2def5be7-e159-4d07-ba7c-65459e7dac30":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).","content":{"application/json":{"schema":{"x-speakeasy-name-override":"BadRequest","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request"],"description":"A short code indicating the error code returned.","example":"bad_request","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://docs.antsfield.com/api-reference/errors#bad-request","uniqueKey":"error.doc_url","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"bad_request","message":"The requested resource was not found.","doc_url":"https://docs.antsfield.com/api-reference/errors#bad-request"}}}},"exampleType":"generated"}},"exampleType":"generated"},"ad876753-a519-4217-a7a2-e0d3d09be538":{"description":"Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response.","content":{"application/json":{"schema":{"x-speakeasy-name-override":"Unauthorized","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["unauthorized"],"description":"A short code indicating the error code returned.","example":"unauthorized","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://docs.antsfield.com/api-reference/errors#unauthorized","uniqueKey":"error.doc_url","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"unauthorized","message":"The requested resource was not found.","doc_url":"https://docs.antsfield.com/api-reference/errors#unauthorized"}}}},"exampleType":"generated"}},"exampleType":"generated"},"b9211097-f8d2-44e1-9cf0-4cf94e2b638a":{"description":"The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.","content":{"application/json":{"schema":{"x-speakeasy-name-override":"Forbidden","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["forbidden"],"description":"A short code indicating the error code returned.","example":"forbidden","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://docs.antsfield.com/api-reference/errors#forbidden","uniqueKey":"error.doc_url","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"forbidden","message":"The requested resource was not found.","doc_url":"https://docs.antsfield.com/api-reference/errors#forbidden"}}}},"exampleType":"generated"}},"exampleType":"generated"},"f4b355c8-de62-472f-a58f-b3e79c4de530":{"description":"The server cannot find the requested resource.","content":{"application/json":{"schema":{"x-speakeasy-name-override":"NotFound","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["not_found"],"description":"A short code indicating the error code returned.","example":"not_found","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://docs.antsfield.com/api-reference/errors#not-found","uniqueKey":"error.doc_url","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"not_found","message":"The requested resource was not found.","doc_url":"https://docs.antsfield.com/api-reference/errors#not-found"}}}},"exampleType":"generated"}},"exampleType":"generated"},"b9c24c60-fbfb-4b3e-ac64-0484a9b0d488":{"description":"This response is sent when a request conflicts with the current state of the server.","content":{"application/json":{"schema":{"x-speakeasy-name-override":"Conflict","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["conflict"],"description":"A short code indicating the error code returned.","example":"conflict","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://docs.antsfield.com/api-reference/errors#conflict","uniqueKey":"error.doc_url","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"conflict","message":"The requested resource was not found.","doc_url":"https://docs.antsfield.com/api-reference/errors#conflict"}}}},"exampleType":"generated"}},"exampleType":"generated"},"1e6bf4d1-aa4a-40ce-b8ff-b2f6045bcf2b":{"description":"This response is sent when the requested content has been permanently deleted from server, with no forwarding address.","content":{"application/json":{"schema":{"x-speakeasy-name-override":"InviteExpired","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["invite_expired"],"description":"A short code indicating the error code returned.","example":"invite_expired","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://docs.antsfield.com/api-reference/errors#invite-expired","uniqueKey":"error.doc_url","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invite_expired","message":"The requested resource was not found.","doc_url":"https://docs.antsfield.com/api-reference/errors#invite-expired"}}}},"exampleType":"generated"}},"exampleType":"generated"},"e864c1e2-1004-4185-86c6-a3605366e458":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"schema":{"x-speakeasy-name-override":"UnprocessableEntity","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["unprocessable_entity"],"description":"A short code indicating the error code returned.","example":"unprocessable_entity","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://docs.antsfield.com/api-reference/errors#unprocessable-entity","uniqueKey":"error.doc_url","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"unprocessable_entity","message":"The requested resource was not found.","doc_url":"https://docs.antsfield.com/api-reference/errors#unprocessable-entity"}}}},"exampleType":"generated"}},"exampleType":"generated"},"71b207f9-c19d-4564-9bd8-2a08eb253a23":{"description":"The user has sent too many requests in a given amount of time (\"rate limiting\")","content":{"application/json":{"schema":{"x-speakeasy-name-override":"RateLimitExceeded","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"],"description":"A short code indicating the error code returned.","example":"rate_limit_exceeded","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://docs.antsfield.com/api-reference/errors#rate-limit_exceeded","uniqueKey":"error.doc_url","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"rate_limit_exceeded","message":"The requested resource was not found.","doc_url":"https://docs.antsfield.com/api-reference/errors#rate-limit_exceeded"}}}},"exampleType":"generated"}},"exampleType":"generated"},"f6ccbd9c-2792-4210-9638-c731bcdb74f2":{"description":"The server has encountered a situation it does not know how to handle.","content":{"application/json":{"schema":{"x-speakeasy-name-override":"InternalServerError","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["internal_server_error"],"description":"A short code indicating the error code returned.","example":"internal_server_error","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://docs.antsfield.com/api-reference/errors#internal-server_error","uniqueKey":"error.doc_url","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"internal_server_error","message":"The requested resource was not found.","doc_url":"https://docs.antsfield.com/api-reference/errors#internal-server_error"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"b0719312-8f66-4ef7-82c7-3c011e481b5b":{"token":{"type":"http","description":"Bearer API key from Settings → API Keys. Use restricted keys (prefix `retrac_`) with the minimum scopes required.","scheme":"bearer","bearerFormat":"API key","scopes":[],"schemeName":"token"}}},"servers":{"147c4611-7afc-4c3d-80f3-b0312dd47290":{"url":"https://api.antsfield.com","description":"Production API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"Bearer API key from Settings → API Keys. Use restricted keys (prefix `retrac_`) with the minimum scopes required.","scheme":"bearer","bearerFormat":"API key","scopes":[],"schemeName":"token"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer API key from Settings → API Keys. Use restricted keys (prefix `retrac_`) with the minimum scopes required.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"token","name":"Authorization"}],"title":"token"}]},"originalFileLocation":"https://api.antsfield.com"},"subdomain":"adiamar","siteName":"Antsfield Docs","title":"Get item info with the Antsfield API - API Reference","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T01:50:56.320Z","originalFileLocation":"api-reference/endpoint/retrieve-an-item.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieve the info for an item.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Antsfield Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/adiamar/ZOwRp_NrhVBnGhrY/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/adiamar/ZOwRp_NrhVBnGhrY/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/adiamar/ZOwRp_NrhVBnGhrY/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/adiamar/ZOwRp_NrhVBnGhrY/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/adiamar/ZOwRp_NrhVBnGhrY/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/adiamar/ZOwRp_NrhVBnGhrY/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/adiamar/ZOwRp_NrhVBnGhrY/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/adiamar/ZOwRp_NrhVBnGhrY/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/adiamar/ZOwRp_NrhVBnGhrY/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get item info with the Antsfield API - API Reference\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve the info for an item.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Antsfield Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.antsfield.com/api-reference/endpoint/retrieve-an-item\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://adiamar.mintlify.app/_mintlify/api/og/v2?division=Items\u0026amp;title=Retrieve+an+item\u0026amp;description=Retrieve+the+info+for+an+item.\u0026amp;theme=c243e068992cce0ce99326b4\u0026amp;signature=59fa3eda4f491522bf75483c9a8fc60f62903bed913f00e73a4b9e0ed13ef907\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get item info with the Antsfield API - API Reference\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve the info for an item.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://adiamar.mintlify.app/_mintlify/api/og/v2?division=Items\u0026amp;title=Retrieve+an+item\u0026amp;description=Retrieve+the+info+for+an+item.\u0026amp;theme=c243e068992cce0ce99326b4\u0026amp;signature=59fa3eda4f491522bf75483c9a8fc60f62903bed913f00e73a4b9e0ed13ef907\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/adiamar/ZOwRp_NrhVBnGhrY/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Antsfield Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.antsfield.com/api-reference/endpoint/retrieve-an-item\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/retrieve-an-item.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.antsfield.com/#organization\",\"name\":\"Antsfield Docs\",\"url\":\"https://docs.antsfield.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/adiamar/89QSU7keLFLF5xC2/logos/full-logo-light.png?fit=max\u0026auto=format\u0026n=89QSU7keLFLF5xC2\u0026q=85\u0026s=88a1e16eb4ce4435b4cd6f95c20f0fbb\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.antsfield.com#website\",\"name\":\"Antsfield Docs\",\"url\":\"https://docs.antsfield.com\",\"publisher\":{\"@id\":\"https://docs.antsfield.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.antsfield.com/api-reference/endpoint/retrieve-an-item#webpage\",\"url\":\"https://docs.antsfield.com/api-reference/endpoint/retrieve-an-item\",\"name\":\"Retrieve an item\",\"description\":\"Retrieve the info for an item.\",\"dateModified\":\"2026-01-07T01:50:56.320Z\",\"isPartOf\":{\"@id\":\"https://docs.antsfield.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.antsfield.com/api-reference/endpoint/retrieve-an-item#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.antsfield.com/api-reference/endpoint/retrieve-an-item#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Items\",\"item\":\"https://docs.antsfield.com/api-reference/endpoint/create-a-new-item\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Retrieve an item\",\"item\":\"https://docs.antsfield.com/api-reference/endpoint/retrieve-an-item\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.antsfield.com/api-reference/endpoint/retrieve-an-item#apireference\",\"headline\":\"Retrieve an item\",\"name\":\"Retrieve an item\",\"description\":\"Retrieve the info for an item.\",\"url\":\"https://docs.antsfield.com/api-reference/endpoint/retrieve-an-item\",\"mainEntityOfPage\":{\"@id\":\"https://docs.antsfield.com/api-reference/endpoint/retrieve-an-item#webpage\"},\"dateModified\":\"2026-01-07T01:50:56.320Z\",\"publisher\":{\"@id\":\"https://docs.antsfield.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.antsfield.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Antsfield Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Antsfield Docs","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"Help Center","pages":[{"title":"Help Center","href":"/help"}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"Introduction","icon":"webhook","href":"/api-reference/introduction"},{"title":"Authentication","icon":"key","href":"/api-reference/authentication"},{"title":"Security","icon":"shield","href":"/api-reference/security"},{"title":"Rate limits","icon":"clock","href":"/api-reference/rate-limits"},{"title":"Errors","icon":"bug","href":"/api-reference/errors"}]},{"group":"Items","pages":[{"openapi":"post /items","title":"Create a new item","description":"Create a new item for the authenticated workspace.","href":"/api-reference/endpoint/create-a-new-item"},{"openapi":"get /items/info","title":"Retrieve an item","href":"/api-reference/endpoint/retrieve-an-item"},{"openapi":"patch /items/{itemId}","title":"Update an item","description":"Update an item for the authenticated workspace. If there's no change, returns it as it is.","href":"/api-reference/endpoint/update-an-item"},{"openapi":"delete /items/{itemId}","title":"Delete an item","href":"/api-reference/endpoint/delete-an-item"},{"openapi":"get /items","title":"Retrieve a list of items","href":"/api-reference/endpoint/retrieve-a-list-of-items"},{"openapi":"get /items/count","title":"Retrieve the number of items","href":"/api-reference/endpoint/retrieve-number-of-items"},{"openapi":"post /items/bulk","title":"Bulk create items","href":"/api-reference/endpoint/bulk-create-items"}]},{"group":"Workspaces","pages":[{"openapi":"post /workspaces","title":"Create a workspace","href":"/api-reference/endpoint/create-a-new-workspace"},{"openapi":"get /workspaces/{idOrSlug}","title":"Retrieve a workspace","href":"/api-reference/endpoint/retrieve-a-workspace"},{"openapi":"get /workspaces","title":"Retrieve a list of workspaces","href":"/api-reference/endpoint/retrieve-a-list-of-workspaces"}]},{"group":"Tags","pages":[{"openapi":"post /tags","title":"Create a new tag","href":"/api-reference/endpoint/create-a-new-tag"},{"openapi":"get /tags","title":"Retrieve a list of tags","href":"/api-reference/endpoint/retrieve-a-list-of-tags"}]},{"group":"Locations","pages":[{"openapi":"post /locations","title":"Create a location","href":"/api-reference/endpoint/create-a-location"},{"openapi":"get /locations/{id}","title":"Retrieve a location","href":"/api-reference/endpoint/retrieve-a-location"},{"openapi":"patch /locations/{id}","title":"Update a location","href":"/api-reference/endpoint/update-a-location"},{"openapi":"delete /locations/{id}","title":"Delete a location","href":"/api-reference/endpoint/delete-a-location"},{"openapi":"get /locations","title":"Retrieve a list of locations","href":"/api-reference/endpoint/retrieve-a-list-of-locations"},{"openapi":"get /locations/count","title":"Retrieve the number of locations","href":"/api-reference/endpoint/retrieve-number-of-locations"}]},{"group":"Inventory","pages":[{"openapi":"get /inventory/balances","title":"List inventory balances","href":"/api-reference/endpoint/list-inventory-balances"},{"openapi":"put /inventory/balances","title":"Set on-hand stock","href":"/api-reference/endpoint/set-on-hand-stock"},{"openapi":"get /inventory/movements","title":"List inventory movements","href":"/api-reference/endpoint/list-inventory-movements"}]},{"group":"Transfers","pages":[{"openapi":"post /inventory/transfers","title":"Create a transfer","href":"/api-reference/endpoint/create-a-transfer"},{"openapi":"get /inventory/transfers/{id}","title":"Retrieve a transfer","href":"/api-reference/endpoint/retrieve-a-transfer"},{"openapi":"get /inventory/transfers","title":"List transfers","href":"/api-reference/endpoint/list-transfers"},{"openapi":"post /inventory/transfers/{id}/revert","title":"Revert a transfer","href":"/api-reference/endpoint/revert-a-transfer"}]}]}]},"basePath":"","title":"Get item info with the Antsfield API - API Reference","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","Page-Buji1S4J.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","clsx-B2v50t8t.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DJnKvr0g.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BHrrjR1K.js"]}