Skip to main content
Starshipit logo
  • Category: ecommerce
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 15
  • Triggers: 0
  • Slug: STARSHIPIT
  • Version: 20261101_00

Tools

Slug: STARSHIPIT_CREATE_MANIFESTCreate and finalize a Starshipit manifest PDF for only the explicitly listed shipments. WARNING: manifesting is an irreversible fulfilment operation that can mark shipments as manifested; verify every identifier before calling.

Input Parameters

string ("tracking_number" | "order_number")
Whether shipment_numbers contains tracking numbers or order numbers.
array
required
Explicit allowlist of shipment identifiers to manifest. Each value is a tracking number unless identifier_type is order_number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STARSHIPIT_CREATE_ORDERCreate one unshipped Starshipit order with destination, line items, packages, sender, and customs details.

Input Parameters

object
required
Order to create with a unique order_number and required destination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STARSHIPIT_CREATE_SHIPPING_LABELCreate shipping labels for one Starshipit order. This also creates the shipment and its tracking numbers and is irreversible. Labels come back in the account’s configured format, usually PDF.

Input Parameters

string
required
Carrier code to use when creating the shipment.
integer
Starshipit numeric order ID. Provide exactly one of order_id or order_number.
array
required
One or more packages to include. Each package requires a positive weight; include dimensions or packaging_type when required by the carrier.
string
Source-platform order number. Provide exactly one of order_number or order_id.
string
required
Carrier service code selected for delivery.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STARSHIPIT_CREATE_SHIPPING_LABELSCreate shipping labels for multiple existing Starshipit orders in one irreversible batch. This creates shipments and tracking numbers and can move orders to Printed. Starshipit does not document atomicity or label-to-order mapping, so verify every order before calling.

Input Parameters

array
required
Starshipit numeric order IDs to print together. Each order must already have package and carrier settings that Starshipit can resolve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STARSHIPIT_GET_ORDERRetrieve one order by its Starshipit numeric ID or source-platform order number.

Input Parameters

integer
Starshipit numeric order ID. Provide exactly one of order_id or order_number.
string
Order identifier from the source commerce platform. Provide exactly one of order_number or order_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STARSHIPIT_GET_SHIPPING_RATESQuote available Starshipit shipping services and prices for a destination and one or more packages.

Input Parameters

object
Sender address. Omit this field to use the pickup address configured in Starshipit.
string
Currency code for the shipment value, such as AUD.
array
required
One or more packages to quote, with weights in kilograms and dimensions in metres.
object
required
Shipment destination address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STARSHIPIT_GET_TRACKINGGet current shipment status and carrier tracking events by tracking number or order number.

Input Parameters

string
Source-platform order number. Provide exactly one of order_number or tracking_number.
string
Carrier tracking number. Provide exactly one of tracking_number or order_number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STARSHIPIT_GET_WMS_PERFORMANCEReturn Starshipit WMS order-cycle and SLA performance metrics for the previous 1 to 90 days.

Input Parameters

integer
Number of previous days included in the analytics window (1-90).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STARSHIPIT_LIST_MANIFESTSList a page of Starshipit manifests in reverse chronological order. Choose a page and page size (default 50, maximum 250); the result includes the total manifest count and continuation information.

Input Parameters

integer
1-based page number to return; the response reports has_more and next_page for the continuation.
integer
Maximum manifests to return on this page (1-250).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STARSHIPIT_LIST_PRODUCTSSearch and page through the Starshipit product catalogue with optional sorting.

Input Parameters

integer
Products per page (10-2000). Starshipit clamps smaller values to 10.
string
Opaque continuation cursor returned by a previous call; omit for the first page.
string
Product search text; use an empty string to list all products.
string ("Barcode" | "BinLocation" | "Brand" | "Colour" | "Country" | "CustomsDescription" | "DangerousGoodsType" | "Height" | "HSCode" | "Length" | "Manufacturer" | "Materials" | "Model" | "Price" | "Purpose" | "Size" | "Sku" | "Title" | "Weight" | "Width")
Product field used for sorting.
integer
Optional number of matching product records to skip.
string ("Ascending" | "Descending")
Sort direction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STARSHIPIT_LIST_TAGSReturn one page of user-defined order tags, optionally filtered by tag name.

Input Parameters

string
Optional tag-name filter.
integer
Maximum tags to return on this page.
string
Opaque continuation cursor returned by a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STARSHIPIT_LIST_UNSHIPPED_ORDERSReturn one page of unshipped orders, optionally filtered by creation or update time. By default, Starshipit returns orders updated in the last 24 hours.

Input Parameters

integer
1-based page number to return; the response reports has_more and next_page for the continuation.
integer
Maximum orders to return on this page (1-250).
boolean
Return only numeric order IDs instead of full order records.
string
Return orders created after this RFC 3339 UTC timestamp.
string
Return orders updated after this RFC 3339 UTC timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STARSHIPIT_LIST_WMS_INVENTORYReturn one page of Starshipit WMS inventory grouped by product or location, including stock, reservation, and availability quantities.

Input Parameters

string ("all" | "incoming" | "reserved" | "insufficient" | "frozen")
Inventory state filter. insufficient is supported only in product view.
Search SKU, product name, barcode, or location content for the selected view.
string ("sku" | "name" | "price" | "quantityOnHand" | "quantityIncoming" | "quantityReserved" | "quantityCommitted" | "quantityAvailable")
Sort field. Product view supports sku, name, price, quantityOnHand, quantityIncoming, quantityReserved, quantityCommitted, and quantityAvailable.
string
In product view, limit inventory to one client.
integer
Inventory records to return on this page (1-100).
string ("product" | "location")
Group inventory by product or by warehouse location.
string
Opaque continuation cursor from a previous response; omit for the first page.
string ("all" | "standard" | "bundle")
In product view, filter by canonical product type.
boolean
In product view, return only products with on-hand stock.
string ("asc" | "desc")
Sort direction when sort_by is provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STARSHIPIT_SEARCH_ORDERSSearch orders by a phrase and optional field, status, or child-account inclusion filter. Returns one page at a time.

Input Parameters

integer
1-based page number to return; the response reports has_more and next_page for the continuation.
integer
Maximum matching orders to return on this page (1-250).
string ("All" | "Order_Number" | "TheirRef")
Provider search field. Use All to search order number, tracking number, customer reference, and recipient name.
string
required
Text to search for, such as an order number, tracking number, customer reference, or recipient name.
string ("All" | "Unshipped" | "Shipped")
Optional provider order-status filter.
boolean
Include matching orders from child accounts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STARSHIPIT_UPDATE_ORDERUpdate editable fields on one Starshipit order identified by order_id or order_number. This sends one PUT request and does not read the order first. Unshipped orders permit updates to non-read-only fields; once a label has been generated, Starshipit restricts editable shipment details, and printed or shipped orders cannot be moved back to an unshipped state.

Input Parameters

object
required
Order identifier and fields to update. Unshipped orders permit updates to non-read-only fields; after a label is generated, Starshipit restricts which shipment details remain editable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not