Quickstart

From zero to your first API response in about five minutes.

1. Create an API key#

   In the Ecomone backend open Apps › Ecomone API and choose API key. Only the shop owner can create keys. Pick the permissions, for example Orders: read. You get a key id (ek_…) and a secret (sk_…).

   !

   The secret is shown only once and stored by Ecomone only as a hash. Keep it on your server — never in a browser, app bundle or public repository.

2. Make a request#

   Send the key id and secret as headers. This lists the five newest orders:

   Your first request

   cURLNode.jsPython

   Copy

   curl "https://api.ecomone.shop/api/public/v1/orders?limit=5" \
     -H "X-Api-Key: ek_..." \
     -H "X-Api-Secret: sk_..."

   ★

   No code needed to explore: every endpoint in the API reference has a Try it console. Enter your key once and send real requests from the browser — credentials stay in your tab.

3. Fetch the next page#

   List endpoints return up to 50 items (max 200 via limit). Pass the returned cursor to get the next page. See Pagination.

   cURLCopy

   curl "https://api.ecomone.shop/api/public/v1/orders?limit=50&cursor=2026-11-12T08:41:02.118Z" \
     -H "X-Api-Key: ek_..." -H "X-Api-Secret: sk_..."

4. Update an order#

   With the orders:fulfillment scope you can mark an order as shipped and add tracking. The customer gets the shop's shipping e-mail unless you send "notify_customer": false.

   cURLCopy

   curl -X PATCH "https://api.ecomone.shop/api/public/v1/orders/<ORDER_ID>" \
     -H "X-Api-Key: ek_..." -H "X-Api-Secret: sk_..." \
     -H "Content-Type: application/json" \
     -d '{"fulfillment_status":"shipped","tracking_carrier":"Swiss Post","tracking_number":"99.60.123456.12345678"}'

5. Next steps#

   Browse the API reference, subscribe to webhooks instead of polling, or turn your integration into an app that any merchant can connect.