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

The Customers API from Imprint — 7 operation(s) for customers.

Imprint Customers API is one of 14 APIs that Imprint publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 8 operations across 7 paths, and defines 23 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.

8 operations 7 paths 23 schemas 7 GET1 POST

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 Customers 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 8

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

Customers 8
GET
/v2/customers
Search for customers
searchCustomers 3 params → 200
POST
/v2/customers
Search for customers
searchCustomersPost body → 200
GET
/v2/customers/{customer_id}
Retrieve a customer
getCustomer 1 param → 200404
GET
/v2/customers/{customer_id}/rewards_balance
Get customer's current rewards balance
getRewardsBalance 1 param → 200404
GET
/v2/customers/{customer_id}/payment_methods
List customer's payment methods
getPaymentMethods 1 param → 200404
GET
/v2/customers/{customer_id}/transaction_intents
List customer's transaction intents
getTransactionIntents 1 param → 200404
GET
/v2/customers/{customer_id}/transactions
List customer's transactions
getTransactions 3 params → 200404
GET
/v2/customers/{customer_id}/rewards
List customer's rewards
getRewards 3 params → 200404

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are Transaction (15 properties), Customer (14 properties), TransactionIntent (11 properties), Reward (10 properties). Each schema is shown below with its type and property counts.

PaymentMethod
object
10 properties 6 required
RewardStatus
string
PurchaseMethod
string
How the purchase was completed.
RewardType
string
TransactionIntentStatus
string
Customer
object
Represents a customer in the Imprint system
14 properties 1 required
CustomerListResponse
object
3 properties
Merchant
object
5 properties
CustomerProgramStatus
string
Status of a customer within a card program.
CardType
string
The type of card
TransactionCurrency
string
The 3-character currency code of the amount in ISO 4217 format (e.g., "USD")
DateOfBirth
object
Customer's date of birth
3 properties
Address
object
Mailing address information
6 properties
Reward
object
10 properties 6 required
PaymentMethodToken
object
5 properties 4 required
TransactionNotFoundError
object
3 properties 2 required
RewardCurrency
string
The 3-character currency code of the amount in ISO 4217 format (e.g., "USD") or a reward unit (e.g., "POINTS")
Transaction
object
15 properties 8 required
CustomerNotFoundError
object
3 properties 2 required
TransactionStatus
string
TransactionIntent
object
11 properties 6 required
CardDesignID
string
Imprint ID for the graphic design printed on the card
PartnerCustomerId
string
The unique identifier for the customer in the partner's system

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

imprint-customers-api-openapi.yml Raw ↑

Other APIs Imprint publishes across the network.

Imprint Customer Links API
Imprint Customer Sessions API
Imprint Keys API
Imprint Offers API
Imprint Order Events API
Imprint Orders 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