Order Management

Create Order

There are three types of orders that can be created:

Point-to-Point Delivery: This type of order includes both a pickup location and a drop-off location. It is also commonly referred to as “Individual Delivery.”
Pickup-Only Order: This type of order specifies only a pickup location, with no drop-off location.
Dropoff-Only Order: This type of order specifies only a drop-off location, with no pickup location.

Let us provide a detailed explanation of each type of order, accompanied by examples.

Point-to-Point Delivery

The Create Order endpoint is utilized to create a Point-to-Point Delivery. To do so, both pickupDetails and dropoffDetails must be provided. It is important to note that if only pickupDetails or dropoffDetails is supplied, the order will automatically be classified as a Pickup-Only or Dropoff-Only delivery, respectively. Please refer to Pickup-Only and Dropoff-Only section for more details.

Example payload:

{
    "orderId": "0b41610a-39b1-4536-b591-3295ed3ab720",
    "externalId": "FUL-3281-1",
    "order": {  
        "description": "1 chocolate box",  
        "total": 100,  
        "tip": 5,  
        "itemCount": 1,  
        "serviceTime": 9  
    },
    "pickupDetails": {
        "address": "Central Park, New York, NY, USA",
        "instructions": "If the main gate is locked, call me",
        "phone": "1234567891",
        "location": {
            "latitude": 40.785091,
            "longitude": -73.968285
        },
        "scheduledPickupAt": "2025-01-15T17:45:36.745Z",
        "name": "Shohidul Bari",
        "businessName": "Bari Soft Ltd."
    },
    "dropoffDetails": {
        "address": "252 First Avenue, New York, NY 10009",
        "phone": "1234567891",
        "location": {
            "latitude": 40.7326,
            "longitude": -73.9815
        },
        "scheduledDropoffAt": "2025-01-15T18:45:36.745Z",
        "name": "Faisal Mohd",
        "businessName": "Fulflld Ltd.",
        "instructions": "Call me"
    },
    "deliveryRequirements": {
        "signature": false,
        "photo": true,
        "notes": true
    }
}

Pickup-Only

We can create Pickup-Ony order using both Create Order and Create Pickup-Only Order API. The request payload is same for both API.

{  
  "orderId": "0b41610a-39b1-4536-b591-3295ed3ab720",  
  "externalId": "FUL-6158-1",  
  "order": {  
    "total": 100,  
    "itemCount": 1,  
    "description": "1 bag or chocolate",  
    "tip": 5,  
    "serviceTime": 9  
  },  
  "pickupDetails": {  
    "address": "Central Park, New York, NY, USA",  
    "instructions": "call me",  
    "phone": "1234567891",  
    "location": {  
      "latitude": 40.785091,  
      "longitude": -73.968285  
    },  
    "scheduledPickupAt": "2025-01-13T17:45:36.745Z",  
    "schedulePickupBeforeAt": "2025-01-13T18:45:36.745Z",  
    "name": "Shohidul Bari",  
    "businessName": "Bari Soft"  
  },  
  "deliveryRequirements": {  
    "signature": true,  
    "photo": true,  
    "notes": false  
  }  
}

We are including an additional property, schedulePickupBeforeAt, within pickupDetails. This property is mandatory when creating a Pickup-Only order.

Dropoff-Only

Same as Pickup-Only orders, we can create Dropoff-Only order with the Create Order or Create Dropoff-Only Order API.

{
    "orderId": "0b41610a-39b1-4536-b591-3295ed3ab720",
    "externalId": "FUL-2754-1",
    "order": {
        "total": 100,
        "itemCount": 1,
        "description": "1 bag or chocolate",
        "tip": 5,
        "serviceTime": 9
    },
    "dropoffDetails": {
        "address": "Central Park, New York, NY, USA",
        "instructions": "call me",
        "phone": "1234567891",
        "location": {
            "latitude": 40.785091,
            "longitude": -73.968285
        },
        "scheduledDropoffAt": "2025-01-13T17:45:36.745Z",
        "scheduleDropoffAfterAt": "2025-01-13T16:45:36.745Z",
        "name": "Shohidul Bari",
        "businessName": "Bari Soft"
    },
    "deliveryRequirements": {
        "signature": true,
        "photo": false,
        "notes": true
    }
}

We are including an additional property, scheduleDropoffAfterAt, within dropoffDetails. This property is required when creating a Dropoff-Only order.

Update Order

Order can be updated through Update Order API. The payload will consist solely of the specific part that you wish to update.

For instance, if we need to update the Pickup name and Business name, the payload will be as follows:

{
    "pickupDetails": {
        "name": "Sumaiya Akter",
        "businessName": "Sumu Soft Ltd."
    }
}

Kindly note that the schema hierarchy must remain intact, and only the property requiring an update should be included.

Cancel Order

To cancel an order, the same Update Order API can be used to modify the status of the order. The payload will be as follows:

{
	"status": "CANCELLED"
}