Skip to main content

Store operations

Routes​

MethodRoutePermissionSince
GET/delivery-boysManagement or store1.2.0
GET/payment-methodsSigned in1.2.0
GET/payment-gatewaysManagement1.2.0
GET/shipping-methodsPublic1.2.0

Couriers​

GET /delivery-boys lists users with the Delivery Boy role (deliveryboy_user), sorted by name. It accepts page, per_page and search (username, email or name).

{ "id": 31, "username": "diego", "display_name": "Diego Ruiz", "email": "diego@example.test", "roles": ["deliveryboy_user"], "meta": { "phone": "+57 300 000 0001", "store": "" } }

These are WordPress users with that role. NOTIWOO app courier accounts are managed in Employees.

Payment methods​

GET /payment-methods returns an object with the active gateways, in the form { "id": "name" }:

{ "success": true, "data": { "cod": "Cash on delivery", "bacs": "Direct bank transfer" } }

GET /payment-gateways is the detailed version for management: { id, title, description, method_title, enabled, supports[], settings{} }. Secret settings (keys, passwords, webhook secrets) arrive empty.

Shipping zones​

GET /shipping-methods returns the WooCommerce shipping zones, plus "Rest of the world" (id 0), with their active methods: { id, name, order, locations[], shipping_methods[{ id, title, cost }] }. Free shipping also includes requires and min_amount.

For pickup to work, the store's zone must have the Local pickup method (local_pickup). See Services and hours.