Items
Get an item
GET
/
item
/
{id}
Get an item
curl --request GET \
--url https://{instance}/api/v2/item/{id} \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://{instance}/api/v2/item/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{instance}/api/v2/item/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"value": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"isArchived": true,
"archivedAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"identifier": "<string>",
"sku": "<string>",
"description": "<string>",
"category": "<string>",
"type": "raw_material",
"status": "design",
"isConsumable": true,
"shipLoose": true,
"trackedOnly": true,
"baseUnitMeasureId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"purchaseUnitMeasureId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"unitsPerPurchase": 123,
"stockLength": 123,
"defaultLocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parentItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"trackingMode": "aggregate",
"minQuantity": 123,
"maxQuantity": 123,
"unitCost": 123,
"metadata": {},
"onHand": 123,
"allocated": 123,
"available": 123,
"onOrder": 123,
"isShort": true,
"belowMin": true,
"vendorSkus": "<string>"
}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}Authorizations
Organization-scoped API key. Create one in the BuildingSwell app under Organization settings, API keys.
Path Parameters
Record id.
Query Parameters
Fields to return. Comma-separated or repeated parameters are equivalent; an explicit selection includes only requested fields. Nested JSON paths are supported.
Response
Successful response.
Show child attributes
Show child attributes
⌘I
Get an item
curl --request GET \
--url https://{instance}/api/v2/item/{id} \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://{instance}/api/v2/item/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{instance}/api/v2/item/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"value": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"isArchived": true,
"archivedAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"identifier": "<string>",
"sku": "<string>",
"description": "<string>",
"category": "<string>",
"type": "raw_material",
"status": "design",
"isConsumable": true,
"shipLoose": true,
"trackedOnly": true,
"baseUnitMeasureId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"purchaseUnitMeasureId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"unitsPerPurchase": 123,
"stockLength": 123,
"defaultLocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parentItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"trackingMode": "aggregate",
"minQuantity": 123,
"maxQuantity": 123,
"unitCost": 123,
"metadata": {},
"onHand": 123,
"allocated": 123,
"available": 123,
"onOrder": 123,
"isShort": true,
"belowMin": true,
"vendorSkus": "<string>"
}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}