SMKlog Parcel Shipping Rates

{'type': 'object', 'required': [], 'properties': {'to_zip': {'type': 'string', 'description': "Destination postal code: a 5-digit ZIP for the US, or the destination country's own postal code. Required unless quote_id is given."}, 'product': {'type': 'string', 'description': 'Plain-words item description. Required unless quote_id is given.'}, 'service': {'type': 'string', 'description': 'Service to anchor the amount to, e.g. "USPS Ground Advantage". Omitted or unmatched, the amount anchors the quote\'s first rate, top of the best-value ranking rather than the cheapest; the human can still pick any service on the page.'}, 'from_zip': {'type': 'string', 'description': 'Origin US ZIP code, 5 digits. Required unless quote_id is given.'}, 'quantity': {'type': 'integer', 'default': 1, 'minimum': 1, 'description': 'How many of the item ship together. Default 1.'}, 'quote_id': {'type': 'string', 'description': 'The quote_id returned by a previous get_parcel_quote call. Valid for 15 minutes.'}, 'to_country': {'enum': ['US', 'CA', 'GB', 'DE', 'AU'], 'type': 'string', 'default': 'US', 'description': 'Two-letter destination country: US (default), CA, GB, DE, AU.'}}}

{'type': 'object', 'required': ['intent', 'amount', 'currency', 'handoff_url'], 'properties': {'note': {'type': 'string', 'description': 'Standing caveats: live quote, human confirms consents and pays'}, 'amount': {'type': 'number', 'description': 'Live-quoted checkout total for the anchored service, USD'}, 'intent': {'type': 'string', 'description': 'Always "session" — this tool never charges'}, 'method': {'type': 'array', 'items': {'type': 'string'}, 'description': 'Payment rails behind the checkout, e.g. stripe, card'}, 'service': {'type': 'string', 'description': 'The service the amount is anchored to'}, 'currency': {'type': 'string', 'description': 'ISO currency, USD'}, 'session_id': {'type': ['string', 'null'], 'description': 'Handle for get_checkout_status, shaped as_ plus a UUID, good for 30 days. Null only when the session record could not be stored.'}, 'handoff_url': {'type': 'string', 'description': 'Opens the SMKlog checkout prefilled with this shipment'}, 'quote_reused': {'type': 'boolean', 'description': 'True when the amount came from a quote_id you supplied, so no carrier call was spent. False when this tool priced the shipment live -- either because no quote_id was given, or because the one given had expired.'}, 'identified_product_title': {'type': 'string', 'description': 'What the estimator understood the item to be'}}, 'description': 'A payment session, not a charge: the amount and the handoff URL where the human pays. The amount is a live quote at this moment, not a hold or a reservation, and no money moves until the human completes the page.'}

{'type': 'object', 'required': ['session_id'], 'properties': {'session_id': {'type': 'string', 'pattern': '^as_[A-Za-z0-9-]{8,80}$', 'description': 'The session_id from create_checkout_link.'}}}

{'type': 'object', 'required': ['session_id', 'status'], 'properties': {'next': {'type': 'string', 'description': 'What, if anything, the agent should do now'}, 'amount': {'type': 'number', 'description': 'The amount the session was anchored to, USD'}, 'status': {'enum': ['awaiting_checkout', 'checkout_started', 'paid', 'label_ready', 'delivered', 'refunded'], 'type': 'string', 'description': 'Stage, in that order'}, 'service': {'type': 'string', 'description': 'The service the session was anchored to'}, 'checkout': {'type': ['object', 'null'], 'properties': {'paid': {'type': 'boolean'}, 'carrier': {'type': ['string', 'null'], 'description': 'USPS, UPS, FedEx or DHL'}, 'service': {'type': ['string', 'null'], 'description': 'The service the human actually chose'}, 'order_id': {'type': 'string', 'description': 'SMKlog order id, the reference for support'}, 'refunded': {'type': 'boolean'}, 'started_at': {'type': 'string', 'description': 'When the checkout was created'}, 'label_ready': {'type': 'boolean'}, 'delivered_at': {'type': ['string', 'null']}, 'tracking_number': {'type': ['string', 'null'], 'description': 'Present from label_ready on'}, 'tracking_status': {'type': ['string', 'null'], 'description': 'Latest carrier status when known'}, 'estimated_delivery': {'type': ['string', 'null']}}, 'description': 'The checkout the human started, null while awaiting_checkout'}, 'currency': {'type': 'string', 'description': 'ISO currency, USD'}, 'created_at': {'type': 'string', 'description': 'When create_checkout_link made the session, ISO 8601'}, 'expires_at': {'type': 'string', 'description': 'When the session stops answering, ISO 8601'}, 'session_id': {'type': 'string', 'description': 'The session asked about'}, 'quote_reused': {'type': 'boolean', 'description': 'Whether the session reused a quote_id'}}, 'description': 'The stage of the checkout this session led to, derived from the order record.'}

