Schémas de données: Stocks

Schémas de données: Stocks. Champs, types et contraintes des données acceptées ou renvoyées par l’API.

Schémas de données

Quantités affectées aux emplacements de stockage

AllocationData · Schéma · Schémas de données: Stocks

location_codeChaîneObligatoire: Code de l'emplacement de stockage.

Exemple: "example"
location_idChaîneObligatoire: Identifiant de l'emplacement de stockage.

Exemple: "example"
location_nameChaîneObligatoire: Nom de l'emplacement de stockage.

Exemple: "example"
on_handEntierObligatoire: Quantité physique en stock.

Exemple: 10

Champs supplémentaires: Non

Lister · Stocks — Stocks — Réponse

ApiResponse_list_StockData__ · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

dataTableau <StockData > Obligatoire: Exemple de réponse · ApiResponse_list_StockData__.

Exemple: [{"active":true,"available":5,"id":"stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ","manual_reserved":2,"on_hand":10,"reserved":3,"sellable_limit":10,"target_id":"example","target_type":"product","total_reserved":5,"updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoire: Métadonnées de la réponse.

Exemple: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Champs supplémentaires: Non

Obtenir · Stocks — Stocks — Réponse

ApiResponse_StockDetailData_ · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

dataStockDetailData Obligatoire: Exemple de réponse · StockDetailData.

Exemple: {"active":true,"allocations":[{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}],"available":5,"id":"stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ","manual_reserved":2,"on_hand":10,"reserved":3,"sellable_limit":10,"target_id":"example","target_type":"product","total_reserved":5,"updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoire: Métadonnées de la réponse.

Exemple: {"request_id":"example"}

Champs supplémentaires: Non

Modifier · Réservation manuelle — Stocks — Corps de la requête

ManualReservationUpdate · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

expected_versionEntierObligatoire: Version lue avant l'écriture ; une différence entraîne le rejet de la modification.

minimum: 1maximum: 9223372036854775807

Exemple: 1
manual_reservedEntierObligatoire: Quantité réservée manuellement.

minimum: 0maximum: 2147483647

Exemple: 1
reasonChaîneFacultatif: Motif enregistré pour la modification.

maxLength: 500

Valeur par défaut: ""

Champs supplémentaires: Non

Modifier · Limite de vente — Stocks — Corps de la requête

SalesLimitUpdate · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

expected_versionEntierObligatoire: Version lue avant l'écriture ; une différence entraîne le rejet de la modification.

minimum: 1maximum: 9223372036854775807

Exemple: 1
reasonChaîneFacultatif: Motif enregistré pour la modification.

maxLength: 500

Valeur par défaut: ""
sellable_limitEntierObligatoire: Limite de vente : -1 signifie illimitée et 0 empêche les ventes disponibles.

minimum: -1maximum: 2147483647

Exemple: 1

Champs supplémentaires: Non

Créer · Ajustement de stock — Stocks — Corps de la requête

StockAdjustmentCreate · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

expected_versionEntierObligatoire

Version lue avant l'écriture ; une différence entraîne le rejet de la modification.

minimum: 0maximum: 9223372036854775807

Exemple: 0

locationsTableau <LocationQuantity > Obligatoire

Emplacements de stockage.

minItems: 1maxItems: 100

Exemple: [{"location_id":"example","on_hand":1}]

reasonChaîneObligatoire

Motif enregistré pour la modification.

minLength: 1maxLength: 500

Exemple: "Example"

target_idChaîneObligatoire

Identifiant du produit ou de la variante concernée par l'opération.

Contraintes

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

Exemple: "example"

target_typeChaîneObligatoire

Indique si l'opération concerne un produit ou une variante.

Contraintes

enum: ["product", "variant"]

Exemple: "product"

warehouse_idChaîneObligatoire

Identifiant de l'entrepôt.

Contraintes

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

Exemple: "example"

Champs supplémentaires: Non

Modifier · Stocks — Stocks — Corps de la requête

StockAdjustmentUpdate · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

expected_versionEntierObligatoire: Version lue avant l'écriture ; une différence entraîne le rejet de la modification.

minimum: 1maximum: 9223372036854775807

Exemple: 1
locationsTableau <LocationQuantity > Obligatoire: Emplacements de stockage.

minItems: 1maxItems: 100

Exemple: [{"location_id":"example","on_hand":1}]
reasonChaîneObligatoire: Motif enregistré pour la modification.

minLength: 1maxLength: 500

Exemple: "Example"

Champs supplémentaires: Non

Lister · Stocks — Stocks — Réponse

StockData · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

activeBooléenObligatoire

Indique si la ressource est active.

Exemple: true

availableEntier nullObligatoire

Quantité disponible à la vente ; null signifie illimitée.

Exemple: 5

idChaîneObligatoire

Identifiant de ressource ; conserver la valeur renvoyée. (StockData).

Exemple: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedEntierObligatoire

Quantité réservée manuellement.

Exemple: 2

on_handEntierObligatoire

Quantité physique en stock.

Exemple: 10

reservedEntierObligatoire

Quantité réservée par les commandes.

Exemple: 3

sellable_limitEntierObligatoire

Limite de vente : -1 signifie illimitée et 0 empêche les ventes disponibles.

Exemple: 10

target_idChaîneObligatoire

Identifiant du produit ou de la variante concernée par l'opération.

Exemple: "example"

target_typeChaîneObligatoire

Indique si l'opération concerne un produit ou une variante.

Contraintes

enum: ["product", "variant"]

Exemple: "product"

total_reservedEntierObligatoire

Quantité totale réservée.

Exemple: 5

updated_atChaîneObligatoire

Date et heure de la dernière modification.

format: "date-time"

Exemple: "2026-01-01T12:00:00Z"

versionEntierObligatoire

Version de ressource utilisée pour le contrôle de concurrence.

Exemple: 1

warehouse_idChaîneObligatoire

Identifiant de l'entrepôt.

Exemple: "example"

Champs supplémentaires: Non

Obtenir · Stocks — Stocks — Réponse

StockDetailData · Champs, types et contraintes des données acceptées ou renvoyées par l’API.

activeBooléenObligatoire

Indique si la ressource est active.

Exemple: true

allocationsTableau <AllocationData > Obligatoire

Quantités affectées aux emplacements de stockage.

Exemple: [{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}]

availableEntier nullObligatoire

Quantité disponible à la vente ; null signifie illimitée.

Exemple: 5

idChaîneObligatoire

Identifiant de ressource ; conserver la valeur renvoyée. (StockDetailData).

Exemple: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedEntierObligatoire

Quantité réservée manuellement.

Exemple: 2

on_handEntierObligatoire

Quantité physique en stock.

Exemple: 10

reservedEntierObligatoire

Quantité réservée par les commandes.

Exemple: 3

sellable_limitEntierObligatoire

Limite de vente : -1 signifie illimitée et 0 empêche les ventes disponibles.

Exemple: 10

target_idChaîneObligatoire

Identifiant du produit ou de la variante concernée par l'opération.

Exemple: "example"

target_typeChaîneObligatoire

Indique si l'opération concerne un produit ou une variante.

Contraintes

enum: ["product", "variant"]

Exemple: "product"

total_reservedEntierObligatoire

Quantité totale réservée.

Exemple: 5

updated_atChaîneObligatoire

Date et heure de la dernière modification.

format: "date-time"

Exemple: "2026-01-01T12:00:00Z"

versionEntierObligatoire

Version de ressource utilisée pour le contrôle de concurrence.

Exemple: 1

warehouse_idChaîneObligatoire

Identifiant de l'entrepôt.

Exemple: "example"

Champs supplémentaires: Non