Workist Order Confirmations API is one of 8 APIs that Workist publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Order Confirmations. 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 operations5 paths11 schemas1 DELETE2 GET1 PATCH1 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Workist Order Confirmations 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.
The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are OrderConfirmationLineItem (24 properties), OrderConfirmationProcessingRecord (23 properties), Address (18 properties), OrderConfirmation (13 properties). Each schema is shown below with its type and property counts.
User
object
3 properties1 required
MarkImportedRequest
object
4 properties
OrderConfirmation
object
13 properties
PatchedMetaRequest
object
2 properties
OrderConfirmationProcessingRecord
object
23 properties19 required
CreateDocumentRequest
object
3 properties2 required
OrderConfirmationLineItem
object
24 properties
AssignUserRequest
object
1 property1 required
Address
object
18 properties
PaginatedOrderConfirmationProcessingRecordList
object
4 properties2 required
Customer
object
10 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
