How to Use AfriRegions

PrerequisitesWordPress 5.8+ · WooCommerce 6.0+ · PHP 7.4+

1. 1.Upload the plugin folder to /wp-content/plugins/, or install it from WordPress.org
2. 2.Activate it from the WordPress Plugins menu
3. 3.Go to WooCommerce → Settings → General and add the African countries you sell and ship to
4. 4.Open WooCommerce → AfriRegions to reach the dashboard and start setting up

1. 1.Go to WooCommerce → Settings → General
2. 2.Add your African countries to Selling location(s) and Shipping location(s)
3. 3.If you only sell in Cameroon, add only Cameroon, the plugin then loads Cameroon data only

1. 1.The search tolerates mistakes, typing “yaounde” finds “Yaoundé”, no accents or exact spelling needed
2. 2.Lists load progressively with a visual indicator, so it works on slow connections
3. 3.If the connection really drops, the plugin falls back to manual entry rather than blocking the order
4. 4.Until a region is chosen, the city field reads “Choose your region first”, so the order is self-explanatory

1. 1.Browse: expand a region to see its cities, expand a city to see its neighborhoods
2. 2.Search: the bar at the top filters the list as you type
3. 3.Filter by country: a selector lets you show one country at a time
4. 4.Add a city: expand a region, click “Add a city”, type the name
5. 5.Add a neighborhood: inside a city, click “Add” and type the name
6. 6.Delete: anything you added can be removed, and places shipped with the plugin can be hidden if you don't use them

1. 1.Turn on the master switch “Enable order field customization”, it is off by default and WooCommerce keeps its usual fields until you enable it
2. 2.Pick a sub-tab, Billing and Shipping are configured separately and independently
3. 3.Reorder: grab the handle on the left of a row and drag it
4. 4.Rename: type a name in the “Custom label” column, leave it empty to keep the default
5. 5.Toggle the “Required” and “Visible” checkboxes, a hidden field is never asked for
6. 6.Save your settings, or reset the active section back to the WooCommerce defaults

1. 1.Go to WooCommerce → Shipping, pick or create a shipping zone, then Add shipping method
2. 2.Choose “AfriRegions - Region / City / Neighborhood rates”
3. 3.Set the Title shown to the customer, keep it neutral like “Home delivery”, avoid putting “AfriRegions” in it
4. 4.Set the Default price, the rate used when none of your rules matches the destination
5. 5.Optionally tick “Hide if no rule matches”, the method then disappears instead of showing the default price, which makes the default price irrelevant
6. 6.Optionally set “Free shipping from” (Pro), leave it empty to disable, 0 disables the threshold rather than making everything free
7. 7.Add your rules: a region (required), optionally a city, optionally one or more neighborhoods, a price, and optionally a per-rule free shipping threshold (Pro)
8. 8.In Pro, add delivery tiers (Express, Same Day) with their surcharge and estimated time, and use CSV export/import for bulk editing

1. 1.Go to WooCommerce → Shipping → your zone → Add shipping method
2. 2.Choose “AfriRegions - Pickup Point”
3. 3.Set the Title shown to the customer
4. 4.Add your pickup points: name, location (region, city, neighborhood), address, opening hours and phone
5. 5.At checkout, customers only see the points in their city or region and pick the most convenient one

1. 1.Go to WooCommerce → Shipping → your zone → Add shipping method
2. 2.Choose “AfriRegions - Travel Agency”
3. 3.Set the Title shown to the customer, the tax status and the default price
4. 4.Add your routes: one price per destination, city or region
5. 5.Add your agencies, the collection points at destination
6. 6.At checkout the price comes from the route, and the customer selects the agency that suits them

1. 1.Enable REST API: exposes your address data (countries, regions, cities, neighborhoods) so a mobile app or another system can read it. Once on, the screen shows the API base URL and the list of routes
2. 2.Enable international phone field: turns the checkout phone field into one with a country flag and automatic dial code. The flag follows the billing country and the number is stored in international format (+237…)
3. 3.Click Save settings after changing either switch

1. 1.GET /wc/store/v1/cart to get a cart, note the Cart-Token and Nonce response headers and send them back on every following call
2. 2.POST /wc/store/v1/cart/add-item with {"id": 18172, "quantity": 1} to add a product
3. 3.POST /wc/store/v1/cart/update-customer with the shipping address, including the neighborhood under the scpwoo/neighborhood key
4. 4.Read the shipping_rates array in the response, each entry lists the available methods and their price
5. 5.POST /cart/select-shipping-rate for the customer's choice, then continue with the standard POST /checkout flow

curl -X POST https://your-store.com/wp-json/wc/store/v1/cart/update-customer \
  -H "Content-Type: application/json" \
  -H "Cart-Token: <token>" \
  -H "Nonce: <nonce>" \
  -d '{
        "shipping_address": {
          "country": "CM",
          "state": "LT",
          "city": "Douala",
          "address_1": "Rue 123",
          "scpwoo/neighborhood": "Bonapriso"
        }
      }'