The ShipStation connector lets your AI agent act in each user's ShipStation account. Each user connects their own ShipStation API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 29 tools.
- Tools
- 29
- What they doRead · write · destructive
- 18 · 8 · 318 read8 write3 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the ShipStation connection
In AgentKit > Connections, create a ShipStation connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'shipstation'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize ShipStation:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'shipstation_carriers_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "shipstation"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize ShipStation:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="shipstation_carriers_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their ShipStation credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolshipstation_address_validateValidate and normalize one or more mailing addresses.Read-onlyValidate Addresses
Validate and normalize one or more mailing addresses. Returns one result per address with status (verified, unverified, warning or error), original_address, matched_address and messages. Use shipstation_address_validate before creating shipments.
Inputs
addressesarrayrequired- Addresses to validate. Each needs address_line1, city_locality, state_province and country_code; postal_code, name, company_name, phone, address_line2 and address_residential_indicator are optional. Example: [{"address_line1": "525 S Winchester Blvd", "city_locality": "San Jose", "state_province": "CA", "postal_code": "95128", "country_code": "US"}]
shipstation_carrier_getGet one connected carrier account by ID.Read-onlyGet Carrier
Get one connected carrier account by ID. Returns carrier_code, friendly_name, account_number, balance, services, packages and options. Use shipstation_carrier_get for a known carrier ID.
Inputs
carrier_idstringrequired- ID of the carrier. Example: se-28529731
shipstation_carrier_packages_listList the package types a carrier account supports.Read-onlyList Carrier Package Types
List the package types a carrier account supports. Returns packages[] with package_code, name, description and dimensions. Use shipstation_carrier_packages_list to pick a package_code.
Inputs
carrier_idstringrequired- ID of the carrier. Example: se-28529731
shipstation_carrier_services_listList the shipping services a carrier account offers.Read-onlyList Carrier Services
List the shipping services a carrier account offers. Returns services[] with service_code, name, domestic, international and is_multi_package_supported. Use shipstation_carrier_services_list to pick a service_code.
Inputs
carrier_idstringrequired- ID of the carrier. Example: se-28529731
shipstation_carriers_listList the carrier accounts connected to ShipStation, with their services and package types.Read-onlyList Carriers
List the carrier accounts connected to ShipStation, with their services and package types. Returns carriers[] with carrier_id, carrier_code, friendly_name, account_number, balance and, by default, services[] and packages[]. Use shipstation_carriers_list to get carrier_id and service_code values for rates and labels.
Inputs
include_extended_detailsboolean- true (default) to include each carrier's services and packages; false for a smaller response. Example: false
pageinteger- Page of results to return, starting at 1. Example: 2
page_sizeinteger- Results per page (default 25). Example: 50
shipstation_label_getGet one label by ID.Read-onlyGet Label
Get one label by ID. Returns status, tracking_number, shipment_cost, insurance_cost, carrier and service, label_download links (pdf, png, zpl), voided state and packages. Use shipstation_label_get to fetch label download links.
Inputs
label_idstringrequired- ID of the label. Example: se-28529731
label_download_typestring- url for links or inline for base64 label data. Example: urlone of
urlinline
shipstation_label_tracking_getGet tracking events for a label bought through ShipStation.Read-onlyGet Label Tracking
Get tracking events for a label bought through ShipStation. Returns tracking_number, status_code, status_description, estimated_delivery_date, actual_delivery_date and events[]. Use shipstation_label_tracking_get with a label ID. Use shipstation_tracking_get with a carrier and tracking number.
Inputs
label_idstringrequired- ID of the label. Example: se-28529731
shipstation_labels_listList purchased labels with status, carrier, tracking number, date and refund filters.Read-onlyList Labels
List purchased labels with status, carrier, tracking number, date and refund filters. Returns labels[] (label_id, status, tracking_number, shipment_cost, carrier_code, service_code, label_download, voided) plus total and pages. Use shipstation_labels_list to find labels. Use shipstation_label_get for one label.
Inputs
batch_idstring- Only labels created in this batch. Example: se-28529731
carrier_idstring- Only labels from this carrier account. Example: se-123890
created_at_endstring- Created on or before this date-time. Example: 2026-11-15T23:59:59Z
created_at_startstring- Created on or after this date-time. Example: 2026-11-01T00:00:00Z
external_shipment_idstring- Only labels for this external shipment ID. Example: order-1001
label_statusstring- Only labels in this status: processing, completed, error or voided. Example: completedone of
processingcompletederrorvoided pageinteger- Page of results to return, starting at 1. Example: 2
page_sizeinteger- Results per page (default 25). Example: 50
rate_idstring- Only labels bought from this rate. Example: se-28529731
refund_statusarray- Only labels with these refund statuses. Example: ["pending"]
service_codestring- Only labels for this carrier service. Example: usps_priority_mail
shipment_idstring- Only labels for this shipment. Example: se-28529731
sort_bystring- Sort field: created_at (default), modified_at or voided_at. Example: created_atone of
modified_atcreated_atvoided_at sort_dirstring- asc or desc (default). Example: descone of
ascdesc tracking_numberstring- Only labels with this tracking number. Example: 9400111899223197428490
warehouse_idstring- Only labels shipped from this warehouse. Example: se-28529731
shipstation_manifests_listList end-of-day manifests (SCAN forms) with carrier, warehouse and date filters.Read-onlyList Manifests
List end-of-day manifests (SCAN forms) with carrier, warehouse and date filters. Returns manifests[] with manifest_id, carrier_id, warehouse_id, ship_date, shipments count and manifest_download. Use shipstation_manifests_list to find past manifests.
Inputs
carrier_idstring- Only manifests for this carrier. Example: se-123890
created_at_endstring- Created at or before. Example: 2026-11-15T23:59:59Z
created_at_startstring- Created at or after. Example: 2026-11-01T00:00:00Z
label_idsarray- Only manifests containing these label IDs. Example: ["se-28529731"]
pageinteger- Page of results to return, starting at 1. Example: 2
page_sizeinteger- Results per page (default 25). Example: 50
ship_date_endstring- Ship date range end. Example: 2026-11-15T23:59:59Z
ship_date_startstring- Ship date range start. Example: 2026-11-01T00:00:00Z
warehouse_idstring- Only manifests for this warehouse. Example: se-28529731
shipstation_pickups_listList scheduled carrier pickups.Read-onlyList Pickups
List scheduled carrier pickups. Returns pickups[] with pickup_id, carrier_id, confirmation_number, pickup_window and label_ids. Use shipstation_pickups_list to see upcoming pickups. Use shipstation_pickup_cancel to cancel one.
Inputs
carrier_idstring- Only pickups for this carrier. Example: se-123890
created_at_endstring- Created on or before. Example: 2026-11-15T23:59:59Z
created_at_startstring- Created on or after. Example: 2026-11-01T00:00:00Z
pageinteger- Page of results to return, starting at 1. Example: 2
page_sizeinteger- Results per page (default 25). Example: 50
warehouse_idstring- Only pickups for this warehouse. Example: se-28529731
shipstation_rate_getGet one rate by rate ID.Read-onlyGet Rate
Get one rate by rate ID. Returns the rate with carrier, service_code, shipping_amount, other_amount, delivery_days and validation_status. Use shipstation_rate_get to recheck a rate before shipstation_label_create_from_rate.
Inputs
rate_idstringrequired- ID of the rate. Example: se-28529731
shipstation_rates_estimateEstimate shipping rates from origin and destination postal details and package weight, without creating a shipment.Read-onlyEstimate Rates
Estimate shipping rates from origin and destination postal details and package weight, without creating a shipment. Returns an array of rate estimates with carrier, service_code, shipping_amount and delivery_days; these cannot be bought. Use shipstation_rates_estimate for quick quotes. Use shipstation_rates_calculate for buyable rates.
Inputs
from_city_localitystringrequired- Origin city. Example: Austin
from_country_codestringrequired- Origin country (ISO 3166-1 two-letter). Example: US
from_postal_codestringrequired- Origin postal code. Example: 78756
from_state_provincestringrequired- Origin state or province. Example: TX
ship_datestringrequired- Planned ship date (ISO 8601). Example: 2026-11-16T00:00:00Z
to_city_localitystringrequired- Destination city. Example: San Jose
to_country_codestringrequired- Destination country (ISO 3166-1 two-letter). Example: US
to_postal_codestringrequired- Destination postal code. Example: 95128
to_state_provincestringrequired- Destination state or province. Example: CA
weightobjectrequired- Package weight with value and unit (pound, ounce, gram or kilogram). Example: {"value": 20, "unit": "ounce"}
address_residential_indicatorstring- Whether the destination is residential: yes, no or unknown. Example: yesone of
unknownyesno carrier_idstring- A single carrier ID to quote, instead of carrier_ids. Example: se-123890
carrier_idsarray- Carrier IDs to quote. Provide carrier_ids or carrier_id. Example: ["se-123890"]
confirmationstring- Delivery confirmation type. Example: noneone of
nonedeliverysignatureadult_signatureadult_signature_restricted_deliverydirect_signaturedelivery_mailedverbal_confirmationdelivery_codeage_verification_16_plus dimensionsobject- Package dimensions with length, width, height and unit (inch or centimeter). Example: {"length": 12, "width": 8, "height": 4, "unit": "inch"}
shipstation_shipment_getGet one shipment by ShipStation shipment ID.Read-onlyGet Shipment
Get one shipment by ShipStation shipment ID. Returns the shipment with status, addresses, carrier and service, packages, items, amounts and tags. Use shipstation_shipment_get for a known ID. Use shipstation_shipment_get_by_external_id for your own ID.
Inputs
shipment_idstringrequired- ID of the shipment. Example: se-28529731
shipstation_shipment_get_by_external_idGet one shipment by the external_shipment_id you assigned when creating it.Read-onlyGet Shipment by External ID
Get one shipment by the external_shipment_id you assigned when creating it. Returns the same shipment object as shipstation_shipment_get. Use shipstation_shipment_get_by_external_id to look up a shipment from your own order system.
Inputs
external_shipment_idstringrequired- Your external shipment ID. Example: order-1001
shipstation_shipment_rates_listList the rates already calculated for a shipment.Read-onlyList Shipment Rates
List the rates already calculated for a shipment. Returns rate_response with rates[] (rate_id, carrier, service_code, shipping_amount, delivery_days, estimated_delivery_date) and invalid_rates. Use shipstation_shipment_rates_list after shipstation_rates_calculate. Use shipstation_label_create_from_rate to buy one.
Inputs
shipment_idstringrequired- ID of the shipment. Example: se-28529731
created_at_startstring- Only rates created at or after this date-time. Example: 2026-11-15T00:00:00Z
shipstation_shipments_listList shipments with status, date, tag, store and keyword filters, sorted and paged.Read-onlyList Shipments
List shipments with status, date, tag, store and keyword filters, sorted and paged. Returns shipments[] (shipment_id, shipment_number, shipment_status, ship_to, carrier and service, packages, items) plus total, page and pages. Use shipstation_shipments_list to find shipments or orders awaiting labels. Use shipstation_shipment_get for one shipment.
Inputs
batch_idstring- Only shipments in this batch. Example: se-28529731
created_at_endstring- Created at or before this ISO 8601 date-time. Example: 2026-11-15T23:59:59Z
created_at_startstring- Created at or after this ISO 8601 date-time. Example: 2026-11-01T00:00:00Z
external_shipment_idstring- Your external shipment ID. Example: order-1001
item_keywordstring- Matches item SKU, description or options. Example: mug
modified_at_endstring- Modified at or before this date-time. Example: 2026-11-15T23:59:59Z
modified_at_startstring- Modified at or after this date-time. Example: 2026-11-01T00:00:00Z
pageinteger- Page of results to return, starting at 1. Example: 2
page_sizeinteger- Results per page (default 25). Example: 50
payment_date_endstring- Order paid at or before this date-time. Example: 2026-11-15T23:59:59Z
payment_date_startstring- Order paid at or after this date-time. Example: 2026-11-01T00:00:00Z
sales_order_idstring- Only shipments for this sales order. Example: se-28529731
ship_to_namestring- Recipient name. Example: Amanda Miller
shipment_numberstring- Shipment number set by you or the order source. Example: 1001
shipment_statusstring- Only shipments in this status: pending, processing, label_purchased or cancelled. Example: pendingone of
pendingprocessinglabel_purchasedcancelled sort_bystring- Sort field: created_at or modified_at. Example: created_atone of
modified_atcreated_at sort_dirstring- Sort direction: asc or desc (default). Example: descone of
ascdesc store_idstring- Only shipments from this store. Example: se-123456
tagstring- Only shipments with this tag name (one tag). Example: Priority
shipstation_tracking_getGet tracking events for a package by carrier code and tracking number.Read-onlyGet Tracking
Get tracking events for a package by carrier code and tracking number. Returns status_code, status_description, carrier_status_description, estimated and actual delivery dates and events[]. Use shipstation_tracking_get for any tracking number. Use shipstation_label_tracking_get when you have the label ID.
Inputs
carrier_codestringrequired- Carrier code, such as usps, fedex, ups or dhl_express. Example: usps
tracking_numberstringrequired- Tracking number. Example: 9400111899223197428490
carrier_idstring- Carrier account ID, when the account has several of the same carrier. Example: se-123890
shipstation_warehouses_listList the account's warehouses (ship-from locations).Read-onlyList Warehouses
List the account's warehouses (ship-from locations). Returns warehouses[] with warehouse_id, name, origin_address, return_address and is_default. Use shipstation_warehouses_list to get a warehouse_id for shipments, manifests and pickups.
Inputs
This tool takes no inputs.
shipstation_label_createBuy a shipping label for shipment details given inline; this charges the carrier account unless test_label is true.WriteBuy Label
Buy a shipping label for shipment details given inline; this charges the carrier account unless test_label is true. Returns the label with label_id, tracking_number, shipment_cost and label_download links. Use shipstation_label_create to ship in one call. Use shipstation_label_create_from_rate to buy a rate you already quoted.
Inputs
shipmentobjectrequired- Shipment details: carrier_id and service_code (from shipstation_carriers_list), ship_date, ship_to and ship_from addresses (each needs name, phone, address_line1, city_locality, state_province, postal_code, country_code and address_residential_indicator yes, no or unknown), or warehouse_id instead of ship_from, and packages[] each with weight {value, unit} and optional dimensions {length, width, height, unit}. Example: {"carrier_id": "se-123890", "service_code": "usps_priority_mail", "ship_to": {"name": "Amanda Miller", "phone": "555-555-5555", "address_line1": "525 S Winchester Blvd", "city_locality": "San Jose", "state_province": "CA", "postal_code": "95128", "country_code": "US", "address_residential_indicator": "yes"}, "ship_from": {"name": "John Doe", "company_name": "Example Corp", "phone": "111-111-1111", "address_line1": "4009 Marathon Blvd", "city_locality": "Austin", "state_province": "TX", "postal_code": "78756", "country_code": "US", "address_residential_indicator": "no"}, "packages": [{"weight": {"value": 20, "unit": "ounce"}, "dimensions": {"length": 12, "width": 8, "height": 4, "unit": "inch"}}]}
display_schemestring- label, paperless (QR or code instead of a printed label, where the carrier supports it) or label_and_paperless. Defaults to label. Example: labelone of
labelpaperlesslabel_and_paperless external_shipment_idstring- Your unique ID for the shipment (max 50 characters). Example: order-1001
is_return_labelboolean- true for a return label. Example: false
label_download_typestring- url returns links to the label files; inline returns the label as base64 in the response. Defaults to url. Example: urlone of
urlinline label_formatstring- Label file format: pdf, png or zpl. Defaults to pdf. Example: pdfone of
pdfpngzpl label_layoutstring- Label size: 4x6 or letter (letter only for pdf). Defaults to 4x6. Example: 4x6one of
4x6letter rma_numberstring- Return merchandise authorization number for return labels. Example: RMA-1001
ship_datestring- Date the package will ship (ISO 8601). Example: 2026-11-16T00:00:00Z
test_labelboolean- true to create a test label that is not charged. Example: true
validate_addressstring- Address validation before buying: no_validation, validate_only or validate_and_clean. Example: validate_and_cleanone of
no_validationvalidate_onlyvalidate_and_clean
shipstation_label_create_from_rateBuy a label using a rate ID returned by shipstation_rates_calculate; this charges the carrier account.WriteBuy Label from Rate
Buy a label using a rate ID returned by shipstation_rates_calculate; this charges the carrier account. Returns the label with label_id, tracking_number, shipment_cost and label_download links. Use shipstation_label_create_from_rate after comparing rates. Use shipstation_label_create_from_shipment to buy with the shipment's own carrier and service.
Inputs
rate_idstringrequired- ID of the rate to buy. Example: se-28529731
display_schemestring- label, paperless (QR or code instead of a printed label, where the carrier supports it) or label_and_paperless. Defaults to label. Example: labelone of
labelpaperlesslabel_and_paperless external_shipment_idstring- Your unique ID for the shipment (max 100 characters). Example: order-1001
label_download_typestring- url returns links to the label files; inline returns the label as base64 in the response. Defaults to url. Example: urlone of
urlinline label_formatstring- Label file format: pdf, png or zpl. Defaults to pdf. Example: pdfone of
pdfpngzpl label_layoutstring- Label size: 4x6 or letter (letter only for pdf). Defaults to 4x6. Example: 4x6one of
4x6letter validate_addressstring- Address validation before buying: no_validation, validate_only or validate_and_clean. Example: validate_and_cleanone of
no_validationvalidate_onlyvalidate_and_clean
shipstation_label_create_from_shipmentBuy a label for an existing shipment using the carrier and service already set on it; this charges the carrier account.WriteBuy Label from Shipment
Buy a label for an existing shipment using the carrier and service already set on it; this charges the carrier account. Returns the label with label_id, tracking_number, shipment_cost and label_download links. Use shipstation_label_create_from_shipment for shipments created with shipstation_shipments_create or imported from a store.
Inputs
shipment_idstringrequired- ID of the shipment to buy a label for. Example: se-28529731
display_schemestring- label, paperless (QR or code instead of a printed label, where the carrier supports it) or label_and_paperless. Defaults to label. Example: labelone of
labelpaperlesslabel_and_paperless label_download_typestring- url returns links to the label files; inline returns the label as base64 in the response. Defaults to url. Example: urlone of
urlinline label_formatstring- Label file format: pdf, png or zpl. Defaults to pdf. Example: pdfone of
pdfpngzpl label_layoutstring- Label size: 4x6 or letter (letter only for pdf). Defaults to 4x6. Example: 4x6one of
4x6letter validate_addressstring- Address validation before buying: no_validation, validate_only or validate_and_clean. Example: validate_and_cleanone of
no_validationvalidate_onlyvalidate_and_clean
shipstation_label_return_createCreate a return label for an outbound label; carriers may charge on creation or when scanned.WriteCreate Return Label
Create a return label for an outbound label; carriers may charge on creation or when scanned. Returns the new return label with label_id, tracking_number and label_download links. Use shipstation_label_return_create when a customer sends an order back.
Inputs
label_idstringrequired- ID of the outbound label. Example: se-28529731
carrier_idstring- Carrier to use for the return instead of the outbound carrier; needs service_code. Example: se-123890
charge_eventstring- When the return label is charged: carrier_default, on_creation or on_carrier_acceptance. Example: on_carrier_acceptanceone of
carrier_defaulton_creationon_carrier_acceptance confirmationstring- Delivery confirmation for the return. Example: noneone of
nonedeliverysignatureadult_signatureadult_signature_restricted_deliverydirect_signaturedelivery_mailedverbal_confirmationdelivery_codeage_verification_16_plus display_schemestring- label, paperless (QR or code instead of a printed label, where the carrier supports it) or label_and_paperless. Defaults to label. Example: labelone of
labelpaperlesslabel_and_paperless label_download_typestring- url returns links to the label files; inline returns the label as base64 in the response. Defaults to url. Example: urlone of
urlinline label_formatstring- Label file format: pdf, png or zpl. Defaults to pdf. Example: pdfone of
pdfpngzpl label_layoutstring- Label size: 4x6 or letter (letter only for pdf). Defaults to 4x6. Example: 4x6one of
4x6letter package_codestring- Package type to use instead of the outbound one. Example: package
service_codestring- Service to use for the return. Example: usps_priority_mail
shipstation_manifest_createCreate an end-of-day manifest so the carrier can scan many labels at once, either from a list of label IDs or from a carrier, warehouse and ship date.WriteCreate Manifest
Create an end-of-day manifest so the carrier can scan many labels at once, either from a list of label IDs or from a carrier, warehouse and ship date. Returns the manifest(s) with manifest_id, form_id, label_ids and manifest_download (PDF). Use shipstation_manifest_create before carrier pickup or drop-off.
Inputs
carrier_idstring- Carrier to manifest all labels for, with warehouse_id and ship_date. Example: se-123890
excluded_label_idsarray- Labels to leave out when manifesting by carrier and date. Example: ["se-28529732"]
label_idsarray- Labels to include. Provide label_ids, or carrier_id + warehouse_id + ship_date. Example: ["se-28529731"]
ship_datestring- Ship date of the labels to include. Example: 2026-11-16T00:00:00Z
warehouse_idstring- Warehouse the labels ship from. Example: se-28529731
shipstation_pickup_scheduleSchedule a carrier pickup for one or more labels; some carriers charge for pickups.WriteSchedule Pickup
Schedule a carrier pickup for one or more labels; some carriers charge for pickups. Returns the pickup with pickup_id, confirmation_number and the pickup_windows the carrier accepted. Use shipstation_pickup_schedule after buying labels. Use shipstation_pickup_cancel to cancel.
Inputs
contact_detailsobjectrequired- Contact for the pickup with name, email and phone (all required). Example: {"name": "John Doe", "email": "john@example.com", "phone": "111-111-1111"}
label_idsarrayrequired- Labels to be picked up (same carrier). Example: ["se-28529731"]
pickup_windowobjectrequired- Requested pickup time range with start_at and end_at (ISO 8601). Example: {"start_at": "2026-11-17T14:00:00Z", "end_at": "2026-11-17T18:00:00Z"}
pickup_notesstring- Instructions for the driver. Example: Packages are at the loading dock
shipstation_rates_calculateGet shipping rates from one or more carriers for an existing shipment ID or a new shipment, which ShipStation then saves.WriteCalculate Rates
Get shipping rates from one or more carriers for an existing shipment ID or a new shipment, which ShipStation then saves. Returns the shipment with rate_response.rates[] (rate_id, carrier_id, service_code, shipping_amount, delivery_days) and invalid_rates. Use shipstation_rates_calculate before buying with shipstation_label_create_from_rate. Use shipstation_rates_estimate for a quick quote without addresses.
Inputs
rate_optionsobjectrequired- Rate options; carrier_ids is required, and service_codes, package_types, calculate_tax_amount, preferred_currency, is_return and rate_type are optional. Example: {"carrier_ids": ["se-123890"]}
shipmentobject- Shipment details: carrier_id and service_code (from shipstation_carriers_list), ship_date, ship_to and ship_from addresses (each needs name, phone, address_line1, city_locality, state_province, postal_code, country_code and address_residential_indicator yes, no or unknown), or warehouse_id instead of ship_from, and packages[] each with weight {value, unit} and optional dimensions {length, width, height, unit}. Example: {"carrier_id": "se-123890", "service_code": "usps_priority_mail", "ship_to": {"name": "Amanda Miller", "phone": "555-555-5555", "address_line1": "525 S Winchester Blvd", "city_locality": "San Jose", "state_province": "CA", "postal_code": "95128", "country_code": "US", "address_residential_indicator": "yes"}, "ship_from": {"name": "John Doe", "company_name": "Example Corp", "phone": "111-111-1111", "address_line1": "4009 Marathon Blvd", "city_locality": "Austin", "state_province": "TX", "postal_code": "78756", "country_code": "US", "address_residential_indicator": "no"}, "packages": [{"weight": {"value": 20, "unit": "ounce"}, "dimensions": {"length": 12, "width": 8, "height": 4, "unit": "inch"}}]}
shipment_idstring- Existing shipment to rate. Provide shipment_id or shipment. Example: se-28529731
shipstation_shipments_createCreate one or more shipments (orders ready to ship) without buying labels.WriteCreate Shipments
Create one or more shipments (orders ready to ship) without buying labels. Returns has_errors and shipments[] with each new shipment_id, status and any errors. Use shipstation_shipments_create to stage shipments, then shipstation_rates_calculate or shipstation_label_create_from_shipment.
Inputs
shipmentsarrayrequired- Shipments to create. Each takes carrier_id, service_code, ship_date, external_shipment_id, ship_to, ship_from (or warehouse_id), packages, items, and notes or amount fields as needed. Addresses need name, phone, address_line1, city_locality, state_province, postal_code, country_code and address_residential_indicator. Packages need weight {value, unit}. Example: [{"carrier_id": "se-123890", "service_code": "usps_priority_mail", "ship_to": {"name": "Amanda Miller", "phone": "555-555-5555", "address_line1": "525 S Winchester Blvd", "city_locality": "San Jose", "state_province": "CA", "postal_code": "95128", "country_code": "US", "address_residential_indicator": "yes"}, "ship_from": {"name": "John Doe", "company_name": "Example Corp", "phone": "111-111-1111", "address_line1": "4009 Marathon Blvd", "city_locality": "Austin", "state_province": "TX", "postal_code": "78756", "country_code": "US", "address_residential_indicator": "no"}, "packages": [{"weight": {"value": 20, "unit": "ounce"}, "dimensions": {"length": 12, "width": 8, "height": 4, "unit": "inch"}}]}]
shipstation_label_voidVoid an unused label and request a refund of its postage.DestructiveVoid Label
Void an unused label and request a refund of its postage. Returns approved (true or false) and a message from the carrier. Use shipstation_label_void for labels that will not be used. Use shipstation_shipment_cancel for shipments without a label.
- Idempotent
Inputs
label_idstringrequired- ID of the label to void. Example: se-28529731
shipstation_pickup_cancelCancel a scheduled carrier pickup.DestructiveCancel Pickup
Cancel a scheduled carrier pickup. Returns the pickup_id of the cancelled pickup. Use shipstation_pickup_cancel with an ID from shipstation_pickups_list.
- Idempotent
Inputs
pickup_idstringrequired- ID of the pickup to cancel. Example: pik_3YcKU5zdtJuCqoeNwyqqbW
shipstation_shipment_cancelCancel a shipment so it is no longer awaiting a label.DestructiveCancel Shipment
Cancel a shipment so it is no longer awaiting a label. Returns no content on success. Use shipstation_shipment_cancel for a shipment that will not ship. Use shipstation_label_void to void a label that was already bought.
- Idempotent
Inputs
shipment_idstringrequired- ID of the shipment to cancel. Example: se-28529731
No tools match.