Vertragspartner auslesen

GET/customers/{customerNumber}/contractpartner/

API version

v1

Request method

GET

Operation ID

getCustomerContractPartner

---

Diese Operation liefert Details zum Vertragspartner eines Kunden zurück

Request

• customerNumberinteger

  required

  Kundennummer

Responses

Format

application/json

Beschreibung

Eine Beschreibung des Vertragspartners des Kunden

Schema-Dokumentation

• firstNamestring

  required

  Vorname

• lastNamestring

  required

  Nachname

• titlestring

  (Akademischer) grad

• salutationstring

  required

  Grußformel, z.B. Herr oder Frau

• companystring

  Firmenname, oder null

• addressobject

  required
  • streetstring

    required

    Straße

  • houseNumberstring

    required

    Hausnummer

  • zipstring

    required

    PLZ

  • citystring

    required

    Stadt

  • countryobject

    required
    • isoShortstring

      required

      2-Zeichen-ISO-Name des Landes (z.B. DE)

    • isoLongstring

      required

      Langer ISO-Name des Landes (z.B. DEU)

    • euMemberboolean

      required

      true wenn dieses Land EU-Mitglied ist

    • nameobject

      required
      • destring

        required

        Deutscher Name

      • enstring

        required

        Englischer Name

• contactobject

  required
  • telephonestring

    required
  • faxstring
  • emailstring (email)

    required

Beispiel

{
  "firstName": "string",
  "lastName": "string",
  "title": "string",
  "salutation": "string",
  "company": "string",
  "address": {
    "street": "string",
    "houseNumber": "string",
    "zip": "string",
    "city": "string",
    "country": {
      "isoShort": "string",
      "isoLong": "string",
      "euMember": true,
      "name": {
        "de": "string",
        "en": "string"
      }
    }
  },
  "contact": {
    "telephone": "string",
    "fax": "string",
    "email": "email@mittwald.example"
  }
}

JSON Schema

{
  "title": "CustomerPartner",
  "required": [
    "address",
    "contact",
    "firstName",
    "lastName",
    "salutation"
  ],
  "type": "object",
  "properties": {
    "firstName": {
      "type": "string",
      "description": "Vorname"
    },
    "lastName": {
      "type": "string",
      "description": "Nachname"
    },
    "title": {
      "type": "string",
      "description": "(Akademischer) grad"
    },
    "salutation": {
      "type": "string",
      "description": "Grußformel, z.B. *Herr* oder *Frau*"
    },
    "company": {
      "type": "string",
      "description": "Firmenname, oder `null`"
    },
    "address": {
      "title": "CustomerAddress",
      "required": [
        "city",
        "country",
        "houseNumber",
        "street",
        "zip"
      ],
      "type": "object",
      "properties": {
        "street": {
          "type": "string",
          "description": "Straße"
        },
        "houseNumber": {
          "type": "string",
          "description": "Hausnummer"
        },
        "zip": {
          "type": "string",
          "description": "PLZ"
        },
        "city": {
          "type": "string",
          "description": "Stadt"
        },
        "country": {
          "title": "Country",
          "required": [
            "euMember",
            "isoLong",
            "isoShort",
            "name"
          ],
          "type": "object",
          "properties": {
            "isoShort": {
              "type": "string",
              "description": "2-Zeichen-ISO-Name des Landes (z.B. `DE`)"
            },
            "isoLong": {
              "type": "string",
              "description": "Langer ISO-Name des Landes (z.B. `DEU`)",
              "readOnly": true
            },
            "euMember": {
              "type": "boolean",
              "description": "`true` wenn dieses Land EU-Mitglied ist",
              "readOnly": true
            },
            "name": {
              "required": [
                "de",
                "en"
              ],
              "type": "object",
              "properties": {
                "de": {
                  "type": "string",
                  "description": "Deutscher Name",
                  "readOnly": true
                },
                "en": {
                  "type": "string",
                  "description": "Englischer Name",
                  "readOnly": true
                }
              },
              "readOnly": true
            }
          }
        }
      }
    },
    "contact": {
      "title": "CustomerContactData",
      "required": [
        "email",
        "telephone"
      ],
      "type": "object",
      "properties": {
        "telephone": {
          "type": "string"
        },
        "fax": {
          "type": "string"
        },
        "email": {
          "type": "string",
          "format": "email"
        }
      }
    }
  }
}

Usage examples

cURL

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