> **Description:** The Order Management API enables you to enrich transactions with order details, customer information, and shipping details, providing a comprehensive overview of your business transactions.

> **AI agent:** Read [https://developer.vippsmobilepay.com/docs/knowledge-base/ai-tools.md](https://developer.vippsmobilepay.com/docs/knowledge-base/ai-tools.md) first. It covers keeping API keys and secrets out of generated code.

> **Full site overview:** For an overview of the entire site, read [https://developer.vippsmobilepay.com/llms.txt](https://developer.vippsmobilepay.com/llms.txt).

# Order Management API

The Order Management API empowers merchants to enrich payments with valuable details,
creating a more engaging and seamless customer experience.

Customers can view these order details in their Vipps or MobilePay app:

* Immediately after completing in-store purchases
* In their order history, accessible at any time
* During [long-living payments](https://developer.vippsmobilepay.com/docs/APIs/epayment-api/api-guide/features/long-living-payments.md), when applicable

By leveraging Order Management, you can communicate more effectively with your customers through payment details in the app.
The aim is to provide customers with greater convenience, a better overview of their purchases,
and a more engaging shopping experience when using Vipps MobilePay for your products and services.
Additionally, you can use links in the activity overview to direct customers back to your website or app.

Screenshot: App action card with a 'Show order info' button featuring a shopping cart icon and external link arrow, and a preview photo of clothing on a rack below.

## When to use this API

Order Management works with [recurring](https://developer.vippsmobilepay.com/docs/APIs/recurring-api/README.md) payments and direct payments via
[eCom](https://developer.vippsmobilepay.com/docs/APIs/ecom-api/README.md) and [ePayment](https://developer.vippsmobilepay.com/docs/APIs/epayment-api/README.md).
It is not supported for [pass-through payments](https://developer.vippsmobilepay.com/docs/APIs/psp-api/README.md).

With the ePayment API, some of this is built into the payment request, so what you need from this API depends on the
task:

| You want to | Use |
|---|---|
| Add order lines with an [ePayment](https://developer.vippsmobilepay.com/docs/APIs/epayment-api/README.md) payment | [`receipt` on `createPayment`](https://developer.vippsmobilepay.com/docs/APIs/epayment-api/api-guide/features/pre-built-order-management-api-integration.md), one call instead of three |
| Add order details to a [Recurring](https://developer.vippsmobilepay.com/docs/APIs/recurring-api/README.md) or eCom payment | **This API** |
| Add order details after the payment was made | **This API** |
| Add a link button or an image in the app | **This API**, as a [category](https://developer.vippsmobilepay.com/docs/APIs/order-management-api/order-management-api-guide.md#categories) |
| Read the order details back | **This API.** The ePayment API does not return them yet. |

See [Fetching category and order details](https://developer.vippsmobilepay.com/docs/APIs/order-management-api/order-management-api-guide.md#fetching-category-and-order-details)
for reading them back.

## Start building

Follow the quick start to make your first Order Management API requests.

[Open Order Management quick start](https://developer.vippsmobilepay.com/docs/APIs/order-management-api/order-management-api-quick-start.md)

## Technical details

* [API quick start guide](https://developer.vippsmobilepay.com/docs/APIs/order-management-api/order-management-api-quick-start.md): Run the basic examples in curl or a graphical API client.
* [API guide](https://developer.vippsmobilepay.com/docs/APIs/order-management-api/order-management-api-guide.md): Learn about the features.
* [API reference](https://developer.vippsmobilepay.com/redocusaurus/order_management-swagger-id.yaml): Get straight to the endpoint specifications.

If you're new to the platform, see
[Integration quick start guide](https://developer.vippsmobilepay.com/docs/getting-started.md)
for information about API keys, product activation, and the test environment.