Orders

Below are the services that allow your organization to integrate directly with Boosmap.

Create order

POST /order

Example of a standard call

curl --request POST "https://api.boosmap.io/order" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer [TOKEN]" \
-d '{
    "order_number": "LOREM123123",
    "delivery_date": "2018-12-06 13:00:00",
    "delivery_service": "Sameday",
    "delivery_start_time": "13:00",
    "delivery_end_time": "16:00",
    "notes": "Lorem Ipsum Lorem Ipsum",
    "pickup": {
      "location": {
        "name": "Nombre del Punto retiro",
        "address": "Brown Sur 333",
        "district": "Nunoa"
      }
    },
    "dropoff": {
      "contact": {
        "fullname": "Testing Testing",
        "email": "email@gmail.com",
        "phone": "+56991234567"
      },
      "location": {
        "address": "Direccion prueba",
        "district": "La Florida",
        "latitude": -33.4583,
        "longitude": -70.5945
      }
    },
    "packages": [
      {
        "code": "123123123",
        "name": "Lorem Ipsum 1",
        "price": "23000",
        "qty": 1
      },
      {
        "code": "123123125",
        "name": "Lorem Ipsum 2",
        "price": "10000",
        "qty": 2
      }
    ],
    "tags": {
      "brand": "Lorem Ipsum"
    },
    "files": [
      {
        "name": "Lorem Ipsum",
        "kind": "recipe",
        "url": "https://picsum.photos/200/300.jpg"
      },
      {
        "name": "Lorem Ipsum",
        "kind": "recipe",
        "url": "https://picsum.photos/200/300.jpg"
      }
    ],
    "url_tracking": "true"
}'

Example of a call using a branch ID, after branch homologation.
Creating orders using pickup.location.id allows us to distribute your orders strategically, creating optimal delivery routes and reaching the destination in the shortest possible time, since we know the branches.

curl --request POST "https://api.boosmap.io/order" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer [TOKEN]" \
-d '{
    "order_number": "LOREM123123",
    "delivery_date": "2018-12-06 13:00:00",
    "delivery_service": "Sameday",
    "delivery_start_time": "13:00",
    "delivery_end_time": "16:00",
    "notes": "Lorem Ipsum Lorem Ipsum",
    "pickup": {
      "location": {
        "id": 123
      }
    },
    "dropoff": {
      "contact": {
        "fullname": "Testing Testing",
        "email": "email@gmail.com",
        "phone": "+56991234567"
      },
      "location": {
        "address": "Direccion prueba",
        "district": "La Florida",
        "latitude": -33.4583,
        "longitude": -70.5945
      }
    },
    "packages": [
      {
        "code": "123123123",
        "name": "Lorem Ipsum 1",
        "price": "23000",
        "qty": 1
      },
      {
        "code": "123123125",
        "name": "Lorem Ipsum 2",
        "price": "10000",
        "qty": 2
      }
    ],
    "tags": {
      "brand": "Lorem Ipsum"
    },
    "files": [
      {
        "name": "Lorem Ipsum",
        "kind": "recipe",
        "url": "https://picsum.photos/200/300.jpg"
      },
      {
        "name": "Lorem Ipsum",
        "kind": "recipe",
        "url": "https://picsum.photos/200/300.jpg"
      }
    ],
    "url_tracking": "true"
}'

Parameters


order_number Required string	Order number
delivery_date Required datetime	Delivery date of the order (Y-m-d H:i:s)
delivery_service Required string	Delivery window type (Nextday, Express, Sameday, NextdayWithWindow, SamedayWithWindow)
delivery_start_time Optional string	Start time
delivery_end_time Optional string	End time
notes Optional string	Additional notes for the order
pickup Required object	Pickup point information
dropoff Required object	Delivery point information
packages Required array	Packages in the order
tags Required object	Additional data that needs to be recorded
files Optional object	Additional files for the order
url_tracking Optional boolean	If true, the response will include the tracking URL

Get order information

GET /order/{order_number}

Example call

curl --request GET "https://api.boosmap.io/order/{order_number}" \
-H "Content-Type: application/json" -H "Authorization: Bearer [TOKEN]"

Example response

{
  "errors": null,
  "success": true,
  "data": {
    "deliveries": [
      {
        "notes": "Lorem Ipsum Lorem Ipsum",
        "updated": "2019-02-05T10:49:46Z",
        "created": "2019-02-05T10:49:45Z",
        "contactName": "Testing Testing",
        "orderNumber": "PRUEBA_12234235",
        "deliveryDate": "2018-12-06T16:00:00Z",
        "contactPhone": "+56991234567",
        "contactEmail": "email@gmail.com",
        "last_state": "asignación aceptada",
        "state": [
          {
            "date": "05-05-2020 18:46:44",
            "status": "entregado"
          },
          {
            "date": "05-05-2020 18:46:21",
            "status": "en camino entrega"
          },
          {
            "date": "05-05-2020 18:46:18",
            "status": "en despacho"
          },
          {
            "date": "05-05-2020 17:41:28",
            "status": "en punto de retiro"
          },
          {
            "date": "05-05-2020 17:35:37",
            "status": "asignación aceptada"
          },
          {
            "date": "05-05-2020 16:26:45",
            "status": "ingresado"
          }
        ],
        "packages": [
          {
            "name": "Lorem Ipsum 1",
            "price": 23000,
            "qty": "1"
          },
          {
            "name": "Lorem Ipsum 2",
            "price": 10000,
            "qty": "2"
          }
        ],
        "trackingURL": "https://"
      }
    ]
  }
}

Parameters

order_number

Required

string

Order number

Response

Returns an object with the information of a specific order