Skip to content

Regions

What This Is

Regions are the territory records Pyle uses to describe where tax or shipping behavior applies. The shared package includes a few related pieces here, including geographic regions, sale regions, and country/state lookup data.

This is mostly an operator concept for understanding coverage and exceptions. The packaged product does not expose one polished region-management screen. In practice, most teams experience territory behavior through address forms, inventory locations, and order review rather than through a dedicated region page.

When You Would Use It

Use Regions when you need to:

  • understand why an address is inside or outside a territory
  • check whether a destination should be taxed or handled differently
  • confirm the regions behind shipping or tax rules
  • compare geographic coverage between different territories

Do not use this page when you only want to edit a tax percentage. That belongs in Tax Rates.

Before You Start

Make sure you know:

  • the customer or shipping address you are checking
  • whether the issue is about tax, shipping, or exemption behavior
  • whether your project exposes a region review screen, API-backed lookup, or only indirect setup

In some installations, you may only be able to inspect region data through related setup screens rather than a dedicated region page.

How To Use It In The Admin

  1. Start with the address or destination that looks wrong.
  2. Check the related tax or shipping setup that uses territory data.
  3. Verify the country and state first. These are usually the most visible territory controls in packaged admin and storefront forms.
  4. Confirm whether the destination is expected to fall inside a geographic or sale region.
  5. Check address or location-management screens if your project uses them as the main territory entry point.
  6. If your project exposes region lists or lookup pages, review the matching region records there.
  7. If your project does not expose a direct region screen, use the related tax, shipping, address, or location workflow to confirm the coverage instead.

What It Changes In The Storefront

Region data can change:

  • which tax rules apply
  • which shipping options appear
  • whether a customer is treated as inside or outside a territory
  • whether a customer qualifies for certain exemptions or special handling

Shoppers usually do not see the region records themselves. They only see the outcome through tax, shipping, or eligibility behavior.

Common Tasks

  • confirm whether an address belongs to the expected territory
  • compare geographic and sale region coverage
  • check country and state data when a rule is not firing
  • investigate why shipping or tax differs between two destinations
  • verify whether a customer is being treated as exempt in a region

Rules, Limits, And Things To Watch

  • There is no strong packaged UI for regions in the shared product.
  • Country and state selectors are more user-visible than geo-region or sale-region records in the shared package.
  • Sale regions and geo regions are related but not identical.
  • Country and state data are supporting lookup records, not the main business control.
  • Region changes often affect other workflows indirectly rather than showing up on their own page.

Troubleshooting

  • If a tax rate is not applying, check the address country and state first.
  • If shipping looks wrong, compare the destination against the territory records your project uses.
  • If a customer is unexpectedly exempt, check whether a nexus or exemption rule is involved.
  • If you cannot find a region screen, that may be expected in the shared package.
  • If the destination looks right but the outcome is still wrong, inspect the underlying address or inventory-location setup next.
  • Tax Rates
  • Orders
  • Shipping Services
  • Customers

Sources:

  • packages/framework/src/Models/GeoRegion.php
  • packages/framework/src/Models/SaleRegion.php
  • packages/framework/src/Models/Nexus.php
  • packages/framework/src/Http/Controllers/Api/Admin/GeoRegionsController.php
  • packages/framework/src/Http/Controllers/Api/World/StatesController.php
  • packages/framework/src/Actions/SaleRegion/Requests/Index.php
  • packages/framework/src/Actions/GeoRegion/SyncAddresses.php
  • packages/framework/src/Actions/GeoRegion/SyncShippingPostalCodes.php
  • packages/framework/src/Observers/NexusObserver.php
  • packages/framework/src/Actions/TaxJar/CreateOrUpdateTaxExemptCustomer.php