# Shopware Admin API usage

This endpoint reference contains an overview of all Ratepay relevant endpoints for the Shopware Admin API.

Version: for the Ratepay SW6 module v6.x and below

## Servers

```
http://your_shopware_url/api
```

## Security

### oAuth

Authentication API

Type: oauth2
Token URL: http://your_shopware_url/api/oauth/token
Scopes:
- `write`: Full write access

## Download OpenAPI description

[Shopware Admin API usage](https://docs.ratepay.com/_bundle/docs/developer/shop_modules/shopware/shopware_6/daily_business/operations_6.x.yaml)

## Other

### Get the current state of Ratepay processed order-items

 - [GET /ratepay/order-management/load/{orderId}](https://docs.ratepay.com/docs/developer/shop_modules/shopware/shopware_6/daily_business/operations_6.x/other/ratepayorderitemsinfo.md)

### Report delivery of order-line-items of order processed by Ratepay

 - [POST /ratepay/order-management/deliver/{orderId}](https://docs.ratepay.com/docs/developer/shop_modules/shopware/shopware_6/daily_business/operations_6.x/other/ratepayorderitemdeliver.md)

### Cancel order-line-items of order processed by Ratepay

 - [POST /ratepay/order-management/cancel/{orderId}](https://docs.ratepay.com/docs/developer/shop_modules/shopware/shopware_6/daily_business/operations_6.x/other/ratepayorderitemcancel.md)

### Refund order-line-items of order processed by Ratepay

 - [POST /ratepay/order-management/return/{orderId}](https://docs.ratepay.com/docs/developer/shop_modules/shopware/shopware_6/daily_business/operations_6.x/other/ratepayorderitemrefund.md)

### Add order-line-items of order processed by Ratepay

 - [POST /ratepay/order-management/addItem/{orderId}](https://docs.ratepay.com/docs/developer/shop_modules/shopware/shopware_6/daily_business/operations_6.x/other/ratepayorderitemadditem.md): You can add a debit or credit to the processed order by Ratepay. It is required that at least one order-item has been marked as shipped and not returned.