Get started
Use with Postman
Try every endpoint without writing code. The GetPrice Postman collection has one request per endpoint, grouped like the API reference, each with saved example responses.
Import the collection#
- Download the collection and the environment.
- In Postman, select Import and drop in both files.
- In the environment selector at the top right, choose GetPrice API.
Add your key#
Open the GetPrice API environment and paste your key into the Current value of api_key. Leave the
initial value empty, then save.
Warning: Postman shares initial values with anyone who can see the environment. Keep your key in the current value only, and never import it into a shared or public workspace.
Send your first request#
Open Account > Check your API key and select Send. You should get 200 OK and a body like this:
{
"key": {
"name": "ERP production",
"prefix": "k3Xa91Qz",
"environment": "live"
},
"company": {
"name": "Example Trading (Pty) Ltd"
},
"scopes": [
"catalog:read",
"matches:read",
"skus:write"
],
"limits": {
"per_minute": 120,
"window_seconds": 60
}
}A 401 means the key is missing or wrong. Check that the environment is selected and that api_key has a current
value.
Every request in the collection already has illustrative values filled in, such as sku=TV-55UHD. Replace them with
your own SKUs and ids. Create or replace a SKU mapping and Delete a SKU mapping change your data, so try
them on a SKU you can relink.
Test without touching live data#
There is no test environment yet: every key is live and every call reads your real data. Every GET is safe to
call as often as you like. PUT and DELETE change only SKU mappings, never prices or sets, so try them on a
SKU you can relink. To develop offline, run a mock server from the
OpenAPI file, for example npx @stoplight/prism-cli mock openapi.v1.yaml: it
answers every endpoint with the examples from the reference.