Schémas de données: Livraisons

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

Schémas de données

Obtenir — Livraisons — Réponse

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

dataDeliveryDetailData Obligatoire: Exemple de réponse · DeliveryDetailData.

Exemple: {"created_at":"2026-01-01T12:00:00Z","deleted_at":null,"delivered_at":"2026-01-01T12:00:00Z","id":"example","increases_stock":true,"location_id":"example","notes":"example","quantity":1,"received_at":null,"record_status":"active","status":"planned","stock_applied_at":null,"target_id":"example","target_type":"product","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

Lister — Livraisons — Réponse

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

dataTableau <DeliveryData > Obligatoire: Exemple de réponse · ApiResponse_list_DeliveryData__.

Exemple: [{"created_at":"2026-01-01T12:00:00Z","deleted_at":null,"delivered_at":"2026-01-01T12:00:00Z","id":"example","increases_stock":true,"location_id":"example","quantity":1,"received_at":null,"record_status":"active","status":"planned","stock_applied_at":null,"target_id":"example","target_type":"product","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

Créer — Livraisons — Corps de la requête

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

delivered_atChaîneObligatoire

Date et heure de livraison.

format: "date-time"

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

increases_stockBooléenFacultatif

Indique si la réception de la livraison augmente le stock.

Valeur par défaut: true

location_idChaîneObligatoire

Identifiant de l'emplacement de stockage.

Contraintes

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

Exemple: "example"

notesChaîneFacultatif

Remarques complémentaires.

maxLength: 2000

Valeur par défaut: ""

quantityEntierObligatoire

Nombre d'unités.

minimum: 1maximum: 2147483647

Exemple: 1

reasonChaîneFacultatif

Motif enregistré pour la modification.

maxLength: 500

Valeur par défaut: ""

statusChaîneObligatoire

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

Contraintes

enum: ["planned", "received"]

Exemple: "planned"

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

Lister — Livraisons — Réponse

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

created_atChaîneObligatoire

Date et heure de création.

format: "date-time"

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

deleted_atChaîne nullObligatoire

Date et heure de suppression, le cas échéant.

Chaîne:format: "date-time"

Exemple: null

delivered_atChaîneObligatoire

Date et heure de livraison.

format: "date-time"

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

idChaîneObligatoire

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

Exemple: "example"

increases_stockBooléenObligatoire

Indique si la réception de la livraison augmente le stock.

Exemple: true

location_idChaîneObligatoire

Identifiant de l'emplacement de stockage.

Exemple: "example"

quantityEntierObligatoire

Nombre d'unités.

Exemple: 1

received_atChaîne nullObligatoire

Date et heure de réception de la livraison.

Chaîne:format: "date-time"

Exemple: null

record_statusChaîneObligatoire

Statut enregistré.

Contraintes

enum: ["active", "deleted"]

Exemple: "active"

statusChaîneObligatoire

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

Contraintes

enum: ["planned", "received"]

Exemple: "planned"

stock_applied_atChaîne nullObligatoire

Date et heure d'application de la variation de stock de la livraison.

Chaîne:format: "date-time"

Exemple: null

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"

updated_atChaîne nullObligatoire

Date et heure de la dernière modification.

Chaîne: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 — Livraisons — Réponse

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

created_atChaîneObligatoire

Date et heure de création.

format: "date-time"

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

deleted_atChaîne nullObligatoire

Date et heure de suppression, le cas échéant.

Chaîne:format: "date-time"

Exemple: null

delivered_atChaîneObligatoire

Date et heure de livraison.

format: "date-time"

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

idChaîneObligatoire

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

Exemple: "example"

increases_stockBooléenObligatoire

Indique si la réception de la livraison augmente le stock.

Exemple: true

location_idChaîneObligatoire

Identifiant de l'emplacement de stockage.

Exemple: "example"

notesChaîne nullObligatoire

Remarques complémentaires.

Exemple: "example"

quantityEntierObligatoire

Nombre d'unités.

Exemple: 1

received_atChaîne nullObligatoire

Date et heure de réception de la livraison.

Chaîne:format: "date-time"

Exemple: null

record_statusChaîneObligatoire

Statut enregistré.

Contraintes

enum: ["active", "deleted"]

Exemple: "active"

statusChaîneObligatoire

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

Contraintes

enum: ["planned", "received"]

Exemple: "planned"

stock_applied_atChaîne nullObligatoire

Date et heure d'application de la variation de stock de la livraison.

Chaîne:format: "date-time"

Exemple: null

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"

updated_atChaîne nullObligatoire

Date et heure de la dernière modification.

Chaîne: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