offerAPI-Referenz

GET/v2/offer/list/export

Angebote für einen Zeitraum exportieren

Erstellt einen Angebotsgesamt-Export im gewählten Konto. from und to müssen mit PHP strtotime parsebare Zeitwerte sein und to muss nach from liegen; format wählt csv, xls, xlsx oder ods. Es werden Angebote mit Angebotsbeginn strikt nach from und strikt vor to berücksichtigt; dies ist keine Überschneidungssuche über Beginn und Ende. filter, fields und die generische Listenpaginierung werden für diesen Export nicht verwendet.

Operation-ID get_v2_offer_list_export

Vertrag & Verhalten

Dokumentationsstand: reviewed
Ändert Zustand: Nein
Als readOnly markiert: Ja
Für Automation markiert: Ja

GET-Verhalten laut Spezifikation

read

Authentifizierung

Eine der folgenden Alternativen muss erfüllt sein (ODER). Innerhalb jeder Alternative werden alle angegebenen Schemas gemeinsam benötigt (UND).

Alternative 1

bearerAuthhttp · bearer

Existing edoobox v2 access token. Never substitute API key/secret headers.

Format: JWT

Security-Schema als JSON

{
  "type": "http",
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "description": "Existing edoobox v2 access token. Never substitute API key/secret headers."
}

accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Alternative 2

sessionCookieapiKey

Existing browser login session, with the same permission checks as Bearer authentication.

cookie: _edlogin

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "cookie",
  "name": "_edlogin",
  "description": "Existing browser login session, with the same permission checks as Bearer authentication."
}

accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Berechtigungen

Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope.

Ressource: offer · offe
Levels: 1, 3, 4
Dispatcher-Prüfung: Ja

Parameter

Header

languageoptional

Account language code, where the resource supports setLanguage().

string

Schema-Beispiel

"de"

Vollständiges Schema als JSON

{
  "type": "string",
  "examples": [
    "de"
  ]
}

Query-Parameter

fromerforderlich

Parsebarer Zeitwert; nur Angebote mit Beginn strikt nach from werden exportiert.

string

Vollständiges Schema als JSON

{
  "type": "string"
}

Beispiel

"2026-11-01T00:00:00+01:00"

toerforderlich

Parsebarer Zeitwert nach from; nur Angebote mit Beginn strikt vor to werden exportiert.

string

Vollständiges Schema als JSON

{
  "type": "string"
}

Beispiel

"2026-12-01T00:00:00+01:00"

formaterforderlich

Format der erzeugten Exportdatei.

string

Erlaubte Werte

"csv""xls""xlsx""ods"

Vollständiges Schema als JSON

{
  "type": "string",
  "enum": [
    "csv",
    "xls",
    "xlsx",
    "ods"
  ]
}

Beispiel

"csv"

Request Body

Kein Request Body in der Spezifikation beschrieben.

Antworten

HTTP-Status und Antwortinhalt gemeinsam auswerten. In dieser API können auch Antworten mit HTTP 200 einen Fehler enthalten.

200text/csv · application/vnd.ms-excel · application/vnd.openxmlformats-officedocument.spreadsheetml.sheet · application/vnd.oasis.opendocument.spreadsheet

Generated spreadsheet download. CSV output can include a UTF-8 BOM.

Response Header

`text/csv`

string

Vollständiges Schema als JSON

{
  "type": "string"
}

Beispiel

"Name;Number\nExample;EXAMPLE-2026\n"

`application/vnd.ms-excel`

string

format: "binary"

Vollständiges Schema als JSON

{
  "type": "string",
  "format": "binary"
}

`application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`

string

format: "binary"

Vollständiges Schema als JSON

{
  "type": "string",
  "format": "binary"
}

`application/vnd.oasis.opendocument.spreadsheet`

string

format: "binary"

Vollständiges Schema als JSON

{
  "type": "string",
  "format": "binary"
}

402application/json

Missing/invalid from, to, or format; response require map identifies invalid fields.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80100",
  "require": {
    "from": false,
    "to": false,
    "format": false
  }
}

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Offer.php:1014getOffer()

Diese Angaben stammen unverändert aus der gelieferten OpenAPI-Datei. Zusätzliche Freigaben, Vorbedingungen, sensible Felder und Hinweise stehen in den Erweiterungen.

x-edoobox-mutates-state

false

x-edoobox-mutationReview

{
  "source": {
    "file": "application/libraries/edoobox/integrations/export/Export.php",
    "line": 127
  },
  "reason": "Allowed formats are streamed to php://output; persistent xlsxFile mode is not accepted here."
}

x-edoobox-runtimeMutationGuard

false

x-edoobox-get-effect

"read"

x-edoobox-documentationReview

{
  "file": "docs/openapi/operation-contracts/03-offers-places.json",
  "notes": []
}

x-edoobox-source

{
  "file": "application/models/v2/Offer.php",
  "method": "getOffer",
  "line": 1014
}

x-edoobox-documentationStatus

"reviewed"

x-edoobox-readOnly

true

x-edoobox-safeForAutomation

true

x-edoobox-permission

{
  "resource": "offer",
  "short": "offe",
  "checkedByDispatcher": true,
  "levels": [
    1,
    3,
    4
  ],
  "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
}

Vollständige Operation als JSON

