ePAL REST API Overview
Use the information provided here to understand how to use the REST API.
CAUTION:
This section is intended only for users who
integrate directly with ePAL, using the ePAL REST API. If you
are a WooCommerce plugin user,
you cannot use this API.
This section and the topics in it lists the API and its component parts.
For more information about how to get started with the API, see the Getting Started with the API section. This includes topics about authorizatoin and commands.
Restrictions and Limitations
The following restrictions and limitations apply:
- You must include authentication information in each request. For more information, see the API Authentication topic.
- You must include the
Content-Type: application/jsonandAccept: application/jsonheader information in all your requests. - The rate limit is around 300 requests per minute. This can vary depending on the individual requests.
Environments
The API can be used in 2 dffierent environments:
- Sandbox: This is the environment that you should use before you are ready to use the live production system.
- Production: This is the live production environment. Charges will be applied here.
The following table summarizes the detals for these:
| Detail | Sandbox | Production |
|---|---|---|
| API URL | https://sandbox-api.epalglobal.com/ |
https://api.epalglobal.com/ |
| Client ID | epal_20377450bbb442d6be9ed6c49ac84d15 |
This is your secret client ID. You can retrieve it from the
ePAL Portal. CAUTION: It is important
to keep this information secure and secret. |
| Client Secret | sk_sandbox_1f04c6fdf868ac8bfa481338b54827ea1e5c01f7a8711d09d700f25c6375ff50 |
This is your secret. You can retrieve it from the ePAL Portal. CAUTION: It is important
to keep this information secure and secret. |
| ePAL Portal | ePAL Dashboard (Sandbox) | ePAL Portal |
| ePAL Portal User |
|
This is your user and password for the ePAL Portal. |
API Components
Detailed reference information is provided for each endpoint and its requests and fields. For more information, see the API Reference Guide section.
The following table shows the API endpoints and requests:
| Endpoint | Requests |
|---|---|
Health (/health) |
Get welcome message |
| Health check | |
Health Check (/Health/Integrations) |
Check health status of all integrations |
Transactions (/transaction) |
Process transaction |
Quotes (/quotes) |
Get user quotes |
| Get user quotes (Pagination/Summary) | |
| Get quotes by session ID | |
| Get quote by session ID with raw data () | |
Documents
(/generate-labels) |
Generate shipping labels and documents |
| Get label by ID | |
| Get label by tracking number | |
| Get all Shippo documents for a transaction | |
| Get Shippo customs declaration by ID | |
Fulfillment (/fulfillment) |
Process fulfillment |
IOSS Validation
(/{ioss-validation}) |
Validate IOSS eligibility |
| Validate IOSS eligibility by session ID | |
Code Translation (/code-translation) |
Translate export/import/transport codes |
HS Code (/hscode) |
Search HS/TARIC by code |
| Search HS/TARIC by description |
API Commands
You can use commands to modify how the Process transaction request works. For more information about commands, see the API Commands topic.
Example Use Cases
The following table lists some examples of how you might use the API's requests:
| Use Case | API Request |
|---|---|
| Test the connection | Get welcome message |
| Perform a health check | Health check |
| Check the health status of connected applications | Check health status of all integrations |
| Process a quote transaction | Use the Process transaction with the
executeTransaction command set to
False |
| Process a complete or final transaction | Use the Process transaction with the
executeTransaction command set to
True |
| Process a transaction where tax is excluded | Use the Process transaction with the
calculateTaxExclusive command set to
True |
| Process a transaction where tax is included | Use the Process transaction with the
calculateTaxInclusive command set to
True |
| Calculate customs duties as part of the transaction | Use the Process transaction with the
calculateCustomDuties command set to
True |
| Check for denied parties when processing a transaction | Use the Process transaction with the
deniedParties command set to
True |
| Use Shippo for shipping rates when processing a transaction | Use the Process transaction with the
useShipping command set to
Shippo |
| Use real-time rates from Shippo when processing a transaction | Use the Process transaction with the
getShippingRates command set to
True |
| Retrieve quotes | Get user quotes |
| Generate shipping labels | Generate shipping labels and documents |
| Process an order fulfillment | Process fulfillment |
| Validate whether a transaction is eligible for IOSS or not | Validate IOSS eligibility |
| Translate transport codes | Translate export/import/transport codes |
| Search for a HS code | Search HS/TARIC by code |
| Search for a HS code using its description | Search HS/TARIC by description |