{'type': 'object', 'required': ['product', 'from_zip', 'to_zip'], 'properties': {'to_zip': {'type': 'string', 'description': "Destination postal code: a 5-digit ZIP for the US, or the destination country's own postal code, e.g. M5V 2T6 for Toronto or SW1A 1AA for London."}, 'product': {'type': 'string', 'description': 'Plain-words item description, e.g. "65 inch flat screen TV in original box".'}, 'from_zip': {'type': 'string', 'description': 'Origin US ZIP code, 5 digits. The origin is always in the United States.'}, 'quantity': {'type': 'integer', 'default': 1, 'minimum': 1, 'description': 'How many of the item ship together. Default 1.'}, 'width_in': {'type': 'number', 'description': 'Packed box width, inches.', 'exclusiveMinimum': 0}, 'height_in': {'type': 'number', 'description': 'Packed box height, inches.', 'exclusiveMinimum': 0}, 'length_in': {'type': 'number', 'description': 'Packed box length, inches.', 'exclusiveMinimum': 0}, 'weight_lb': {'type': 'number', 'description': 'Packed weight, pounds. Decimals allowed.', 'exclusiveMinimum': 0}, 'to_country': {'enum': ['US', 'CA', 'GB', 'DE', 'AU'], 'type': 'string', 'default': 'US', 'description': 'Two-letter destination country: US (default), CA, GB, DE, AU.'}}}

{'type': 'object', 'required': ['rates'], 'properties': {'mode': {'type': 'string', 'description': 'Quote mode: parcel_label_ready when rates are listed; not_a_parcel, multiple_boxes or parcel_restricted when they are not'}, 'rates': {'type': 'array', 'items': {'type': 'object', 'required': ['carrier', 'service', 'amount'], 'properties': {'amount': {'type': 'number', 'description': 'Checkout total, USD, SMKlog fee inside'}, 'carrier': {'type': 'string', 'description': 'USPS, UPS, FedEx or DHL'}, 'service': {'type': 'string', 'description': 'Service name without the carrier prefix'}, 'currency': {'type': 'string', 'description': 'ISO currency, USD'}, 'delivery_days': {'type': ['integer', 'null'], 'description': 'Business days in transit when the carrier quotes one'}, 'retail_amount': {'type': 'number', 'description': 'Carrier retail counter price, USD; 0 when not published'}, 'service_label': {'type': 'string', 'description': 'Full display name, carrier included'}, 'delivery_window': {'type': ['string', 'null'], 'description': 'e.g. "2-5 business days"'}, 'delivery_estimated_date': {'type': ['string', 'null'], 'description': 'Estimated delivery date when quoted'}}}, 'description': 'Up to five purchasable services. Not cheapest first: they are ranked by best value, each rate scored as its checkout total in cents plus 175 per business day of transit (30 days when the carrier quotes none), lowest score first, and a rate that publishes a carrier counter price may lead a near-tie within 50 cents or 2 percent. Sort by amount yourself when you want the cheapest.'}, 'package': {'type': 'object', 'description': 'The packed box the rates were computed for'}, 'quote_id': {'type': 'string', 'description': 'Handle to this quote, good for 15 minutes. Pass it to create_checkout_link as quote_id and that call spends no second carrier call. Null when no rate came back, or when the handle could not be stored.'}}, 'description': 'Live rates for the shipment. Empty rates come with a mode that says why: not_a_parcel (SMKlog does not arrange pallet or freight shipments), multiple_boxes (quote each box on its own) or parcel_restricted.'}

