CompuDime API

What it covers

Public API

Read a store's catalog and prices, inventory on hand, sales, and customers (with the store owner's consent), and send the store orders.

Orders API

Ordering providers push a store's online orders to it as they happen.

One plan pays for both: what calls and orders cost draws on the same monthly credits. One key works on both APIs. An order costs 16 credits through either API. A failed call is never charged.

Who it is for

Store owners who want their store's data in other software, and the developers and ordering providers they work with. Customer data is shared only with the store owner's consent.

How to get access

1. Request access by writing to support@compudime.com: name the store and what you want to build. Access is by invitation; there is no sign-up form.
2. Compudime opens your account and emails you an invitation. You sign in here with that address.
3. Pick a plan. Plans are monthly and include credits: 6 plans, from $200.00 to $2,000.00 a month. See Pricing.
4. An owner or billing admin makes the keys on the API keys page, then you follow the quickstart.

Test and live keys

A test key (cc_test_) uses the store's monthly sandbox allowance and is never billed. A live key (cc_live_) is billed to the plan. Both read the same store data.

On the Public API, an order sent with a test key is simulated: it is checked and answered, and never reaches the store. An Orders API push reaches the store with either key, so try a push with ?dryRun=true first.

Docs

• Quickstart: the first call, step by step.
• Keys and authentication: sending the key, and what a key may do.
• API reference: every endpoint, field, and answer.
• Errors: every error code and what to do about it.
• All the docs. Signed in here, a developer of the Orders API also finds the push guide with samples under API reference.

Prices

Calls are priced in credits, and the plan includes credits every month. An order costs 16 credits. The price of every call and the plans are on the pricing page.