Delivery

Delivery Resources

Manage drivers, customers, vehicles, zones, and hubs for your delivery operations. All routes live under /modules/delivery/*.

Drivers

Manage delivery drivers, their online/offline status, and location tracking via linked geo entities.

deliveryDriverCreate

GET

typescript

const driver = await ss.delivery.drivers.create({
  name: 'Alex Rivera',
  phone: '+15551234567',
  vehicle_id: 'veh_01',
})

Open Delivery and go to Drivers
Click Add Driver
Fill in the driver details and click Save

deliveryDriverList

GET

typescript

const drivers = await ss.delivery.drivers.list()

Open Delivery and go to Drivers
Browse or filter the driver list

deliveryDriverGet

GET

typescript

const driver = await ss.delivery.drivers.get('drv_01')

Open Delivery and go to Drivers
Click on a driver to view their profile

deliveryDriverUpdate

GET

typescript

const updated = await ss.delivery.drivers.update('drv_01', {
  phone: '+15559876543',
})

Open Delivery and go to Drivers
Click on a driver, edit the fields, then click Save

deliveryDriverOnline

GET

typescript

await ss.delivery.drivers.online('drv_01')

Open Delivery and go to Drivers
Click on a driver, then toggle their status to Online

deliveryDriverOffline

GET

typescript

await ss.delivery.drivers.offline('drv_01')

Open Delivery and go to Drivers
Click on a driver, then toggle their status to Offline

deliveryDriverDelete

GET

typescript

await ss.delivery.drivers.delete('drv_01')

Open Delivery and go to Drivers
Click on a driver, then click Delete

Customers

Manage delivery customers and their saved addresses.

deliveryCustomerCreate

GET

typescript

const customer = await ss.delivery.customers.create({
  name: 'Jane Smith',
  email: 'jane@example.com',
  phone: '+15551234567',
})

Open Delivery and go to Customers
Click Add Customer
Fill in the customer details and click Save

deliveryCustomerList

GET

typescript

const customers = await ss.delivery.customers.list()

Open Delivery and go to Customers
Browse or search the customer list

deliveryCustomerGet

GET

typescript

const customer = await ss.delivery.customers.get('cust_01')

Open Delivery and go to Customers
Click on a customer to view their profile

deliveryCustomerUpdate

GET

typescript

const updated = await ss.delivery.customers.update('cust_01', {
  phone: '+15559876543',
})

Open Delivery and go to Customers
Click on a customer, edit the fields, then click Save

deliveryCustomerDelete

GET

typescript

await ss.delivery.customers.delete('cust_01')

Open Delivery and go to Customers
Click on a customer, then click Delete

deliveryCustomerAddressCreate

GET

typescript

await ss.delivery.customers.addAddress('cust_01', {
  label: 'Home',
  address: '42 Elm St',
  lat: 40.71,
  lng: -74.01,
})

Open Delivery and go to Customers
Click on a customer, open the Addresses tab
Click Add Address, fill in details, then click Save

deliveryCustomerAddressList

GET

typescript

const addresses = await ss.delivery.customers.listAddresses('cust_01')

Open Delivery and go to Customers
Click on a customer, then open the Addresses tab

deliveryCustomerAddressDelete

GET

typescript

await ss.delivery.customers.deleteAddress('cust_01', 'addr_01')

Open Delivery and go to Customers
Click on a customer, open the Addresses tab
Click on an address, then click Delete

Vehicles

Manage delivery vehicles and assign them to drivers.

deliveryVehicleCreate

GET

typescript

const vehicle = await ss.delivery.vehicles.create({
  type: 'van',
  plate: 'ABC-1234',
  capacity: 500,
})

Open Delivery and go to Vehicles
Click Add Vehicle
Fill in the vehicle details and click Save

deliveryVehicleList

GET

typescript

const vehicles = await ss.delivery.vehicles.list()

Open Delivery and go to Vehicles
Browse or filter the vehicle list

deliveryVehicleGet

GET

typescript

const vehicle = await ss.delivery.vehicles.get('veh_01')

Open Delivery and go to Vehicles
Click on a vehicle to view its details

deliveryVehicleUpdate

GET

typescript

const updated = await ss.delivery.vehicles.update('veh_01', {
  capacity: 750,
})

Open Delivery and go to Vehicles
Click on a vehicle, edit the fields, then click Save

deliveryVehicleDelete

GET

typescript

await ss.delivery.vehicles.delete('veh_01')

Open Delivery and go to Vehicles
Click on a vehicle, then click Delete

Zones

Define delivery zones backed by logistics geofences.

deliveryZoneCreate

GET

typescript

const zone = await ss.delivery.zones.create({
  name: 'Downtown',
  polygon: [
    { lat: 40.75, lng: -74.00 },
    { lat: 40.75, lng: -73.97 },
    { lat: 40.72, lng: -73.97 },
    { lat: 40.72, lng: -74.00 },
  ],
})

Open Delivery and go to Zones
Click Create Zone
Draw the zone boundary on the map and click Save

deliveryZoneList

GET

typescript

const zones = await ss.delivery.zones.list()

Open Delivery and go to Zones
Browse the list of delivery zones

deliveryZoneGet

GET

typescript

const zone = await ss.delivery.zones.get('zone_01')

Open Delivery and go to Zones
Click on a zone to view its details and boundary

deliveryZoneUpdate

GET

typescript

const updated = await ss.delivery.zones.update('zone_01', {
  name: 'Downtown Extended',
})

Open Delivery and go to Zones
Click on a zone, edit the fields or boundary, then click Save

deliveryZoneDelete

GET

typescript

await ss.delivery.zones.delete('zone_01')

Open Delivery and go to Zones
Click on a zone, then click Delete

Hubs

Manage delivery hubs (warehouses, kitchens, pickup points).

deliveryHubCreate

GET

typescript

const hub = await ss.delivery.hubs.create({
  name: 'Warehouse A',
  lat: 40.74,
  lng: -73.99,
  address: '100 Main St',
})

Open Delivery and go to Hubs
Click Add Hub
Fill in the hub details and click Save

deliveryHubList

GET

typescript

const hubs = await ss.delivery.hubs.list()

Open Delivery and go to Hubs
Browse the list of hubs

deliveryHubGet

GET

typescript

const hub = await ss.delivery.hubs.get('hub_01')

Open Delivery and go to Hubs
Click on a hub to view its details

deliveryHubUpdate

GET

typescript

const updated = await ss.delivery.hubs.update('hub_01', {
  name: 'Warehouse A — East Wing',
})

Open Delivery and go to Hubs
Click on a hub, edit the fields, then click Save

deliveryHubDelete

GET

typescript

await ss.delivery.hubs.delete('hub_01')

Open Delivery and go to Hubs
Click on a hub, then click Delete