Curosa
Supplier Portal API Reference New

Fulfilment

Inventar

Rufen Sie Fabriklagerbestände und Zuweisungen für Ihre Produkte ab

Übersicht

Der Inventory-Endpunkt ermöglicht es Ihnen, Informationen über den Fabriklagerbestand für Ihre Produkte abzurufen. Der Fabriklagerbestand repräsentiert den Bestand, der in Ihrer Fertigungsstätte oder Ihrem Lager verfügbar ist, bevor er bestimmten Vertriebszentren oder Aufträgen zugewiesen wurde. Dieser Endpunkt bietet Einblick in Ihre Gesamtbestandsmengen, reservierten Mengen und freien (verfügbaren) Mengen.

Bestandsmengen verstehen

  • Lagerbestand (Stock Quantity): Gesamtbestand, der in Ihrer Fabrik/Ihrem Lager verfügbar ist
  • Reservierte Menge (Allocated Quantity): Bestand, der für bestimmte Aufträge reserviert oder zugewiesen wurde
  • Freie Menge (Free Quantity): Verfügbarer Bestand, der zugewiesen werden kann (stock_quantity - stock_quantity_allocated)

Verwenden Sie diesen Endpunkt, um Ihre Fabriklagerbestände zu überwachen und Produkte zu identifizieren, die nachbestellt werden müssen oder bei denen überschüssiger Bestand für eine Zuweisung verfügbar ist.

Authentifizierung

Dieser Endpunkt erfordert eine Authentifizierung. Geben Sie Ihr API-Token im Authorization-Header an. Weitere Informationen zum Erhalt eines Tokens finden Sie im Authentifizierungsleitfaden.

Fabriklagerbestand auflisten

Rufen Sie eine Liste aller Fabriklagerbestände für Ihre Produkte ab.

Anfrage

curl --location 'https://curosa.com/api/v1/factory-stocks' \
--header 'Authorization: Bearer YOUR_API_TOKEN'

Optionale Abfrageparameter

Sie können den Fabriklagerbestand mithilfe der folgenden Abfrageparameter nach Mengenbereichen filtern:

  • stock_quantity_gte (Integer, optional): Filtert nach Produkten mit einem Lagerbestand größer als oder gleich diesem Wert
  • stock_quantity_lte (Integer, optional): Filtert nach Produkten mit einem Lagerbestand kleiner als oder gleich diesem Wert
  • stock_quantity_allocated_gte (Integer, optional): Filtert nach Produkten mit einer reservierten Bestandsmenge größer als oder gleich diesem Wert
  • stock_quantity_allocated_lte (Integer, optional): Filtert nach Produkten mit einer reservierten Bestandsmenge kleiner als oder gleich diesem Wert

Beispiel mit Filtern:

curl --location 'https://curosa.com/api/v1/factory-stocks?stock_quantity_gte=10&stock_quantity_lte=100' \
--header 'Authorization: Bearer YOUR_API_TOKEN'

Antwort

Alle Antworten werden im JSON-Format zurückgegeben:

{
    "data": [
        {
            "sku": "T3272P287613",
            "platform_sku": "367.983.903",
            "stock_quantity": 150,
            "stock_quantity_allocated": 0,
            "stock_quantity_free": 150
        },
        {
            "sku": "T3272P355456",
            "platform_sku": "107.871.472",
            "stock_quantity": 0,
            "stock_quantity_allocated": 0,
            "stock_quantity_free": 0
        }
    ],
    "links": {
        "first": null,
        "last": null,
        "prev": null,
        "next": "https://curosa.com/api/v1/factory-stocks?cursor=eyJmYWN0b3J5X3N0b2Nrcy5pZCI6MiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ"
    },
    "meta": {
        "path": "https://curosa.com/api/v1/factory-stocks",
        "per_page": 2500,
        "next_cursor": "eyJmYWN0b3J5X3N0b2Nrcy5pZCI6MiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ",
        "prev_cursor": null
    }
}

Antwortfelder:

  • sku (String): Ihre interne SKU-Kennung für das Produkt
  • platform_sku (String): Die Curosa-Plattform-SKU-Kennung für das Produkt
  • stock_quantity (Integer): Der gesamte in der Fabrik verfügbare Lagerbestand
  • stock_quantity_allocated (Integer): Die Menge, die Aufträgen oder Vertriebszentren zugewiesen wurde
  • stock_quantity_free (Integer): Die Menge, die frei und für eine Zuweisung verfügbar ist (berechnet als stock_quantity - stock_quantity_allocated)

Paginierung:

Dieser Endpunkt verwendet eine Cursor-basierte Paginierung. Die Antwort enthält:

  • links: Navigationslinks für die Paginierung (first, last, prev, next)
  • meta: Metadaten zur Paginierung
    • path: Der Basispfad für diesen Endpunkt
    • per_page: Anzahl der Elemente pro Seite (Standard ist 2500)
    • next_cursor: Cursor-Token für die nächste Seite (zur Verwendung im Abfrageparameter cursor)
    • prev_cursor: Cursor-Token für die vorherige Seite (zur Verwendung im Abfrageparameter cursor)

Um die nächste Seite abzurufen, geben Sie den Abfrageparameter cursor mit dem Wert aus meta.next_cursor an:

curl --location 'https://curosa.com/api/v1/factory-stocks?cursor=eyJmYWN0b3J5X3N0b2Nrcy5pZCI6MiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ' \
--header 'Authorization: Bearer YOUR_API_TOKEN'

