Deliveries
Get a delivery
GET
/
delivery
/
{id}
Get a delivery
curl --request GET \
--url https://{instance}/api/v2/delivery/{id} \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://{instance}/api/v2/delivery/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{instance}/api/v2/delivery/{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>",
"direction": "inbound",
"status": "expected",
"fromKind": "<string>",
"fromLocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fromVendorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fromAddress": "<string>",
"toKind": "<string>",
"toLocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toAddress": "<string>",
"plannedStartAt": "2023-11-07T05:31:56Z",
"plannedEndAt": "2023-11-07T05:31:56Z",
"cargoItemCount": 123,
"cargoDeliveredCount": 123,
"actualStartAt": "2023-11-07T05:31:56Z",
"actualEndAt": "2023-11-07T05:31:56Z",
"poNumber": "<string>",
"expectedDate": "2023-11-07T05:31:56Z",
"truckId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"truck": "<string>",
"truckName": "<string>",
"trailerType": "<string>",
"isOverDimension": true,
"carrierKind": "own",
"receiverContactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"driverContactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"publicToken": "<string>",
"deliverableGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"confirmationTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data": {},
"isLate": true
}
}{
"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 a delivery
curl --request GET \
--url https://{instance}/api/v2/delivery/{id} \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://{instance}/api/v2/delivery/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{instance}/api/v2/delivery/{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>",
"direction": "inbound",
"status": "expected",
"fromKind": "<string>",
"fromLocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fromVendorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fromAddress": "<string>",
"toKind": "<string>",
"toLocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toAddress": "<string>",
"plannedStartAt": "2023-11-07T05:31:56Z",
"plannedEndAt": "2023-11-07T05:31:56Z",
"cargoItemCount": 123,
"cargoDeliveredCount": 123,
"actualStartAt": "2023-11-07T05:31:56Z",
"actualEndAt": "2023-11-07T05:31:56Z",
"poNumber": "<string>",
"expectedDate": "2023-11-07T05:31:56Z",
"truckId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"truck": "<string>",
"truckName": "<string>",
"trailerType": "<string>",
"isOverDimension": true,
"carrierKind": "own",
"receiverContactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"driverContactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"publicToken": "<string>",
"deliverableGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"confirmationTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data": {},
"isLate": true
}
}{
"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": {}
}