Bestellung freigeben oder ablehnen

cURL

curl --request POST \
  --url 'https://api.jobhandy.io/v1/orders/ORDER_ID/decision?dryRun=true' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --data '{"decision":"approved"}'

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({decision: 'approved'})
};

fetch('https://api.jobhandy.io/v1/orders/{id}/decision', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.jobhandy.io/v1/orders/{id}/decision"

payload = { "decision": "approved" }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.jobhandy.io/v1/orders/{id}/decision");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-API-Key", "<api-key>");
request.AddJsonBody("{\n  \"decision\": \"approved\"\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

$headers=@{}
$headers.Add("X-API-Key", "<api-key>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://api.jobhandy.io/v1/orders/{id}/decision' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
  "decision": "approved"
}'

{
  "id": "69eb125feddfff1d13676751",
  "status": "approved",
  "employee": "68a000000000000000000001",
  "orderNumber": 10495,
  "createdAt": "2026-07-01T10:00:00.000Z",
  "updatedAt": "2026-07-02T12:15:00.000Z",
  "products": [
    {
      "id": "69eb125feddfff1d13676761",
      "label": "Example Smartphone, 256 GB, Black, New",
      "model": "Example Smartphone",
      "vatRate": "19.00",
      "manufacturerName": "Example Manufacturer",
      "articleGroupName": "smartphones",
      "grossAmount": "34.99",
      "netAmount": "29.4034",
      "service": false,
      "grossService": null,
      "netService": null,
      "isAccessory": false
    },
    {
      "id": "69eb125feddfff1d13676762",
      "label": "Example Protective Case",
      "model": "Example Protective Case",
      "vatRate": "19.00",
      "manufacturerName": "Example Manufacturer",
      "articleGroupName": "accessories",
      "grossAmount": "3.99",
      "netAmount": "3.3529",
      "service": null,
      "grossService": null,
      "netService": null,
      "isAccessory": true
    }
  ],
  "deliveryAddress": {
    "firstName": "Alex",
    "lastName": "Morgan",
    "street": "Example Street 12",
    "postalCode": "50667",
    "city": "Cologne",
    "countryCode": "DE"
  },
  "contractDurationInMonths": 24,
  "contractStartDate": "2026-08-01T00:00:00.000Z",
  "contractEndDate": "2028-07-31T23:59:59.999Z",
  "attachments": [
    {
      "id": "contract.10495.1",
      "type": "nuev"
    },
    {
      "id": "contract.10495.2",
      "type": "emv"
    }
  ],
  "hrHistory": {
    "approvedBy": null,
    "approvedAt": "2026-07-02T12:15:00.000Z",
    "rejectedBy": null,
    "rejectedAt": null,
    "requestedAt": "2026-07-01T10:00:00.000Z",
    "decisionBy": null
  }
}

POST

https://api.jobhandy.io/v1

orders

{id}

decision

cURL

curl --request POST \
  --url 'https://api.jobhandy.io/v1/orders/ORDER_ID/decision?dryRun=true' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --data '{"decision":"approved"}'

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({decision: 'approved'})
};

