v1

Reference

API Reference

Every endpoint on the SwiftGoma API — grouped the same way as the sidebar. See the API docs for narrative guides on how authentication and user management fit together.

Account

POST/auth/create-accountCreate account POST/auth/verify-emailVerify email POST/auth/resend-verificationResend verification email POST/auth/register/googleRegister with Google

Login

POST/auth/login/googleLog in with Google POST/auth/login/request-otpRequest a passwordless login code POST/auth/login/verify-otpVerify a passwordless login code POST/auth/login/passwordLog in with password POST/auth/login/totpComplete login with a 2FA code

Password

POST/auth/password/forgotRequest a password reset POST/auth/password/resetReset password POST/auth/password/createSet a password POST/auth/password/updateChange password

Two-Factor (TOTP)

POST/auth/totp/setupStart 2FA setup POST/auth/totp/confirmConfirm and enable 2FA POST/auth/totp/disableDisable 2FA POST/auth/totp/regenerate-backup-codesRegenerate backup codes

Passkeys

POST/auth/passkey/login/optionsGet passkey login options POST/auth/passkey/login/verifyVerify passkey login POST/auth/passkey/register/optionsGet passkey registration options POST/auth/passkey/register/verifyVerify passkey registration GET/auth/passkeyList passkeys DELETE/auth/passkey/:passkeyIdRemove a passkey

Sessions

POST/auth/refresh-tokenRefresh access token GET/auth/meGet current user POST/auth/logoutLog out POST/auth/logout-allLog out everywhere GET/auth/sessionsList active sessions DELETE/auth/sessions/:sessionIdRevoke a session

Profile

PATCH/users/profileUpdate profile POST/users/profile/avatarUpload profile picture POST/users/deleteDelete account

Account Recovery

POST/users/recovery/requestRequest account recovery POST/users/recovery/verifyVerify account recovery

Phone Number

POST/users/phone/requestRequest phone verification POST/users/phone/verifyVerify phone POST/users/phone/update/requestRequest phone number change POST/users/phone/update/verifyVerify phone number change

Secondary Email

POST/users/email/secondary/requestAdd a secondary email POST/users/email/secondary/verifyVerify secondary email DELETE/users/email/secondaryRemove secondary email

Google Account

POST/users/google/linkLink Google account POST/users/google/unlinkUnlink Google account

Admin

GET/usersList users GET/users/:idGet user detail POST/users/:id/blockBlock user POST/users/:id/unblockUnblock user POST/users/:id/force-logoutForce logout POST/users/:id/verify-emailManually verify email POST/users/:id/verify-phoneManually verify phone POST/users/:id/deleteDelete user POST/users/:id/restoreRestore user POST/users/:id/roleChange user role

Categories

GET/products/categoriesList categories GET/products/categories/:idGet category POST/products/categoriesCreate category PUT/products/categories/:idUpdate category DELETE/products/categories/:idDelete category POST/products/categories/:categoryId/subcategoriesCreate subcategory PUT/products/categories/subcategories/:idUpdate subcategory DELETE/products/categories/subcategories/:idDelete subcategory

Products

GET/productsList products GET/products/popularList popular products GET/products/slug/:slugGet product POST/productsCreate product GET/products/shop/:shopIdList a shop's products PUT/products/:idUpdate product POST/products/:id/statusChange product status

Reviews

POST/products/:productId/reviewsSubmit a review

Stock

POST/products/variants/:variantId/stockAdjust stock GET/products/variants/:variantId/stock/historyGet stock history

Exchange Rates

GET/products/exchange-ratesList exchange rates GET/products/exchange-rates/:idGet exchange rate POST/products/exchange-ratesCreate exchange rate PUT/products/exchange-rates/:idUpdate exchange rate PUT/products/exchange-ratesUpsert exchange rate DELETE/products/exchange-rates/:idDelete exchange rate POST/products/exchange-rates/previewPreview a conversion

Moderation

GET/products/adminList all products GET/products/admin/:idGet product detail POST/products/admin/:id/statusModerate product status

Cart

