Ressources de l’API Organisation

Utilisez l’API organisation pour planifier des rendez-vous, gérer les produits et les entreprises, et vérifier la capacité de l’entrepôt via une URL de base unique.

Les exemples ci-dessous utilisent acme.datadocks.com. Remplacez acme par le sous-domaine de votre organisation et utilisez un emplacement auquel votre utilisateur API a accès. Consultez Authentification et accès pour commencer.

Ressources disponibles

Ressource	Opérations courantes	Emplacement requis?
Rendez-vous	Lister, voir, créer, modifier	Créer seulement
Produits	Lister, voir, créer, modifier, supprimer	Créer seulement
Entreprises	Lister, voir, créer, modifier, supprimer	Non
Limites de produits	Lister	Non
Emplacements	Lister	Non
Bons de commande	Lister, voir, créer, modifier, supprimer	Non

Lister les emplacements

Objectif

Récupérez les emplacements auxquels l’utilisateur API peut accéder. Utilisez les noms retournés lors des requêtes concernant les produits, rendez-vous ou autres ressources spécifiques à un emplacement.

Requête HTTP

GET https://[organization_subdomain].datadocks.com/api/v1/locations

Paramètres de requête

Paramètre	Type	Obligatoire	Description	Exemple
`location_name`	Chaîne	Non	Retourne un emplacement accessible par nom	`Toronto`

Exemple de code

Voir l’exemple cURL

curl -H "Authorization: Token YOUR_API_TOKEN" \
     https://acme.datadocks.com/api/v1/locations

Format de la réponse

Une requête réussie retourne 200 OK avec un tableau d’emplacements :

[
  { "name": "Toronto", "url": "toronto-acme" },
  { "name": "Vancouver", "url": "vancouver-acme" }
]

Champ	Type	Description
`name`	Chaîne	Nom d’affichage à utiliser comme `location_name`
`url`	Chaîne	Sous-domaine de l’emplacement, tel que `toronto-acme`

Seuls les emplacements de votre organisation accessibles à votre utilisateur API sont inclus. Sélectionner un emplacement sans accessibilité retourne 403 Forbidden. La liste n’est pas paginée.

Rendez-vous

Objectif

Planifiez des livraisons et des ramassages à un entrepôt, récupérez les détails d’un rendez-vous ou mettez à jour une expédition existante.

Requêtes HTTP

Opération	Méthode	Chemin
Lister les rendez-vous	`GET`	`/api/v1/appointments`
Voir un rendez-vous	`GET`	`/api/v1/appointments/123`
Créer un rendez-vous	`POST`	`/api/v1/appointments`
Modifier un rendez-vous	`PATCH` ou `PUT`	`/api/v1/appointments/123`

Corps de la requête

Envoyez les champs du rendez-vous à l’intérieur d’un objet appointment. Incluez location_name lors de la création pour choisir l’entrepôt ; lors des modifications, il est déduit du rendez-vous. Les quais, cours, produits, paramètres et fuseaux horaires de l’entrepôt s’appliquent au rendez-vous.

Exemple de code

Voir l’exemple cURL : créer un rendez-vous

curl -H "Authorization: Token YOUR_API_TOKEN" \
     -H "Content-Type: application/json" \
     -X POST \
     -d '{
       "appointment": {
         "location_name": "Toronto",
         "scheduled_at": "2026-10-01T09:00:00-04:00",
         "duration": 60,
         "dock_name": "Dock 1",
         "carrier_name": "FastCo"
       }
     }' \
     https://acme.datadocks.com/api/v1/appointments

Réponse

Une création ou une modification réussie retourne 200 OK avec les détails du rendez-vous. Consultez l’API Rendez-vous pour la liste complète des champs, les filtres, des exemples de réponses et les instructions d’annulation.

Lors de la modification des listes d’emballage, utilisez les IDs provenant du rendez-vous à modifier. La suppression de rendez-vous n’est pas prise en charge par l’API.

Produits

Objectif

Gardez le catalogue de produits de chaque entrepôt synchronisé avec votre ERP ou WMS. Les listes combinent les catalogues accessibles. Visualisez et modifiez les produits par ID ; le nom d’emplacement, facultatif, permet de cibler la recherche.

Requêtes HTTP

Opération	Méthode	Chemin
Lister les produits	`GET`	`/api/v1/products`
Voir un produit	`GET`	`/api/v1/products/123`
Créer un produit	`POST`	`/api/v1/products`
Modifier un produit	`PATCH` ou `PUT`	`/api/v1/products/123`
Supprimer un produit	`DELETE`	`/api/v1/products/123`

Corps de la requête

Paramètre	Type	Obligatoire	Description	Exemple
`location_name`	Chaîne	À la création	Entrepôt auquel appartient le produit	`Toronto`
`name`	Chaîne	Oui, à la création	Nom du produit	`Premium Widget`
`sku`	Chaîne	Non	Unité de gestion des stocks	`WIDGET-001`

Envoyez ces champs dans un objet product.

Exemple de code

Voir l’exemple cURL : créer un produit

curl -H "Authorization: Token YOUR_API_TOKEN" \
     -H "Content-Type: application/json" \
     -X POST \
     -d '{
       "product": {
         "location_name": "Toronto",
         "name": "Premium Widget",
         "sku": "WIDGET-001"
       }
     }' \
     https://acme.datadocks.com/api/v1/products

Réponse

Une création ou une modification réussie retourne 200 OK avec les détails du produit. Une suppression réussie retourne 204 No Content. Un ID de produit inaccessible ou un ID hors de la plage de l’emplacement explicite retourne 404 Not Found.

