Skip to main content
Postman imports OpenAPI documents directly, so the Flexprice collection is the spec itself. Importing it gives you a folder per resource, a request per endpoint with its body schema filled in, and a place to keep separate environments for sandbox and production.

​
Importing the Postman collection

1

Download the spec

See OpenAPI spec for the other sources.
2

Import into Postman

Click Import in the top left, drop flexprice-openapi.json on the dialog, and choose Postman Collection as the import target. Postman creates a collection named Flexprice API with one folder per tag.
3

Create an environment

Open Environments, click +, and add two variables:Create one Postman environment per Flexprice environment (sandbox and production) so switching is one dropdown and a production key never sits in a sandbox request.
4

Set the auth on the collection

Open the collection, go to Authorization, choose API Key, and set:Every request inherits it. If the import set the base URL as a literal, replace it with {{baseUrl}} in the collection Variables tab.
5

Send a request

Open Customers > Query customers, send it with an empty JSON body {}, and confirm you get an items array back.

​
Pointing Postman at a self-hosted instance

Point baseUrl at your own deployment, for example http://localhost:8080/v1, and use a key created in that deployment. The self-hosting guide covers the local key.

​
Keeping the Postman collection current

The API gains endpoints between SDK releases. Re-import the spec when the changelog lists API changes and choose Replace so your environments and auth settings are kept.

OpenAPI spec

Prefer a terminal? Use the CLI