B2B documentation

B2B API – retrieve order and product information automatically

Our REST API is available to every customer with a customer account and makes it possible to retrieve order and product information automatically and integrate it into your own systems.

vpn_key Open API access in account Business customers page

Authentication

All API requests require a valid API key, which is sent along in the HTTP header. API access is tied to your customer account and is generally available to customer accounts.

info You do not need a separate B2B application: Sign in with your customer account, open the API tab, and generate your API key there. To API access →

Header format

HTTP Request Header

X-API-Key: YOUR_API_KEY_HERE
Content-Type: application/json
Accept: application/json

Example with cURL

cURL

curl -X GET "https://artumos.com/api/v1/orders" \
  -H "X-API-Key: YOUR_API_KEY_HERE" \
  -H "Accept: application/json"

Base URL

All endpoints are relative to the following base URL:

Base URL

https://artumos.com/api/v1

All responses are returned as JSON returned (Content-Type: application/json).

Rate Limits

Plan	Requests / minute	Requests / day
Customer account	60	5.000
Extended limit	on request	on request

If exceeded, HTTP 429 Too Many Requests is returned. The header Retry-After contains the waiting time in seconds.

Error codes

HTTP-Code	Meaning
`200 OK`	Request successful
`400 Bad Request`	Invalid parameters
`401 Unauthorized`	Missing or invalid API key
`403 Forbidden`	No permission for this resource
`404 Not Found`	Resource not found
`429 Too Many Requests`	Rate limit exceeded
`500 Internal Server Error`	Server error – please contact support

Error response format

JSON

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key."
  }
}

Endpoint: Orders

GET /api/v1/orders All orders of the account

Parameter	Type	Description
`page`	integer	Page (default: 1)
`per_page`	integer	Entries per page (max. 100)
`status`	string	`paid` \| `pending` \| `all`

Beispiel-Response

{
  "success": true,
  "data": {
    "orders": [
      {
        "id": "ORD-12345",
        "status": "paid",
        "total": 49.99,
        "currency": "EUR",
        "created_at": "2026-01-15T10:30:00Z",
        "items_count": 2
      }
    ],
    "pagination": {
      "page": 1,
      "per_page": 20,
      "total": 42
    }
  }
}

GET /api/v1/orders/{order_id} Retrieve a single order

Endpoint: Product and order information

GET /api/v1/orders/{order_id}/codes All product information for an order

Beispiel-Response

{
  "success": true,
  "data": {
    "order_id": "ORD-12345",
    "codes": [
      {
        "id": "CODE-789",
        "product_name": "Beispielprodukt vom Marktplatz",
        "product_sku": "ART-PRODUCT-001",
        "product_info": "Hinweise laut Verkäuferangaben",
        "delivery_url": "https://...",
        "delivered_at": "2026-01-15T10:31:00Z",
        "status": "active"
      }
    ]
  }
}

GET /api/v1/codes/{code_id} Retrieve a single product information

warning Product and order information may only be used within the scope of the respective order and seller information. Improper sharing may violate the terms of use.

Endpoint: Products

GET /api/v1/products Retrieve product catalog

Parameter	Type	Description
`category`	string	Filter category slug
`in_stock`	boolean	Available products only
`page`	integer	Page

Beispiel-Response

{
  "success": true,
  "data": {
    "products": [
      {
        "id": 42,
        "sku": "ART-PRODUCT-001",
        "name": "Beispielprodukt vom Marktplatz",
        "price": 49.99,
        "currency": "EUR",
        "in_stock": true,
        "category": "handmade"
      }
    ]
  }
}

Webhooks

Webhooks make it possible to receive real-time notifications when orders or codes are provided. Webhook URLs can be stored in the customer account.

Available events

Event	Description
`order.paid`	Order was paid
`codes.delivered`	Codes were provided
`order.refunded`	Order was refunded

Webhook Payload

POST – Your Webhook endpoint

{
  "event": "codes.delivered",
  "timestamp": "2026-01-15T10:31:05Z",
  "data": {
    "order_id": "ORD-12345",
    "codes_count": 2
  },
  "signature": "sha256=..."
}

Verify the signature with your Webhook secret: HMAC-SHA256(payload, webhook_secret)

Frequently asked questions

Who can use the B2B API?

Every customer with a customer account can use API access. Sign in to your customer account and use the associated API key for authenticated requests.

What format do the responses have?

All responses are returned as JSON. The root object always contains success: true/false as well as either data or error.

Can I place orders via the API?

In the first version, the API serves to retrieve orders, order, and product information. Write order endpoints will be enabled separately as soon as they are available.

Is there a sandbox environment?

Yes. The sandbox can be activated in the customer account in the “API access” tab and is tied directly to the respective API key.