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

ApiResponse[CodeContentData]

ApiResponse_CodeContentData_ · Un code est renvoyé en JSON, un fichier en binaire. Chaque requête exige Bearer et le droit reveal.

dataCodeContentData Obligatoire: Données d'une réponse réussie.

Exemple: {"code":"DEMO-ONE","delivery_id":null,"kind":"code","payload_id":"00000000-0000-4000-8000-000000000004","unit_id":"00000000-0000-4000-8000-000000000003"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoire: Métadonnées de la réponse.

Exemple: {"request_id":"example-request"}

Champs supplémentaires: Non

ApiResponse[DigitalUploadData]

ApiResponse_DigitalUploadData_ · Vérifiez la taille, la somme de contrôle et le format. Un envoi prêt ne signifie pas que la livraison est réceptionnée.

dataDigitalUploadData Obligatoire: Données d'une réponse réussie.

Exemple: {"consumer_id":"00000000-0000-4000-8000-000000000001","consumer_kind":"digital_import","expires_at":"2026-11-03T13:00:00Z","filename":"codes.txt","id":"00000000-0000-4000-8000-000000000002","product_id":"example","purpose":"digital_import","received_bytes":18,"sha256":"636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a","size_bytes":18,"status":"ready"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoire: Métadonnées de la réponse.

Exemple: {"request_id":"example-request"}

Champs supplémentaires: Non

ApiResponse[ImportData]

ApiResponse_ImportData_ · Vérifiez son état, sa version et sa validation. Le brouillon appartient à la clé API qui l’a créé.

dataImportData Obligatoire: Données d'une réponse réussie.

Exemple: {"delivery_id":null,"delivery_status":null,"delivery_version":null,"expected_count":2,"expires_at":"2026-11-03T13:00:00Z","id":"00000000-0000-4000-8000-000000000001","kind":"code","product_id":"example","status":"validated","validated_count":2,"validation_digest":"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb","version":2}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoire: Métadonnées de la réponse.

Exemple: {"request_id":"example-request"}

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

ApiResponse[PoolData]

ApiResponse_PoolData_ · Consultez les réglages et les quantités avant toute modification. La réponse ne contient ni codes ni fichiers.

dataPoolData Obligatoire: Données d'une réponse réussie.

Exemple: {"configured":true,"counts":{"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0},"email_mode":"order_link","enabled":true,"order_version":2,"product_id":"example","retention_days":null,"version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoire: Métadonnées de la réponse.

Exemple: {"request_id":"example-request"}

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

ApiResponse[UnitsData]

ApiResponse_UnitsData_ · Consultez au maximum 100 unités par page. La liste fournit les métadonnées sans révéler les codes.

dataUnitsData Obligatoire: Données d'une réponse réussie.

Exemple: {"order_version":2,"total":1,"units":[{"content_state":"present","delivery_id":"delivery-example","filename":null,"id":"00000000-0000-4000-8000-000000000003","issued_at":null,"kind":"code","location_id":"location-digital","mime_type":null,"payload_id":"00000000-0000-4000-8000-000000000004","product_id":"example","size_bytes":null,"sort_order":1,"state":"available","version":1,"warehouse_id":"warehouse-main"}]}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoire: Métadonnées de la réponse.

Exemple: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example-request"}

Champs supplémentaires: Non

CodeContentData

CodeContentData · Un code est renvoyé en JSON, un fichier en binaire. Chaque requête exige Bearer et le droit reveal.

codeChaîneObligatoire: Le code numérique exact. Conservez la casse et les espaces internes.

minLength: 1maxLength: 512

Exemple: "DEMO-ONE"
delivery_idChaîne nullFacultatif: Identifiant de livraison ou d’attribution à une commande.

Chaîne:format: "uuid"

Exemple: null
kindChaîneFacultatif: Variante de la structure de données définie par les valeurs autorisées.

const: "code"

Valeur par défaut: "code"Exemple: "code"
payload_idChaîneObligatoire: Identifiant du contenu, pas une URL publique de téléchargement.

format: "uuid"

Exemple: "00000000-0000-4000-8000-000000000004"
unit_idChaîneObligatoire: Identifiant d’un code ou fichier individuel.

format: "uuid"

Exemple: "00000000-0000-4000-8000-000000000003"

Champs supplémentaires: Non

DigitalUploadCreate

DigitalUploadCreate · Réservez l’espace d’un fichier et rattachez-le à un import ou à l’unité à remplacer.

consumer_idChaîneObligatoire

Identifiant de l’import ou de l’unité associée.

format: "uuid"

Exemple: "00000000-0000-4000-8000-000000000001"

consumer_kindChaîneObligatoire

Destination de l’envoi : digital_import / digital_unit.

Contraintes

enum: ["digital_import", "digital_unit"]

Exemple: "digital_import"

filenameChaîneObligatoire

Fichier

minLength: 1maxLength: 255

Exemple: "codes.txt"

purposeChaîneObligatoire

digital_import : TXT/CSV ; digital_unit : fichier vendu individuellement.

Contraintes

enum: ["digital_unit", "digital_import"]

Exemple: "digital_import"

sha256ChaîneObligatoire

SHA-256 (hex, 64)

Contraintes

pattern: "^[0-9a-f]{64}$"

Exemple: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesEntierObligatoire

Taille en octets

minimum: 1maximum: 262144000

Exemple: 18

Champs supplémentaires: Non

DigitalUploadData

DigitalUploadData · Vérifiez la taille, la somme de contrôle et le format. Un envoi prêt ne signifie pas que la livraison est réceptionnée.

consumer_idChaîneObligatoire

Identifiant de l’import ou de l’unité associée.

format: "uuid"

Exemple: "00000000-0000-4000-8000-000000000001"

consumer_kindChaîneObligatoire

Destination de l’envoi : digital_import / digital_unit.

Contraintes

enum: ["digital_import", "digital_unit"]

Exemple: "digital_import"

expires_atChaîneObligatoire

Date d’expiration de ce téléversement ou de cet import.

format: "date-time"

Exemple: "2026-11-03T13:00:00Z"

filenameChaîneObligatoire

Fichier

Exemple: "codes.txt"

idChaîneObligatoire

Identifiant de ressource ; conserver la valeur renvoyée.

format: "uuid"

Exemple: "00000000-0000-4000-8000-000000000002"

product_idChaîneObligatoire

Identifiant du produit.

Exemple: "example"

purposeChaîneObligatoire

digital_import : TXT/CSV ; digital_unit : fichier vendu individuellement.

Contraintes

enum: ["digital_unit", "digital_import"]

Exemple: "digital_import"

received_bytesEntierObligatoire

Envoi en cours… · Taille en octets

Exemple: 18

sha256ChaîneObligatoire

SHA-256 (hex, 64)

Exemple: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesEntierObligatoire

Taille en octets

Exemple: 18

statusChaîneObligatoire

Statut accepté par cette opération précise.

Exemple: "ready"

Champs supplémentaires: Non

ImportCommit

ImportCommit · Créez une livraison prévue ou reçue à partir du lot validé. Une livraison prévue n’est pas encore vendable.

delivered_atChaîneObligatoire

Date et heure de livraison.

format: "date-time"

Exemple: "2026-11-03T12:00:00Z"

expected_delivery_versionEntierObligatoire

Version de livraison ; 0 pour une nouvelle livraison.

minimum: 0maximum: 0

Exemple: 0

expected_sales_limit_versionEntier nullFacultatif

Version de la limite de vente, requise avec publish_for_sale=true.

Entier:minimum: 0maximum: 9223372036854775807

Exemple: 0

expected_versionEntierObligatoire

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

minimum: 1maximum: 9223372036854775807

Exemple: 2

location_idChaîneObligatoire

Identifiant de l'emplacement de stockage.

Contraintes

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

Exemple: "location-digital"

publish_for_saleBooléenFacultatif

true augmente aussi la limite de vente finie ; false la laisse inchangée.

Valeur par défaut: falseExemple: true

statusChaîneObligatoire

Statut accepté par cette opération précise.

Contraintes

enum: ["planned", "received"]

Exemple: "received"

validation_digestChaîneObligatoire

Somme de contrôle de validation à transmettre sans modification.

Contraintes

pattern: "^[0-9a-f]{64}$"

Exemple: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

warehouse_idChaîneObligatoire

Identifiant de l'entrepôt.

Contraintes

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

Exemple: "warehouse-main"

Champs supplémentaires: Non

ImportCreate

ImportCreate · Préparez un brouillon de 1000 codes ou 100 fichiers au maximum. Le stock vendable ne change pas encore.

countEntierObligatoire

Nombre exact d’unités dans ce lot.

minimum: 1maximum: 1000

Exemple: 2

kindChaîneObligatoire

Variante de la structure de données définie par les valeurs autorisées.

Contraintes

enum: ["code", "file"]

Exemple: "code"

Champs supplémentaires: Non

ImportData

ImportData · Vérifiez son état, sa version et sa validation. Le brouillon appartient à la clé API qui l’a créé.

delivery_idChaîne nullObligatoire

Identifiant de livraison ou d’attribution à une commande.

Exemple: null

delivery_statusChaîne nullObligatoire

État de livraison : planned / received ; null avant confirmation.

Exemple: null

delivery_versionEntier nullObligatoire

Version actuelle de la livraison en entrepôt.

Exemple: null

expected_countEntierObligatoire

Nombre attendu ; seul le lot complet est accepté.

Exemple: 2

expires_atChaîneObligatoire

Date d’expiration de ce téléversement ou de cet import.

format: "date-time"

Exemple: "2026-11-03T13:00:00Z"

idChaîneObligatoire

Identifiant de ressource ; conserver la valeur renvoyée.

format: "uuid"

Exemple: "00000000-0000-4000-8000-000000000001"

kindChaîneObligatoire

Variante de la structure de données définie par les valeurs autorisées.

Contraintes

enum: ["code", "file"]

Exemple: "code"

product_idChaîneObligatoire

Identifiant du produit.

Exemple: "example"

statusChaîneObligatoire

Statut accepté par cette opération précise.

Exemple: "validated"

validated_countEntierObligatoire

Nombre d’unités acceptées par la dernière validation réussie.

Exemple: 2

validation_digestChaîne nullObligatoire

Somme de contrôle de validation à transmettre sans modification.

Exemple: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

versionEntierObligatoire

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

Exemple: 2

Champs supplémentaires: Non

ImportReceive

ImportReceive · Réceptionnez les éléments existants sans importer une seconde fois leurs codes ou fichiers.

expected_delivery_versionEntierObligatoire: Version de livraison ; 0 pour une nouvelle livraison.

minimum: 1maximum: 9223372036854775807

Exemple: 1
expected_sales_limit_versionEntier nullFacultatif: Version de la limite de vente, requise avec publish_for_sale=true.

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

minimum: 1maximum: 9223372036854775807

Exemple: 3
publish_for_saleBooléenFacultatif: true augmente aussi la limite de vente finie ; false la laisse inchangée.

Valeur par défaut: false

Champs supplémentaires: Non

ImportValidate

ImportValidate · Vérifiez le lot complet. Un doublon ou une entrée incorrecte rejette le lot ; les codes ne sont jamais tronqués.

code_columnChaîne nullFacultatif

Colonne CSV des codes ; utiliser code.

Chaîne:const: "code"

expected_versionEntierObligatoire

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

minimum: 1maximum: 9223372036854775807

Exemple: 1

formatChaîne nullFacultatif

Liste de codes : txt / csv ; utiliser upload_ids pour les fichiers.

Contraintes · Chaîne 1

enum: ["txt", "csv"]

Exemple: "txt"

source_upload_idChaîne nullFacultatif

Envoi privé TXT/CSV prêt appartenant à cet import.

Chaîne:format: "uuid"

Exemple: "00000000-0000-4000-8000-000000000002"

upload_idsTableau <Chaîne> nullFacultatif

1–100 envois privés de fichiers prêts appartenant à cet import.

Tableau:minItems: 1maxItems: 100

Tableau / Tableau:format: "uuid"

Champs supplémentaires: Non

ImportWithdrawal

ImportWithdrawal · Retirez uniquement les unités libres. Les unités réservées ou attribuées restent liées à leurs commandes.

expected_delivery_versionEntierObligatoire: Version de livraison ; 0 pour une nouvelle livraison.

minimum: 1maximum: 9223372036854775807

Exemple: 1
expected_order_versionEntierObligatoire: Version de l’ordre d’attribution, pas de la commande client.

minimum: 0maximum: 9223372036854775807

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

minimum: 1maximum: 9223372036854775807

Exemple: 3
reasonChaîneObligatoire: Motif enregistré pour la modification.

minLength: 1maxLength: 500

Exemple: "Withdraw a revoked license"

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

PoolChange

PoolChange · Activez les codes ou fichiers individuels à partir de Professional. La désactivation conserve les accès des achats antérieurs.

email_modeChaîneFacultatif

disabled : aucun e-mail ; order_link : lien de commande ; code_text : codes possibles en plus.

Contraintes

enum: ["disabled", "order_link", "code_text"]

Valeur par défaut: "disabled"Exemple: "order_link"

enabledBooléenObligatoire

Indique si ce paramètre est activé.

Exemple: true

expected_versionEntierObligatoire

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

minimum: 0maximum: 9223372036854775807

Exemple: 0

retention_daysEntier nullFacultatif

null : sans limite ; 1–3650 jours après le premier accès. Pas de suppression automatique des codes.

Entier:minimum: 1maximum: 3650

Exemple: null

Champs supplémentaires: Non

PoolCounts

PoolCounts · Consultez les réglages et les quantités avant toute modification. La réponse ne contient ni codes ni fichiers.

availableEntierObligatoire: Nombre d’unités libres, ni réservées ni attribuées.

Exemple: 1
heldEntierObligatoire: Unités réservées aux commandes, pas encore remises.

Exemple: 0
issuedEntierObligatoire: Unités déjà remises pour des achats payés.

Exemple: 1
plannedEntierObligatoire: Unités de livraisons confirmées mais non réceptionnées.

Exemple: 0
retiredEntierObligatoire: Unités retirées conservées dans l’historique.

Exemple: 0
stagedEntierObligatoire: Unités d’imports inachevés, pas encore en stock.

Exemple: 0

Champs supplémentaires: Non

PoolData

PoolData · Consultez les réglages et les quantités avant toute modification. La réponse ne contient ni codes ni fichiers.

configuredBooléenObligatoire

Indique si les paramètres du stock sont enregistrés.

Exemple: true

countsPoolCounts Obligatoire

Nombre d’unités par état de stock.

Exemple: {"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0}

email_modeChaîneObligatoire

disabled : aucun e-mail ; order_link : lien de commande ; code_text : codes possibles en plus.

Contraintes

enum: ["disabled", "order_link", "code_text"]

Exemple: "order_link"

enabledBooléenObligatoire

Indique si ce paramètre est activé.

Exemple: true

order_versionEntierObligatoire

Version de l’ordre d’attribution du stock.

Exemple: 2

product_idChaîneObligatoire

Identifiant du produit.

Exemple: "example"

retention_daysEntier nullObligatoire

null : sans limite ; 1–3650 jours après le premier accès. Pas de suppression automatique des codes.

Exemple: null

versionEntierObligatoire

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

Exemple: 1

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

UnitData

UnitData · Consultez au maximum 100 unités par page. La liste fournit les métadonnées sans révéler les codes.

content_stateChaîneObligatoire

État du contenu : present / deleting / deleted.

Exemple: "present"

delivery_idChaîne nullObligatoire

Identifiant de livraison ou d’attribution à une commande.

Exemple: "delivery-example"

filenameChaîne nullObligatoire

Fichier

Exemple: null

idChaîneObligatoire

Identifiant de ressource ; conserver la valeur renvoyée.

format: "uuid"

Exemple: "00000000-0000-4000-8000-000000000003"

issued_atChaîne nullObligatoire

Première remise ; null avant celle-ci.

Chaîne:format: "date-time"

Exemple: null

kindChaîneObligatoire

Variante de la structure de données définie par les valeurs autorisées.

Contraintes

enum: ["file", "code"]

Exemple: "code"

location_idChaîne nullObligatoire

Identifiant de l'emplacement de stockage.

Exemple: "location-digital"

mime_typeChaîne nullObligatoire

Type de contenu du média.

Exemple: null

payload_idChaîneObligatoire

Identifiant du contenu, pas une URL publique de téléchargement.

format: "uuid"

Exemple: "00000000-0000-4000-8000-000000000004"

product_idChaîneObligatoire

Identifiant du produit.

Exemple: "example"

size_bytesEntier nullObligatoire

Taille en octets

Exemple: null

sort_orderEntierObligatoire

Position dans la collection ordonnée.

Exemple: 1

stateChaîneObligatoire

Statut

Exemple: "available"

versionEntierObligatoire

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

Exemple: 1

warehouse_idChaîne nullObligatoire

Identifiant de l'entrepôt.

Exemple: "warehouse-main"

Champs supplémentaires: Non

UnitDeletion

UnitDeletion · Retirez un code ou fichier invendu en indiquant le motif. Les unités réservées ou attribuées sont refusées.

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

minimum: 1

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

minLength: 1maxLength: 500

Exemple: "Withdraw a revoked license"

Champs supplémentaires: Non

UnitReorder

UnitReorder · Envoyez toute la page non filtrée dans l’ordre souhaité. Une version périmée renvoie 409.

expected_order_versionEntierObligatoire: Version de l’ordre d’attribution, pas de la commande client.

minimum: 1

Exemple: 1
unit_idsTableau <Chaîne> Obligatoire: Toutes les unités de la page non filtrée dans l’ordre souhaité.

minItems: 2maxItems: 100
Tableau:format: "uuid"

Exemple: ["00000000-0000-4000-8000-000000000008","00000000-0000-4000-8000-000000000003"]
window_cursorChaîne nullFacultatif: Curseur de la page non filtrée ; null pour la première.

Chaîne:maxLength: 1024

Champs supplémentaires: Non

UnitReplacement

UnitReplacement · Remplacez le code ou fichier sans changer sa place. La modification figure dans l’historique du stock.

codeChaîne nullFacultatif: Le code numérique exact. Conservez la casse et les espaces internes.

Chaîne:minLength: 1maxLength: 512

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

minimum: 1

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

minLength: 1maxLength: 500

Exemple: "Replace an invalid activation code"
upload_idChaîne nullFacultatif: Identifiant de ressource ; conserver la valeur renvoyée. · upload_id

Chaîne:format: "uuid"

Champs supplémentaires: Non

UnitsData

UnitsData · Consultez au maximum 100 unités par page. La liste fournit les métadonnées sans révéler les codes.

order_versionEntierObligatoire: Version de l’ordre d’attribution du stock.

Exemple: 2
totalEntierObligatoire: Montant total.

Exemple: 1
unitsTableau <UnitData > Obligatoire: Métadonnées des unités ; le contenu exige une requête autorisée distincte.

Exemple: [{"content_state":"present","delivery_id":"delivery-example","filename":null,"id":"00000000-0000-4000-8000-000000000003","issued_at":null,"kind":"code","location_id":"location-digital","mime_type":null,"payload_id":"00000000-0000-4000-8000-000000000004","product_id":"example","size_bytes":null,"sort_order":1,"state":"available","version":1,"warehouse_id":"warehouse-main"}]

Champs supplémentaires: Oui