GET |
/app/v1/health |
Surface status |
GET |
/app/oauth/authorize |
Sign-in page |
POST |
/app/oauth/authorize |
Sign-in page form |
POST |
/app/oauth/authorize/verify |
Sign-in page second step |
POST |
/app/oauth/token |
Tokens |
POST |
/app/oauth/revoke |
Revoke |
GET |
/app/v1/me |
Who the token speaks for |
POST |
/app/graphql |
GraphQL |
GET |
/app/v1/wallet |
Get the app-scoped customer wallet |
GET |
/app/v1/wallet/transactions |
List the customer wallet ledger |
GET |
/app/v1/wallet/payment-methods |
List Client-approved wallet payment methods |
POST |
/app/v1/wallet/tax-preview |
Preview configured customer tax |
POST |
/app/v1/wallet/top-ups |
Create an idempotent customer wallet top-up |
GET |
/app/v1/wallet/top-ups/{operationId} |
Get a wallet top-up status |
GET |
/app/v1/privacy |
Get app privacy overview |
POST |
/app/v1/privacy/account-deletion |
Request account closure |
DELETE |
/app/v1/privacy/account-deletion |
Cancel app account deletion |
POST |
/app/v1/privacy/phone/verify |
Verify and link the signed-in customer's phone |
POST |
/app/v1/privacy/phone/request |
Request phone verification for the signed-in customer |
GET |
/app/v1/home |
App home screen summary |
GET |
/app/v1/registration-details |
Registration details still to fill in |
POST |
/app/v1/registration-details |
Fill in the registration details |
GET |
/app/v1/notifications |
List app notifications |
POST |
/app/v1/notifications/{notificationId}/read |
Mark one app notification as read |
POST |
/app/v1/notifications/read-all |
Mark all app notifications as read |
GET |
/app/v1/notifications/preferences |
Get notification preferences |
PUT |
/app/v1/notifications/preferences |
Update notification preferences |
GET |
/app/v1/orders |
List app-enabled customer orders |
GET |
/app/v1/orders/{orderType}/{orderId} |
Show an app-enabled customer order |
GET |
/app/v1/returns |
List customer return requests |
POST |
/app/v1/returns |
Create a customer return request |
GET |
/app/v1/returns/{returnId} |
Show a customer return request |
POST |
/app/v1/returns/{returnId}/cancel |
Cancel a customer return request |
GET |
/app/v1/returns/config |
Get App return configuration |
POST |
/app/v1/returns/fee-quote |
Quote a return channel's fee |
POST |
/app/v1/returns/{returnId}/confirmation-email |
Resend a return confirmation email |
POST |
/app/v1/track |
Track any code (signed in) |
POST |
/app/v1/quotes/{line} |
Quote a line without signing in |
GET |
/app/v1/quotes/schema |
The quote form a client offers without signing in |
GET |
/app/v1/locker-locations |
List app-enabled SmartLocker locations |
GET |
/app/v1/locker-locations/{locationId} |
Show a SmartLocker location |
GET |
/app/v1/locker-locations/{locationId}/guide |
Indoor directions to the lockers of a location |
POST |
/app/v1/locker-locations/{locationId}/guide/feedback |
Answer whether the lockers were found |
PUT |
/app/v1/locker-locations/{locationId}/preference |
Update a customer SmartLocker preference |
GET |
/app/v1/pickups |
List customer locker pickups |
GET |
/app/v1/pickups/{deliveryId} |
Show a customer locker pickup |
POST |
/app/v1/pickups/{deliveryId}/collect |
Collect and remotely open a locker pickup |
POST |
/app/v1/pickups/{deliveryId}/handoff |
Hand a locker pickup to somebody else |
POST |
/app/v1/pickups/{deliveryId}/handoff/revoke |
Take back a handed-over locker pickup |
GET |
/app/v1/locker-storage/rentals |
List the renter's stored luggage |
GET |
/app/v1/locker-storage/rentals/{id} |
Show one stored bag |
POST |
/app/v1/locker-storage/rentals/claim |
Add a stored bag by its code |
POST |
/app/v1/locker-storage/rentals/{id}/delivery |
Have the bag delivered to an address |
POST |
/app/v1/locker-storage/rentals/{id}/keep |
Keep the bag in its compartment |
POST |
/app/v1/locker-storage/rentals/{id}/onward-quote |
Price delivery and shipment to an address |
POST |
/app/v1/locker-storage/rentals/{id}/pickup-site |
Collect at another cabinet |
POST |
/app/v1/locker-storage/rentals/{id}/pickup-site/cancel |
Collect where the bag is after all |
POST |
/app/v1/locker-storage/rentals/{id}/resend-code |
Send the pickup code again |
POST |
/app/v1/locker-storage/rentals/{id}/return-time |
Change when you come back |
POST |
/app/v1/locker-storage/rentals/{id}/shipment |
Ship the bag with a carrier or courier |
GET |
/app/v1/pay/outstanding |
Everything this payer owes |
POST |
/app/v1/pay/resolve |
Resolve a scanned pay tag |
POST |
/app/v1/pay/links |
Pay the code shown on a cabinet screen |
POST |
/app/v1/pay/requests |
Raise a payment request for one payable |
GET |
/app/v1/pay/requests/{publicToken} |
One payment request and its methods |
POST |
/app/v1/pay/requests/{publicToken}/pay |
Pay a payment request |
GET |
/app/v1/storefront |
Storefront entry |
GET |
/app/v1/mall/home |
Mall home blocks |
GET |
/app/v1/mall/stores |
Store directory |
GET |
/app/v1/mall/search |
Mall search |
GET |
/app/v1/mall/categories/{categoryId} |
Mall category products |
GET |
/app/v1/mall/group-buys |
Group buy channel |
GET |
/app/v1/stores/{slug} |
Store page |
GET |
/app/v1/stores/{slug}/home |
Store home page (multi-page style) |
GET |
/app/v1/stores/{slug}/categories/{categoryId} |
Store category page (multi-page style) |
GET |
/app/v1/stores/{slug}/products/{productId} |
Product page |
GET |
/app/v1/stores/{slug}/cart |
Cart of one store |
POST |
/app/v1/stores/{slug}/cart/items |
Add to cart |
PATCH |
/app/v1/stores/{slug}/cart/items/{itemId} |
Change a cart line quantity |
DELETE |
/app/v1/stores/{slug}/cart/items/{itemId} |
Remove a cart line |
POST |
/app/v1/stores/{slug}/checkout/quote |
Price the cart of a store for the order the buyer is about to place |
POST |
/app/v1/stores/{slug}/checkout/place |
Place the order from the cart |
GET |
/app/v1/store-orders |
The account's store orders at this client, newest first |
GET |
/app/v1/store-orders/{code} |
One store order of the account |
POST |
/app/v1/store-orders/{code}/pay |
Pay an unpaid order whose payment was left unfinished |
POST |
/app/v1/store-orders/{code}/confirm-payment |
After the PaymentSheet |
POST |
/app/v1/store-orders/{code}/cancel |
Cancel the order before the store accepts it |
POST |
/app/v1/store-orders/{code}/locker-open |
Open the next door of a paid locker pickup, on the buyer's own press at the cabi |
POST |
/app/v1/store-orders/{code}/locker-refund |
Refund a locker pickup whose door never opened |
POST |
/app/v1/store-orders/{code}/reorder |
Put the order's lines back into the buyer's cart at the store |
POST |
/app/v1/store-orders/{code}/return |
Ask the store to take a paid or completed order back |
POST |
/app/v1/store-orders/{code}/review/{productId} |
Rate one product of the order (1 to 5, optional comment) |
GET |
/app/v1/locker-locations/{locationId}/shop |
What a location's cabinets have for sale |
GET |
/app/v1/locker-shop/items |
Items in cells (merchant staff) |
POST |
/app/v1/locker-shop/orders |
Buy from a cabinet |
GET |
/app/v1/locker-shop/orders |
The caller's shop purchases |
GET |
/app/v1/locker-shop/orders/{id} |
One shop purchase |
POST |
/app/v1/locker-shop/orders/{id}/open |
Open the next door |
POST |
/app/v1/locker-shop/access-codes |
Issue a staff code (merchant staff) |
POST |
/app/v1/locker-shop/orders/{id}/refund-request |
Ask for a refund after a door would not open |
GET |
/app/v1/locker-resale/terms |
Handover terms for the buyer |
GET |
/app/v1/locker-resale/deals |
Handovers this customer is a party to |
POST |
/app/v1/locker-resale/deals |
Open a handover |
GET |
/app/v1/locker-resale/deals/{id} |
One handover |
POST |
/app/v1/locker-resale/deals/{id}/release |
Send the buyer the pickup code |
POST |
/app/v1/locker-resale/deals/{id}/revoke-code |
Revoke the pickup code |
POST |
/app/v1/locker-resale/deals/{id}/abort |
Call the handover off |
POST |
/app/v1/locker-resale/deals/{id}/cancel |
Cancel before anything is dropped off |
POST |
/app/v1/locker-resale/deals/{id}/report |
Report a problem after collecting |
GET |
/app/v1/group-buys/{code} |
Get a group buy campaign |
GET |
/app/v1/group-buys/{code}/address/details |
Get a suggested address |
GET |
/app/v1/group-buys/{code}/address/suggestions |
Suggest home addresses |
POST |
/app/v1/group-buys/{code}/quote |
Price a group buy order |
POST |
/app/v1/group-buys/{code}/order |
Place a group buy order |
POST |
/app/v1/group-buy-orders/{token}/confirm-payment |
Confirm a group buy card hold |
GET |
/app/v1/group-buy-orders |
List my group buy orders |
GET |
/app/v1/group-buy-orders/{token} |
Get a group buy order |
POST |
/app/v1/group-buy-orders/{token}/pay |
Resume a group buy card hold |
POST |
/app/v1/group-buy-orders/{token}/received |
Mark a group buy order received |
GET |
/app/v1/group-buys/{code}/lead |
Get leading a group buy |
POST |
/app/v1/group-buys/{code}/lead |
Apply to lead a group buy |
POST |
/app/v1/group-buys/{code}/lead/open |
Open a group buy group |
POST |
/app/v1/group-buys/{code}/lead/start |
Start a campaign from a self-pick plan |
GET |
/app/v1/group-buy-leading |
List the groups I lead |
GET |
/app/v1/group-buy-leading/{groupId} |
Get a group I lead |
POST |
/app/v1/group-buy-leading/{groupId}/orders/{orderId}/collected |
Mark a household collected |
GET |
/app/v1/clients/{clientCode}/bootstrap |
Bootstrap a client-assigned app |
POST |
/app/v1/clients/{clientCode}/guest/track |
Track any code (guest) |
POST |
/app/v1/clients/{clientCode}/guest/store-orders/{code}/locker-open |
Open the next door of a guest's paid locker pickup |
GET |
/app/v1/registration/clients |
List the Clients that accept new customer registrations |
POST |
/app/v1/clients/{clientCode}/registration/phone/request |
Request a registration phone verification code |
POST |
/app/v1/clients/{clientCode}/registration/email/request |
Request a registration email verification code |
POST |
/app/v1/clients/{clientCode}/registration/complete |
Register a Client customer |
POST |
/app/v1/account-closure/withdraw |
Withdraw a pending account closure request |
GET |
/app/v1/links/resolve |
What a scanned link of the client opens in the app |
GET |
/app/v1/clients/{clientCode}/guest/group-buys/{code} |
Get a group buy campaign as a guest |
GET |
/app/v1/clients/{clientCode}/guest/group-buys/{code}/address/details |
Get a suggested address for a guest |
GET |
/app/v1/clients/{clientCode}/guest/group-buys/{code}/address/suggestions |
Suggest home addresses to a guest |
POST |
/app/v1/clients/{clientCode}/guest/group-buy-orders/{token}/confirm-payment |
Confirm a guest group buy card hold |
GET |
/app/v1/clients/{clientCode}/guest/group-buy-orders/{token} |
Get a guest group buy order |
POST |
/app/v1/clients/{clientCode}/guest/group-buy-orders/{token}/pay |
Resume a guest group buy card hold |
POST |
/app/v1/clients/{clientCode}/guest/group-buy-orders/{token}/received |
Mark a guest group buy order received |
GET |
/app/v1/clients/{clientCode}/guest/group-buy-orders |
List a guest's group buy orders |
POST |
/app/v1/clients/{clientCode}/guest/group-buys/{code}/order |
Place a guest group buy order |
POST |
/app/v1/clients/{clientCode}/guest/group-buys/{code}/quote |
Price a guest group buy order |
POST |
/app/v1/clients/{clientCode}/guest/group-buys/{code}/verify/complete |
Verify a group buy guest's code |
POST |
/app/v1/clients/{clientCode}/guest/group-buys/{code}/verify/request |
Send a group buy guest a code |
GET |
/app/v1/clients/{clientCode}/guest/shipments/{guestOrderId} |
Get a guest shipment |
POST |
/app/v1/clients/{clientCode}/guest/shipments/{guestOrderId}/cancel |
Cancel a guest shipment |
GET |
/app/v1/clients/{clientCode}/guest/shipments/{guestOrderId}/label |
Get the label of a guest shipment |
POST |
/app/v1/clients/{clientCode}/guest/shipments/rate |
Price a guest shipment |
POST |
/app/v1/clients/{clientCode}/guest/shipments |
Submit a guest shipment for payment |
GET |
/app/v1/clients/{clientCode}/guest/shipments |
List a verified contact's guest shipments |
GET |
/app/v1/clients/{clientCode}/guest/storefront |
Storefront entry (guest) |
GET |
/app/v1/clients/{clientCode}/guest/stores/{slug} |
Store page (guest) |
GET |
/app/v1/clients/{clientCode}/guest/stores/{slug}/home |
Store home page (multi-page style) (guest) |
GET |
/app/v1/clients/{clientCode}/guest/stores/{slug}/categories/{categoryId} |
Store category page (multi-page style) (guest) |
GET |
/app/v1/clients/{clientCode}/guest/stores/{slug}/products/{productId} |
Product page (guest) |
GET |
/app/v1/clients/{clientCode}/guest/stores/{slug}/cart |
Cart of one store (guest) |
POST |
/app/v1/clients/{clientCode}/guest/stores/{slug}/cart/items |
Add to cart (guest) |
PATCH |
/app/v1/clients/{clientCode}/guest/stores/{slug}/cart/items/{itemId} |
Change a cart line quantity (guest) |
DELETE |
/app/v1/clients/{clientCode}/guest/stores/{slug}/cart/items/{itemId} |
Remove a cart line (guest) |
POST |
/app/v1/clients/{clientCode}/guest/stores/{slug}/checkout/quote |
Price a guest's cart at a store |
POST |
/app/v1/clients/{clientCode}/guest/stores/{slug}/checkout/place |
Place a guest order where the store takes guest orders (or at a table) |
GET |
/app/v1/clients/{clientCode}/guest/store-orders/{code} |
One guest store order, with its order token |
POST |
/app/v1/clients/{clientCode}/guest/store-orders/{code}/pay |
Pay a guest order whose payment was left unfinished |
POST |
/app/v1/clients/{clientCode}/guest/store-orders/{code}/confirm-payment |
After the PaymentSheet, for a guest order |
POST |
/app/v1/clients/{clientCode}/guest/store-orders/{code}/cancel |
Cancel a guest order before the store accepts it |
POST |
/app/v1/clients/{clientCode}/guest/store-orders/{code}/locker-refund |
Refund a guest's locker pickup whose door never opened |
POST |
/app/v1/clients/{clientCode}/guest/store-orders/{code}/reorder |
Put a guest order's lines back into the guest cart |
POST |
/app/v1/clients/{clientCode}/guest/store-orders/{code}/return |
Ask the store to take a guest's paid or completed order back |
POST |
/app/v1/clients/{clientCode}/guest/store-orders/{code}/review/{productId} |
Rate one product of a guest order |
GET |
/app/v1/clients/{clientCode}/guest/mall/home |
Mall home blocks (guest) |
GET |
/app/v1/clients/{clientCode}/guest/mall/stores |
Store directory (guest) |
GET |
/app/v1/clients/{clientCode}/guest/mall/search |
Mall search (guest) |
GET |
/app/v1/clients/{clientCode}/guest/mall/categories/{categoryId} |
Mall category products (guest) |
GET |
/app/v1/clients/{clientCode}/guest/mall/group-buys |
Group buy channel (guest) |
GET |
/app/v1/clients/{clientCode}/guest/links/resolve |
What a scanned link of the client opens in the app, without signing in |
GET |
/app/v1/guest/clients |
List the providers a visitor may use without signing in |
POST |
/app/v1/clients/{clientCode}/guest/verify/request |
Send a guest a verification code |
POST |
/app/v1/clients/{clientCode}/guest/verify/complete |
Check a guest verification code |
GET |
/app/v1/profile |
GET /app/v1/profile |
POST |
/app/v1/profile |
POST /app/v1/profile |
GET |
/app/v1/address-by-postcode/{postcode} |
GET /app/v1/address-by-postcode/{postcode} |
POST |
/app/v1/address-by-postcode/{postcode?} |
POST /app/v1/address-by-postcode/{postcode?} |
GET |
/app/v1/order-addressbook |
GET /app/v1/order-addressbook |
POST |
/app/v1/order-addressbook |
POST /app/v1/order-addressbook |
GET |
/app/v1/order-addressbook/{id} |
GET /app/v1/order-addressbook/{id} |
PUT |
/app/v1/order-addressbook/{id} |
PUT /app/v1/order-addressbook/{id} |
DELETE |
/app/v1/order-addressbook/{id} |
DELETE /app/v1/order-addressbook/{id} |
GET |
/app/v1/saved-form-answers |
List the order forms whose answers the customer may keep on their account |
PUT |
/app/v1/saved-form-answers/{formId} |
Save the answers the customer keeps for one order form |
DELETE |
/app/v1/saved-form-answers/{formId} |
Remove the answers the customer keeps for one order form |
GET |
/app/v1/storage-orders/config |
Get the configuration bundle needed to render the customer 'create storage order' form |
POST |
/app/v1/storage-orders/calculate-price |
Calculate the price of a storage order |
GET |
/app/v1/storage-orders |
List the authenticated customer's storage orders |
POST |
/app/v1/storage-orders |
Create a storage order |
GET |
/app/v1/storage-orders/{id} |
Get the detail of one storage order owned by the authenticated customer |
PUT |
/app/v1/storage-orders/{id} |
Update a storage order |
GET |
/app/v1/storage-orders/{id}/payment-info |
Get the payment options of a storage order |
POST |
/app/v1/storage-orders/{id}/pay |
Pay a storage order from the wallet balance |
POST |
/app/v1/storage-orders/{id}/cancel |
Cancel a storage order |
GET |
/app/v1/moving-orders/config |
Get the configuration bundle needed to render the customer 'create moving order' form |
POST |
/app/v1/moving-orders/calculate-price |
Calculate the price of a moving order |
GET |
/app/v1/moving-orders |
List the authenticated customer's moving orders |
POST |
/app/v1/moving-orders |
Create a moving order |
GET |
/app/v1/moving-orders/{id} |
Get the detail of one moving order owned by the authenticated customer |
PUT |
/app/v1/moving-orders/{id} |
Update a moving order |
GET |
/app/v1/moving-orders/{id}/payment-info |
Get the payment options of a moving order |
POST |
/app/v1/moving-orders/{id}/pay |
Pay a moving order from the wallet balance |
POST |
/app/v1/moving-orders/{id}/cancel |
Cancel a moving order |
GET |
/app/v1/order-announcements |
GET /app/v1/order-announcements |
POST |
/app/v1/order-announcements/confirm |
POST /app/v1/order-announcements/confirm |
GET |
/app/v1/shipping-orders/services |
List shipping services available to the authenticated customer |
GET |
/app/v1/shipping-orders/services/{serviceCode}/config |
Get the per-service configuration bundle needed to render the 'create shipping order' form |
POST |
/app/v1/shipping-orders/services/{serviceCode}/estimate-price |
Estimate the price of a shipping order on a service |
POST |
/app/v1/shipping-orders/services/{serviceCode}/orders |
Create a shipping order on a service |
GET |
/app/v1/shipping-orders/services/{serviceCode}/orders |
List the authenticated customer's shipping orders under one service |
GET |
/app/v1/shipping-orders/{id} |
Get the detail of one shipping order owned by the authenticated customer |
PUT |
/app/v1/shipping-orders/{id} |
Update a shipping order |
POST |
/app/v1/shipping-orders/{id}/cancel |
Cancel a shipping order |
GET |
/app/v1/shipping-orders/{id}/payment-info |
Get the payment information of a shipping order |
POST |
/app/v1/shipping-orders/{id}/pay |
Pay a shipping order from the wallet balance |
GET |
/app/v1/deals |
GET /app/v1/deals |
POST |
/app/v1/uniorder/rate |
Uniorder: rate a shipment (self delivery and label carrier services) |
POST |
/app/v1/uniorder |
Uniorder: create an order at a rate |
POST |
/app/v1/uniorder/{orderId}/label |
Uniorder: buy the label of a label order kept without one |
GET |
/app/v1/uniorder/{orderId}/label |
Uniorder: download the label |
POST |
/app/v1/uniorder/{orderId}/cancel |
Uniorder: cancel an order |
GET |
/app/v1/uniorder/{orderId} |
Uniorder: read an order |
GET |
/app/v1/uniorder/{orderId}/tracking |
Uniorder: track an order |
GET |
/app/v1/driver/routes |
Get routes for one driver |
GET |
/app/v1/driver/boards |
List the Route Boards visible to the driver |
GET |
/app/v1/driver/boards/{id} |
Get one Route Board with its seats |
POST |
/app/v1/driver/boards/{id}/claim |
Claim a seat (route) on a Route Board, or grab a seat on a seat-mode board |
POST |
/app/v1/driver/boards/{id}/bid |
Place or lower a bid on a seat of a bid-mode (reverse auction) Route Board |
POST |
/app/v1/driver/claims/{id}/withdraw |
Withdraw one of your Route Board claims |
GET |
/app/v1/driver/claims |
List your Route Board claims |
POST |
/app/v1/driver/routes/cancel |
Cancel route by driver |
POST |
/app/v1/driver/startDelivery |
start Delivery By route id |
POST |
/app/v1/driver/endDelivery |
end Delivery By route id |
GET |
/app/v1/driver/routes/{routeId}/orders |
Get orders on route for one driver |
GET |
/app/v1/driver/firebase/routes/{routeId}/area/{area} |
GET /app/v1/driver/firebase/routes/{routeId}/area/{area} |
POST |
/app/v1/driver/routes/{routeId}/orders/{orderId}/remove |
Remove order from route by orderId |
POST |
/app/v1/driver/routes/{routeId}/orders/batchremove |
Batch remove orders from a route |
GET |
/app/v1/driver/routes/{routeId}/get-stop-number/{ref} |
Get order stop number by ref/orderid/trackingnumber |
POST |
/app/v1/driver/routes/{routeId}/add-order/{ref} |
Add order to route by ref/orderid/trackingnumber |
POST |
/app/v1/driver/routes/{routeId}/batch-add-orders-by-driver |
Batch Add Orders to Route by Driver |
GET |
/app/v1/driver/routes/{routeId}/points |
Get points on route for one driver |
GET |
/app/v1/driver/orders-status |
Get order status list |
POST |
/app/v1/driver/orders-status |
Update order status |
POST |
/app/v1/driver/routes/validate-order |
Validate if ref matches order_id |
POST |
/app/v1/driver/addGpsTackingRecord |
Add Gps Tracking Record |
GET |
/app/v1/driver/orders/{orderId} |
Get order by Id |
GET |
/app/v1/driver/orders/{orderId}/price-detail |
Get unified price detail for an order |
PATCH |
/app/v1/driver/orders/{orderId}/related-order-items |
Update related storage/moving/shipping order items by driver order id |
GET |
/app/v1/driver/packagings |
Get packaging types and packagings for the driver's service provider |
GET |
/app/v1/driver/unit-mappings |
Get dimension and weight unit mappings |
GET |
/app/v1/driver/ref/{ref} |
Find the driver's order by ref, id or tracking number |
POST |
/app/v1/driver/orders-notes/create |
Create an order note |
GET |
/app/v1/driver/orders-notes/{orderId} |
Get order notes |
GET |
/app/v1/driver/orders-files/{orderId} |
GET /app/v1/driver/orders-files/{orderId} |
POST |
/app/v1/driver/upload-pictures |
Upload order picture |
POST |
/app/v1/driver/upload-pictures-from-urls |
POST /app/v1/driver/upload-pictures-from-urls |
POST |
/app/v1/driver/delete-pictures |
Delete order picture by orderfile Id |
POST |
/app/v1/driver/update-deliver |
POST /app/v1/driver/update-deliver |
POST |
/app/v1/driver/batch-update-deliver |
POST /app/v1/driver/batch-update-deliver |
GET |
/app/v1/driver/sms/templates |
GET /app/v1/driver/sms/templates |
GET |
/app/v1/driver/sms/success-content/order/{id} |
Delivered message text for an order |
GET |
/app/v1/driver/duty |
Driver duty status and pending offers |
POST |
/app/v1/driver/duty |
Go on / off duty |
GET |
/app/v1/driver/assignments/pending |
Pending auto-assign offers |
POST |
/app/v1/driver/orders/{orderId}/accept |
Accept an assigned order |
POST |
/app/v1/driver/orders/{orderId}/reject |
Reject an assigned order |
GET |
/app/v1/driver/earnings |
Driver earnings summary |
POST |
/app/v1/driver/orders/{orderId}/cash-collected |
Driver records cash collected on an order (payroll v2) |
GET |
/app/v1/driver/pod-requirements |
POD requirements at stop completion (driver app) |
GET |
/app/v1/driver/sms/fail-content/order/{id} |
Delivery failed message text for an order |
GET |
/app/v1/driver/sms/template/{templateId}/order/{id} |
Message text of a template for an order |
GET |
/app/v1/driver/profile |
get driver profile |
PUT |
/app/v1/driver/profile |
update driver profile |
POST |
/app/v1/driver/create-route |
Create a new route by driver |
GET |
/app/v1/driver/orders |
Get Orders |
POST |
/app/v1/driver/optimize-route |
optimize route |
GET |
/app/v1/driver/kiosk-receiving-packages |
Get kiosk receiving area package count |
POST |
/app/v1/driver/kiosk-receive-package |
Scan and receive an awaiting-processing package from kiosk receiving area |
GET |
/app/v1/driver/availability |
Current availability (online, heartbeat, load) |
POST |
/app/v1/driver/availability |
Go online/offline or send a heartbeat |
GET |
/app/v1/driver/pool/orders |
Regular orders in the driver pool |
POST |
/app/v1/driver/pool/orders/{orderId}/claim |
Claim a pool order onto today's route |
POST |
/app/v1/driver/pickup-order/{ref} |
Pickup scan by order or package identifier |
GET |
/app/v1/driver/orders/{orderId}/chat |
Order chat thread (driver view) |
POST |
/app/v1/driver/orders/{orderId}/chat |
Send a driver message into an order chat |
POST |
/app/v1/driver/orders/{orderId}/chat/read |
Mark an order chat as read (driver) |
GET |
/app/v1/driver/chat/unread |
Driver unread chat counters |
GET |
/app/v1/notifications/realtime |
Get foreground notification MQTT credentials |
POST |
/app/v1/devices |
Register an app push device |
DELETE |
/app/v1/devices/{deviceId} |
Revoke an app push device |
GET |
/app/v1/sessions |
List the person's sign-ins to this app |
DELETE |
/app/v1/sessions/{sessionId} |
End one sign-in |
POST |
/app/v1/clients/{clientCode}/driver/register |
Sign up a driver |
GET |
/app/v1/driver/return-reasons/{order_id?} |
Reasons for a failed stop |
GET |
/app/v1/clients/{clientCode}/swidget |
sWidget configuration |
GET |
/app/v1/clients/{clientCode}/swidgets/{widgetId} |
Load a widget by its id |
GET |
/app/v1/clients/{clientCode}/guest/quotes/schema |
Quote form (guest) |
POST |
/app/v1/clients/{clientCode}/guest/quotes/{line} |
Quote one line (guest) |
GET |
/app/v1/clients/{clientCode}/guest/pickup-points |
Pickup points (guest) |
GET |
/app/oauth/swidget/callback |
sWidget sign-in return page |
sMap
sLocker
sPrint
sWidget