WooCommerce Endpoints

Endpoints are essentially an extra part in the website URL that we detect and show different content when present.

For example, you may have a ‘my account’ page shown on the URL yoursite.com/my-account. When the endpoint ‘edit-account’ is appended to this URL, making it ‘yoursite.com/my-account/edit-account‘ we show the Edit account page instead of the My account page.

This allows us to show different content without the need for multiple pages and shortcodes, thus reducing the amount of content we need to install.

By default the endpoints are already set up WooCommerce > Settings > Advanced in the Page setup section.

Checkout endpoints ↑ Back to top

The following endpoints are used for checkout-related functionality and are appended to the URL of the /checkout page:

  1. Pay page – /order-pay/{ORDER_ID}
  2. Order received (thanks) – /order-received/
  3. Add payment method – /add-payment-method/
  4. Delete payment method – /delete-payment-method/
  5. Set default payment method – /set-default-payment-method/

Account endpoints ↑ Back to top

The following endpoints are used for account-related functionality and are appended to the URL of the /my-account page:

  1. Orders – /orders/
  2. View order – /view-order/{ORDER_ID}
  3. Downloads – /downloads/
  4. Edit account (and change password) – /edit-account/
  5. Addresses – /addresses/
  6. Payment methods – /payment-methods/
  7. Lost password – /lost-password/
  8. Logout – /customer-logout/

Customizing endpoint URLs ↑ Back to top

The URL for each endpoint can be customized inWooCommerce > Settings > Advanced in the Page setup section.

Ensure that they are unique to avoid conflicts. If you encounter issues with 404s, go to Settings > Permalinks and save to flush the rewrite rules.

Using endpoints in menus ↑ Back to top

If you want to include an endpoint in your menus, you need to use the Links section:

2014-02-26 at 14.26

Enter the full URL to the endpoint and then insert that into your menu.

Remember that some endpoints, such as view-order, require an order ID to work. In general, we don’t recommend adding these endpoints to your menus. These pages can instead be accessed via the my-account page.

Using endpoints in Payment Gateway Plugins ↑ Back to top

WooCommerce provides helper functions in the order class for getting these URLs. They are:

$order->get_checkout_payment_url( $on_checkout = false );

and:

$order->get_checkout_order_received_url();

Gateways need to use these methods for full 2.1+ compatibility.

Troubleshooting ↑ Back to top

Endpoints showing 404 ↑ Back to top

  1. If you see a 404 error, go to WordPress AdminSettings > Permalinks and Save. This ensures that rewrite rules for endpoints exist and are ready to be used.

  2. If using an endpoint such as view-order, ensure that it specifies an order number. /view-order/ is invalid. /view-order/10/ is valid. These types of endpoints should not be in your navigation menus.

Endpoints are not working ↑ Back to top

On Windows servers, the web.config file may not be set correctly to allow for the endpoints to work correctly. In this case, clicking on endpoint links (e.g. /edit-account/ or /customer-logout/) may appear to do nothing except refresh the page. In order to resolve this, try simplifying the web.config file on your Windows server. Here’s a sample file configuration:

Pages direct to wrong place ↑ Back to top

Landing on the wrong page when clicking an endpoint URL is typically caused by incorrect settings. For example, clicking ‘Edit address’ on your account page takes you to the Shop page instead of the edit address form means you selected the wrong page in settings. Confirm that your pages are correctly configured and that a different page is used for each section.

WooCommerce - the most customizable eCommerce platform for building your online business.

Back to the top