Partenaires toolimo

L'objectif est de permettre à nos partenaires de recuperer la liste des dernières commandes et de devis.

Point de terminaison

La ressource /ordered sur le verbe GET.

L'authentification se fait par jeton, l'en-tête suivante est requise:

header valeur
X-AUTH-TOKEN votre token partenaire

L'API envoie automatiquement le code de statut HTTP approprié au client:

  • 400 pour les erreurs attendues
  • 500 pour les imprévues.

Il fournit également une description de l'erreur dans le format d'erreur Hydra ou dans le format décrit dans le RFC 7807.

Voici un exemple d'une erreur levée lors d'une demande non authorisée

{
    "@context": "/contexts/Error",
    "@type": "Error",
    "hydra:title": "An error occurred",
    "hydra:description": "No orders found"
}

Réponse

En cas de succés l'API retournera un code HTTP 200

header valeur
reference_id La réference dossier ou de devis
order_id Le numéro de commande
created_at Date de création
is_quotation false pour une commande true pour un devis
professional L'UUID du professionnel ayant passé la commande
{
    "@context": "/contexts/Order",
    "@type": "Order",
    "@id": "/ordered",
    "orders": [
        {
            "reference_id": 5355,
            "order_id": "76a1232a-4333-414c-95b4-955507e1f83e",
            "created_at": {
                "date": "2019-07-10 13:22:12.000000",
                "timezone_type": 3,
                "timezone": "Europe/Paris"
            },
            "is_quotation": false,
            "professional": "941c6570-c7da-4de5-9505-6ad8435bf4e3"
        },
        {
            "reference_id": 5350,
            "order_id": "cdcf9f06-d343-4cda-9733-d32546d149bb",
            "created_at": {
                "date": "2019-07-10 10:13:16.000000",
                "timezone_type": 3,
                "timezone": "Europe/Paris"
            },
            "is_quotation": false,
            "professional": "0a01326d-a95f-482d-a534-d71608ead06f"
        },
        ...
        {
            "reference_id": 11159,
            "order_id": "00a8a939-3c20-439e-adf6-20ed404f5e93",
            "created_at": {
                "date": "2019-07-11 10:13:12.000000",
                "timezone_type": 3,
                "timezone": "Europe/Paris"
            },
            "is_quotation": true,
            "professional": "e980c250-9a41-4b1d-ab32-e0f1be6cfcce"
        },
        {
            "reference_id": 11158,
            "order_id": "11ba05db-b304-4671-83b0-5320372d8a8b",
            "created_at": {
                "date": "2019-07-11 10:02:48.000000",
                "timezone_type": 3,
                "timezone": "Europe/Paris"
            },
            "is_quotation": true,
            "professional": "369edc2f-aec7-48da-b371-162828c158c9"
        }
    ]
}

Filtrer par professionnel

Pour filtrer les commandes et devis vous devez ajouter comme deuxième argument l'UUID du professionnel (token du client):

La ressource devient /ordered/{token-professional) sur le verbe GET.

{
    "@context": "/contexts/Order",
    "@type": "Order",
    "@id": "/ordered",
    "@documentation": "https://doc.diagandgo.fr/API/ordered/",
    "orders": [
        {
            "reference_id": 6857,
            "order_id": "cc56d531-4598-4929-8234-6df2484950b1",
            "created_at": {
                "date": "2019-11-05 18:17:02.000000",
                "timezone_type": 3,
                "timezone": "Europe/Paris"
            },
            "is_quotation": false,
            "professional": "bd436c60-921d-4653-a16c-9345eff34379"
        },
        {
            "reference_id": 6478,
            "order_id": "25aad14c-8526-45b0-84ab-d1566ea259f5",
            "created_at": {
                "date": "2019-04-25 20:48:14.000000",
                "timezone_type": 3,
                "timezone": "Europe/Paris"
            },
            "is_quotation": false,
            "professional": "bd436c60-921d-4653-a16c-9345eff34379"
        }
    ]
}