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

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

Reelables 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 Consignments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 1 operation across 1 path, and defines 11 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}.

1 operations 1 paths 11 schemas 1 GET

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 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 1

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

Consignments 1
GET
/consignments/{consignmentId}
Get Consignment
2 params → 200401403404429

Schemas 11

The contract defines 11 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
Workspace
object
2 properties 2 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
AssetLabel
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

got-its-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 External API
Reelables Facilities API
Reelables Facility Asset Groups API
Reelables Print Job Statuses API