canonical: https://jentic.com/apis/swaggerhub.alfah/mag-germany-order-service-api

# Alfah MAG Germany Order Service API

MAG Germany Service API for ordering. The goal of the service to offer orders from one system to another. The order producer company is ALFAH GmbH. The order consumer company is MAG-Germany. When new order produced by ALFAH GmbH, it is become available for MAG-Germany via the API. MAG-Germany may read orders using status criteria or request them directly by order id. MAG-Germany as order consumer . The API exposes 3 endpoints secured with apiKey authentication.

## For AI agents

Programmatically get orders, get order by id. Covers 3 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for e-commerce only.

## Capabilities

- Get orders
- Update order
- Integrate MAG Germany Order Service API into automated workflows
- Query and filter MAG Germany Order Service API records by parameters
- Monitor MAG Germany Order Service API operational status and events

## Use cases

### E-Commerce Operations

Use the MAG Germany Order Service API to perform e commerce operations programmatically. The API provides 3 endpoints covering core functionality including get orders, get order by id, update order.

Example prompt: Call GET /orders to get orders

### Automated Orders Management

Automate orders operations by combining multiple MAG Germany Order Service API endpoints. Agents can get order by id and then update order in a single workflow.

Example prompt: Call GET `/orders/{order-id}` to get order by id, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call MAG Germany Order Service API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'get orders', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/orders` | Get orders |
| GET | `/orders/{order-id}` | Get order by id |
| PUT | `/orders/{order-id}` | Update order |

## Key resources

- **Orders** — Operations for orders

## Why Jentic

- **Setup:** Wiring the MAG Germany Order Service API by hand means setting up its API key in the Authentication header and calling order list, read, and update operations yourself against the alfah gateway host. Through Jentic you install once, import the MAG Germany Order Service API from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** The MAG Germany Order Service API puts the order id in the URL path (`/orders/{order-id}`), so a rule can pin your agent to one order: it can read that order and nothing else. You choose the operations it may call, so the update operation is not included unless you add it.
- **Credential handling:** Your MAG Germany Order Service API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'get orders' or 'read an order by id', and Jentic returns the matching MAG Germany Order Service API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Shopify** — Alternative e commerce API
- **Stripe** — Alternative e commerce API

## FAQ

### What authentication does the MAG Germany Order Service API use?

The MAG Germany Order Service API uses an API key passed in the `Authentication` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I get orders with the MAG Germany Order Service API?

Yes. Use the GET /orders endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the MAG Germany Order Service API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I get orders through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get orders'. Jentic returns the matching MAG Germany Order Service API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the MAG Germany Order Service API have?

The MAG Germany Order Service API exposes 3 endpoints covering orders operations.

### Can I limit what my agent is allowed to do with the MAG Germany Order Service API?

Yes. Because you run Jentic One yourself, your own rules decide which of this API's operations your agent may call, so you can grant read access through GET /orders and GET `/orders/{order-id}` while withholding the PUT `/orders/{order-id}` update operation. Since the order id sits in the URL path, a rule can pin the agent to a single order, letting it read that one order and nothing else. Your API key is stored once by your own instance and injected only for the operations you allow.