Getting started

From API key to your first seller.

The API lives at https://api.marketapi.shop. Keep the address in a variable for the examples:

export BACKEND_URL=https://api.marketapi.shop

1. Create your account

Open the dashboard. On first login you see the What is your company called? screen: fill in Company name and click Continue.

2. Create an API key

Under API keys, create an API key and copy it. It is shown only once. See Authentication.

3. Check that the API responds

curl $BACKEND_URL/health
# { "status": "ok", "mode": "api" }

mode depends on the environment (api, worker or all).

4. Create a seller

curl -X POST $BACKEND_URL/v1/sellers \
  -H "Authorization: Bearer mk_your_api_key" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"name":"Acme Store","externalId":"customer-123"}'

201 response:

{
  "id": "0f6c1d6e-3b8e-4c3e-9a57-2f1f4d0c9b11",
  "name": "Acme Store",
  "externalId": "customer-123",
  "createdAt": "2026-10-06T14:30:00.000Z",
  "updatedAt": "2026-10-06T14:30:00.000Z"
}

The Idempotency-Key header lets you repeat the request without creating another seller. See Idempotency and limits.

5. List your sellers

curl "$BACKEND_URL/v1/sellers?page=1&pageSize=20" \
  -H "Authorization: Bearer mk_your_api_key"
{
  "data": [
    {
      "id": "0f6c1d6e-3b8e-4c3e-9a57-2f1f4d0c9b11",
      "name": "Acme Store",
      "externalId": "customer-123",
      "createdAt": "2026-10-06T14:30:00.000Z",
      "updatedAt": "2026-10-06T14:30:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 20,
    "totalItems": 1,
    "totalPages": 1,
    "hasNext": false,
    "hasPrev": false
  }
}

More about this resource in Sellers.

What's next

Connect the seller's marketplaces: Connecting a seller. To know right away when they connect, register a webhook: Receiving webhooks.

Every endpoint has a page in the API section, with its fields, request and response examples, and a playground to try it.