---
canonical_url: "https://docs.composio.dev/toolkits/starshipit"
markdown_url: "https://docs.composio.dev/toolkits/starshipit.md"
product: "platform"
version: null
last_updated: null
---

# Starshipit

Starshipit provides shipping, fulfilment, order, tracking, and warehouse management APIs for ecommerce operations.

- **Category:** ecommerce
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 15
- **Triggers:** 0
- **Slug:** `STARSHIPIT`
- **Version:** 00000000_00

## Tools

### Create Manifest

**Slug:** `STARSHIPIT_CREATE_MANIFEST`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `identifier_type` | string ("tracking_number" | "order_number") | No | Whether shipment_numbers contains tracking numbers or order numbers. |
| `shipment_numbers` | array | Yes | Explicit allowlist of shipment identifiers to manifest. Each value is a tracking number unless identifier_type is order_number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Order

**Slug:** `STARSHIPIT_CREATE_ORDER`

Create one unshipped Starshipit order with destination, line items, packages, sender, and customs details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order` | object | Yes | Order to create with a unique order_number and required destination. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Shipping Label

**Slug:** `STARSHIPIT_CREATE_SHIPPING_LABEL`

Create 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Shipping Labels

**Slug:** `STARSHIPIT_CREATE_SHIPPING_LABELS`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_ids` | array | Yes | Starshipit numeric order IDs to print together. Each order must already have package and carrier settings that Starshipit can resolve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Order

**Slug:** `STARSHIPIT_GET_ORDER`

Retrieve one order by its Starshipit numeric ID or source-platform order number.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | integer | No | Starshipit numeric order ID. Provide exactly one of order_id or order_number. |
| `order_number` | string | No | Order identifier from the source commerce platform. Provide exactly one of order_number or order_id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Shipping Rates

**Slug:** `STARSHIPIT_GET_SHIPPING_RATES`

Quote available Starshipit shipping services and prices for a destination and one or more packages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sender` | object | No | Sender address. Omit this field to use the pickup address configured in Starshipit. |
| `currency` | string | No | Currency code for the shipment value, such as AUD. |
| `packages` | array | Yes | One or more packages to quote, with weights in kilograms and dimensions in metres. |
| `destination` | object | Yes | Shipment destination address. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tracking

**Slug:** `STARSHIPIT_GET_TRACKING`

Get current shipment status and carrier tracking events by tracking number or order number.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_number` | string | No | Source-platform order number. Provide exactly one of order_number or tracking_number. |
| `tracking_number` | string | No | Carrier tracking number. Provide exactly one of tracking_number or order_number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get WMS Performance

**Slug:** `STARSHIPIT_GET_WMS_PERFORMANCE`

Return Starshipit WMS order-cycle and SLA performance metrics for the previous 1 to 90 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `days_back` | integer | No | Number of previous days included in the analytics window (1-90). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Manifests

**Slug:** `STARSHIPIT_LIST_MANIFESTS`

Return one page of manifests in reverse chronological order.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | 1-based page number to return; the response reports has_more and next_page for the continuation. |
| `limit` | integer | No | Maximum manifests to return on this page (1-250). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Products

**Slug:** `STARSHIPIT_LIST_PRODUCTS`

Search and page through the Starshipit product catalogue with optional sorting.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tags

**Slug:** `STARSHIPIT_LIST_TAGS`

Return one page of user-defined order tags, optionally filtered by tag name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | string | No | Optional tag-name filter. |
| `page_size` | integer | No | Maximum tags to return on this page. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Unshipped Orders

**Slug:** `STARSHIPIT_LIST_UNSHIPPED_ORDERS`

Return one page of unshipped orders, optionally limited to orders created or updated after a UTC timestamp.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | 1-based page number to return; the response reports has_more and next_page for the continuation. |
| `limit` | integer | No | Maximum orders to return on this page (1-250). |
| `ids_only` | boolean | No | Return only numeric order IDs instead of full order records. |
| `since_order_date` | string | No | Return orders created after this RFC 3339 UTC timestamp. |
| `since_last_updated` | string | No | Return orders updated after this RFC 3339 UTC timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List WMS Inventory

**Slug:** `STARSHIPIT_LIST_WMS_INVENTORY`

Return one page of Starshipit WMS inventory grouped by product or location, including stock, reservation, and availability quantities.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Orders

**Slug:** `STARSHIPIT_SEARCH_ORDERS`

Search orders by a phrase and optional field, status, or child-account inclusion filter. Returns one page at a time.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Order

**Slug:** `STARSHIPIT_UPDATE_ORDER`

Update 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order` | object | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |