Stages
Update a stage
Change one stage. Only the fields you send are touched.
PATCH
/
stage
/
{id}
Update a stage
curl --request PATCH \
--url https://{instance}/api/v2/stage/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"shopId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"maxOrderCapacity": 1,
"costCode": "<string>",
"isArchived": false
}
'const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
shopId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
description: '<string>',
maxOrderCapacity: 1,
costCode: '<string>',
isArchived: false
})
};
fetch('https://{instance}/api/v2/stage/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{instance}/api/v2/stage/{id}"
payload = {
"name": "<string>",
"shopId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"maxOrderCapacity": 1,
"costCode": "<string>",
"isArchived": False
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"value": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"shopId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"maxOrderCapacity": 1,
"costCode": "<string>",
"isArchived": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"archivedAt": "2023-11-07T05:31:56Z"
}
}{
"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": {}
}{
"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.
Body
application/json
Every field is optional. Only the fields you send are changed.
Station name, for example Welding.
Department the station belongs to.
What happens at this station.
How many orders the station can hold at once. Zero or greater.
Required range:
x >= 0Cost code. Trimmed on write, and an empty string is rejected: send a non-empty string or null.
Stored as a plain string. It is not validated against the cost code list, and renaming an entry in that list does not change this value.
Archived stations are hidden from list results unless you ask for them.
Response
The updated stage.
A reusable shop station, scoped to one department.
Show child attributes
Show child attributes
⌘I
Update a stage
curl --request PATCH \
--url https://{instance}/api/v2/stage/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"shopId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"maxOrderCapacity": 1,
"costCode": "<string>",
"isArchived": false
}
'const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
shopId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
description: '<string>',
maxOrderCapacity: 1,
costCode: '<string>',
isArchived: false
})
};
fetch('https://{instance}/api/v2/stage/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{instance}/api/v2/stage/{id}"
payload = {
"name": "<string>",
"shopId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"maxOrderCapacity": 1,
"costCode": "<string>",
"isArchived": False
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"value": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"shopId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"maxOrderCapacity": 1,
"costCode": "<string>",
"isArchived": false,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"archivedAt": "2023-11-07T05:31:56Z"
}
}{
"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": {}
}{
"error": {
"message": "<string>",
"code": "BAD_REQUEST",
"requestId": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>",
"code": "<string>"
}
],
"missingPermissions": [
"<string>"
]
},
"context": {}
}