Starlinks Global Guide

Starlinks Global offers domestic and international shipping services for shipments originating in the United States and United Kingdom.

This guide provides developers an overview of shipping services that Starlinks Global offers and the service codes and other details that you will use to create Starlinks Global shipments.

Connect Your Account

ShipEngine API allows you to connect your Starlinks Global accounts programmatically without logging in to the ShipEngine API dashboard. This is useful if you have wrapped a custom UI around the ShipEngine API toolset and want to add or disconnect existing carrier accounts without exposing your end users to the API dashboard.

These APIs can be used in parallel with the ShipEngine Partner APIs to programmatically create new ShipEngine users, and then connect existing Starlinks Global accounts all via the API without logging in to a dashboard. Together these APIs empower you to completely white-label the ShipEngine experience for your end users.

Continue below for instructions on how to programatically connect Starlinks Global using the ShipEngine API.

For instructions on connecting Starlinks Global via the ShipEngine dashboard, go to our Starlinks Global help article.

Starlinks Global Account Information Model

Property	Description	Type	Required
`username`	Your Starlinks Global account username	String	required
`api_key`	Your Starlinks Global account API key	String	required
`accept_fm_parcels`	Accept FM parcels	Boolean	optional

Your username and API key are availale in your Starlinks customer pack.

Example POST Call

POST /v1/connections/carriers/starlinks

1
2
3
4
5
6
7
8
9
10
POST /v1/connections/carriers/starlinks HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json
{
  "username": "mystarlinksusername"
  "api_key": "123456789",
  "accept_fm_parcels": false
}

Example Response

Your account will now appear in your carriers list with an assigned carrier_id that you will specify when creating Starlinks Global shipments.

1
2
3
{
  "carrier-id": "se-1234567"
}

Starlinks Global Service Details

Starlinks Global offers both domestic and international services.

Domestic Services

Service	Carrier Code	API Code
Starlinks Cross Border Standard Domestic	cross_border_standard_domestic	`starlinks_cross_border_standard_domestic`
Starlinks Cross Border Direct Domestic	cross_border_direct_domestic	`starlinks_cross_border_direct_domestic`
Starlinks Cross Border Final Mile Domestic	cross_border_final_mile_domestic	`starlinks_cross_border_final_mile_domestic`
Starlinks Domestic Final Mile	domestic_final_mile	`starlinks_domestic_final_mile`
Starlinks Express Cross Border Final Mile Domestic	express_cross_border_final_mile_domestic	`starlinks_express_cross_border_final_mile_domestic`

International Services

Service	Carrier Code	API Code
Cross Border Standard	cross_border_standard	`starlinks_cross_border_standard`
Cross Border Express	cross_border_express	`starlinks_cross_border_express`
Cross Border PUDO*	cross_border_pudo	`starlinks_cross_border_pudo`
Starlinks Cross Border Direct	cross_border_direct	`starlinks_cross_border_direct`
Starlinks Cross Border Final Mile	cross_border_final_mile	`starlinks_cross_border_final_mile`
Starlinks Express Cross Border Final Mile	express_cross_border_final_mile	`starlinks_express_cross_border_final_mile`

*Cross Border PUDO services requires weight and dimensions to successfully create a label.

Package Types

Name	API Code	Package Attributes
Parcel	`starlinks_parcel`	International

Return Services

Return services are not supported for this carrier.

Adding Shipment Insurance

Stalinks Global supports adding insurance to your shipments. Review the Parcel Insurance page for details on adding shipment insurance with ShipEngine.

Advanced Options

Starlinks Global supports the following advanced options:

Option	Type	Option API Codes
Collect on Delivery (COD)	Object	`collect_on_delivery`
DDP	Boolean	`delivered_duty_paid`

For more details about using the Collect on Delivery advanced option, see the Collect on Delivery page.

To ensure you always have the most up-to-date information, use the List Carrier Advanced Options call.

Additional Notes about Starlinks Global

ShipEngine does not currently submit customs declarations for international shipments. Merchants must generate their own customs documents and submit them electronically to Starlinks. See section 8 "Customs Clearance - All Countries" on page 7 of the Startlinks Global Terms and Conditions PDF for details.
ShipEngine does not currently support multi-package shipments when using Starlinks Global.

You are now ready to create shipments using CarrierName via ShipEngine!