Basket Webservice / Update API
๐ Introduction
We offer a web service API for the automated processing of shopping carts. This allows for the subsequent adjustment of already existing baskets. For access, each user receives an Access Token and a User ID, which are provided via the frontend.
๐ Authentication
The following headers are required to access the API:
| Header | Description | Type |
| Content-Type | The Content-Type of the request | String |
| X-Network-ID | Network ID: typically -1 for cross-client (multi-tenant) API |
Integer |
| X-Auth-Token | Your Access Token (visible in the frontend) | String |
| X-Auth-ID | Your User ID (visible in the frontend) | Integer |
๐ฉ Endpoints
-
Admin:
https://SUBDOMAIN.de/ws/V6/admin/JSON/Baskets -
Advertiser:
https://SUBDOMAIN.de/ws/V6/advertiser/JSON/Baskets
๐งช Example (cURL)
curl -X PUT -H "Content-Type: application/json" -H "X-Network-ID: -1" -H "X-Auth-Token: AUTH-TOKEN" -H "X-Auth-ID: USER-ID" -d '[{"basket_item_id": 76041, "amount": 2, "status": "0", "additional": {"variable1": "text", "variable2": 1}}]' https://SUB.DOMAIN.DE/ws/V6/admin/JSON/Baskets
๐งพ Body Parameters
| Parameter | Description | Data Type | Required |
| basket_item_id | Unique ID of the basket item | Integer | โ Yes |
| amount | Quantity of the basket item | Integer | No |
| price | Net price of the basket item | Float | No |
| status | Status of the order: 0 = open, 1 = confirmed, 2 = canceled |
Integer | โ Yes |
| turnover | Order value in campaign currency | Float | โ Yes |
| additional | Additional information regarding the basket item | JSON | No |
Example Request
Headers:
HTTP
Content-Type: application/json
X-Network-ID: -1
X-Auth-Token: ACCESS-TOKEN
X-Auth-ID: USER-ID
Body:
JSON
[
{
"basket_item_id": 76041,
"amount": 1,
"status": "1",
"additional": {
"variable1": "text",
"variable2": 1
}
}
]