Aller au contenu
Documentation développeursRéférence de l'APIModèles

Lister les modèles

Les modèles de fret de votre organisation (articles enregistrés), des plus récents aux plus anciens.

GEThttps://runner.cargoduo.com/v1/templates

Référencez-en un dans un article avec template_id. Gratuit : aucun crédit n'est débité.

Authentification

Clé API Bearer avec l'autorisationresources:readEn savoir plus

Paramètres de requête

NomTypeObligatoireDescription
limitinteger
integer
Non

Taille de page.

Par défaut 201–100
cursorstring
string
Non

next_cursor de la page précédente.

qstring
string
Non

Uniquement les modèles dont le libellé contient ce texte.

created_bystring
string
Non

Uniquement ce que ce membre a créé : me (le créateur de la clé) ou un ID de membre (usr_…).

Exemple de requête

curl -X GET "https://runner.cargoduo.com/v1/templates?created_by=me" \
  -H "Authorization: Bearer $CARGODUO_API_KEY"

Exemple de réponse

200 OK · TemplateList
{
  "data": [
    {
      "id": "tpl_43",
      "object": "template",
      "label": "Carton A",
      "shape": "box",
      "length": 60,
      "width": 40,
      "height": 40,
      "radius": 0,
      "weight": 12,
      "stackable": true,
      "max_stack_weight": 0,
      "rotation": "upright",
      "hazardous": false,
      "priority": 0,
      "color": "#f59e0b",
      "nesting_height": 0,
      "created_by": {
        "id": "usr_7",
        "name": "Elif Kaya"
      },
      "updated_by": {
        "id": "usr_7",
        "name": "Elif Kaya"
      },
      "created_at": "2026-09-28T14:05:52Z",
      "updated_at": "2026-09-28T14:05:52Z"
    },
    {
      "id": "tpl_42",
      "object": "template",
      "label": "Euro pallet",
      "shape": "box",
      "length": 120,
      "width": 80,
      "height": 140,
      "radius": 0,
      "weight": 450,
      "stackable": false,
      "max_stack_weight": 0,
      "rotation": "all",
      "hazardous": false,
      "priority": 0,
      "color": "#3b82f6",
      "nesting_height": 0,
      "created_by": {
        "id": "usr_7",
        "name": "Elif Kaya"
      },
      "updated_by": {
        "id": "usr_7",
        "name": "Elif Kaya"
      },
      "created_at": "2026-09-28T14:05:52Z",
      "updated_at": "2026-09-28T14:05:52Z"
    }
  ],
  "next_cursor": ""
}

Réponses

  • 200OKUne page de modèles.
    NomTypeObligatoireDescription
    dataTemplate[]
    Template[]
    Non

    Les plus récents en premier.

    next_cursorstring
    string
    Non

    À passer dans ?cursor= pour obtenir la page suivante ; vide sur la dernière page.

  • 401Unauthorizedunauthorizedkey_revokedkey_expired
    • unauthorizedClé API absente, mal formée ou inconnue.
    • key_revokedLa clé a été révoquée.
    • key_expiredLa clé a dépassé sa date d'expiration.
    NomTypeObligatoireDescription
    errorErrorBodyobligatoire
    ErrorBody
    Oui
    Tous les codes d'erreur
  • 403Forbiddenip_not_allowedsubscription_inactiveaccount_inactivescope_missing
    • ip_not_allowedL'adresse IP appelante ne figure pas dans la liste des adresses IP autorisées de la clé.
    • subscription_inactiveL'organisation n'a aucun abonnement actif incluant l'API.
    • account_inactiveL'organisation est suspendue ou n'a aucun propriétaire dont le compte est actif.
    • scope_missingIl manque à la clé une autorisation requise par cet endpoint.
    NomTypeObligatoireDescription
    errorErrorBodyobligatoire
    ErrorBody
    Oui
    Tous les codes d'erreur
  • 422Unprocessable entityvalidation_failed
    • validation_failedLa requête est un JSON bien formé, mais décrit une tâche invalide. details[] liste tous les problèmes.
    NomTypeObligatoireDescription
    errorErrorBodyobligatoire
    ErrorBody
    Oui
    Tous les codes d'erreur
  • 429Too many requestsrate_limited
    • rate_limitedTrop de requêtes dans la minute, l'heure ou la journée en cours (par clé ou par organisation), ou plus de 60 échecs d'authentification par minute depuis votre adresse IP.
    NomTypeObligatoireDescription
    errorErrorBodyobligatoire
    ErrorBody
    Oui
    Tous les codes d'erreur
  • 500Internal server errorinternal_error
    • internal_errorUne erreur s'est produite de notre côté.
    NomTypeObligatoireDescription
    errorErrorBodyobligatoire
    ErrorBody
    Oui
    Tous les codes d'erreur
  • 503Service unavailableapi_disabled
    • api_disabledL'API est temporairement désactivée (maintenance) ou désactivée pour l'organisation.
    NomTypeObligatoireDescription
    errorErrorBodyobligatoire
    ErrorBody
    Oui
    Tous les codes d'erreur