Allow your systems to obtain a list of possible time frames (a.k.a delivery slots) in which an order can be fulfilled.

Most common scenario or an integration point:

By the time a client wants to proceed to checkout. They will be interested in knowing the best time to get their selected products. For that purpose you will publish the data related to the origin, destinations and all the items they selected, and according to your capacity you would get the next delivery slots.

Recommendations

  • Make sure that your system can convert addresses to latitude and longitude coordinates. You are required to connect to a Geocoding API for this purpose. Google Maps offers one.
  • Ensure that the products on your catalog satisfy the required fields for an item.
  • We suggest integrating the result of this endpoint at the beginning of the checkout process.
  • Consume this from your backend and expose the information through your mobile/web API.

👍

Scanning

Check our docs to activate scanning functionality in this link.

📘

Units/Sub-units

Some acceptable units for products measured by weight

  • Kilogram:
    kg - KG - kG - Kg
  • Pound:
    LB - lB - Lb
  • Liter:
    L - l
  • Milliliter:
    ML - ml - mL - Ml
  • Gram:
    g - G - GR - Gr - gr
  • Milligram:
    mg - MG - Mg
  • Gallon:
    gal - GAL - Gal
{
  "currency_code": "string",
  "start": "2019-08-24T14:15:22Z",
  "end": "2019-08-24T14:15:22Z",
  "slot_size": 0,
  "minimum_slot_size": 0,
  "operational_models_priority": [
    "string"
  ],
  "fallback": true,
  "origin": {
    "name": "string",
    "address": "string",
    "address_two": "string",
    "description": "string",
    "country": "string",
    "city": "string",
    "state": "string",
    "zip_code": "string",
    "latitude": 0,
    "longitude": 0
  },
  "destination": {
    "name": "string",
    "address": "string",
    "address_two": "string",
    "description": "string",
    "country": "string",
    "city": "string",
    "state": "string",
    "zip_code": "string",
    "latitude": 0,
    "longitude": 0
  },
  "job_items": [
    {
      "id": "string",
      "name": "string",
      "photo_url": "string",
      "unit": "string",
      "sub_unit": "string",
      "quantity": 0,
      "sub_quantity": 0,
      "quantity_found_limits":{
        "max":5,
        "min":2
      },
      "barcodes": [
        "000000000000",
        "000000000000"
      ],
      "weight": 0,
      "volume": 0,
      "price": 0,
      "comment": "string",
      "attributes": {
        "category": "string",
        "plu": "string",
        "ean": "string",
        "location": "string",
        "picking_index": "string"
      }
    }
  ]
}
Language
Authentication
Header
Click Try It! to start a request and see the response here!