Starshipit MCP by usefulapi
Read Starshipit orders, tracking, rates and manifests; create and update unshipped orders.
¿Debería usar esto?
Calidad y seguridad
A
Hallazgos (3)
- LOWTool 'starshipit_list_unshipped_orders' name length outside 3-30 rangeen starshipit_list_unshipped_orders
- LOWTool 'starshipit_list_delivered_orders' name length outside 3-30 rangeen starshipit_list_delivered_orders
- LOWTool 'starshipit_list_delivery_services' name length outside 3-30 rangeen starshipit_list_delivery_services
Basado en el análisis automatizado de las definiciones de herramientas y el cumplimiento del protocolo.
Costo de contexto
~7,287Tokens (definiciones de herramientas)
~3.3 KBTamaño de respuesta típico
Impacto significativo en la atención (5.69% del contexto de 128k)
Este es el número aproximado de tokens que se consumen cada vez que las herramientas del servidor se cargan en el contexto de un modelo. Los recuentos más altos reducen la atención disponible para otras tareas.
Instalar
Instalación con un clic
Agrega esto a tu archivo `claude_desktop_config.json`:
{
"mcpServers": {
"starshipit": {
"url": "https://starshipit.usefulapi.io/mcp"
}
}
}Puntos de conexión remotos
https://starshipit.usefulapi.io/mcpstreamable-httpQué puede hacer
Inventario de herramientas
Herramientas (19)
🟢 Solo lectura🟡 Escritura🔴 Eliminación⚪ Desconocido
🟢starshipit_list_unshipped_orders(since_order_date, since_last_updated, ids_only, limit, page)
List unshipped (new, not yet printed) orders with full details: addresses, items, packages, carrier. By default only orders updated in the last 24 hours; use since_order_date / since_last_updated to look further back. ids_only=true returns just the order ids. GET /api/orders/unshipped.
Esquema de entrada
{
"type": "object",
"properties": {
"since_order_date": {
"description": "Only orders created after this UTC date-time (RFC 3339).",
"type": "string"
},
"since_last_updated": {
"description": "Only orders updated after this UTC date-time (RFC 3339).",
"type": "string"
},
"ids_only": {
"description": "Return only the unshipped order ids.",
"type": "boolean"
},
"limit": {
"description": "Results per page, 1-250 (default 50).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 250
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢starshipit_list_shipped_orders(since_last_updated, ids_only, limit, page)
List shipped orders (label printed) with tracking number, tracking status, carrier, manifest and shipped date. By default only orders updated in the last 24 hours; use since_last_updated to look further back. Label files are not returned. GET /api/orders/shipped.
Esquema de entrada
{
"type": "object",
"properties": {
"since_last_updated": {
"description": "Only orders updated after this UTC date-time (RFC 3339).",
"type": "string"
},
"ids_only": {
"description": "Return only the shipped order ids.",
"type": "boolean"
},
"limit": {
"description": "Results per page, 1-250 (default 50).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 250
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢starshipit_list_printed_orders(status, since_created_date, limit, page)
List orders whose label was recently printed, or printed but not yet manifested, with tracking numbers. GET /api/orders/shipments.
Esquema de entrada
{
"type": "object",
"properties": {
"status": {
"description": "Which shipments to list (default recently_printed).",
"type": "string",
"enum": [
"recently_printed",
"unmanifested"
]
},
"since_created_date": {
"description": "Only shipments created after this UTC date-time (RFC 3339).",
"type": "string"
},
"limit": {
"description": "Results per page, 1-250 (default 50).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 250
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢starshipit_list_delivered_orders(order_ref)
List delivered orders that carry a given order reference (the customer reference), with full order details. GET /api/orders/delivered.
Esquema de entrada
{
"type": "object",
"properties": {
"order_ref": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "The order reference to look for."
}
},
"required": [
"order_ref"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢starshipit_orders_summary(order_status, filter, sort, sort_direction, page, ...)
A compact list of orders in one status (new, printed, shipped, archived) with contact, country, carrier, weight, manifest and dates, plus account-wide counts (unprinted, printed, shipped, archived, invalid addresses, returns). Supports filters and sorting. GET /api/orders/summary.
Esquema de entrada
{
"type": "object",
"properties": {
"order_status": {
"type": "string",
"enum": [
"new",
"shipped",
"printed",
"archived"
],
"description": "Which orders to summarize."
},
"filter": {
"description": "Filter string COLUMN:::VALUE, several separated by commas, e.g. `Order:::1419,State:::NSW` or `Source:::Shopify`. Columns: Order, Name, Address (valid), Date (>=MAY 2024), Source, State, Country, Carrier, Service, Status, SKU, SingleSKU, Writeback, Weight (>=5), ShippingMethod, ShippingDescription, Tag. Prefix a column with ! to negate (!Country:::Australia).",
"type": "string",
"minLength": 3,
"maxLength": 500
},
"sort": {
"description": "Column to sort by.",
"type": "string",
"enum": [
"Address",
"Carrier",
"Name",
"Country",
"Date",
"Items",
"Manifest",
"Order",
"Product",
"Quantity",
"ShippedDate",
"ShippingDescription",
"ShippingMethod",
"SKU",
"StockOnHand",
"Platform",
"State",
"Status",
"Weight",
"Writeback"
]
},
"sort_direction": {
"type": "string",
"enum": [
"Ascending",
"Descending"
]
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"page_size": {
"description": "Results per page, 1-500 (default 50).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 500
}
},
"required": [
"order_status"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢starshipit_search_orders(phrase, fields, status, include_child_accounts, limit, ...)
Search orders by order number, tracking number, customer reference or recipient name (phrase), optionally limited to unshipped or shipped orders. Returns id, number, date, name, carrier, tracking number and country. GET /api/orders/search.
Esquema de entrada
{
"type": "object",
"properties": {
"phrase": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Search text, e.g. a name, order number or tracking number."
},
"fields": {
"description": "Which field to search (default All: order number, tracking number, reference, name).",
"type": "string",
"enum": [
"All",
"Order_Number",
"TheirRef"
]
},
"status": {
"description": "Limit to unshipped or shipped orders (default All).",
"type": "string",
"enum": [
"All",
"Unshipped",
"Shipped"
]
},
"include_child_accounts": {
"description": "Also search child accounts.",
"type": "boolean"
},
"limit": {
"description": "Results per page, 1-250 (default 50).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 250
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
}
},
"required": [
"phrase"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢starshipit_get_order(order_id, order_number, status, include)
One order by Starshipit order_id or by the order_number from the source platform. Use include to add sections (Items, Packages, Events, Metadatas, Shipping_Price, ...). Status defaults to Unshipped in Starshipit, so pass status=Shipped or Printed for orders already printed. Label files are not returned. GET /api/orders?order_id= or ?order_number=.
Esquema de entrada
{
"type": "object",
"properties": {
"order_id": {
"description": "Starshipit order id.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"order_number": {
"description": "Order number from the source platform, e.g. #1234.",
"type": "string",
"minLength": 1,
"maxLength": 50
},
"status": {
"description": "Order status to look in (Starshipit default: Unshipped).",
"type": "string",
"enum": [
"Unshipped",
"Shipped",
"Printed"
]
},
"include": {
"description": "Extra sections to include.",
"maxItems": 9,
"type": "array",
"items": {
"type": "string",
"enum": [
"Account_Summary",
"Shipment_Attributes",
"Sender_Details",
"Destination",
"Items",
"Packages",
"Metadatas",
"Events",
"Shipping_Price"
]
}
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢starshipit_list_orders(status, filter, include, sort_column, sort_direction, ...)
List full order details for one status (Unshipped by default, or Shipped / Printed), narrowed by a filter such as `Order:::1419,Country:::Australia` and sorted. Heavier than the summary: use starshipit_orders_summary for overviews. Label files are not returned. GET /api/orders (no id).
Esquema de entrada
{
"type": "object",
"properties": {
"status": {
"description": "Order status (default Unshipped).",
"type": "string",
"enum": [
"Unshipped",
"Shipped",
"Printed"
]
},
"filter": {
"description": "Filter string COLUMN:::VALUE, several separated by commas, e.g. `Order:::1419,State:::NSW` or `Source:::Shopify`. Columns: Order, Name, Address (valid), Date (>=MAY 2024), Source, State, Country, Carrier, Service, Status, SKU, SingleSKU, Writeback, Weight (>=5), ShippingMethod, ShippingDescription, Tag. Prefix a column with ! to negate (!Country:::Australia).",
"type": "string",
"minLength": 3,
"maxLength": 500
},
"include": {
"description": "Extra sections to include.",
"maxItems": 9,
"type": "array",
"items": {
"type": "string",
"enum": [
"Account_Summary",
"Shipment_Attributes",
"Sender_Details",
"Destination",
"Items",
"Packages",
"Metadatas",
"Events",
"Shipping_Price"
]
}
},
"sort_column": {
"type": "string",
"enum": [
"Address",
"Carrier",
"Name",
"Country",
"Date",
"Items",
"Manifest",
"Order",
"Product",
"Quantity",
"ShippedDate",
"ShippingDescription",
"ShippingMethod",
"SKU",
"StockOnHand",
"Platform",
"State",
"Status",
"Weight",
"Writeback"
]
},
"sort_direction": {
"type": "string",
"enum": [
"Ascending",
"Descending"
]
},
"page_number": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"page_size": {
"description": "Results per page, 1-100 (default 25).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢starshipit_track_shipment(tracking_number, order_number)
Tracking details for a shipped order, by tracking number or by order number: status, carrier, tracking URL, shipment date and the carrier's tracking events. GET /api/track.
Esquema de entrada
{
"type": "object",
"properties": {
"tracking_number": {
"description": "Carrier tracking number.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"order_number": {
"description": "Order number from the source platform.",
"type": "string",
"minLength": 1,
"maxLength": 50
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢starshipit_get_rates(destination, packages, sender, currency)
QUOTE ONLY: shipping rates (service name, code, price) for a destination and parcels from the couriers enabled in the account. Nothing is purchased, created or printed. The sender defaults to the account's pickup address. Needs at least one enabled courier. POST /api/rates.
Esquema de entrada
{
"type": "object",
"properties": {
"destination": {
"type": "object",
"properties": {
"street": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"suburb": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"city": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"state": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"post_code": {
"type": "string",
"minLength": 1,
"maxLength": 10
},
"country_code": {
"type": "string",
"pattern": "^[A-Za-z]{2}$",
"description": "2-letter country code, e.g. AU, NZ, US."
}
},
"required": [
"country_code"
]
},
"packages": {
"minItems": 1,
"maxItems": 20,
"type": "array",
"items": {
"type": "object",
"properties": {
"weight": {
"type": "number",
"exclusiveMinimum": 0,
"maximum": 100000,
"description": "Parcel weight in kg."
},
"height": {
"description": "Height in metres.",
"type": "number",
"minimum": 0,
"maximum": 1000
},
"width": {
"description": "Width in metres.",
"type": "number",
"minimum": 0,
"maximum": 1000
},
"length": {
"description": "Length in metres.",
"type": "number",
"minimum": 0,
"maximum": 1000
}
},
"required": [
"weight"
]
},
"description": "The parcels (weight in kg, dimensions in metres)."
},
"sender": {
"description": "Sender address; omitted = the account's pickup address.",
"type": "object",
"properties": {
"street": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"suburb": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"city": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"state": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"post_code": {
"type": "string",
"minLength": 1,
"maxLength": 10
},
"country_code": {
"type": "string",
"pattern": "^[A-Za-z]{2}$",
"description": "2-letter country code, e.g. AU, NZ, US."
}
},
"required": [
"country_code"
]
},
"currency": {
"description": "Currency code for the order value, e.g. AUD.",
"type": "string",
"pattern": "^[A-Za-z]{3}$"
}
},
"required": [
"destination",
"packages"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢starshipit_list_delivery_services(destination, packages, sender, declared_value, include_pricing, ...)
QUOTE ONLY: the carrier delivery services available for a shipment (carrier, service name and code) and, with include_pricing, their prices and service options. Nothing is purchased, created or printed. POST /api/deliveryservices.
Esquema de entrada
{
"type": "object",
"properties": {
"destination": {
"type": "object",
"properties": {
"street": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"suburb": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"city": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"state": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"post_code": {
"type": "string",
"minLength": 1,
"maxLength": 10
},
"country_code": {
"type": "string",
"pattern": "^[A-Za-z]{2}$",
"description": "2-letter country code, e.g. AU, NZ, US."
}
},
"required": [
"country_code"
]
},
"packages": {
"minItems": 1,
"maxItems": 20,
"type": "array",
"items": {
"type": "object",
"properties": {
"weight": {
"type": "number",
"exclusiveMinimum": 0,
"maximum": 100000,
"description": "Parcel weight in kg."
},
"height": {
"description": "Height in metres.",
"type": "number",
"minimum": 0,
"maximum": 1000
},
"width": {
"description": "Width in metres.",
"type": "number",
"minimum": 0,
"maximum": 1000
},
"length": {
"description": "Length in metres.",
"type": "number",
"minimum": 0,
"maximum": 1000
}
},
"required": [
"weight"
]
},
"description": "The parcels (weight in kg, dimensions in metres)."
},
"sender": {
"description": "Sender address; omitted = the account's pickup address.",
"type": "object",
"properties": {
"street": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"suburb": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"city": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"state": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"post_code": {
"type": "string",
"minLength": 1,
"maxLength": 10
},
"country_code": {
"type": "string",
"pattern": "^[A-Za-z]{2}$",
"description": "2-letter country code, e.g. AU, NZ, US."
}
},
"required": [
"country_code"
]
},
"declared_value": {
"description": "Value of the shipment.",
"type": "number",
"minimum": 0,
"maximum": 100000000
},
"include_pricing": {
"description": "Return prices (default false).",
"type": "boolean"
},
"return_order": {
"type": "boolean"
},
"signature_required": {
"type": "boolean"
},
"authority_to_leave": {
"type": "boolean"
},
"dangerous_goods": {
"type": "boolean"
},
"insurance_value": {
"type": "number",
"minimum": 0,
"maximum": 100000000
}
},
"required": [
"destination",
"packages"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢starshipit_list_address_book(sort, sort_direction, page, page_size)
List contacts in the account's address book (name, company, address, phone, email), sorted by a column. GET /api/addressbook/filtered.
Esquema de entrada
{
"type": "object",
"properties": {
"sort": {
"type": "string",
"enum": [
"None",
"Name",
"Company",
"Street",
"Suburb",
"PostCode",
"City",
"State",
"Country",
"Code",
"Phone",
"Email"
]
},
"sort_direction": {
"type": "string",
"enum": [
"None",
"Ascending",
"Descending"
]
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"page_size": {
"description": "Contacts per page, 1-250 (default 50).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 250
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢starshipit_list_manifests(limit, page)
List manifests already submitted to carriers (newest first): number, date, carrier, package and consignment counts. Read only; manifesting is not available here. GET /api/manifests.
Esquema de entrada
{
"type": "object",
"properties": {
"limit": {
"description": "Results per page, 1-250 (default 50).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 250
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢starshipit_list_products(search_term, sort_column, sort_direction, page_number, page_size)
List Product Catalogue records (SKU, title, weight, dimensions, HS code, bin location, price), optionally searching by SKU or title. GET /api/products.
Esquema de entrada
{
"type": "object",
"properties": {
"search_term": {
"description": "Search text for SKU or title.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"sort_column": {
"description": "Column to sort by (default Sku).",
"type": "string",
"pattern": "^[A-Za-z_]{1,30}$"
},
"sort_direction": {
"type": "string",
"enum": [
"Ascending",
"Descending"
]
},
"page_number": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"page_size": {
"description": "Products per page, 1-250 (default 50).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 250
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢starshipit_list_tags(filter, page_number, page_size)
List the account's user-defined order tags, optionally filtered by tag name. GET /api/tags.
Esquema de entrada
{
"type": "object",
"properties": {
"filter": {
"description": "Tag-name filter.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"page_number": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"page_size": {
"description": "Tags per page, 1-250 (default 50).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 250
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢starshipit_list_pickups(page_number, page_size)
List courier pickups already booked for the account. Read only; booking a pickup is not available here. GET /api/pickup.
Esquema de entrada
{
"type": "object",
"properties": {
"page_number": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"page_size": {
"description": "Pickups per page, 1-250 (default 50).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 250
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴starshipit_create_order(order_number, destination, reference, shipping_method, shipping_description, ...)
WRITE: create ONE new UNSHIPPED order in Starshipit (order number, destination, optional items, parcels, sender). No label is printed, no shipment is booked and no postage is bought; staff still print the label in Starshipit. Not idempotent: creating the same order_number twice may create a duplicate, so check with starshipit_search_orders first. Starshipit rules configured in the account (carrier selection, validation) may run on the new order. POST /api/orders.
Esquema de entrada
{
"type": "object",
"properties": {
"order_number": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "Order number from the source system (max 50 chars)."
},
"destination": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Contact name."
},
"email": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"phone": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"building": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"company": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"street": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"suburb": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"city": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"state": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"post_code": {
"type": "string",
"minLength": 1,
"maxLength": 10
},
"country": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Country name, e.g. Australia."
},
"delivery_instructions": {
"description": "Instructions for the courier (max 100 chars).",
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"required": [
"name",
"street",
"country"
]
},
"reference": {
"description": "Customer reference (max 50 chars).",
"type": "string",
"minLength": 1,
"maxLength": 50
},
"shipping_method": {
"description": "Delivery method name, e.g. Express Shipping.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"shipping_description": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"carrier": {
"description": "Starshipit carrier code, e.g. AusPost (optional; rules may choose one).",
"type": "string",
"minLength": 1,
"maxLength": 50
},
"carrier_service_code": {
"description": "Carrier service code from a rates quote, e.g. 7B05.",
"type": "string",
"minLength": 1,
"maxLength": 50
},
"signature_required": {
"type": "boolean"
},
"return_order": {
"description": "true = a return order (only the return label will be generated later).",
"type": "boolean"
},
"currency": {
"description": "Currency code of the item values, e.g. AUD.",
"type": "string",
"pattern": "^[A-Za-z]{3}$"
},
"sender_details": {
"description": "Sender; omitted = the account's pickup address.",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Contact name."
},
"email": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"phone": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"building": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"company": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"street": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"suburb": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"city": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"state": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"post_code": {
"type": "string",
"minLength": 1,
"maxLength": 10
},
"country": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Country name, e.g. Australia."
}
},
"required": [
"name",
"street",
"country"
]
},
"items": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"description": "Product name or description.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"sku": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"quantity": {
"type": "number",
"exclusiveMinimum": 0,
"maximum": 1000000
},
"weight": {
"description": "Unit weight in kg.",
"type": "number",
"minimum": 0,
"maximum": 100000
},
"value": {
"description": "Unit price.",
"type": "number",
"minimum": 0,
"maximum": 100000000
},
"tariff_code": {
"description": "Harmonized system (HS) code.",
"type": "string",
"minLength": 1,
"maxLength": 18
},
"country_of_origin": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"barcode": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
}
}
},
"packages": {
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"weight": {
"description": "Parcel weight in kg.",
"type": "number",
"minimum": 0,
"maximum": 100000
},
"height": {
"description": "Height in metres.",
"type": "number",
"minimum": 0,
"maximum": 1000
},
"width": {
"description": "Width in metres.",
"type": "number",
"minimum": 0,
"maximum": 1000
},
"length": {
"description": "Length in metres.",
"type": "number",
"minimum": 0,
"maximum": 1000
}
}
}
}
},
"required": [
"order_number",
"destination"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴starshipit_update_order(order_id, order_number, reference, carrier, carrier_service_code, ...)
WRITE: change details of ONE UNSHIPPED order by order_id (the order is read first and refused if it is already printed or shipped): addresses, shipping method/carrier/service, items, packages, reference or an internal note. This tool never sends status or manifest flags. It does not print a label or buy postage. Items/packages: include item_id / package_id (from starshipit_get_order with include=Items,Packages) to modify an existing line; a line without an id may be added. Nothing is deleted. Send only the fields you want to change. PUT /api/orders.
Esquema de entrada
{
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Starshipit order id."
},
"order_number": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"reference": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"carrier": {
"description": "Starshipit carrier code, e.g. AusPost.",
"type": "string",
"minLength": 1,
"maxLength": 50
},
"carrier_service_code": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"shipping_method": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"shipping_description": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"signature_required": {
"type": "boolean"
},
"currency": {
"type": "string",
"pattern": "^[A-Za-z]{3}$"
},
"note": {
"description": "Internal order note.",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"sender_details": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Contact name."
},
"email": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"phone": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"building": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"company": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"street": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"suburb": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"city": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"state": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"post_code": {
"type": "string",
"minLength": 1,
"maxLength": 10
},
"country": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Country name, e.g. Australia."
},
"delivery_instructions": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
}
},
"destination": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Contact name."
},
"email": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"phone": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"building": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"company": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"street": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"suburb": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"city": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"state": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"post_code": {
"type": "string",
"minLength": 1,
"maxLength": 10
},
"country": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Country name, e.g. Australia."
},
"delivery_instructions": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
}
},
"items": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"description": "Product name or description.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"sku": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"quantity": {
"type": "number",
"exclusiveMinimum": 0,
"maximum": 1000000
},
"weight": {
"description": "Unit weight in kg.",
"type": "number",
"minimum": 0,
"maximum": 100000
},
"value": {
"description": "Unit price.",
"type": "number",
"minimum": 0,
"maximum": 100000000
},
"tariff_code": {
"description": "Harmonized system (HS) code.",
"type": "string",
"minLength": 1,
"maxLength": 18
},
"country_of_origin": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"barcode": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"item_id": {
"description": "Existing item id to modify.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"quantity_to_ship": {
"type": "number",
"minimum": 0,
"maximum": 1000000
}
}
}
},
"packages": {
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"weight": {
"description": "Parcel weight in kg.",
"type": "number",
"minimum": 0,
"maximum": 100000
},
"height": {
"description": "Height in metres.",
"type": "number",
"minimum": 0,
"maximum": 1000
},
"width": {
"description": "Width in metres.",
"type": "number",
"minimum": 0,
"maximum": 1000
},
"length": {
"description": "Length in metres.",
"type": "number",
"minimum": 0,
"maximum": 1000
},
"package_id": {
"description": "Existing package id to modify.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"packaging_type": {
"description": "e.g. Carton, Box, Envelope, Jiffy, Pallet, Satchel, Bag.",
"type": "string",
"minLength": 1,
"maxLength": 50
}
}
}
}
},
"required": [
"order_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴starshipit_add_order_tags(order_id, tags)
WRITE: add up to 10 tags to ONE UNSHIPPED order (read first; refused if printed or shipped) (a tag that does not exist yet is created). Tags are used for filtering and can drive the account's automation rules. Adding a tag the order already has changes nothing. Tags are not removed. POST /api/tags/order.
Esquema de entrada
{
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Starshipit order id."
},
"tags": {
"minItems": 1,
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"description": "Tag names to add (1-10)."
}
},
"required": [
"order_id",
"tags"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Comunidad
Evidencia
Observaciones recientes
verificadoversión no registrada19 herramientas