POST/cart/itemsAdd item to cart PUT/cart/items/:itemIdUpdate cart item quantity DELETE/cart/items/:itemIdRemove cart item GET/cartList my carts GET/cart/shop/:shopIdGet cart for a shop POST/cart/shop/:shopId/clearClear cart

Checkout & Orders

POST/orders/checkoutCheckout GET/orders/meList my orders GET/orders/:idGet order POST/orders/:id/cancelCancel order POST/orders/:id/confirm-receiptConfirm receipt GET/orders/:id/qr-codeGet order QR code POST/orders/scanScan order QR code

Seller Fulfillment

POST/orders/:id/acceptAccept order POST/orders/:id/rejectReject order POST/orders/:id/readyMark order ready POST/orders/:id/complete-pickupComplete pickup handoff POST/orders/:id/assign-riderAssign rider GET/orders/shop/:shopIdList shop orders

Rider Delivery

POST/orders/:id/picked-upMark picked up POST/orders/:id/on-the-wayMark on the way POST/orders/:id/complete-deliveryComplete delivery POST/orders/:id/failed-deliveryMark failed delivery GET/orders/rider/meList my deliveries

Order Messages

GET/orders/:id/messagesList order messages POST/orders/:id/messagesSend order message POST/orders/:id/messages/readMark messages read

Order Moderation

GET/orders/adminList all orders GET/orders/admin/:idGet order detail POST/orders/admin/:id/cancelCancel order (staff)POST/orders/admin/:id/refund/request-approvalRequest order refund approval POST/orders/admin/:id/refund/confirmConfirm order refund POST/orders/admin/:id/refundRefund order (direct)

Seller Profile

POST/sellerCreate seller profile GET/seller/my-profileGet my seller profile PUT/sellerUpdate seller profile POST/seller/:userId/suspendSuspend seller profile POST/seller/:userId/reactivateReactivate seller profile

Seller KYC

POST/seller/kycSubmit KYC GET/seller/kyc/my-kycGet my KYC POST/seller/kyc/resubmitResubmit KYC GET/seller/kycList KYC submissions GET/seller/kyc/:idGet KYC detail POST/seller/kyc/:id/support-reviewMark support-reviewed POST/seller/kyc/:id/approveApprove KYC POST/seller/kyc/:id/rejectReject KYC

Deposits

POST/pawapay/depositsInitiate deposit GET/pawapay/deposits/:depositIdGet deposit status

Payouts

POST/pawapay/payouts/request-approvalRequest payout approval POST/pawapay/payouts/confirmConfirm payout GET/pawapay/payouts/historyGet payout history GET/pawapay/payouts/:payoutIdGet payout status

Refunds

POST/pawapay/refunds/request-approvalRequest refund approval POST/pawapay/refunds/confirmConfirm refund GET/pawapay/refunds/:refundIdGet refund status

Wallet & Configuration

GET/pawapay/wallet-balancesGet wallet balances GET/pawapay/active-configurationGet active configuration

Payin

POST/mbiyopay/payinInitiate payin

Payout

POST/mbiyopay/payout/request-approvalRequest payout approval POST/mbiyopay/payout/confirmConfirm payout GET/mbiyopay/payout/historyGet payout history

Transactions & Balances

GET/mbiyopay/transactions/:transactionIdGet transaction status GET/mbiyopay/balancesGet wallet balances GET/mbiyopay/balances/networksGet network balances GET/mbiyopay/countriesList supported countries

Notifications

GET/notificationsList notifications POST/notifications/:id/readMark notification read POST/notifications/read-allMark all notifications read DELETE/notifications/:idDelete notification GET/notifications/preferencesGet notification preferences PUT/notifications/preferencesUpdate notification preference POST/notificationsCreate notification

Shops

GET/seller/shop/slug/:slugGet shop GET/seller/shopsList shops POST/seller/shopCreate shop GET/seller/shop/meList my shops PUT/seller/shop/:idUpdate shop POST/seller/shop/:id/publishPublish shop POST/seller/shop/:id/unpublishUnpublish shop POST/seller/shop/:id/suspendSuspend my shop POST/seller/shop/:id/reactivateReactivate my shop DELETE/seller/shop/:idDelete my shop

Shop Moderation

