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

Imprint Orders API

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

Imprint Orders API is one of 14 APIs that Imprint 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, API documentation, an API reference, and authentication docs.

This API exposes 4 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 2.0.

Requests are made against a single base URL, https://dev.sbx.imprint.co.

4 operations 2 paths 6 schemas 1 DELETE1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0
Base URL
https://dev.imprint.co
Authentication
HTTP Basic, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Imprint Orders API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (auth-scheme) (bearerAuth). By default, every request must be authenticated.

  • basicAuth — Basic HTTP authentication. Allowed headers-- Authorization: Basic
  • bearerAuth — Bearer HTTP authentication. Allowed headers-- Authorization: Bearer

Paths & Operations 4

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

Orders 4
GET
/v2/orders
Retrieve orders
listOrders 2 params → 200
POST
/v2/orders
Create orders
createOrder body → 200
PUT
/v2/orders/{order_id}
Modify order
putOrder 1 param body → 200
DELETE
/v2/orders/{order_id}
Delete order
deleteOrder 1 param → 204

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are OrderBase (13 properties), Address (6 properties), OrderLine (5 properties), OrdersResponse (1 property). Each schema is shown below with its type and property counts.

CurrencyAmount
integer
Amount in the smallest currency unit (e.g., cents for USD)
OrderBase
object
13 properties 3 required
Order
OrderLine
object
5 properties 4 required
OrdersResponse
object
1 property 1 required
Address
object
Mailing address information
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

imprint-orders-api-openapi.yml Raw ↑

Other APIs Imprint publishes across the network.

Imprint Customer Links API
Imprint Customer Sessions API
Imprint Customers API
Imprint Keys API
Imprint Offers API
Imprint Order Events API
Imprint Payment Methods API
Imprint Rewards API
Imprint Simulate Reward API
Imprint Simulate Statement Reward API
Imprint Simulate Transaction Event API
Imprint Transaction Intents API