Fabriklagerbestand aktualisieren

Aktualisieren Sie die Fabriklagerbestandsmenge für ein einzelnes Produkt durch Angabe der SKU und der neuen Bestandsmenge.

Anfrage

curl --location 'https://curosa.com/api/v1/factory-stocks' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
    "sku": "ABC123",
    "stock_quantity": 10
  }'

Felder im Anfrage-Body:

  • sku (String, erforderlich): Ihre interne SKU-Kennung für das Produkt
  • stock_quantity (Integer, erforderlich): Die neue Gesamtbestandsmenge, die für dieses Produkt festgelegt werden soll

Antwort

Die Antwort enthält sowohl erfolgreich aktualisierte Elemente als auch aufgetretene Fehler:

{
    "updated": [
        {
            "platform_sku": "880.033.390",
            "sku": "ABC123",
            "stock_quantity": 10
        }
    ],
    "errors": []
}

Antwortfelder:

  • updated (Array): Array der erfolgreich aktualisierten Bestandselemente
    • platform_sku (String): Die Curosa-Plattform-SKU-Kennung
    • sku (String): Ihre interne SKU-Kennung
    • stock_quantity (Integer): Die aktualisierte Bestandsmenge
  • errors (Array): Array von Elementen, bei denen die Aktualisierung fehlgeschlagen ist, falls vorhanden
    • platform_sku (String|null): Die Plattform-SKU, falls gefunden, andernfalls null
    • sku (String): Ihre interne SKU-Kennung, die fehlgeschlagen ist
    • stock_quantity (Integer|null): Die angeforderte Bestandsmenge oder null, falls das Produkt nicht gefunden wurde
    • error (String): Fehlermeldung, die beschreibt, warum die Aktualisierung fehlgeschlagen ist (z. B. "Produkt nicht gefunden")

Beispiel mit Fehler:

{
    "updated": [],
    "errors": [
        {
            "platform_sku": null,
            "sku": "ABC1234",
            "stock_quantity": null,
            "error": "Product not found"
        }
    ]
}

Massenaktualisierung von Fabriklagerbeständen

Aktualisieren Sie die Fabriklagerbestandsmengen für mehrere Produkte in einer einzigen Anfrage. Dies ist effizienter als einzelne Aktualisierungsanfragen für jedes Produkt zu stellen.

Anfrage

curl --location 'https://curosa.com/api/v1/factory-stocks/bulk-update' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data '[
    {
        "sku": "ABC123",
        "stock_quantity": 10
    },
    {
        "sku": "DEF456",
        "stock_quantity": 25
    },
    {
        "sku": "GHI789",
        "stock_quantity": 5
    }
  ]'

Anfrage-Body:

Der Anfrage-Body ist ein Array von Objekten, die jeweils enthalten:

  • sku (String, erforderlich): Ihre interne SKU-Kennung für das Produkt
  • stock_quantity (Integer, erforderlich): Die neue Gesamtbestandsmenge, die für dieses Produkt festgelegt werden soll

Antwort

Die Antwort enthält sowohl erfolgreich aktualisierte Elemente als auch alle aufgetretenen Fehler. Die Elemente werden unabhängig voneinander verarbeitet, sodass einige erfolgreich sein können, während andere fehlschlagen:

{
    "updated": [
        {
            "platform_sku": "880.033.390",
            "sku": "ABC123",
            "stock_quantity": 10
        },
        {
            "platform_sku": "574.478.508",
            "sku": "DEF456",
            "stock_quantity": 25
        }
    ],
    "errors": [
        {
            "platform_sku": null,
            "sku": "GHI789",
            "stock_quantity": null,
            "error": "Product not found"
        }
    ]
}

Antwortfelder:

  • updated (Array): Array der erfolgreich aktualisierten Bestandselemente
    • platform_sku (String): Die Curosa-Plattform-SKU-Kennung
    • sku (String): Ihre interne SKU-Kennung
    • stock_quantity (Integer): Die aktualisierte Bestandsmenge
  • errors (Array): Array der Elemente, bei denen die Aktualisierung fehlgeschlagen ist
    • platform_sku (String|null): Die Plattform-SKU, falls gefunden, andernfalls null
    • sku (String): Ihre interne SKU-Kennung, die fehlgeschlagen ist
    • stock_quantity (Integer|null): Die angeforderte Bestandsmenge oder null, falls das Produkt nicht gefunden wurde
    • error (String): Fehlermeldung, die beschreibt, warum die Aktualisierung fehlgeschlagen ist

Wichtige Hinweise:

  • Jedes Element in der Massenaktualisierung wird unabhängig verarbeitet. Wenn ein Element fehlschlägt, können andere dennoch erfolgreich sein.
  • Die Arrays updated und errors enthalten die Ergebnisse für alle Elemente in Ihrer Anfrage.
  • Überprüfen Sie immer das Array errors, um Produkte zu identifizieren, die nicht aktualisiert werden konnten.
  • Verwenden Sie Massenaktualisierungen, wenn Sie mehrere Produkte gleichzeitig aktualisieren möchten, um die Anzahl der API-Aufrufe zu reduzieren und die Leistung zu verbessern.

Ratenbegrenzung (Rate Limiting)

Die Endpunkte für den Fabriklagerbestand sind auf 3.600 Anfragen pro Stunde begrenzt. Das aktuelle Limit und die verbleibenden Anfragen werden in den Antwort-Headern als x-ratelimit-limit und x-ratelimit-remaining zurückgegeben.