Schémas de données: Entrepôts et emplacements

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

Schémas de données

Lister · Emplacements — Entrepôts et emplacements — Réponse

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

dataTableau <LocationData > Obligatoire: Exemple de réponse · ApiResponse_list_LocationData__.

Exemple: [{"code":"example","created_at":"2026-01-01T12:00:00Z","id":"example","is_leaf":true,"location_type":"zone","name":"Example","parent_id":null,"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

Lister — Entrepôts et emplacements — Réponse

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

dataTableau <WarehouseData > Obligatoire: Exemple de réponse · ApiResponse_list_WarehouseData__.

Exemple: [{"active":true,"address_line":"example","city":"example","code":"example","country_code":"PL","created_at":"2026-01-01T12:00:00Z","customer_visible":false,"id":"example","name":"Example","postal_code":"example","updated_at":"2026-01-01T12:00:00Z","version":1}]
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 — Entrepôts et emplacements — Réponse

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

dataWarehouseData Obligatoire: Exemple de réponse · WarehouseData.

Exemple: {"active":true,"address_line":"example","city":"example","code":"example","country_code":"PL","created_at":"2026-01-01T12:00:00Z","customer_visible":false,"id":"example","name":"Example","postal_code":"example","updated_at":"2026-01-01T12:00:00Z","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoire: Métadonnées de la réponse.

Exemple: {"request_id":"example"}

Champs supplémentaires: Non

Lister · Emplacements — Entrepôts et emplacements — Réponse

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

codeChaîneObligatoire

Code stable lisible par une machine.

Exemple: "example"

created_atChaîneObligatoire

Date et heure de création.

format: "date-time"

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

idChaîneObligatoire

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

Exemple: "example"

is_leafBooléenObligatoire

Indique si la catégorie ne comporte aucune sous-catégorie.

Exemple: true

location_typeChaîneObligatoire

Type de l'emplacement de stockage.

Contraintes

enum: ["zone", "rack", "shelf", "bin"]

Exemple: "zone"

nameChaîneObligatoire

Nom de la ressource dans le contexte concerné.

Exemple: "Example"

parent_idChaîne nullObligatoire

Identifiant de la catégorie parente.

Exemple: null

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

Emplacements de stockage

LocationQuantity · Schéma · Schémas de données: Entrepôts et emplacements

location_idChaîneObligatoire

Identifiant de l'emplacement de stockage.

Contraintes

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

Exemple: "example"

on_handEntierObligatoire

Quantité physique en stock.

minimum: 0maximum: 2147483647

Exemple: 1

Champs supplémentaires: Non

Obtenir — Entrepôts et emplacements — Réponse

WarehouseData · 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
address_lineChaîne nullObligatoire: Ligne d'adresse.

Exemple: "example"
cityChaîne nullObligatoire: Ville ou localité.

Exemple: "example"
codeChaîneObligatoire: Code stable lisible par une machine.

Exemple: "example"
country_codeChaîneObligatoire: Code du pays.

Exemple: "PL"
created_atChaîneObligatoire: Date et heure de création.

format: "date-time"

Exemple: "2026-01-01T12:00:00Z"
customer_visibleBooléenObligatoire: Indique si le statut est visible par le client.

Exemple: false
idChaîneObligatoire: Identifiant de ressource ; conserver la valeur renvoyée. (WarehouseData).

Exemple: "example"
nameChaîneObligatoire: Nom de la ressource dans le contexte concerné.

Exemple: "Example"
postal_codeChaîne nullObligatoire: Code postal.

Exemple: "example"
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

Champs supplémentaires: Non