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

Worders Orders API

The Orders API from Worders — 2 operation(s) for orders.

Worders Orders API is one of 7 APIs that Worders 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 and API documentation.

This API exposes 3 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.0.1, at version v1.

Requests are made against a single base URL, https://api.worders.net.

3 operations 2 paths 7 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
v1
Base URL
https://api.worders.net
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Worders Orders API declares 2 security schemes for authenticating requests. An API key is passed in the cookie as _worders_session (cookie_session). It accepts HTTP bearer tokens (bearer_auth).

  • cookie_session — Authenticated Devise session cookie (api.worders.net).
  • bearer_auth — Service API key issued from the admin UI. Sent as Authorization: Bearer wrdlive….

Paths & Operations 3

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

Orders 3
GET
/V1/orders
List orders eligible for the weekly client budget export
5 params → 200401
POST
/V1/orders
Create a Plunet order with items
body → 201200404400
GET
/V1/orders/{id}
Show a single order
1 param → 200404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Order (17 properties), OrderItem (10 properties), OrderCreateResponse (8 properties), PaginationMeta (3 properties). Each schema is shown below with its type and property counts.

Order
object
17 properties
ErrorResponse
object
1 property 1 required
PaginationMeta
object
3 properties
OrderCreateResponse
object
8 properties
OrderItem
object
10 properties
OrderCreateRequest
object
1 property 1 required
Customer
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

worders-orders-api-openapi.yml Raw ↑

Other APIs Worders publishes across the network.

Worders Customers API
Worders Freelancers API
Worders Invoices API
Worders PurchaseOrders API
Worders Quotes API
Worders Templates API