https://parcelsapp.com/.well-known/ai-plugin.json
{
"schema_version": "v1",
"name_for_model": "parcelsapp",
"name_for_human": "Parcels",
"description_for_model": "Plugin for comprehensive tracking of packages, shipments, freights, and waybills. Leverages a broad range of courier APIs and data sources to provide updates and tracking information. Use it when you need to check the status of a delivery, trace a shipment route, or get estimated delivery times. Facilitates the use of multiple tracking numbers and supports global tracking by requiring the user to provide their destination country and language code, or provide inferred country and language. Optimal usage entails including specific keywords such as 'track', 'status', 'where is my package', or the direct use of tracking numbers. Should not provide any parameters outside of API spec. Should not provide inferred courier suggestions. It's MANDATORY to provide destination country for each package or use default as 'United States', if user's language is not specified assume 'en'. MANDATORY to repeat reading with tracking request UUID at least 5 times before giving up, some tracking numbers can take 60-90 seconds to track. You can and should display completed trackings, even if others are still in progress, continue to track until done. You should always provide first status update with timestamp and location, and summarize the rest, provide days in transit, detected delivery couriers and provide external links to courier websites. In case you receive partial tracking results for 1 or more tracking numbers, while others are still in progress, display completed tracking results and conitnue tracking the rest until done. Always display an ETA if it's provided. Do not write anything about exact delivery address or that it was hidden",
"description_for_human": "Track packages using parcelsapp.com",
"auth": {
"type": "none"
},
"api": {
"type": "openapi",
"url": "https://parcelsapp.com/.well-known/openapi.yaml",
"has_user_authentication": false
},
"logo_url": "https://parcelsapp.com/.well-known/logo.png",
"contact_email": "hello@parcelsapp.com",
"legal_info_url": "https://parcelsapp.com/terms-api"
}https://parcelsapp.com/.well-known/openapi.yaml
openapi: 3.0.2
info:
version: 1.0.0
title: Parcels API
description: 'Track packages globally with Parcels API. Create a Tracking Request to receive a UUID. Use it to query for results. Results might be cached. Continue step 2 until ".done" flag or error.'
servers:
- url: https://parcelsapp.com/api/v3
tags:
- name: Tracking Request
description: Create tracking requests and retrieve results
paths:
/shipments/gpt-tracking:
post:
operationId: createRequest
summary: Create tracking request
description: 'Create a tracking request. If all are tracked, "done" flag turns true. Stages: 1. Request Made - Returns UUID for later queries. 2. In Progress - Gives completed results. 3. If tracking ongoing, returns initial Request ID.'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TrackingRequest'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/TrackingResult'
get:
operationId: readResults
summary: Read shipment tracking results
description: Call POST /shipments/tracking with trackingIds to initiate tracking. Then, call GET /shipments/tracking every N seconds for updates. 'Done' flag set to true when tracking ends.
parameters:
- name: uuid
required: true
in: query
description: Tracking request UUID. You must use UUID to read results later
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/TrackingResult'
components:
schemas:
OutgoingLink:
type: object
properties:
slug:
type: string
description: Carrier slug
url:
type: string
description: Carrier URL
trackingId:
type: string
description: Package tracking number
method:
type: string
description: HTTP method GET/POST
Attribute:
type: object
properties:
l:
type: string
description: Attribute label
'n':
type: string
description: Attribute title
val:
type: string
description: Attribute values
Event:
type: object
properties:
state:
type: string
description: Event text
location:
type: string
description: Event location
date:
type: string
format: date-time
description: Event date & time in UTC
carrier:
type: integer
format: int32
description: Index of the carrier in .services array for the current event
TrackingItem:
type: object
properties:
trackingId:
type: string
description: Package tracking number, pass it as trackingId param
destinationCountry:
type: string
description: 'Destination country name in English: United States, United Kingdom, Germany, France, etc'
zipcode:
type: string
description: Optional postal code if required by carrier
Shipment:
type: object
properties:
trackingId:
type: string
description: Package tracking number, pass it as trackingId param
states:
type: array
description: List of tracking events
items:
$ref: '#/components/schemas/Event'
origin:
type: string
description: Origin country name localized to requested language
destination:
type: string
description: Destination country name localized to requested language
originCode:
type: string
description: Origin country 2-letter code
destinationCode:
type: string
description: Destination country 2-letter code
status:
type: string
description: Parcel status
enum:
- archive
- transit
- arrived
- pickup
detectedCarrier:
description: Carrier with the most tracking events or destination country carrier after parcel has arrived to destination
$ref: '#/components/schemas/Carrier'
detected:
type: array
description: List of carrier indexes tracking events were found in
items:
type: integer
format: int32
services:
type: array
description: List of tracked carriers
items:
$ref: '#/components/schemas/Carrier'
attributes:
type: array
description: List of attributes
items:
$ref: '#/components/schemas/Attribute'
externalTracking:
type: array
description: List of outgoing links for detected carriers
items:
$ref: '#/components/schemas/OutgoingLink'
Carrier:
type: object
properties:
slug:
type: string
description: Carrier slug
name:
type: string
description: Carrier title
TrackingRequest:
type: object
properties:
shipments:
type: array
description: List of shipments with trackingIds and destination country
items:
$ref: '#/components/schemas/TrackingItem'
language:
type: string
description: Language 2-letter ISO code
TrackingResult:
type: object
properties:
uuid:
type: string
description: Tracking request ID
done:
type: boolean
description: Flag indicating if all parcels finished tracking
shipments:
type: array
description: List of parcels that has finished tracking
items:
$ref: '#/components/schemas/Shipment'
Discover other plugins from the logistics category
0 VotesBoxon package helper
Plugin for giving the visitor a complete list of products to package its goods
0 Comments
0 VotesExpress Tracking
An assistant for tracking international express logistics.
0 Comments
0 VotesKargo Takibi
Track where your the parcel is, its movements and more for Turkish cargo providers.
0 Comments