List delivery lines

GET

delivery-line

List delivery lines

curl --request GET \
  --url https://{instance}/api/v2/delivery-line \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://{instance}/api/v2/delivery-line', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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",
      "isArchived": true,
      "archivedAt": "2023-11-07T05:31:56Z",
      "deliveryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "itemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "deliverableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "quantityExpected": 1,
      "quantityActual": 123,
      "unitMeasureId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "unitCost": 123,
      "locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "loadStopId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "unloadStopId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "loadedAt": "2023-11-07T05:31:56Z",
      "unloadedAt": "2023-11-07T05:31:56Z",
      "rawDescription": "<string>",
      "notes": "<string>"
    }
  ],
  "hasMore": 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": {}
}

Authorizations

X-API-Key

string

header

required

Organization-scoped API key. Create one in the BuildingSwell app under Organization settings, API keys.

Query Parameters

page

integer

default:1

Page to return, starting at 1. Pages are 1-based, so page=0 is rejected with a 400.

Required range: x >= 1

pageSize

integer

default:100

Records per page. Defaults to 100 when no pagination parameter is sent. /timesheet applies no default at all, so send this explicitly.

orderBy

string

Sort fields, e.g. name:asc,createdAt:desc. Comma-separated and repeated parameters are equivalent.

select

string[]

Fields to return. Comma-separated or repeated parameters are equivalent; an explicit selection includes only requested fields. Nested JSON paths are supported.

string

Full-text search across the resource's search columns. Append :col1,col2 to limit which columns are searched.

filter

string

AND/OR filter expression, for example type eq 'phase' and isArchived eq false. Simple equality can also be passed as plain field parameters.

Response

Successful response.

values

object[]

Show child attributes

hasMore

boolean

List delivery lines

curl --request GET \
  --url https://{instance}/api/v2/delivery-line \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://{instance}/api/v2/delivery-line', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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",
      "isArchived": true,
      "archivedAt": "2023-11-07T05:31:56Z",
      "deliveryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "itemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "deliverableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "quantityExpected": 1,
      "quantityActual": 123,
      "unitMeasureId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "unitCost": 123,
      "locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "loadStopId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "unloadStopId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "loadedAt": "2023-11-07T05:31:56Z",
      "unloadedAt": "2023-11-07T05:31:56Z",
      "rawDescription": "<string>",
      "notes": "<string>"
    }
  ],
  "hasMore": 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": {}
}

Overview

Projects

Stages

Deliverables

Work sessions

Dependencies

Documents

Custom properties

QC

People (Workers)

Timesheets

Codes

Roles

Users

Domain concepts

Items

Item vendors

Inventory stock

Inventory transactions

Inventory allocations

BOM lines

Production outputs

Units of measure

Vendors

Locations

Deliveries

Delivery lines

Trucks

Contacts

Project contacts

Teams

Shifts

Departments (shops)

Authorizations

Query Parameters

Response