Kundendetails auslesen

GET/customers/{customerNumber}/

API version

v1

Request method

GET

Operation ID

getCustomer

---

Diese Ressource enthält Detailinformationen zu einem bestimmten Kunden.

Request

• customerNumberinteger

  required

  Kundennummer

Responses

Format

application/json

Beschreibung

Eine Beschreibung des Kunden

Schema-Dokumentation

• customerNumbernumber

  required

  Die Kundennummer des Kunden

• prospectboolean

  required

  Wahr, wenn der Kunde als Interessent hinterlegt ist

Beispiel

{
  "customerNumber": 123,
  "prospect": true
}

JSON Schema

{
  "title": "Customer",
  "required": [
    "customerNumber",
    "prospect"
  ],
  "type": "object",
  "properties": {
    "customerNumber": {
      "type": "number",
      "description": "Die Kundennummer des Kunden"
    },
    "prospect": {
      "type": "boolean",
      "description": "Wahr, wenn der Kunde als Interessent hinterlegt ist"
    }
  }
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v1/customers/123