Add a Custom Shipping Endpoint

Overview

This article walks through adding a custom shipping endpoint from the Foxy admin. For how the endpoint works, the request payload, and the response format, see Custom Shipping Endpoint.

Before you start

• Your endpoint must be reachable at an HTTPS URL and return rates in the JSON format Foxy expects. See the Custom Shipping Endpoint page for the request and response formats.

• The categories that should use the endpoint must have their delivery type set to "Shipped using live shipping rates" with a default weight configured.

Steps

1. 1

   In the Foxy admin, go to Settings and open the Shipping page.

2. 2

   In the Shipping methods list, click Custom Shipping Endpoint (With Native Rates). It shows as "Inactive" until configured.

3. 3

   A New shipping method panel opens with an Endpoint URL field.

4. 4

   Enter your endpoint's HTTPS URL (for example, https://example.com/rates).

5. 5

   Click Create.

6. 6

   Click Save (top right) to save the Shipping page.

Recommended: prevent rate tampering

On the same Shipping page, enable Prevent shipping rate tampering. This signs each rate Foxy receives from your endpoint and verifies it hasn't been altered between the cart and checkout submission.

Test it

Add a product from an eligible category to your cart and proceed to checkout with a shipping address. Foxy will POST the cart to your endpoint and display the rates it returns. If rates don't appear:

• Confirm the category delivery type is "Shipped using live shipping rates" with a default weight.

• Confirm your endpoint returns valid JSON with at least one rate (or an error). Any non JSON output will cause rates to fail.

• Check that service_id values are 10000 or higher and unique.

See the common errors section in the Custom Shipping Endpoint Overview for more troubleshooting.