GET/seller/shops/adminList all shops POST/seller/shop/:id/admin/suspendSuspend shop POST/seller/shop/:id/admin/reactivateReactivate shop DELETE/seller/shop/:id/adminDelete shop POST/seller/shop/:id/restoreRestore shop

Riders

GET/ridersList my riders POST/ridersInvite a rider POST/riders/:id/suspendSuspend rider POST/riders/:id/reactivateReactivate rider DELETE/riders/:idRemove rider GET/riders/me/deliveriesGet my delivery history

Plans

GET/plansList plans GET/plans/:idGet plan GET/plans/slug/:slugGet plan by slug POST/plansCreate plan PUT/plans/:idUpdate plan PUT/plans/:id/pricesUpdate plan price POST/plans/:id/activeSet plan active state

Subscriptions

POST/subscriptionsSubscribe POST/subscriptions/upgradeUpgrade subscription GET/subscriptions/meGet my subscription GET/subscriptions/me/paymentsGet my payment history POST/subscriptions/me/cancelCancel subscription POST/subscriptions/me/reactivateReactivate subscription POST/subscriptions/payments/:depositId/check-statusCheck payment status GET/subscriptions/statsGet subscription stats GET/subscriptions/revenueGet subscription revenue GET/subscriptions/adminList all subscriptions GET/subscriptions/admin/:idGet subscription detail

Invoices

GET/invoices/meList my invoices GET/invoices/me/download/:idDownload my invoice GET/invoices/statsGet invoice stats GET/invoices/adminList all invoices GET/invoices/admin/:idDownload any invoice

Dashboard

GET/dashboard/support-overviewGet support overview GET/dashboard/support-metricsGet support metrics GET/dashboard/accountant-overviewGet accountant overview GET/dashboard/overviewGet admin overview GET/dashboard/metricsGet admin metrics

Wallet Settings

POST/wallet-settingsCreate wallet settings GET/wallet-settings/meGet my wallet settings PUT/wallet-settingsUpdate wallet settings

Wallet

GET/wallet/meGet my wallet GET/wallet/me/transactionsGet my wallet transactions POST/wallet/payout/otpRequest payout OTP POST/wallet/payoutWithdraw from wallet

Favorites

GET/favoritesList favorites GET/favorites/idsList favorite IDs POST/favorites/:productIdAdd favorite DELETE/favorites/:productIdRemove favorite

Support

POST/support/contactSubmit contact message GET/support/messagesList contact messages GET/support/messages/:idGet contact message PATCH/support/messages/:idUpdate contact message POST/support/messages/:id/assign-meAssign to me

Incidents

GET/incidentsList incidents POST/incidentsCreate incident PATCH/incidents/:idUpdate incident PATCH/incidents/:id/statusUpdate incident status

Blog

GET/blogList posts GET/blog/slug/:slugGet post GET/blog/adminList all posts GET/blog/admin/:idGet post (any status)POST/blogCreate post PUT/blog/:idUpdate post DELETE/blog/:idDelete post

Reports

GET/accounting/reportPreview accountant report GET/accounting/report/pdfDownload report (PDF)GET/accounting/report/csvDownload report (CSV)POST/accounting/report/emailEmail report GET/accounting/reportsGet report history GET/accounting/reports/:id/pdfDownload stored report

Transactions & Ledger

GET/payments/transactionsList payout transactions GET/payments/ledgerGet payment ledger GET/payments/ledger/export/csvExport ledger (CSV)

Expenses

GET/expenses/metaGet expense categories GET/expensesList expenses GET/expenses/:idGet expense POST/expensesCreate expense PUT/expenses/:idUpdate expense POST/expenses/:id/rejectReject expense POST/expenses/:id/approve/requestRequest approval POST/expenses/:id/approve/resendResend approval code POST/expenses/:id/approve/confirmConfirm approval GET/expenses/export/csvExport expenses (CSV)

Storefront

GET/storefront/heroGet hero slides GET/storefront/admin/hero-slidesList hero slides POST/storefront/admin/hero-slidesCreate hero slide PUT/storefront/admin/hero-slides/:idUpdate hero slide DELETE/storefront/admin/hero-slides/:idDelete hero slide