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

The Consignment Gateways API from Reelables — 2 operation(s) for consignment gateways.

Reelables Consignment Gateways 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 Gateways. 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 4 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 4 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 Gateways 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 Gateways 3
GET
/consignments/{consignmentId}/gateways
List Gateways in a Consignment
4 params → 200401403404429
POST
/consignments/{consignmentId}/gateways
Add Gateways to a Consignment
2 params body → 201401403404429
DELETE
/consignments/{consignmentId}/gateways/{gatewayId}
Remove a Gateway from a Consignment
3 params → 204401403404429

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Gateway (11 properties), ConsignmentGateways (2 properties), ErrorResponse (1 property). Each schema is shown below with its type and property counts.

Gateway
object
11 properties 2 required
ConsignmentGatewaysInput
array
Gateways to add to a Consignment
ConsignmentGateways
object
Gateways in the Consignment
2 properties 1 required
ErrorResponse
object
This is an error
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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