SwiftGoma.SwiftGoma

Search endpoints

Jump to any API endpoint by name, method, or path

Guide

Riders

Riders handle delivery for a shop's orders — see Rider Delivery for the delivery lifecycle itself. Every endpoint on this page lives under https://api.swiftgoma.com/api/v1/riders.

Inviting a rider

A seller invites a rider by email — this creates a RIDER-role account (if one doesn't already exist for that address) linked to the seller's shop, and emails a verification code the invitee uses to set their password and activate the account.

Lifecycle

ActionEffect
SuspendRider can no longer be assigned deliveries. Existing in-progress deliveries are unaffected.
ReactivateRestores assignment eligibility.
DeleteRemoves the rider from the shop. Requires no active deliveries in progress.
Only the seller who owns the shop the rider belongs to can manage them — riders aren't shared across shops.

A rider's own view

A signed-in rider can pull their own delivery history — every order they've been assigned, past and present.

Browse the Riders endpoints in the API Reference