API Web-to-Store

Comme spécifié dans le cas pratique “Points de retrait multiples”, l’API Web-to-Store peut être utilisé lorsque plusieurs points de retrait sont disponibles.

Il faut alors utiliser l’une des URLs suivantes lors de la première étape (Tester l’éligibilité du service) :

  • Sandbox : https://sandbox-web2store.api.colisweb.com/deliveries/options
  • Production : https://web2store.api.colisweb.com/deliveries/options

Tout comme pour chaque test d’éligibilité, vous devez indiquez les dimensions du colis et le point de livraison souhaité.

Cependant à la différence de l’API “classique”, vous ne nous spécifiez pas un mais plusieurs points de retrait (point de type pickup) à prendre en compte.

Les slots alors retournés contiennent toutes les informations permettant de Précommander une livraison dans l’API “classique”.

Le type de la location du point de livraison ne peut être que city.

{
  "route": [
    {
      "type": "pickup",
      "location": {
        "type": "store",
        "store_code": "francs"
      }
    },
    {
      "type": "pickup",
      "location": {
        "type": "store",
        "store_code": "louvre"
      }
    },
    {
      "type": "shipping",
      "location": {
        "type": "city",
        "postal_code": "75003"
      }
    }
  ],
  "packaging": {
    "global_description": "Computer Set",
    "packets": [
      {
        "description": "Screen",
        "height": 30,
        "length": 20,
        "width": 5,
        "weight": 2
      },
      {
        "description": "Computer",
        "height": 10,
        "length": 20,
        "width": 30,
        "weight": 3
      }
    ]
  }
}