{'type': 'object', 'properties': {'month': {'type': 'string', 'description': 'Issue month as YYYY-MM. Omit for the newest published issue.'}}}

{'type': 'object', 'required': ['month', 'captured_on', 'cells'], 'properties': {'page': {'type': 'string', 'description': 'The published issue page on smklog.com'}, 'cells': {'type': 'array', 'items': {'type': 'object', 'required': ['box', 'to', 'cheapest'], 'properties': {'to': {'type': 'string', 'description': 'Destination city'}, 'box': {'type': 'string', 'description': 'Basket carton, e.g. "Book box"'}, 'dims': {'type': 'string', 'description': 'Packed dimensions, inches'}, 'to_zip': {'type': 'string', 'description': 'Destination ZIP'}, 'weight': {'type': 'string', 'description': 'Packed weight, pounds'}, 'cheapest': {'type': 'object', 'description': 'The lowest-priced purchasable service for this cell'}, 'services': {'type': 'array', 'description': 'Every purchasable service for this cell, cheapest first'}}}, 'description': 'One entry per box and destination'}, 'label': {'type': 'string', 'description': 'Issue month spelled out, e.g. "August 2026"'}, 'month': {'type': 'string', 'description': 'Issue month, YYYY-MM'}, 'origin': {'type': 'string', 'description': 'Origin of every lane, Newark NJ (07102)'}, 'captured_on': {'type': 'string', 'description': 'The date every price in this issue was captured'}, 'methodology': {'type': 'string', 'description': 'How the numbers are produced'}, 'carrier_wins': {'type': ['object', 'null'], 'description': 'How many cells each carrier priced cheapest'}, 'basket_average': {'type': ['number', 'null'], 'description': 'Mean of the cheapest rate across all thirty cells, USD'}}, 'description': 'One published issue of the index: the cheapest service per box and lane with every rate behind it.'}

{'type': 'object', 'required': ['tracking_number'], 'properties': {'tracking_number': {'type': 'string', 'description': 'Carrier tracking number from the SMKlog receipt or label page'}}}

{'type': 'object', 'required': ['tracking', 'events'], 'properties': {'events': {'type': 'array', 'items': {'type': 'object', 'properties': {'zip': {'type': 'string', 'description': 'Scan ZIP'}, 'city': {'type': 'string', 'description': 'Scan city'}, 'state': {'type': 'string', 'description': 'Scan state'}, 'status': {'type': 'string', 'description': 'Machine status at this scan'}, 'message': {'type': 'string', 'description': 'What the carrier reported'}, 'datetime': {'type': 'string', 'description': 'Scan timestamp'}, 'status_label': {'type': 'string', 'description': 'Human-readable status'}}}, 'description': 'Scan events, newest first, up to eight'}, 'tracking': {'type': 'object', 'required': ['tracking_code', 'status'], 'properties': {'status': {'type': 'string', 'description': 'Machine status, e.g. in_transit, delivered'}, 'carrier': {'type': 'string', 'description': 'USPS, UPS, FedEx or DHL'}, 'updated_at': {'type': 'string', 'description': 'When this record last changed'}, 'delivered_at': {'type': 'string', 'description': 'Delivery timestamp once delivered'}, 'status_label': {'type': 'string', 'description': 'Human-readable status'}, 'last_event_at': {'type': 'string', 'description': 'Timestamp of the latest scan'}, 'status_detail': {'type': 'string', 'description': 'Carrier detail when reported'}, 'tracking_code': {'type': 'string', 'description': 'The carrier tracking number'}, 'estimated_delivery': {'type': 'string', 'description': 'Estimated delivery date when the carrier reports one'}}}}, 'description': 'Current delivery status plus the scan timeline, newest first.'}