CompuDime API docs

Sandbox: the demo store

CompuDime Demo Market is a store that does not exist. Its products, customers, stock, sales and invoices are invented, so you can try the API with a test key before you have a real store's key.

What it holds

The same data comes back every time you ask for the same day. Nothing you send changes it.

Get a demo key

Demo keys are test keys (cd_test_ or cc_test_) for the demo store, one per capability: catalog-feed, sales-data, customer-access or order-intake. Write to support@compudime.com and say which ones you want.

Try it

export PUBLIC_API_KEY='paste your demo key here'
curl -s https://api.compudime.com/v1/me -H "Authorization: Bearer $PUBLIC_API_KEY"
curl -s https://api.compudime.com/v1/products/lookup/080000003027 -H "Authorization: Bearer $PUBLIC_API_KEY"

With a customer-access key, read /v1/customers/C0001 or look up the phone 7185550100. With a sales-data key, read /v1/inventory/onhand and /v1/sales/movement for any days of the last four weeks.

What it answers

Your key

Who the key is and what it may do. The store object says "sandbox": true.

The catalog copy

The demo store's catalog, refreshed every 15 minutes.

Live reads

Answered the way a store's POS answers them, with the same paging, fields and errors.

Sales history

The last four weeks, day by day.

Orders

Checked like any order, then simulated, as for every test key: nothing reaches a store.

Your webhook receivers

Register a receiver with an order-intake key and send it test events. A test key's receivers get only the test events you send: simulated orders send none.

What it does not answer

These answer 422 not_in_sandbox for the demo store, without charging anything or reaching a store. Try them with a key for a real store.