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 > Retrieve your API key and select Send. You should get 200 OK and a body like this:

JSON

{
  "key": {
    "name": "Odoo production",
    "prefix": "k3Xa91Qz",
    "environment": "live"
  },
  "company": {
    "name": "Example Wholesale (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=10072L. Replace them with your own SKUs and ids. Link a SKU to a product and Remove a SKU link change your data, so try them on a SKU you can relink.