GET · Checkout API

API-ReferenzCheckout APIMenus

GET

Checkout API Menus

GET/api/v1/menus

Retrieves a collection of menus available to the client.

• The Accept-Language header can be used by the client to specify the preferred language(s) for localized menu information.

Request-Header

Content-Type

application/json; charset=utf-8

Authorization

Token <accessToken>

Accept-Language

<localeIdentifier>

Originaler Blueprint-Ausschnitt

API BlueprintKopieren

### GET [GET]

Retrieves a collection of menus available to the client.
+ The `Accept-Language` header can be used by the client to specify the preferred language(s) for localized menu information.

+ Request (application/json; charset=utf-8)

    + Headers

            Authorization: Token <accessToken>
            Accept-Language: <localeIdentifier>

+ Response 200 (application/json; charset=utf-8)

    + Attributes (object)
        + id: `514717` (number, required) - The unique identifier of the menu card.
        + name: `Checkout menu card` (string) - The localized name of the menu card.

    + Body

            [
                {
                    "id": "514717",
                    "name": "Checkout menu card"
                }
            ]

    + Schema

            {
                "type": "array",
                "items": {
                {
                    "type": "object",
                    "properties": {
                        "id": {
                            "type": "number"
                        },
                        "name": {
                            "type": "string"
                        }
                    }
                }
            }

Request

cURLKopieren

curl --request GET \
  'https://checkout-clients-live-eu.qnips.com/api/v1/menus' \
  --header 'Content-Type: application/json; charset=utf-8' \
  --header 'Authorization: Token <accessToken>' \
  --header 'Accept-Language: <localeIdentifier>'

Dokumentationsbeispiel. Platzhalter vor der Verwendung ersetzen.

Response

200

Response-HeaderKopieren

Content-Type: application/json; charset=utf-8

Response 200Kopieren

[
    {
        "id": "514717",
        "name": "Checkout menu card"
    }
]

Response-SchemaKopieren

{
    "type": "array",
    "items": {
    {
        "type": "object",
        "properties": {
            "id": {
                "type": "number"
            },
            "name": {
                "type": "string"
            }
        }
    }
}