Keys
Send a private key in theX-API-Key header. See Authentication.
The key decides the business and the environment. A pk_live_ key reads live sales, and a pk_sandbox_ key reads test sales. Every response has an environment field. No parameter or header changes either value.
A marketplace operator’s Store Pulse figures include its active sub-merchants, as they do on the dashboard. Its sales, orders and customers cover its own business only.
Empty is not zero
A value that nothing measures isnull, never 0. Show “not tracked” or “not measurable” instead of a number.
Money
- Store Pulse amounts,
amount.minorandtotals[].minorare in hundredths of their currency. Divide by 100 to show them. - Sales summary fields ending in
_usdand itsrevenue_by_dayamounts are whole US dollars. - Currencies are never added together.
Errors
Every error has a stableerror_code. Switch on the code, not the message.
Requests count against the key’s hourly limit, so cache responses on your server. A minute is enough for most pages.
