API Web-to-Store

As explained in the use case “Points de retrait multiples” (french), the Web-to-Store API can be used when different pick-up points are available.

You must then use one of the following URLs in the first step (Check the eligibility):

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

As for each eligibility test, you should indicate the dimensions of the package and the desired delivery point.

However, unlike the “classic” API, you do not specify one but several pick-up points (point of type pickup).

The returned slots contain all the information needed to Pre-order a delivery in the “classic” API.

{
  "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": "Ensemble set cuisine",
    "packets": [
      {
        "description": "micro-onde",
        "height": 60,
        "length": 80,
        "width": 30,
        "weight": 2.5
      },
      {
        "description": "Cafetière",
        "height": 60,
        "length": 80,
        "width": 30,
        "weight": 1
      }
    ]
  }
}