ShipSmarter Shipping

Track any parcel by its tracking number. No account needed. Works for parcels shipped through this service with any carrier, and for most Canadian carrier numbers (Canada Post, UPS, FedEx, Purolator, Nationex, GLS). Returns the current status, the estimated or actual delivery date and the carrier's latest scans, plus a link to the full tracking page. Use this whenever someone asks where a parcel is.

{
  "type": "object",
  "properties": {
    "tracking_number": {
      "type": "string",
      "description": "The carrier tracking number, e.g. \"1Z999AA10123456784\"."
    },
    "lang": {
      "type": "string",
      "enum": [
        "fr",
        "en"
      ],
      "description": "Language of the answer. Defaults to the user's locale, then to the site's language."
    }
  },
  "required": [
    "tracking_number"
  ],
  "additionalProperties": false
}

Get live shipping prices for one parcel from several carriers (Canada Post, UPS, FedEx and others). No account needed. Give the origin and destination postal or ZIP codes and the weight in kilograms (convert pounds and inches first); the box size is optional and a 30 x 20 x 10 cm box is assumed when it is missing. Returns up to 6 of the cheapest services with price and estimated transit time, and a link that opens the same quote on the website, where the label can be bought. Prices are the public rates at the moment of the quote. If the user is signed in, compare_shipping_rates returns their own account prices instead.

{
  "type": "object",
  "properties": {
    "from_postal": {
      "type": "string",
      "description": "Origin postal or ZIP code, e.g. \"H2X 1Y1\"."
    },
    "from_country": {
      "type": "string",
      "description": "Origin country, ISO alpha-2. Defaults to \"CA\"."
    },
    "to_postal": {
      "type": "string",
      "description": "Destination postal or ZIP code, e.g. \"M5V 2T6\"."
    },
    "to_country": {
      "type": "string",
      "description": "Destination country, ISO alpha-2. Defaults to \"CA\"."
    },
    "weight_kg": {
      "type": "number",
      "description": "Parcel weight in kilograms. Must be greater than 0."
    },
    "length_cm": {
      "type": "number",
      "description": "Optional. Box length in centimetres."
    },
    "width_cm": {
      "type": "number",
      "description": "Optional. Box width in centimetres."
    },
    "height_cm": {
      "type": "number",
      "description": "Optional. Box height in centimetres."
    },
    "lang": {
      "type": "string",
      "enum": [
        "fr",
        "en"
      ],
      "description": "Language of the answer. Defaults to the user's locale, then to the site's language."
    }
  },
  "required": [
    "from_postal",
    "to_postal",
    "weight_kg"
  ],
  "additionalProperties": false
}

Find places near a Canadian postal code where a parcel can be dropped off or picked up. No account needed. Covers Canada Post outlets, FedEx locations, UniUni drop-off points and MesColis counters, nearest first, with the address, distance, what can be done there and a map link. Optionally limit the search to one network. Opening hours vary, so suggest checking the map link before going.

{
  "type": "object",
  "properties": {
    "postal_code": {
      "type": "string",
      "description": "A full Canadian postal code, e.g. \"H2X 1Y1\"."
    },
    "network": {
      "type": "string",
      "enum": [
        "any",
        "canada_post",
        "fedex",
        "uniuni",
        "mescolis"
      ],
      "description": "Limit to one network: canada_post, fedex, uniuni or mescolis. Defaults to \"any\"."
    },
    "max_per_network": {
      "type": "integer",
      "minimum": 1,
      "maximum": 5,
      "description": "Points per network, 1 to 5. Default 3."
    },
    "lang": {
      "type": "string",
      "enum": [
        "fr",
        "en"
      ],
      "description": "Language of the answer. Defaults to the user's locale, then to the site's language."
    }
  },
  "required": [
    "postal_code"
  ],
  "additionalProperties": false
}

Compare live shipping rates for one parcel across every carrier available on the SIGNED-IN account (Canada Post, Purolator, UPS, FedEx and others), at the prices of that account. Returns each carrier and service with its total price, currency and estimated transit days. Requires the user to connect their account; for someone without an account use get_shipping_quote, which needs no sign-in. Prices are live and account-specific; do not cache them.

{
  "type": "object",
  "properties": {
    "from_postal": {
      "type": "string",
      "description": "Origin postal or ZIP code, e.g. \"H2X 1Y1\"."
    },
    "from_country": {
      "type": "string",
      "description": "Origin country, ISO alpha-2. Defaults to \"CA\"."
    },
    "to_postal": {
      "type": "string",
      "description": "Destination postal or ZIP code, e.g. \"M5V 2T6\"."
    },
    "to_country": {
      "type": "string",
      "description": "Destination country, ISO alpha-2. Defaults to \"CA\"."
    },
    "weight_kg": {
      "type": "number",
      "description": "Parcel weight in kilograms. Must be greater than 0."
    },
    "length_cm": {
      "type": "number",
      "description": "Parcel length in centimetres."
    },
    "width_cm": {
      "type": "number",
      "description": "Parcel width in centimetres."
    },
    "height_cm": {
      "type": "number",
      "description": "Parcel height in centimetres."
    },
    "residential": {
      "type": "boolean",
      "description": "True if delivering to a home address. Affects price on some carriers."
    }
  },
  "required": [
    "from_postal",
    "to_postal",
    "weight_kg",
    "length_cm",
    "width_cm",
    "height_cm"
  ],
  "additionalProperties": false
}

Look up the live status and checkpoint history of a parcel on the SIGNED-IN account by its tracking number. Returns the current status, estimated delivery date, the shipment id and the full checkpoint list. Requires the user to connect their account; to track any parcel without signing in, use track_package. Supplying the carrier is optional but makes the lookup faster.

{
  "type": "object",
  "properties": {
    "tracking_number": {
      "type": "string",
      "description": "The carrier tracking number."
    },
    "carrier": {
      "type": "string",
      "description": "Optional carrier slug, e.g. \"ups\", \"purolator\", \"canada_post\"."
    }
  },
  "required": [
    "tracking_number"
  ],
  "additionalProperties": false
}

List shipments on the authenticated account, newest first. Supports paging and filtering by status (for example "Delivered" or "In Transit"). Use get_shipment for the full record of one shipment.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "description": "How many to return. Max 100, default 20."
    },
    "offset": {
      "type": "integer",
      "description": "How many to skip, for paging. Default 0."
    },
    "status": {
      "type": "string",
      "description": "Optional status filter, e.g. \"Delivered\"."
    }
  },
  "additionalProperties": false
}

Retrieve the full record of a single shipment by its ID, including addresses, carrier, service, cost and current status.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The shipment ID, e.g. \"SHP-9FD8D9B5\"."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

List saved addresses from the account address book. Read-only — this server cannot create, change or delete addresses.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "description": "How many to return. Max 100, default 50."
    },
    "offset": {
      "type": "integer",
      "description": "How many to skip, for paging. Default 0."
    }
  },
  "additionalProperties": false
}