fetch('https://api.jobhandy.io/v1/orders/{id}/decision', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.jobhandy.io/v1/orders/{id}/decision"

payload = { "decision": "approved" }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.jobhandy.io/v1/orders/{id}/decision");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-API-Key", "<api-key>");
request.AddJsonBody("{\n  \"decision\": \"approved\"\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

$headers=@{}
$headers.Add("X-API-Key", "<api-key>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://api.jobhandy.io/v1/orders/{id}/decision' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
  "decision": "approved"
}'

{
  "id": "69eb125feddfff1d13676751",
  "status": "approved",
  "employee": "68a000000000000000000001",
  "orderNumber": 10495,
  "createdAt": "2026-07-01T10:00:00.000Z",
  "updatedAt": "2026-07-02T12:15:00.000Z",
  "products": [
    {
      "id": "69eb125feddfff1d13676761",
      "label": "Example Smartphone, 256 GB, Black, New",
      "model": "Example Smartphone",
      "vatRate": "19.00",
      "manufacturerName": "Example Manufacturer",
      "articleGroupName": "smartphones",
      "grossAmount": "34.99",
      "netAmount": "29.4034",
      "service": false,
      "grossService": null,
      "netService": null,
      "isAccessory": false
    },
    {
      "id": "69eb125feddfff1d13676762",
      "label": "Example Protective Case",
      "model": "Example Protective Case",
      "vatRate": "19.00",
      "manufacturerName": "Example Manufacturer",
      "articleGroupName": "accessories",
      "grossAmount": "3.99",
      "netAmount": "3.3529",
      "service": null,
      "grossService": null,
      "netService": null,
      "isAccessory": true
    }
  ],
  "deliveryAddress": {
    "firstName": "Alex",
    "lastName": "Morgan",
    "street": "Example Street 12",
    "postalCode": "50667",
    "city": "Cologne",
    "countryCode": "DE"
  },
  "contractDurationInMonths": 24,
  "contractStartDate": "2026-08-01T00:00:00.000Z",
  "contractEndDate": "2028-07-31T23:59:59.999Z",
  "attachments": [
    {
      "id": "contract.10495.1",
      "type": "nuev"
    },
    {
      "id": "contract.10495.2",
      "type": "emv"
    }
  ],
  "hrHistory": {
    "approvedBy": null,
    "approvedAt": "2026-07-02T12:15:00.000Z",
    "rejectedBy": null,
    "rejectedAt": null,
    "requestedAt": "2026-07-01T10:00:00.000Z",
    "decisionBy": null
  }
}

Auf einen Blick

Eigenschaft	Verhalten
Authentifizierung	Erforderlich in `X-API-Key`
Tenant-Kontext	Optionale Einschränkung; Ressource und Referenzen müssen im Scope bleiben
Dry Run	Unterstützt mit `dryRun=true`
Request-Body	`application/json`; geschlossenes Schema; maximal dokumentierte Body-Größe 5 MiB
Response	JSON
Primärer Erfolg	`200`
Side Effects	Wendet die HR-Entscheidung an und löst die zugehörigen Benachrichtigungen aus; Dry Run unterdrückt beides
Retry-Empfehlung	Bestellung erneut lesen; eine finale Entscheidung kann bereits angewendet worden sein

Betriebsverhalten

Gibt eine Bestellung in HR-Prüfung frei oder lehnt sie ab. Eine Freigabe wendet die dokumentierten Standardwerte für Vertragsdaten an und sendet die entsprechenden Benachrichtigungen. Mit dryRun=true gibt die API die projizierte Bestellung zurück, ohne die Entscheidung anzuwenden oder Benachrichtigungen zu senden.

Nur eine Bestellung im Status under_review ist für diese öffentliche Decision-Operation zulässig.
Eine finale Entscheidung kann über diesen Endpoint nicht überschrieben werden.
Lesen Sie die Bestellung nach einem Timeout erneut, bevor Sie einen Retry erwägen.

Häufige Fehler

Fehlercode	Bedeutung
`VALIDATION_ERROR`	Schema- oder fachliche Validierung ist fehlgeschlagen
`INVALID_REQUEST_ID`	`X-Request-ID` ist keine UUID v4 oder v7
`INVALID_API_KEY`	API-Key fehlt, ist ungültig, gelöscht oder inaktiv
`TENANT_NOT_IN_SCOPE`	Ausgewählter Tenant liegt außerhalb des API-Key-Scopes
`NOT_FOUND`	Ressource fehlt oder ist im Scope nicht zugänglich
`NOT_ACCEPTABLE`	Angeforderter Response-Medientyp ist nicht verfügbar
`ORDER_ALREADY_DECIDED`	Bestellung besitzt bereits eine finale HR-Entscheidung
`INVALID_STATE_TRANSITION`	Aktueller Lifecycle-Status erlaubt die Anfrage nicht
`PAYLOAD_TOO_LARGE`	Vollständiger Request überschreitet das dokumentierte Limit
`UNSUPPORTED_MEDIA_TYPE`	Request-Medientyp wird nicht akzeptiert
`RATE_LIMIT_EXCEEDED`	Rate Limit des API-Keys wurde überschritten
`INTERNAL_SERVER_ERROR`	Unerwarteter Serverfehler

Die Response-Liste der Operation und die Seite Fehlerbehandlung sind für die vollständige Behandlung maßgeblich.

Vor der Implementierung

Erzeugen und protokollieren Sie für den Versuch eine neue X-Request-ID.
Behandeln Sie jeden dokumentierten Response-Status.
Protokollieren Sie weder X-API-Key noch unnötige personenbezogene Daten.
Gleichen Sie den aktuellen Ressourcenstatus ab, bevor Sie einen mehrdeutigen Write wiederholen.

Zugehöriger Integrationsleitfaden

Prüfen Sie den vollständigen Prozess sowie Status-, Retry- und Betriebsmuster für diese Operation.

Autorisierungen

X-API-Key

string

header

erforderlich

JobHandy integration API key. Send the credential in the X-API-Key header. Treat the key as a secret and use it only from trusted server-side environments.

Header

X-Tenant-ID

string

inactive

optional

not sent by default

Narrows the operation to one tenant in the API key's scope. Any referenced or target resource must be accessible through that tenant. In interactive clients, use the {{tenantId}} variable when a tenant must be selected. Keep the header disabled when tenant selection is not required.

Pattern: ^[0-9a-fA-F]{24}$

X-Request-ID

string<uuid>

inactive

optional

not sent by default

Optional request identifier. If supplied, it must be a UUID v4 or v7 and is returned unchanged in every response. If omitted, the API generates one. Invalid values return 400 INVALID_REQUEST_ID. If your client uses a {{requestId}} variable, refresh it with a new UUID version 4 or 7 for every HTTP request attempt. Keep the header disabled to let the API generate the request identifier.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[47][0-9a-fA-F]{3}-[89aAbB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

Pfadparameter

string

erforderlich

Order ID.

Pattern: ^[0-9a-fA-F]{24}$

Beispiel:

"69eb125feddfff1d13676751"

Abfrageparameter

dryRun

boolean

inactive

optional

server default: false

not sent by default

When true, the API validates the request without applying the change. The operation's responses specify the returned representation. When omitted, the server uses false.

Beispiel:

true

Body

application/json

The JSON request body must not exceed 5,242,880 bytes.

Approval or rejection to record for an order under HR review.

decision

enum<string>

erforderlich

Target decision. Values are case-sensitive.

Verfügbare Optionen:

approved,

rejected

Minimum string length: 1

Antwort

Returns the decided order, or the projected order when dryRun=true.

Order details.

string

erforderlich

read-only

Unique order identifier.

Pattern: ^[0-9a-fA-F]{24}$

Beispiel:

"69eb125feddfff1d13676751"

status

enum<string>

erforderlich

read-only

Current order lifecycle status. Values are case-sensitive.

Verfügbare Optionen:

under_review,

rejected,

approved,

active,

archived,

withdrawn

Minimum string length: 1

Beispiel:

"approved"

employee

string

erforderlich

Identifier of the employee who placed or owns the order.

Pattern: ^[0-9a-fA-F]{24}$

Beispiel:

"68a000000000000000000001"

orderNumber

integer

erforderlich

read-only

Human-readable numeric order number.

Muss ein Vielfaches sein von 1

Beispiel:

10495

createdAt

string<date-time>

erforderlich

read-only

UTC timestamp at which the order was created.

Minimum string length: 1

Pattern: Z$

Beispiel:

"2026-07-01T10:00:00.000Z"

updatedAt

string<date-time>

erforderlich

read-only

UTC timestamp of the latest order update.

Minimum string length: 1

Pattern: Z$

Beispiel:

"2026-07-02T12:15:00.000Z"

products

object[]

erforderlich

Products and accessories included in the order.

Show child attributes

deliveryAddress

object | null

erforderlich

nullable

Delivery address for the order, or null when no delivery address is available.

Show child attributes

Beispiel:

{
  "firstName": "Alex",
  "lastName": "Morgan",
  "street": "Example Street 12",
  "postalCode": "50667",
  "city": "Cologne",
  "countryCode": "DE"
}

hrHistory

object

erforderlich

HR review request and decision history.

Show child attributes

Beispiel:

{
  "approvedBy": null,
  "approvedAt": "2026-07-02T12:15:00.000Z",
  "rejectedBy": null,
  "rejectedAt": null,
  "requestedAt": "2026-07-01T10:05:00.000Z",
  "decisionBy": null
}

contractDurationInMonths

number | null

erforderlich

nullable

Contract duration in whole months, or null when not determined.

Muss ein Vielfaches sein von 1

Beispiel:

24

contractStartDate

string<date-time> | null

erforderlich

nullable

UTC contract start date, or null when not determined.

Minimum string length: 1

Pattern: Z$

Beispiel:

"2026-08-01T00:00:00.000Z"

contractEndDate

string<date-time> | null

erforderlich

nullable

UTC contract end date, or null when not determined.

Minimum string length: 1

Pattern: Z$

Beispiel:

"2028-07-31T23:59:59.999Z"

attachments

object[]

erforderlich

Order contract documents available through the order attachment download endpoint.

Show child attributes

Zuletzt geändert am 27. August 2026

Übersicht

Datenmodelle

Spezifikation

Bestellung freigeben oder ablehnen

Auf einen Blick

Betriebsverhalten

Häufige Fehler

Vor der Implementierung

Zugehöriger Integrationsleitfaden

Autorisierungen

Header

Pfadparameter

Abfrageparameter

Body

Antwort

​Auf einen Blick

​Betriebsverhalten

​Häufige Fehler

​Vor der Implementierung

Zugehöriger Integrationsleitfaden

Autorisierungen

Header

Pfadparameter

Abfrageparameter

Body

Antwort

Auf einen Blick

Betriebsverhalten

Häufige Fehler

Vor der Implementierung