Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Workist Delivery Notes API

The Delivery Notes API from Workist — 5 operation(s) for delivery notes.

Workist Delivery Notes API is one of 8 APIs that Workist publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Delivery Notes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 7 operations across 5 paths, and defines 11 schemas. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against 2 base URLs: /v1/, /api/v1/.

7 operations 5 paths 11 schemas 1 DELETE2 GET1 PATCH1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://api.workist.com/api/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Workist Delivery Notes API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuthentication).

Paths & Operations 7

Across 5 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Delivery Notes 7
GET
/delivery-notes
Get all processing records for this document type
delivery_notes_list 12 params → 200400401404500
POST
/delivery-notes
Add a new processing record for this document type
delivery_notes_create 1 param body → 201400401404500
GET
/delivery-notes/{id}
Get a specific processing record for this document type
delivery_notes_retrieve 2 params → 200400401404500
DELETE
/delivery-notes/{id}
Delete a processing record of this document type
delivery_notes_destroy 1 param → 204400401404500
PUT
/delivery-notes/{id}/assign_user
Assign a user to a specific processing record of this document type
delivery_notes_assign_user_update 2 params body → 200400401404500
PUT
/delivery-notes/{id}/mark_imported
Mark a processing record of this document type as imported
delivery_notes_mark_imported_update 2 params body → 200400401404500
PATCH
/delivery-notes/{id}/meta
Update the meta information of a processing record of this document type
delivery_notes_meta_partial_update 2 params body → 200400401404500

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are DeliveryNoteLineItem (24 properties), DeliveryNoteProcessingRecord (23 properties), Address (18 properties), DeliveryNote (11 properties). Each schema is shown below with its type and property counts.

DeliveryNote
object
11 properties
MarkImportedRequest
object
4 properties
DeliveryNoteProcessingRecord
object
23 properties 19 required
PatchedMetaRequest
object
2 properties
PaginatedDeliveryNoteProcessingRecordList
object
4 properties 2 required
CreateDocumentRequest
object
3 properties 2 required
DeliveryNoteLineItem
object
24 properties
AssignUserRequest
object
1 property 1 required
Address
object
18 properties
User
object
3 properties 1 required
Customer
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workist-delivery-notes-api-openapi.yml Raw ↑

Other APIs Workist publishes across the network.

Workist Invoices API
Workist List Of Services API
Workist Master Data API
Workist Order Confirmations API
Workist Orders API
Workist Property Bills API
Workist Rfq API