Abrufen von Nachschlagewerken für Zahlungen

GET/api/crm/v2/payments.fieldsv2

operationId: payments.fields

Autorisierung

api-token + language + role

Antworten

object

statusstringerforderlich

Werte:successerror

Beispiel: success

dataobject

branch_idobject (FilterSelectInteger)

valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object

valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

curl -X GET 'https://foodsoul.pro/api/crm/v2/payments.fields' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: de' \
  -H 'role: partner'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/payments.fields', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'de',
        'role' => 'partner',
    ],
]);

$data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.pro/api/crm/v2/payments.fields", {
    method: "GET",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "de",
        "role": "partner"
    },
})
const data = await response.json()

import requests

response = requests.request(
    "GET",
    "https://foodsoul.pro/api/crm/v2/payments.fields",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "de",
        "role": "partner",
    },
)
data = response.json()

Antwort 200

{
  "status": "success",
  "data": {
    "branch_id": {
      "value": 8920,
      "type": "select",
      "option": [
        {
          "value": 8920,
          "name": "Green Basket | Kaliningrad"
        }
      ],
      "mode": "value_required"
    }
  }
}

Anfragen werden an foodsoul.pro gesendet – dies ist der Host dieses Portals, ein anderer kann nicht ausgewählt werden.