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

Reelables Workspace Consignments API

The Workspace Consignments API from Reelables — 1 operation(s) for workspace consignments.

Reelables Workspace Consignments API is one of 24 APIs that Reelables publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workspace Consignments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 1 path, and defines 17 schemas. It is described by OpenAPI 3.0.1, at version 1.1.1.

Requests are made against a single base URL, https://api.reelables.com/{basePath}.

3 operations 1 paths 17 schemas 1 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.1.1
Base URL
https://api.reelables.com/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Reelables Workspace Consignments API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (api_key).

Paths & Operations 3

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

Workspace Consignments 3
GET
/workspaces/{workspaceId}/consignments
List Consignments in a Workspace
5 params → 200401403429
POST
/workspaces/{workspaceId}/consignments
Create new Consignment in Workspace
2 params body → 201401403429
PATCH
/workspaces/{workspaceId}/consignments
Update a Consignment using a Tracking Reference
3 params body → 200401403404429

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are Gateway (11 properties), Consignment (9 properties), Piece (7 properties), InFacility (6 properties). Each schema is shown below with its type and property counts.

Gateway
object
11 properties 2 required
InFacility
object
6 properties 3 required
Consignment
object
9 properties 3 required
ConsignmentPiecesInput
array
Pieces to add to a Consignment
Workspace
object
2 properties 2 required
ConsignmentGatewaysInput
array
Gateways to add to a Consignment
WorkspaceConsignments
object
Consignments in the Workspace
2 properties 1 required
ConsignmentPieces
object
Pieces in the Consignment
3 properties 1 required
LabelConfig
object
1 property
ConsignmentGateways
object
Gateways in the Consignment
2 properties 1 required
ErrorResponse
object
This is an error
1 property 1 required
Piece
object
7 properties 4 required
Facility
object
5 properties 3 required
ConsignmentInput
object
Consignment data
3 properties 2 required
AssetLabel
object
4 properties 3 required
WorkspaceConsignmentsInput
object
Consignments to create in the Workspace
1 property 1 required
PatchConsignmentInput
object
Consignment data
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

got-its-workspace-consignments-api-openapi.yml Raw ↑

Other APIs Reelables publishes across the network.

Reelables Asset Facilities API
Reelables Asset Labels API
Reelables Asset Locations API
Reelables Asset Spaces API
Reelables Asset Temperatures API
Reelables Assets API
Reelables Consignment Gateways API
Reelables Consignment Pieces API
Reelables Consignments API
Reelables External API
Reelables Facilities API
Reelables Facility Asset Groups API