
Postal Ninja
@XPack
Postal Ninja offers an official tracking API for developers. It has tools like moveTrack, createTrack, etc., allowing interaction with package tracking info. Endpoints, methods, and parameters are provided for each tool. Authentication, response format, and error handling are also detailed.
Postal Ninja API Documentation
1. Overview
Postal Ninja provides an official tracking API for developers. This API allows developers to interact with package tracking information in various ways.
2. Tools
moveTrack
- Description: Moves a package with a given ID to the ARCHIVED, TRASHED or back to the ACTIVE list.
- Usage:
- Endpoint: [Specify the endpoint for moveTrack]
- Method: [HTTP method, e.g., POST]
- Parameters:
packageId
: The ID of the package to be moved.status
: The new status (ARCHIVED, TRASHED, ACTIVE).
createTrack
- Description: Returns the ID of a newly created package (status = CREATED) or the stored ID if the tracking number already exists (status = FOUND).
- Usage:
- Endpoint: [Specify the endpoint for createTrack]
- Method: [HTTP method, e.g., POST]
- Parameters:
trackingNumber
: The tracking number of the package.
listTracks
- Description: Lists all or selected packages with pagination.
- Usage:
- Endpoint: [Specify the endpoint for listTracks]
- Method: [HTTP method, e.g., GET]
- Parameters:
page
: The page number (default: 1).limit
: The number of packages per page (default: 10).filters
: Optional filters to narrow down the list (e.g., status=ACTIVE).
listCarriers
- Description: Returns a list of all supported carriers.
- Usage:
- Endpoint: [Specify the endpoint for listCarriers]
- Method: [HTTP method, e.g., GET]
ping
- Description: Returns OK for an authorized API user.
- Usage:
- Endpoint: [Specify the endpoint for ping]
- Method: [HTTP method, e.g., GET]
getTrack
- Description: Returns tracking info for a given package ID.
- Usage:
- Endpoint: [Specify the endpoint for getTrack]
- Method: [HTTP method, e.g., GET]
- Parameters:
packageId
: The ID of the package for which to get the tracking info.
updateTrack
- Description: Updates the following attribute of the package with the given ID: destination country.
- Usage:
- Endpoint: [Specify the endpoint for updateTrack]
- Method: [HTTP method, e.g., PUT]
- Parameters:
packageId
: The ID of the package to be updated.destinationCountry
: The new destination country.
refreshTrack
- Description: Submits an on-demand refresh request to the tracking engine for a package with the given ID. Note that packages in the ACTIVE list are auto-tracked regularly, so this is not needed for such packages.
- Usage:
- Endpoint: [Specify the endpoint for refreshTrack]
- Method: [HTTP method, e.g., POST]
- Parameters:
packageId
: The ID of the package for which to refresh the tracking.
3. Authentication
[Describe the authentication mechanism, e.g., API keys, OAuth]
4. Response Format
[Describe the format of the responses, e.g., JSON]
5. Error Handling
[Describe how errors are returned, e.g., status codes, error messages]
XPack MCP
{
"mcpServers": {
"postal-ninja": {
"type": "sse",
"autoApprove":"all",
"url": "https://mcp.xpack.ai/v1/mcp/postal-ninja?authkey={Your-XPack-Auth-Key}"
}
}
}