For the complete documentation index, see llms.txt.
Rates
Request checkout rates and delivery services from courier accounts configured in Starshipit.
3 related endpoints
Endpoint
Endpoint URL
https://api.starshipit.com/api/deliveryservices
Details
Get a list of available carrier delivery services
Delivery Services Request
Delivery Services - Sender Model
Delivery Services - Destination Model
Delivery Services - Packages Model
Delivery Services Response
Delivery Services - Service Model
Delivery Services - Meta Field Model
Request body
{
"order_id": 100000,
"refresh_rate": true,
"sender": {
"street": "10 Geonic Street",
"suburb": "Woodridge",
"city": "",
"state": "QLD",
"post_code": "4114",
"country_code": "AU"
},
"destination": {
"street": "10 Geoffrey Place",
"suburb": "Mangere East",
"city": "Auckland",
"state": "",
"post_code": "2024",
"country_code": "NZ"
},
"packages": [
{
"weight": 1.0,
"height": 0.1,
"width": 0.1,
"length": 0.1,
"package_name": "Package"
}
],
"declared_value": 20.00,
"return_order": false,
"include_pricing": true,
"signature_required": null,
"authority_to_leave": false,
"dangerous_goods": false,
"insurance_value": 0.0
}Response examples
Delivery Services (200)
{
"services": [
{
"carrier": "AusPost",
"carrier_name": "Australia Post",
"service_name": "INTL EXPRESS MERCH",
"service_code": "ECM8",
"total_price": 14.8,
"metafields": [
{
"key": "INSURANCEVALUE",
"name": "Cover/Warranty",
"description": "",
"display_type": "textbox",
"value": "0.00",
"default_value": "0.00",
"value_type": "string",
"label": "Cover/Warranty",
"read_only": false
},
{
"key": "EXPORTTYPE",
"name": "Classification",
"description": "",
"display_type": "dropdownlist",
"value": "",
"default_value": "",
"available_values": [
"Not Set",
"Gift",
"Commercial Sample",
"Other",
"Returned Goods",
"Sale of Goods"
],
"value_type": "string",
"label": "Classification",
"read_only": false
},
{
"key": "COMMERCIALVALUE",
"name": "Has Commercial Value",
"description": "",
"display_type": "checkbox",
"value": "False",
"default_value": "False",
"value_type": "boolean",
"label": "Has Commercial Value",
"read_only": false
},
{
"key": "EXPORTNUMBER",
"name": "Export Number",
"description": "",
"display_type": "textbox",
"value": "",
"default_value": "",
"value_type": "string",
"label": "Export Number",
"read_only": false
},
{
"key": "INSURANCE",
"name": "Insurance",
"description": "",
"display_type": "checkbox",
"value": "False",
"default_value": "False",
"value_type": "boolean",
"label": "Cover/Warranty Required",
"read_only": false
}
],
"pricing_breakdown": {
"Calculated Price ex GST": "$14.80",
"Calculated GST": "$0.00",
"Calculated Price": "$14.80",
"Estimated delivery days (earliest)": "4",
"Estimated delivery days (latest)": "4",
"Estimated delivery date": "2024-02-01"
}
},
{
"carrier": "AusPost",
"carrier_name": "Australia Post",
"service_name": "INTL EXPRESS DOCS",
"service_code": "ECD8",
"total_price": 19.9,
"metafields": [
{
"key": "INSURANCEVALUE",
"name": "Cover/Warranty",
"description": "",
"display_type": "textbox",
"value": "0.00",
"default_value": "0.00",
"value_type": "string",
"label": "Cover/Warranty",
"read_only": false
},
{
"key": "EXPORTTYPE",
"name": "Classification",
"description": "",
"display_type": "dropdownlist",
"value": "",
"default_value": "",
"available_values": [
"Not Set",
"Gift",
"Commercial Sample",
"Other",
"Returned Goods",
"Sale of Goods"
],
"value_type": "string",
"label": "Classification",
"read_only": false
},
{
"key": "COMMERCIALVALUE",
"name": "Has Commercial Value",
"description": "",
"display_type": "checkbox",
"value": "False",
"default_value": "False",
"value_type": "boolean",
"label": "Has Commercial Value",
"read_only": false
},
{
"key": "EXPORTNUMBER",
"name": "Export Number",
"description": "",
"display_type": "textbox",
"value": "",
"default_value": "",
"value_type": "string",
"label": "Export Number",
"read_only": false
},
{
"key": "INSURANCE",
"name": "Insurance",
"description": "",
"display_type": "checkbox",
"value": "False",
"default_value": "False",
"value_type": "boolean",
"label": "Cover/Warranty Required",
"read_only": false
}
],
"pricing_breakdown": {
"Calculated Price ex GST": "$19.90",
"Calculated GST": "$0.00",
"Calculated Price": "$19.90",
"Estimated delivery days (earliest)": "4",
"Estimated delivery days (latest)": "4",
"Estimated delivery date": "2024-02-01"
}
},
{
"carrier": "AusPost",
"carrier_name": "Australia Post",
"service_name": "INTL STANDARD/PACK & TRACK",
"service_code": "PTI8",
"total_price": 11.85,
"metafields": [
{
"key": "INSURANCEVALUE",
"name": "Cover/Warranty",
"description": "",
"display_type": "textbox",
"value": "0.00",
"default_value": "0.00",
"value_type": "string",
"label": "Cover/Warranty",
"read_only": false
},
{
"key": "EXPORTTYPE",
"name": "Classification",
"description": "",
"display_type": "dropdownlist",
"value": "",
"default_value": "",
"available_values": [
"Not Set",
"Gift",
"Commercial Sample",
"Other",
"Returned Goods",
"Sale of Goods"
],
"value_type": "string",
"label": "Classification",
"read_only": false
},
{
"key": "COMMERCIALVALUE",
"name": "Has Commercial Value",
"description": "",
"display_type": "checkbox",
"value": "False",
"default_value": "False",
"value_type": "boolean",
"label": "Has Commercial Value",
"read_only": false
},
{
"key": "EXPORTNUMBER",
"name": "Export Number",
"description": "",
"display_type": "textbox",
"value": "",
"default_value": "",
"value_type": "string",
"label": "Export Number",
"read_only": false
},
{
"key": "INSURANCE",
"name": "Insurance",
"description": "",
"display_type": "checkbox",
"value": "False",
"default_value": "False",
"value_type": "boolean",
"label": "Cover/Warranty Required",
"read_only": false
}
],
"pricing_breakdown": {
"Calculated Price ex GST": "$11.85",
"Calculated GST": "$0.00",
"Calculated Price": "$11.85",
"Estimated delivery days (earliest)": "5",
"Estimated delivery days (latest)": "8"
}
},
{
"carrier": "AusPost",
"carrier_name": "Australia Post",
"service_name": "INT'L STANDARD WITH SIGNATURE",
"service_code": "PTI7",
"total_price": 16.35,
"metafields": [
{
"key": "INSURANCEVALUE",
"name": "Cover/Warranty",
"description": "",
"display_type": "textbox",
"value": "0.00",
"default_value": "0.00",
"value_type": "string",
"label": "Cover/Warranty",
"read_only": false
},
{
"key": "EXPORTTYPE",
"name": "Classification",
"description": "",
"display_type": "dropdownlist",
"value": "",
"default_value": "",
"available_values": [
"Not Set",
"Gift",
"Commercial Sample",
"Other",
"Returned Goods",
"Sale of Goods"
],
"value_type": "string",
"label": "Classification",
"read_only": false
},
{
"key": "COMMERCIALVALUE",
"name": "Has Commercial Value",
"description": "",
"display_type": "checkbox",
"value": "False",
"default_value": "False",
"value_type": "boolean",
"label": "Has Commercial Value",
"read_only": false
},
{
"key": "EXPORTNUMBER",
"name": "Export Number",
"description": "",
"display_type": "textbox",
"value": "",
"default_value": "",
"value_type": "string",
"label": "Export Number",
"read_only": false
},
{
"key": "INSURANCE",
"name": "Insurance",
"description": "",
"display_type": "checkbox",
"value": "False",
"default_value": "False",
"value_type": "boolean",
"label": "Cover/Warranty Required",
"read_only": false
}
],
"pricing_breakdown": {
"Calculated Price ex GST": "$16.35",
"Calculated GST": "$0.00",
"Calculated Price": "$16.35",
"Estimated delivery days (earliest)": "5",
"Estimated delivery days (latest)": "8"
}
},
{
"carrier": "AusPost",
"carrier_name": "Australia Post",
"service_name": "APGL NZ EXPRESS",
"service_code": "IC5",
"total_price": 12.16,
"metafields": [
{
"key": "INSURANCEVALUE",
"name": "Cover/Warranty",
"description": "",
"display_type": "textbox",
"value": "0.00",
"default_value": "0.00",
"value_type": "string",
"label": "Cover/Warranty",
"read_only": false
},
{
"key": "EXPORTTYPE",
"name": "Classification",
"description": "",
"display_type": "dropdownlist",
"value": "",
"default_value": "",
"available_values": [
"Not Set",
"Gift",
"Commercial Sample",
"Other",
"Returned Goods",
"Sale of Goods"
],
"value_type": "string",
"label": "Classification",
"read_only": false
},
{
"key": "COMMERCIALVALUE",
"name": "Has Commercial Value",
"description": "",
"display_type": "checkbox",
"value": "False",
"default_value": "False",
"value_type": "boolean",
"label": "Has Commercial Value",
"read_only": false
},
{
"key": "EXPORTNUMBER",
"name": "Export Number",
"description": "",
"display_type": "textbox",
"value": "",
"default_value": "",
"value_type": "string",
"label": "Export Number",
"read_only": false
},
{
"key": "INSURANCE",
"name": "Insurance",
"description": "",
"display_type": "checkbox",
"value": "False",
"default_value": "False",
"value_type": "boolean",
"label": "Cover/Warranty Required",
"read_only": false
}
],
"pricing_breakdown": {
"Calculated Price ex GST": "$12.16",
"Calculated GST": "$0.00",
"Calculated Price": "$12.16"
}
},
{
"carrier": "AusPost",
"carrier_name": "Australia Post",
"service_name": "APGL NZ EXPRESS W/SIGNATURE",
"service_code": "IC6",
"total_price": 14.16,
"metafields": [
{
"key": "INSURANCEVALUE",
"name": "Cover/Warranty",
"description": "",
"display_type": "textbox",
"value": "0.00",
"default_value": "0.00",
"value_type": "string",
"label": "Cover/Warranty",
"read_only": false
},
{
"key": "EXPORTTYPE",
"name": "Classification",
"description": "",
"display_type": "dropdownlist",
"value": "",
"default_value": "",
"available_values": [
"Not Set",
"Gift",
"Commercial Sample",
"Other",
"Returned Goods",
"Sale of Goods"
],
"value_type": "string",
"label": "Classification",
"read_only": false
},
{
"key": "COMMERCIALVALUE",
"name": "Has Commercial Value",
"description": "",
"display_type": "checkbox",
"value": "False",
"default_value": "False",
"value_type": "boolean",
"label": "Has Commercial Value",
"read_only": false
},
{
"key": "EXPORTNUMBER",
"name": "Export Number",
"description": "",
"display_type": "textbox",
"value": "",
"default_value": "",
"value_type": "string",
"label": "Export Number",
"read_only": false
},
{
"key": "INSURANCE",
"name": "Insurance",
"description": "",
"display_type": "checkbox",
"value": "False",
"default_value": "False",
"value_type": "boolean",
"label": "Cover/Warranty Required",
"read_only": false
}
],
"pricing_breakdown": {
"Calculated Price ex GST": "$14.16",
"Calculated GST": "$0.00",
"Calculated Price": "$14.16"
}
},
{
"carrier": "FedEx",
"carrier_name": "FedEx",
"service_name": "FEDEX_INTERNATIONAL_PRIORITY",
"service_code": "FEDEX_INTERNATIONAL_PRIORITY",
"total_price": 60.38,
"currency": "AUD",
"metafields": [
{
"key": "DTP",
"name": "Sender Pays Duty",
"description": "",
"display_type": "checkbox",
"value": "False",
"default_value": "False",
"value_type": "boolean",
"label": "Sender Pays Duty",
"read_only": false
}
],
"pricing_breakdown": {
"Total Base Charge": "45.49AUD",
"Demand Surcharge": "1.50AUD",
"Fuel": "13.39AUD",
"Total Billing Weight": "1.00KG"
}
},
{
"carrier": "DHL",
"carrier_name": "DHL Express",
"service_name": "EXPRESS WORLDWIDE NONDOC",
"service_code": "WPX",
"total_price": 151.04,
"currency": "GBP",
"metafields": [
{
"key": "INSURANCEVALUE",
"name": "Cover/Warranty",
"description": "",
"display_type": "textbox",
"value": "0.00",
"default_value": "0.00",
"value_type": "string",
"label": "Cover/Warranty",
"read_only": false
},
{
"key": "CONTENTS",
"name": "Contents",
"description": "",
"display_type": "textbox",
"value": "Pillow",
"default_value": "",
"value_type": "string",
"label": "Contents",
"read_only": false
},
{
"key": "CUSTOMSINCOTERM",
"name": "Customs Incoterm",
"description": "",
"display_type": "dropdownlist",
"value": "Delivered at Place",
"default_value": "Delivered at Place",
"available_values": [
"Not Set",
"Ex Works",
"Free Carrier",
"Carriage Paid To",
"Cost and Freight",
"Carriage and Insurance Paid To",
"Cost Insurance and Freight",
"Delivered at Place",
"Delivered Duty Paid",
"Delivered at Place Unloaded",
"Free Alongside Ship",
"Free on Board"
],
"value_type": "string",
"label": "Customs Incoterm",
"read_only": false
},
{
"key": "CUSTOMSEXPORTREASON",
"name": "Customs Export Reason",
"description": "",
"display_type": "dropdownlist",
"value": "Not Set",
"default_value": "Not Set",
"available_values": [
"Not Set",
"Returned Goods",
"Sale of Goods",
"Commercial Sample",
"Gift",
"Warranty Replacement",
"Personal Use"
],
"value_type": "string",
"label": "Customs Export Reason",
"read_only": false
},
{
"key": "CUSTOMSDUTYACCOUNTNUMBER",
"name": "Customs Duty Account Number",
"description": "",
"display_type": "textbox",
"value": "",
"default_value": "",
"value_type": "string",
"label": "Customs Duty Account Number",
"read_only": false
},
{
"key": "ATL",
"name": "Authority to Leave",
"description": "",
"display_type": "checkbox",
"value": "False",
"default_value": "False",
"value_type": "boolean",
"label": "Authority to Leave",
"read_only": false
},
{
"key": "BATTERY",
"name": "Contains Battery",
"description": "",
"display_type": "checkbox",
"value": "False",
"default_value": "False",
"value_type": "boolean",
"label": "Dangerous Goods",
"read_only": false
},
{
"key": "SATURDAY",
"name": "Saturday Delivery",
"description": "",
"display_type": "checkbox",
"value": "False",
"default_value": "False",
"value_type": "boolean",
"label": "Saturday Delivery",
"read_only": false
},
{
"key": "INSURANCE",
"name": "Insurance",
"description": "",
"display_type": "checkbox",
"value": "False",
"default_value": "False",
"value_type": "boolean",
"label": "Shipment Value Protection",
"read_only": false
},
{
"key": "DTP",
"name": "Sender Pays Duty",
"description": "",
"display_type": "checkbox",
"value": "False",
"default_value": "False",
"value_type": "boolean",
"label": "Duties & Taxes Paid",
"read_only": false
},
{
"key": "GREENSERVICE",
"name": "GoGreen Plus",
"description": "",
"display_type": "checkbox",
"value": "False",
"default_value": "False",
"value_type": "boolean",
"label": "GoGreen Plus",
"read_only": false
}
],
"pricing_breakdown": {
"Product": "EXPRESS WORLDWIDE NONDOC",
"Chargeable Weight": "1.0 KG",
"Total transit days": "1",
"Est. delivery date": "26 January",
"Base Charge": "118.03",
"Emergency Situation": "0.20",
"Fuel Surcharge": "32.81",
"Tax": "0.00"
}
},
{
"carrier": "PlainLabel",
"carrier_name": "Plain Label",
"service_name": "Plain Label - SANTAS DELIVERY",
"service_code": "Plain Label",
"total_price": 0,
"metafields": [
{
"key": "SIGNATURE",
"name": "Signature Required",
"description": "",
"display_type": "checkbox",
"value": "False",
"default_value": "False",
"value_type": "boolean",
"label": "Signature Required",
"read_only": false
},
{
"key": "ATL",
"name": "Authority to Leave",
"description": "",
"display_type": "checkbox",
"value": "False",
"default_value": "False",
"value_type": "boolean",
"label": "Authority to Leave",
"read_only": false
},
{
"key": "SATCHEL",
"name": "Satchel",
"description": "",
"display_type": "none",
"value": "True",
"default_value": "",
"value_type": "boolean",
"label": "Satchel",
"read_only": false
}
]
},
{
"carrier": "PlainLabel3",
"carrier_name": "Plain Label 3",
"service_name": "Plain Label 3 - Click & Collect",
"service_code": "Plain Label3",
"total_price": 5,
"currency": "NZD",
"metafields": [
{
"key": "SIGNATURE",
"name": "Signature Required",
"description": "",
"display_type": "checkbox",
"value": "False",
"default_value": "False",
"value_type": "boolean",
"label": "Signature Required",
"read_only": false
},
{
"key": "ATL",
"name": "Authority to Leave",
"description": "",
"display_type": "checkbox",
"value": "False",
"default_value": "False",
"value_type": "boolean",
"label": "Authority to Leave",
"read_only": false
},
{
"key": "SATCHEL",
"name": "Satchel",
"description": "",
"display_type": "none",
"value": "True",
"default_value": "",
"value_type": "boolean",
"label": "Satchel",
"read_only": false
}
],
"pricing_breakdown": {
"Estimated Transit Time": "5"
}
},
{
"carrier": "PlainLabel2",
"carrier_name": "Plain Label 2",
"service_name": "Plain Label 2 - FRIDAY SERVICE",
"service_code": "Plain Label2",
"total_price": 100,
"metafields": [
{
"key": "SIGNATURE",
"name": "Signature Required",
"description": "",
"display_type": "checkbox",
"value": "False",
"default_value": "False",
"value_type": "boolean",
"label": "Signature Required",
"read_only": false
},
{
"key": "ATL",
"name": "Authority to Leave",
"description": "",
"display_type": "checkbox",
"value": "False",
"default_value": "False",
"value_type": "boolean",
"label": "Authority to Leave",
"read_only": false
},
{
"key": "SATCHEL",
"name": "Satchel",
"description": "",
"display_type": "none",
"value": "True",
"default_value": "",
"value_type": "boolean",
"label": "Satchel",
"read_only": false
}
]
},
{
"carrier": "Sendle",
"carrier_name": "Sendle",
"service_name": "SENDLE",
"service_code": "SENDLE",
"total_price": 0,
"metafields": [
{
"key": "SIGNATURE",
"name": "Signature Required",
"description": "",
"display_type": "checkbox",
"value": "False",
"default_value": "False",
"value_type": "boolean",
"label": "Signature Required",
"read_only": false
},
{
"key": "ATL",
"name": "Authority to Leave",
"description": "",
"display_type": "checkbox",
"value": "False",
"default_value": "False",
"value_type": "boolean",
"label": "Authority to Leave",
"read_only": false
}
]
},
{
"carrier": "Sendle",
"carrier_name": "Sendle",
"service_name": "Sendle Express",
"service_code": "EXPRESS-PICKUP",
"total_price": 0,
"metafields": [
{
"key": "SIGNATURE",
"name": "Signature Required",
"description": "",
"display_type": "checkbox",
"value": "False",
"default_value": "False",
"value_type": "boolean",
"label": "Signature Required",
"read_only": false
},
{
"key": "ATL",
"name": "Authority to Leave",
"description": "",
"display_type": "checkbox",
"value": "False",
"default_value": "False",
"value_type": "boolean",
"label": "Authority to Leave",
"read_only": false
}
]
},
{
"carrier": "PickupInStore",
"carrier_name": "Pickup In Store",
"service_name": "Pickup In Store",
"service_code": "Pickup In Store",
"total_price": 0,
"metafields": []
}
],
"submitActualShippingCost": false,
"success": true,
"errors": []
}