{
  "operationId": "get_v2_offer_list_export",
  "summary": "Angebote für einen Zeitraum exportieren",
  "description": "Erstellt einen Angebotsgesamt-Export im gewählten Konto. from und to müssen mit PHP strtotime parsebare Zeitwerte sein und to muss nach from liegen; format wählt csv, xls, xlsx oder ods. Es werden Angebote mit Angebotsbeginn strikt nach from und strikt vor to berücksichtigt; dies ist keine Überschneidungssuche über Beginn und Ende. filter, fields und die generische Listenpaginierung werden für diesen Export nicht verwendet.",
  "tags": [
    "offer"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "language",
      "in": "header",
      "required": false,
      "description": "Account language code, where the resource supports setLanguage().",
      "schema": {
        "type": "string",
        "examples": [
          "de"
        ]
      }
    },
    {
      "name": "from",
      "in": "query",
      "required": true,
      "description": "Parsebarer Zeitwert; nur Angebote mit Beginn strikt nach from werden exportiert.",
      "schema": {
        "type": "string"
      },
      "example": "2026-11-01T00:00:00+01:00"
    },
    {
      "name": "to",
      "in": "query",
      "required": true,
      "description": "Parsebarer Zeitwert nach from; nur Angebote mit Beginn strikt vor to werden exportiert.",
      "schema": {
        "type": "string"
      },
      "example": "2026-12-01T00:00:00+01:00"
    },
    {
      "name": "format",
      "in": "query",
      "required": true,
      "description": "Format der erzeugten Exportdatei.",
      "schema": {
        "type": "string",
        "enum": [
          "csv",
          "xls",
          "xlsx",
          "ods"
        ]
      },
      "example": "csv"
    }
  ],
  "responses": {
    "200": {
      "description": "Generated spreadsheet download. CSV output can include a UTF-8 BOM.",
      "headers": {
        "Content-Disposition": {
          "schema": {
            "type": "string"
          },
          "example": "attachment; filename=\"Export.csv\""
        }
      },
      "content": {
        "text/csv": {
          "schema": {
            "type": "string"
          },
          "example": "Name;Number\nExample;EXAMPLE-2026\n"
        },
        "application/vnd.ms-excel": {
          "schema": {
            "type": "string",
            "format": "binary"
          }
        },
        "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
          "schema": {
            "type": "string",
            "format": "binary"
          }
        },
        "application/vnd.oasis.opendocument.spreadsheet": {
          "schema": {
            "type": "string",
            "format": "binary"
          }
        }
      }
    },
    "402": {
      "description": "Missing/invalid from, to, or format; response require map identifies invalid fields.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80100",
            "require": {
              "from": false,
              "to": false,
              "format": false
            }
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": false,
  "x-edoobox-mutationReview": {
    "source": {
      "file": "application/libraries/edoobox/integrations/export/Export.php",
      "line": 127
    },
    "reason": "Allowed formats are streamed to php://output; persistent xlsxFile mode is not accepted here."
  },
  "x-edoobox-runtimeMutationGuard": false,
  "x-edoobox-get-effect": "read",
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/03-offers-places.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Offer.php",
    "method": "getOffer",
    "line": 1014
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": true,
  "x-edoobox-safeForAutomation": true,
  "x-edoobox-permission": {
    "resource": "offer",
    "short": "offe",
    "checkedByDispatcher": true,
    "levels": [
      1,
      3,
      4
    ],
    "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
  }
}

Aufruf vorbereiten

Beispiel

Platzhalter ersetzen und Vertragsangaben prüfen. Die Beispiele werden hier nicht ausgeführt.

cURL

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
: "${API_ORIGIN:?API_ORIGIN setzen}"
: "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}"
: "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}"
: "${QUERY_FROM:?QUERY_FROM setzen}"
: "${QUERY_TO:?QUERY_TO setzen}"
: "${QUERY_FORMAT:?QUERY_FORMAT setzen}"
curl --request 'GET' \
  --url "${API_ORIGIN%/}"'/v2/offer/list/export' \
  --url-query 'from='"${QUERY_FROM}" \
  --url-query 'to='"${QUERY_TO}" \
  --url-query 'format='"${QUERY_FORMAT}" \
  --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \
  --header 'edid: '"${AUTH_ACCOUNTCONTEXT}"

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/offer/list/export";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
url.searchParams.append("from", required("QUERY_FROM"));
url.searchParams.append("to", required("QUERY_TO"));
url.searchParams.append("format", required("QUERY_FORMAT"));
const headers = {};
headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH");
headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT");
const response = await fetch(url, { method: "GET", headers, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/offer/list/export"
url = os.environ["API_ORIGIN"].rstrip("/") + path
url += "?" + urllib.parse.urlencode([("from", os.environ["QUERY_FROM"]), ("to", os.environ["QUERY_TO"]), ("format", os.environ["QUERY_FORMAT"])])
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="GET")
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Ohne JavaScript können Sie die weiteren Aufrufbeispiele hier aufklappen und den Code manuell kopieren.

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/offer/list/export";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
url.searchParams.append("from", required("QUERY_FROM"));
url.searchParams.append("to", required("QUERY_TO"));
url.searchParams.append("format", required("QUERY_FORMAT"));
const headers = {};
headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH");
headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT");
const response = await fetch(url, { method: "GET", headers, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/offer/list/export"
url = os.environ["API_ORIGIN"].rstrip("/") + path
url += "?" + urllib.parse.urlencode([("from", os.environ["QUERY_FROM"]), ("to", os.environ["QUERY_TO"]), ("format", os.environ["QUERY_FORMAT"])])
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="GET")
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Server aus der Spezifikation

https://app2.edoobox.com

edoobox API

Verwenden Sie die für Ihre Integration bestätigte API-Basis-URL. Ein lokaler Entwicklungsserver ist keine Produktionsadresse.

Als Markdown lesenEin Endpunkt. Vollständig. Für Menschen und LLM.