The basket API provides shopping baskets. It is designed fast access for a big amount of users.
To access the endpoints you require a X-API-Key in the header. Partners, please contact Transfermedia to retrieve one.
All endpoints are protected with a standard Authentication Bearer JWT token. We provide two mechanisms here:
A JWT token provided on partner side. Signature validation is required. This allows comfort functions like:
This requires:
A JWT token and a user id is generated on an endpoint in the basket api for guest users. In such a case the basket has some limitations:
To use a specific implementation version of this API place it to the request header X-API-Version. If the header is missed the latest implementation version 2025-07-21 is used. The response header X-API-Version contains the implementation version the request was processed with.
A shopping basket contains three product lists:
Products are represented by a product identifier with an order count. A product can be a main product or a product variant (e.g. a shoe in a specific size).
When the user decides to start the order process the checkout is the first step in the order process. It communicates with the payment service provider (PSP) responsible to manage the payment. If the payment succeeds an order process starts in the background.
The API provides the ability to transfer a basket e.g., to a web shop. Optionally a QR code image can be created to be presented to a customer. For security reasons the transfer needs to be finished within 1 minute.
For further details please visit the documentation or contact Transfermedia support@transfermedia.de.
https://docs.jay-metadata.com/_mock/apis/basket/latest/openapi/
https://docs.jay-metadata.com/_mock/apis/basket/latest/openapi/baskets/users/{userId}
curl -i -X GET \
'https://docs.jay-metadata.com/_mock/apis/basket/latest/openapi/baskets/users/{userId}' \
-H 'Authorization: Bearer <YOUR_Bearer_HERE>' \
-H 'X-API-Key: string' \
-H '__Secure-jay_tracking: __Secure-jay_tracking=eyJzZX...' \
-H 'x-jay-api-version: 2025-07-21'Successfully retrieved the shopping basket of the specified user.
Represents a users shopping basket.
{ "data": { "lastChanged": "2025-06-04T12:34:56Z", "cart": [ … ], "saved": [ … ], "checkout": [ … ] } }
https://docs.jay-metadata.com/_mock/apis/basket/latest/openapi/baskets/users/{userId}
curl -i -X DELETE \
'https://docs.jay-metadata.com/_mock/apis/basket/latest/openapi/baskets/users/{userId}' \
-H 'Authorization: Bearer <YOUR_Bearer_HERE>' \
-H 'X-API-Key: string' \
-H '__Secure-jay_tracking: __Secure-jay_tracking=eyJzZX...' \
-H 'x-jay-api-version: 2025-07-21'Required. API access key for authorized use of the checkout endpoints. Partners, please contact Transfermedia to retrieve a valid key.
Tracking session header for user tracking and analytics. This is set by the /playouts/tracking/session endpoint.
Used to speed up the checkout process (prefill customer related information).
This is comfort function which needs user validation.
https://docs.jay-metadata.com/_mock/apis/basket/latest/openapi/baskets/users/{userId}/comfort
curl -i -X PATCH \
'https://docs.jay-metadata.com/_mock/apis/basket/latest/openapi/baskets/users/{userId}/comfort' \
-H 'Authorization: Bearer <YOUR_Bearer_HERE>' \
-H 'Content-Type: application/json' \
-H 'X-API-Key: string' \
-H '__Secure-jay_tracking: __Secure-jay_tracking=eyJzZX...' \
-H 'x-jay-api-version: 2025-07-21' \
-d '{
"customerId": "string",
"paymentToken": "string"
}'{ "data": null, "nextToken": "string", "error": { "code": 1001, "message": "string", "details": null } }