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 Orders API

The Orders API from Workist — 5 operation(s) for orders.

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

Tagged areas include Orders. 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 12 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 12 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 Orders 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.

Orders 7
GET
/orders
Get all processing records for this document type
orders_list 12 params → 200400401404500
POST
/orders
Add a new processing record for this document type
orders_create 1 param body → 201400401404500
GET
/orders/{id}
Get a specific processing record for this document type
orders_retrieve 2 params → 200400401404500
DELETE
/orders/{id}
Delete a processing record of this document type
orders_destroy 1 param → 204400401404500
PUT
/orders/{id}/assign_user
Assign a user to a specific processing record of this document type
orders_assign_user_update 2 params body → 200400401404500
PUT
/orders/{id}/mark_imported
Mark a processing record of this document type as imported
orders_mark_imported_update 2 params body → 200400401404500
PATCH
/orders/{id}/meta
Update the meta information of a processing record of this document type
orders_meta_partial_update 2 params body → 200400401404500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are OrderLineItem (30 properties), Order (26 properties), OrderProcessingRecord (23 properties), Address (18 properties). Each schema is shown below with its type and property counts.

OrderLineItem
object
30 properties 1 required
MarkImportedRequest
object
4 properties
PaginatedOrderProcessingRecordList
object
4 properties 2 required
PatchedMetaRequest
object
2 properties
CreateDocumentRequest
object
3 properties 2 required
OrderProcessingRecord
object
23 properties 19 required
ContactPerson
object
4 properties
AssignUserRequest
object
1 property 1 required
Address
object
18 properties
User
object
3 properties 1 required
Order
object
26 properties
Customer
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workist-orders-api-openapi.yml Raw ↑

Other APIs Workist publishes across the network.

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