Über diese Operation kann ein neues Partnerbox bestellt werden.

Achtung: Ist der Nutzer der API als Kunde authentifiziert (d.h. ein API-Token über den /authenticate-Endpunkt bezogen hat), ist die erneute Angabe von Kundenstammdaten im Request (hier über das customer-Attribut) nicht notwendig. Dennoch übergebene Kundenstammdaten werden zugunsten der bereits im System hinterlegten ignoriert.

Request

POST https://api.mittwald.de/v1/orders/partnerbox

Request-Body

The request body takes a complete PartnerHostingOrderRequest resource, containing the following writable properties:

{
    "billing": {
        "vatRegNumber": "string"
    },
    "customer": {
        "city": "string",
        "company": "string",
        "country": "string",
        "emailAddress": "email",
        "firstName": "string",
        "houseNumber": "string",
        "lastName": "string",
        "phone": "string",
        "salutation": "string",
        "street": "string",
        "title": "string",
        "zip": "string"
    }
}

Properties

Name Typ Beschreibung Weiteres
billing object Billing Optional
billing.vatRegNumber string Optional
customer object HostingOrderCustomer Optional
customer.city string
customer.company string Optional
customer.country string

iso country short code (ISO 3166-1 alpha-2)

customer.emailAddress email
customer.firstName string
customer.houseNumber string
customer.lastName string
customer.phone string
customer.salutation string

Mögliche Werte sind:

  • Herr
  • Frau
  • Mr.
  • Ms.
customer.street string
customer.title string Optional
customer.zip string of integer

Response

Diese Operation kann mit den folgenden HTTP-Statuscodes antworten:

Statuscode Beschreibung Ressource
202 Accepted

Die Anfrage wurde zur Bearbeitung angenommen

400 Bad Request

Ungültige Anfrage. Dies kann beispielsweise geschehen, wenn die Anfrage ungültig codierte Inhalte enthält oder der Inhalt semantisch inkorrekt ist.

Error
403 Forbidden

Zugriff verweigert

Error
500 Internal Server Error

Bei der Verarbeitung der Anfrage ist ein Fehler aufgetreten.

Error

Explore this API

partnerHostingOrderRequest

Die Bestellanfrage; diese enthält notwendige Kundenstammdaten

Request Content-Type
Response Content-Type
Try it out!