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 Consignment Pieces API

The Consignment Pieces API from Reelables — 2 operation(s) for consignment pieces.

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

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

This API exposes 3 operations across 2 paths, and defines 7 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 2 paths 7 schemas 1 DELETE1 GET1 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 Consignment Pieces 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 2 paths, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Consignment Pieces 3
GET
/consignments/{consignmentId}/pieces
List Pieces in a Consignment
4 params → 200401403404429
POST
/consignments/{consignmentId}/pieces
Add Pieces to a Consignment
2 params body → 201401403404429
DELETE
/consignments/{consignmentId}/pieces/{pieceId}
Remove a Piece from a Consignment
3 params → 204401403404429

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Piece (7 properties), InFacility (6 properties), AssetLabel (4 properties), ConsignmentPieces (3 properties). Each schema is shown below with its type and property counts.

InFacility
object
6 properties 3 required
ConsignmentPiecesInput
array
Pieces to add to a Consignment
ConsignmentPieces
object
Pieces in the Consignment
3 properties 1 required
LabelConfig
object
1 property
ErrorResponse
object
This is an error
1 property 1 required
Piece
object
7 properties 4 required
AssetLabel
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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