Les réponses produits incluent location_name dans les listes ainsi que dans les réponses à un seul enregistrement, la création et la modification, afin de pouvoir identifier l’entrepôt propriétaire même si les noms ou SKU sont identiques entre les emplacements.

Consultez l’API Produits pour les champs additionnels, les filtres sur les noms et SKU, et des exemples de réponses.

Entreprises

Objectif

Gérer les dossiers des clients et transporteurs utilisés par votre organisation. Les entreprises sont partagées entre tous les emplacements, ainsi la modification d’une entreprise met à jour l’enregistrement dans toute l’organisation.

Requêtes HTTP

Opération	Méthode	Chemin
Lister les entreprises	`GET`	`/api/v1/companies`
Voir une entreprise	`GET`	`/api/v1/companies/123`
Créer une entreprise	`POST`	`/api/v1/companies`
Modifier une entreprise	`PATCH` ou `PUT`	`/api/v1/companies/123`
Supprimer une entreprise	`DELETE`	`/api/v1/companies/123`

Corps de la requête

Envoyez les champs de l’entreprise dans un objet company. Aucun emplacement n’est requis : l’autorisation utilise votre appartenance admin à cette organisation. Si vous fournissez un emplacement, ses autorisations s’appliquent, mais cela ne limite pas l’entreprise à cet entrepôt.

Exemple de code

Voir l’exemple cURL : créer un transporteur

curl -H "Authorization: Token YOUR_API_TOKEN" \
     -H "Content-Type: application/json" \
     -X POST \
     -d '{
       "company": {
         "name": "Express Logistics",
         "company_type": "carrier"
       }
     }' \
     https://acme.datadocks.com/api/v1/companies

Réponse

Une création ou une modification réussie retourne 200 OK avec les détails de l’entreprise. Consultez l’API Entreprises pour tous les champs, filtres et exemples de réponse.

Limites de produits

Objectif

Vérifiez les limites de produit dans un entrepôt avant d’organiser une expédition. Ce point d’accès retourne les limites activées et leurs dérogations pour les dates demandées.

Requête HTTP

GET https://[organization_subdomain].datadocks.com/api/v1/product_limits

Paramètres de requête

Paramètre	Type	Obligatoire	Description	Exemple
`location_name`	Chaîne	Non	Filtre optionnel par entrepôt	`Toronto`
`start_date`	Date	Non	Première date à inclure, au format `AAAA-MM-JJ`	`2026-10-01`
`end_date`	Date	Non	Dernière date à inclure, au format `AAAA-MM-JJ`	`2026-10-07`
`product_name`	Chaîne	Non	Filtrer par nom du produit	`Widgets`
`page`	Entier	Non	Numéro de page	`2`

Exemple de code

Voir l’exemple cURL

curl -H "Authorization: Token YOUR_API_TOKEN" \
     "https://acme.datadocks.com/api/v1/product_limits?location_name=Toronto&start_date=2026-10-01&end_date=2026-10-07"

Format de la réponse

Une requête réussie retourne 200 OK avec un objet JSON contenant un tableau product_limits. Sans filtres de date, chaque entrepôt utilise sa propre date courante jusqu’à sept jours plus tard, sélection des dérogations incluse. Les dates explicites demeurent des dates calendaires locales. Les horaires de début et de fin récurrents restent à l’heure locale de l’emplacement. Consultez l’API Limites de produits pour les valeurs par défaut, règles de filtrage et le format complet de la réponse.

Les limites de produits sont en lecture seule via l’API. Gérez-les dans DataDocks.

Routes additionnelles

Les APIs organisation et emplacement n’exposent pas d’actions de formulaire new ou edit. Récupérez les enregistrements existants via GET /api/v1/[resource]/[id], créez-les avec POST, et modifiez-les avec PATCH ou PUT.

Les téléchargements en vrac sont disponibles via l’API emplacement.

Aide et support

Si une requête échoue, consultez le guide de gestion des erreurs. Vérifiez le nom de l’emplacement, l’accès de votre utilisateur API et l’ID de l’enregistrement avant de réessayer.

Pour obtenir de l’aide avec une intégration, contactez support@datadocks.com.

Ressources disponibles​

Lister les emplacements​

Objectif​

Requête HTTP​

Paramètres de requête​

Exemple de code​

Format de la réponse​

Rendez-vous​

Objectif​

Requêtes HTTP​

Corps de la requête​

Exemple de code​

Réponse​

Produits​

Objectif​

Requêtes HTTP​

Corps de la requête​

Exemple de code​

Réponse​

Entreprises​

Objectif​

Requêtes HTTP​

Corps de la requête​

Exemple de code​

Réponse​

Limites de produits​

Objectif​

Requête HTTP​

Paramètres de requête​

Exemple de code​

Format de la réponse​

Routes additionnelles​

Aide et support​

Ressources disponibles

Lister les emplacements

Objectif

Requête HTTP

Paramètres de requête

Exemple de code

Format de la réponse

Rendez-vous

Objectif

Requêtes HTTP

Corps de la requête

Exemple de code

Réponse

Produits

Objectif

Requêtes HTTP

Corps de la requête

Exemple de code

Réponse

Entreprises

Objectif

Requêtes HTTP

Corps de la requête

Exemple de code

Réponse

Limites de produits

Objectif

Requête HTTP

Paramètres de requête

Exemple de code

Format de la réponse

Routes additionnelles

Aide et support