Locations
Update matching locations
A filter is required.
PATCH
/
location
/
bulk
Update matching locations
curl --request PATCH \
--url https://{instance}/api/v2/location/bulk \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"code": "<string>",
"metadata": {},
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"latitude": 123,
"longitude": 123,
"timezone": "<string>",
"deliveryInstructions": "<string>",
"notes": "<string>",
"isArchived": false
}
'const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
parentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
code: '<string>',
metadata: {},
addressLine1: '<string>',
addressLine2: '<string>',
city: '<string>',
stateOrProvince: '<string>',
postalCode: '<string>',
latitude: 123,
longitude: 123,
timezone: '<string>',
deliveryInstructions: '<string>',
notes: '<string>',
isArchived: false
})
};
fetch('https://{instance}/api/v2/location/bulk', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{instance}/api/v2/location/bulk"
payload = {
"parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"code": "<string>",
"metadata": {},
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"latitude": 123,
"longitude": 123,
"timezone": "<string>",
"deliveryInstructions": "<string>",
"notes": "<string>",
"isArchived": False
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"values": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"shopId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"code": "<string>",
"type": "storage",
"metadata": {},
"isArchived": true,
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"country": "US",
"latitude": 123,
"longitude": 123,
"timezone": "<string>",
"deliveryInstructions": "<string>",
"notes": "<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.
Query Parameters
Full-text search across the resource's search columns. Append :col1,col2 to limit which columns are searched.
AND/OR filter expression, for example type eq 'phase' and isArchived eq false. Simple equality can also be passed as plain field parameters.
Body
application/json
Available options:
storage, staging, in_transit, yard, build_bay, station, rack, bay, booth, cell, shelf, zone, work_center, site Available options:
US, CA Available options:
false Response
Successful response.
Show child attributes
Show child attributes
⌘I
Update matching locations
curl --request PATCH \
--url https://{instance}/api/v2/location/bulk \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"code": "<string>",
"metadata": {},
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"latitude": 123,
"longitude": 123,
"timezone": "<string>",
"deliveryInstructions": "<string>",
"notes": "<string>",
"isArchived": false
}
'const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
parentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
code: '<string>',
metadata: {},
addressLine1: '<string>',
addressLine2: '<string>',
city: '<string>',
stateOrProvince: '<string>',
postalCode: '<string>',
latitude: 123,
longitude: 123,
timezone: '<string>',
deliveryInstructions: '<string>',
notes: '<string>',
isArchived: false
})
};
fetch('https://{instance}/api/v2/location/bulk', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{instance}/api/v2/location/bulk"
payload = {
"parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"code": "<string>",
"metadata": {},
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"latitude": 123,
"longitude": 123,
"timezone": "<string>",
"deliveryInstructions": "<string>",
"notes": "<string>",
"isArchived": False
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"values": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"shopId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"code": "<string>",
"type": "storage",
"metadata": {},
"isArchived": true,
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"country": "US",
"latitude": 123,
"longitude": 123,
"timezone": "<string>",
"deliveryInstructions": "<string>",
"notes": "<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": {}
}