The Shippo connector lets your AI agent act in each user's Shippo account. Each user connects their own Shippo API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 63 tools.
- Tools
- 63
- What they doRead · write · destructive
- 37 · 23 · 337 read23 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 Shippo connection
In AgentKit > Connections, create a Shippo 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 = 'shippo'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Shippo:', 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: 'shippo_list_address_book_entries',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 = "shippo"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Shippo:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="shippo_list_address_book_entries",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Shippo credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolshippo_create_estimatesEstimate delivery dates for a parcel between two ZIP codes without buying a label.Read-onlyCreate Delivery Estimates
Estimate delivery dates for a parcel between two ZIP codes without buying a label. Returns the estimate with object_id, confidence_level, messages and a predictions array of delivery date predictions. Use to preview transit times before shipping. Reading only; nothing is created or purchased.
Inputs
destinationobjectrequired- Destination as an object with a zip code, for example {"zip":"10001"}.
originobjectrequired- Origin as an object with a zip code, for example {"zip":"94117"}.
parcelobjectrequired- Parcel as an object with numeric length, width, height, distance_unit, weight and mass_unit.
planned_ship_datestringrequired- Date you plan to hand the parcel to the carrier, in YYYY-MM-DD format.
confidence_levelstring- How conservative the delivery date should be: TYPICAL, DEFAULT or HIGH. Allowed values: TYPICAL, DEFAULT, HIGH.one of
TYPICALDEFAULTHIGH latest_delivery_datestring- Optional latest acceptable delivery date; only service levels that can meet it are returned.
servicelevel_tokensarray- Optional list of service level tokens to restrict the estimate to.
shippo_create_live_ratesGet checkout shipping rates for a cart, using your configured service groups, without creating a shipment.Read-onlyCreate Live Rates
Get checkout shipping rates for a cart, using your configured service groups, without creating a shipment. Returns count and results, each a rate option with title, amount, currency, estimated_days and amount_local. Use at checkout to show shipping options. Reading only; nothing is purchased. Use shippo_create_shipment to rate a real shipment.
Inputs
address_tostringrequired- Recipient address as an address object, or the object_id of an existing address.
line_itemsarrayrequired- Cart items as a list. Each has title, quantity, total_price, currency, weight and weight_unit (and optionally sku).
address_fromstring- Sender address as an address object or object_id. Defaults to your default sender address.
parcelstring- Object ID of a user parcel template, or a parcel object, used for the whole cart. Optional when line items carry weights.
shippo_get_addressRetrieve one address object by its object ID.Read-onlyGet Address
Retrieve one address object by its object ID. Returns the address fields, is_complete flag and validation_results if the address was validated. Use when you have an address object_id. Use shippo_list_addresses to find ids.
Inputs
address_idstringrequired- Object ID of the address to retrieve, as returned by shippo_create_address or shippo_list_addresses.
shippo_get_address_book_entryRetrieve one address book entry by its object ID.Read-onlyGet Address Book Entry
Retrieve one address book entry by its object ID. Returns the stored address fields. Use when you have the entry id. Use shippo_list_address_book_entries to search.
Inputs
address_idstringrequired- Object ID of the address book entry.
shippo_get_batchRetrieve a batch and a page of its batch shipments.Read-onlyGet Batch
Retrieve a batch and a page of its batch shipments. Returns the batch status (VALIDATING, VALID, INVALID, PURCHASING, PURCHASED), counts and batch_shipments with their own statuses. Use to poll validation or purchase progress.
Inputs
batch_idstringrequired- Object ID of the batch.
pageinteger- Page number to return, starting at 1.
resultsinteger- Number of results per page (maximum 100).default
5
shippo_get_carrier_accountRetrieve one carrier account by its object ID.Read-onlyGet Carrier Account
Retrieve one carrier account by its object ID. Returns carrier, account_id, active, test and the account parameters. Use when you have a carrier account object_id.
Inputs
carrier_account_idstringrequired- Object ID of the carrier account.
shippo_get_carrier_parcel_templateRetrieve one carrier preset parcel template by its token.Read-onlyGet Carrier Parcel Template
Retrieve one carrier preset parcel template by its token. Returns carrier, name, dimensions, units and the service levels it applies to. Use when you know the template token.
Inputs
carrier_parcel_template_tokenstringrequired- Template token such as USPS_FlatRateEnvelope.
shippo_get_customs_declarationRetrieve one customs declaration by its object ID.Read-onlyGet Customs Declaration
Retrieve one customs declaration by its object ID. Returns the declaration with contents_type, items, certify_signer and object_state. Use to verify a declaration before attaching it to a shipment.
Inputs
customs_declaration_idstringrequired- Object ID of the customs declaration.
pageinteger- Page number to return, starting at 1.
shippo_get_customs_itemRetrieve one customs item by its object ID.Read-onlyGet Customs Item
Retrieve one customs item by its object ID. Returns description, quantity, net_weight, value_amount, origin_country and tariff details. Use to check an item before declaring it.
Inputs
customs_item_idstringrequired- Object ID of the customs item.
pageinteger- Page number to return, starting at 1.
shippo_get_labelRetrieve one purchased label (transaction) by its object ID.Read-onlyGet Label
Retrieve one purchased label (transaction) by its object ID. Returns status, tracking_number, tracking_url_provider, label_url, commercial_invoice_url and messages. Use to poll an asynchronous purchase or fetch the label_url.
Inputs
transaction_idstringrequired- Object ID of the transaction, as returned when the label was purchased.
shippo_get_manifestRetrieve one manifest by its object ID.Read-onlyGet Manifest
Retrieve one manifest by its object ID. Returns status, documents (links to the manifest files) and errors. Use to poll an asynchronous manifest or fetch its document links.
Inputs
manifest_idstringrequired- Object ID of the manifest.
shippo_get_orderRetrieve one order by its object ID.Read-onlyGet Order
Retrieve one order by its object ID. Returns the order with status, addresses, line_items and any linked transactions. Use when you have an order object_id.
Inputs
order_idstringrequired- Object ID of the order.
shippo_get_parcelRetrieve one parcel object by its object ID.Read-onlyGet Parcel
Retrieve one parcel object by its object ID. Returns the parcel dimensions, weight and units. Use when you have a parcel object_id.
Inputs
parcel_idstringrequired- Object ID of the parcel.
shippo_get_rateRetrieve one shipping rate by its object ID.Read-onlyGet Rate
Retrieve one shipping rate by its object ID. Returns the rate with provider, servicelevel, amount, currency, estimated_days and attributes. Use to inspect a rate before buying it with shippo_create_label_from_rate. Rates older than 390 days are not returned.
Inputs
rate_idstringrequired- Object ID of the rate, as listed in a shipment rates array.
shippo_get_refundRetrieve one refund request by its object ID.Read-onlyGet Refund
Retrieve one refund request by its object ID. Returns the refund with status and the transaction id. Use to check whether a refund has been accepted.
Inputs
refund_idstringrequired- Object ID of the refund.
shippo_get_shipmentRetrieve one shipment object by its object ID.Read-onlyGet Shipment
Retrieve one shipment object by its object ID. Returns the shipment with status, addresses, parcels, messages and the rates array. Use to re-read a shipment or poll an asynchronous one. Use shippo_list_shipment_rates for a paginated rates list.
Inputs
shipment_idstringrequired- Object ID of the shipment, as returned by shippo_create_shipment.
shippo_get_tracking_statusGet the current tracking status and history of a package from the carrier name and tracking number.Read-onlyGet Tracking Status
Get the current tracking status and history of a package from the carrier name and tracking number. Returns tracking_status (status, status_details, status_date, location), tracking_history, eta, servicelevel and addresses. Use to track a package. The carrier must be a Shippo carrier token such as usps, ups, fedex or dhl_express.
Inputs
carrierstringrequired- Shippo carrier token, for example usps, ups, fedex, dhl_express.
tracking_numberstringrequired- Tracking number issued by the carrier.
shippo_get_user_parcel_templateRetrieve one saved parcel template by its object ID.Read-onlyGet User Parcel Template
Retrieve one saved parcel template by its object ID. Returns name, dimensions, units and default weight. Use when you have the template id.
Inputs
user_parcel_template_object_idstringrequired- Object ID of the user parcel template.
shippo_list_address_book_entriesList or search addresses stored in the Shippo address book.Read-onlyList Address Book Entries
List or search addresses stored in the Shippo address book. Returns a page of address book entries; use offset and limit to page through them. Use to find a saved address by search text. Use shippo_get_address_book_entry when you know the id.
Inputs
limitinteger- Maximum number of entries to return.default
30 offsetinteger- Number of entries to skip, for paging.default
0 searchstring- Free text matched against stored address fields such as name, organization and city.
shippo_list_addressesList address objects that were created in this Shippo account.Read-onlyList Addresses
List address objects that were created in this Shippo account. Returns a paginated object with next, previous and results (each result is an address with object_id, street1, city, state, zip, country). Use to browse stored addresses. Use shippo_get_address when you already know the object_id.
Inputs
pageinteger- Page number to return, starting at 1.
resultsinteger- Number of results per page (maximum 100).default
5
shippo_list_carrier_accountsList the carrier accounts connected to this Shippo account, including Shippo-provided and your own.Read-onlyList Carrier Accounts
List the carrier accounts connected to this Shippo account, including Shippo-provided and your own. Returns a paginated object with next, previous and results (each has object_id, carrier, account_id, active, test). Use to find the carrier_account ids needed for shipments, labels, batches and manifests.
Inputs
account_idstring- Only return the account with this carrier account identifier.
carrierstring- Only return accounts for this carrier token, for example usps.one of
airterraapc_postalapgaramexasendia_usaustralia_postaxlehirebetter_trucksborderguruboxberrybringcanada_postchronopostcollect_pluscorreios_brcorreos_espanacolissimodeutsche_postdhl_beneluxdhl_ecommercedhl_expressdhl_germany_c2cdhl_germanydpd_dedpd_ukestafetafastway_australiafedexglobegisticsgls_usgophrgsohermes_germany_b2chermes_ukhongkong_postlasershiplsomondial_relaynew_zealand_postnippon_expressontracparcelforcepassportpcfposte_italianepostipurolatorroyal_mailroyal_mail_sfrr_donnelleyrussian_postskypostalstuartswyftudsupsuspsveho pageinteger- Page number to return, starting at 1.
resultsinteger- Number of results per page (maximum 100).default
5 service_levelsboolean- If true, include the service_levels offered by each account.
shippo_list_carrier_parcel_templatesList carrier preset parcel templates (flat-rate boxes, envelopes and similar).Read-onlyList Carrier Parcel Templates
List carrier preset parcel templates (flat-rate boxes, envelopes and similar). Returns an object with results, each a template with token, carrier, name and dimensions. Use to find a template token for shippo_create_parcel. Use shippo_list_user_parcel_templates for your own templates.
Inputs
carrierstring- Only return templates of this carrier token, for example usps.
includestring- Which templates to return: all, user (only those you saved) or enabled. Allowed values: all, user, enabled.one of
alluserenabled
shippo_list_customs_declarationsList customs declarations created in this account.Read-onlyList Customs Declarations
List customs declarations created in this account. Returns a paginated object with next, previous and results. Use to browse declarations. Use shippo_get_customs_declaration for one.
Inputs
pageinteger- Page number to return, starting at 1.
resultsinteger- Number of results per page (maximum 100).default
5
shippo_list_customs_itemsList customs items created in this account.Read-onlyList Customs Items
List customs items created in this account. Returns a paginated object with next, previous and results. Use to browse items. Use shippo_get_customs_item for one.
Inputs
pageinteger- Page number to return, starting at 1.
resultsinteger- Number of results per page (maximum 100).default
25
shippo_list_labelsList purchased shipping labels (transactions), optionally filtered by rate, status, tracking status or creation date.Read-onlyList Labels
List purchased shipping labels (transactions), optionally filtered by rate, status, tracking status or creation date. Returns a paginated object with next, previous and results (each a transaction with tracking_number, label_url and status). Use to find labels. Use shippo_get_label for one label.
Inputs
object_created_gtstring- Only return objects created after this ISO 8601 UTC date and time.
object_created_gtestring- Only return objects created at or after this ISO 8601 UTC date and time.
object_created_ltstring- Only return objects created before this ISO 8601 UTC date and time.
object_created_ltestring- Only return objects created at or before this ISO 8601 UTC date and time.
object_statusstring- Only return labels with this transaction status. Allowed values: WAITING, QUEUED, SUCCESS, ERROR, REFUNDED, REFUNDPENDING, REFUNDREJECTED.one of
WAITINGQUEUEDSUCCESSERRORREFUNDEDREFUNDPENDINGREFUNDREJECTED pageinteger- Page number to return, starting at 1.
ratestring- Only return labels bought with this rate object ID.
resultsinteger- Number of results per page (maximum 100).default
25 tracking_statusstring- Only return labels with this tracking status. Allowed values: UNKNOWN, PRE_TRANSIT, TRANSIT, DELIVERED, RETURNED, FAILURE.one of
UNKNOWNPRE_TRANSITTRANSITDELIVEREDRETURNEDFAILURE
shippo_list_manifestsList manifests created in this account.Read-onlyList Manifests
List manifests created in this account. Returns a paginated object with next, previous and results. Use to browse manifests. Use shippo_get_manifest for one.
Inputs
pageinteger- Page number to return, starting at 1.
resultsinteger- Number of results per page (maximum 100).default
5
shippo_list_ordersList orders, optionally filtered by status, shop app or date range.Read-onlyList Orders
List orders, optionally filtered by status, shop app or date range. Returns a paginated object with next, previous and results. Use to browse orders. Use shippo_get_order for one.
Inputs
end_datestring- Only return orders created before this ISO 8601 UTC date and time.
order_statusarray- Only return orders in these statuses, for example PAID and SHIPPED.
pageinteger- Page number to return, starting at 1.
resultsinteger- Number of results per page (maximum 100).default
25 shop_appstring- Only return orders imported from this shop platform.one of
AmazonBigcommerceCSV_ImporteBayePagesEtsyGodaddyMagentoShippoShopifySpreecommerceStripeRelayWalmartWeeblyWooCommerce start_datestring- Only return orders created after this ISO 8601 UTC date and time.
shippo_list_parcelsList parcel objects created in this Shippo account.Read-onlyList Parcels
List parcel objects created in this Shippo account. Returns a paginated object with next, previous and results (each a parcel with dimensions and weight). Use to browse parcels. Use shippo_get_parcel for one parcel.
Inputs
pageinteger- Page number to return, starting at 1.
resultsinteger- Number of results per page (maximum 100).default
25
shippo_list_refundsList label refund requests.Read-onlyList Refunds
List label refund requests. Returns a paginated object with next, previous and results (each refund has object_id, status and transaction). Use to review refunds. Use shippo_get_refund for one refund.
Inputs
This tool takes no inputs.
shippo_list_service_groupsList service groups used for live rates at checkout.Read-onlyList Service Groups
List service groups used for live rates at checkout. Returns an array of service groups with object_id, name, type, flat_rate and service_levels. Use to see how checkout shipping options are configured.
Inputs
This tool takes no inputs.
shippo_list_shipment_ratesList the shipping rates calculated for a shipment.Read-onlyList Shipment Rates
List the shipping rates calculated for a shipment. Returns a paginated object with next, previous and results (each rate has object_id, provider, servicelevel, amount, currency, estimated_days). Use to compare rates for an existing shipment. Use shippo_list_shipment_rates_in_currency to get amounts in another currency.
Inputs
shipment_idstringrequired- Object ID of the shipment.
pageinteger- Page number to return, starting at 1.
resultsinteger- Number of results per page (maximum 100).default
25
shippo_list_shipment_rates_in_currencyList the shipping rates of a shipment with amounts converted to a chosen currency.Read-onlyList Shipment Rates in Currency
List the shipping rates of a shipment with amounts converted to a chosen currency. Returns a paginated object with next, previous and results; amount_local and currency_local hold the converted values. Use when you need rates in a currency other than the carrier currency. Use shippo_list_shipment_rates otherwise.
Inputs
currency_codestringrequired- ISO 4217 currency code to convert the rates to, for example EUR.
shipment_idstringrequired- Object ID of the shipment.
pageinteger- Page number to return, starting at 1.
resultsinteger- Number of results per page (maximum 100).default
25
shippo_list_shipmentsList shipment objects created in this Shippo account, optionally filtered by creation date.Read-onlyList Shipments
List shipment objects created in this Shippo account, optionally filtered by creation date. Returns a paginated object with next, previous and results (each a shipment with addresses, parcels and rates). Use to browse shipments. Use shippo_get_shipment for one shipment.
Inputs
object_created_gtstring- Only return objects created after this ISO 8601 UTC date and time.
object_created_gtestring- Only return objects created at or after this ISO 8601 UTC date and time.
object_created_ltstring- Only return objects created before this ISO 8601 UTC date and time.
object_created_ltestring- Only return objects created at or before this ISO 8601 UTC date and time.
pageinteger- Page number to return, starting at 1.
page_tokenstring- Pagination token taken from the next or previous link of an earlier list response.
resultsinteger- Number of results per page (maximum 100).default
25
shippo_list_user_parcel_templatesList your saved custom parcel templates.Read-onlyList User Parcel Templates
List your saved custom parcel templates. Returns an object with results, each a template with name, dimensions and default weight. Use to find a saved package size. Use shippo_list_carrier_parcel_templates for carrier presets.
Inputs
This tool takes no inputs.
shippo_parse_addressParse a single free-text address string into structured address fields.Read-onlyParse Address
Parse a single free-text address string into structured address fields. Returns address_line_1, address_line_2, city_locality, state_province, postal_code, country_code, email and phone where found. Use when you only have an unstructured address line, before creating an address or shipment.
Inputs
addressstringrequired- The full address as a single string, for example "965 Mission St, Suite 425, San Francisco, CA 94103".
shippo_validate_addressValidate an existing address object and return any corrections.Read-onlyValidate Address
Validate an existing address object and return any corrections. Returns the address with validation_results (is_valid and messages) and the normalized address fields. Use on an address you already created. Use shippo_validate_address_by_fields to check an address that is not stored yet. Prerequisite: create the address first with shippo_create_address.
Inputs
address_idstringrequired- Object ID of the address to validate, as returned by shippo_create_address.
shippo_validate_address_by_fieldsValidate a US or international address from its fields without storing it, and get a recommended address back.Read-onlyValidate Address by Fields
Validate a US or international address from its fields without storing it, and get a recommended address back. Returns original_address, recommended_address, analysis (validation_result, address_type, changed_attributes) and geo. Use to check an address that is not saved. Use shippo_validate_address for a stored address object.
Inputs
address_line_1stringrequired- First line of the street address (street number and name).
country_codestringrequired- Two-letter ISO 3166 country code of the address (for example US, CA, GB).one of
AEARATAUAXAZBABDBEBGBHBMBNBRBSBWBYCACHCLCOCNCYCZDEDKECEEEGESFIFOFRGBGEGFGGGIGPGRGUHKHRHUIDIEILIMINISITJEJOJPKRKYKWKZLBLILTLULVMAMCMDMEMKMOMPMQMTMXMYNANLNONZOMPEPHPLPMPRPTPYQARERORUSASCSESGSISKSMSRTHTNTRTWUAUSUYVNWEYTZA address_line_2string- The second line of the address. Must be percent encoded when passed as a query parameter (e.g. #200 → %23200).
city_localitystring- The city or locality of the address
namestring- The name of the addressee
organizationstring- The organization of the addressee
postal_codestring- The postal code or zip code
state_provincestring- The state, province, county, or municipal division
shippo_add_shipments_to_batchAdd batch shipments to an existing batch.WriteAdd Shipments to Batch
Add batch shipments to an existing batch. Returns the updated batch with its batch_shipments. Use before purchasing. The batch must not have been purchased yet.
Inputs
batch_idstringrequired- Object ID of the batch to extend.
batch_shipmentsarrayrequired- List of batch shipment objects to add. Each has a shipment object (address_from, address_to, parcels) plus optional carrier_account, servicelevel_token and metadata.
shippo_create_addressCreate an address object in Shippo that can be reused when creating shipments, orders and live rate requests.WriteCreate Address
Create an address object in Shippo that can be reused when creating shipments, orders and live rate requests. Returns the address with its object_id, is_complete flag and, when validate is true, validation_results. Use to store a sender or recipient address. Use shippo_validate_address to check an existing address, or shippo_create_address_book_entry for the newer address book.
Inputs
countrystringrequired- ISO 3166-1 alpha-2 country code (for example US or DE). Country names are also accepted but codes are more reliable.
citystring- required for purchase Name of a city. When creating a Quote Address, sending a city is optional but will yield more accurate Rates. Please bear in mind that city names may be ambiguous (there are 34 Springfields in the US).
companystring- Company Name
emailstring- E-mail address of the contact person, RFC3696/5321-compliant.
is_residentialboolean- Set true if the address is a residence and false if it is a business; some carriers charge a residential surcharge.
metadatastring- Free-text note of up to 100 characters stored on the object, for example your own order or reference number.
namestring- required for purchase First and Last Name of the addressee
phonestring- Addresses containing a phone number allow carriers to call the recipient when delivering the Parcel. This increases the probability of delivery and helps to avoid accessorial charges after a Parcel has been shipped.
statestring- required for purchase for some countries State/Province values are required for shipments from/to the US, AU, and CA. UPS requires province for some countries (i.e Ireland). To receive more accurate quotes, passing this field is recommended.
street_nostring- Street number of the addressed building. This field can be included in street1 for all carriers except for DHL Germany.
street1string- First street line: street number and name, for example 965 Mission St. Needed to buy a label.
street2string- Second street line.
street3string- Third street line. Only accepted for USPS international shipments, UPS domestic and UPS international shipments.
validateboolean- Set to true to validate Address object.
zipstring- required for purchase Postal code of an Address. When creating a Quote Addresses, sending a ZIP is optional but will yield more accurate Rates.
shippo_create_address_book_entryStore an address in the Shippo address book (Addresses API v2).WriteCreate Address Book Entry
Store an address in the Shippo address book (Addresses API v2). Returns the stored address with its object_id and normalized fields. Use to keep reusable addresses. Use shippo_create_address for the classic address object used directly by shipments.
Inputs
address_line_1stringrequired- The first line of the address
country_codestringrequired- The ISO 3166 country code
namestringrequired- The name of the addressee
address_line_2string- The second line of the address. Must be percent encoded when passed as a query parameter (e.g. #200 → %23200).
address_typestring- The category of the address. It may affect how certain carriers charge for a delivery/pickup.It is recommended to specify it, if it is known. Allowed values: unknown, residential, commercial, po_box, military.one of
unknownresidentialcommercialpo_boxmilitary city_localitystring- The city or locality of the address
emailstring- The email of the addressee
organizationstring- The organization of the addressee
phonestring- The phone number of the addressee
postal_codestring- The postal code or zip code
state_provincestring- The state, province, county, or municipal division
shippo_create_batchCreate a batch to buy many labels at once; Shippo validates the batch shipments asynchronously.WriteCreate Batch
Create a batch to buy many labels at once; Shippo validates the batch shipments asynchronously. Returns the batch with object_id and status (VALIDATING at first), plus batch_shipments once validated. Use for bulk label purchase. Poll shippo_get_batch until status is VALID, then call shippo_purchase_batch.
Inputs
batch_shipmentsarrayrequired- List of batch shipment objects. Each has a shipment object (address_from, address_to, parcels) and optionally carrier_account, servicelevel_token and metadata.
default_carrier_accountstringrequired- Object ID of the carrier account used for every shipment that does not set its own.
default_servicelevel_tokenstringrequired- Service level token used for every shipment that does not set its own, for example usps_priority.
label_filetypestring- Print format of the label. If empty, will use the default format set from the Shippo dashboard. Allowed values: PNG, PNG_2.3x7.5, PDF, PDF_2.3x7.5, PDF_4x6, PDF_4x8, PDF_A4, PDF_A5, PDF_A6, ZPLII.one of
PNGPNG_2.3x7.5PDFPDF_2.3x7.5PDF_4x6PDF_4x8PDF_A4PDF_A5PDF_A6ZPLII metadatastring- Free-text note of up to 100 characters stored on the object, for example your own order or reference number.
shippo_create_carrier_accountConnect a carrier account to Shippo, or add a Shippo-managed one.WriteCreate Carrier Account
Connect a carrier account to Shippo, or add a Shippo-managed one. Returns the carrier account with object_id, carrier, account_id and active. Use to add your own carrier credentials. The required parameters differ per carrier; see the Shippo carrier accounts guide.
Inputs
account_idstringrequired- Identifier of the account at the carrier, such as the account number.
carrierstringrequired- Shippo carrier token, for example usps, ups, fedex, dhl_express.
activeboolean- Whether the carrier account is active. Inactive accounts are not used when rating shipments.
metadatastring- Free-text note of up to 100 characters stored on the object, for example your own order or reference number.
parametersstring- Carrier-specific credentials and settings as an object. The needed keys differ per carrier, for example account_number or username and password.
testboolean- Set true to mark the object as a test object.
shippo_create_customs_declarationCreate a customs declaration for an international shipment.WriteCreate Customs Declaration
Create a customs declaration for an international shipment. Returns the declaration with object_id, contents_type, items and object_state (VALID or INVALID). Use before shippo_create_shipment for cross-border shipments, then pass its object_id as customs_declaration.
Inputs
certifybooleanrequired- Set true to confirm the information is accurate; it must be true for the declaration to be valid.
certify_signerstringrequired- Name of the person who prepared the declaration and is responsible for it.
contents_typestringrequired- Type of goods of the shipment. Allowed values available hereone of
DOCUMENTSGIFTSAMPLEMERCHANDISEHUMANITARIAN_DONATIONRETURN_MERCHANDISEOTHER itemsarrayrequired- List of customs item objects. Each has description, quantity, net_weight, mass_unit, value_amount, value_currency and origin_country, and optionally tariff_number or hs_code.
non_delivery_optionstringrequired- Indicates how the carrier should proceed in case the shipment can't be delivered. Allowed values available hereone of
ABANDONRETURN address_importerobject- Address of the importer as an address object.
aes_itnstring- required if eel_pfc is AES_ITN AES / ITN reference of the shipment.
b13a_filing_optionstring- B13A Option details are obtained by filing a B13A Canada Export Declaration via the Canadian Export Reporting System (CERS). More information on reporting commercial exports from Canada. Allowed values available hereone of
FILED_ELECTRONICALLYSUMMARY_REPORTINGNOT_REQUIRED b13a_numberstring- must be provided if and only if b13a_filing_option is provided Represents the Proof of Report (POR) Number when b13a_filing_option is FILED_ELECTRONICALLY; the Summary ID Number when b13a_filing_option is SUMMARY_REPORTING; or the Exemption Number when b13a_filing_option is NOT_REQUIRED.
certificatestring- Certificate reference of the shipment.
commercial_invoiceboolean- Set true to request a commercial invoice for the shipment where the carrier supports it.
contents_explanationstring- required if contents_type is OTHER Explanation of the type of goods of the shipment.
disclaimerstring- Disclaimer for the shipment and customs information that have been provided.
duties_payorobject- Who pays duties, as an object with type (SENDER, RECIPIENT or THIRD_PARTY), account (the carrier account number that pays) and address. Only accepted for FedEx shipments.
eel_pfcstring- EEL / PFC type of the shipment. For most shipments from the US to CA, NOEEI_30_36 is applicable; for most other shipments from the US, NOEEI_30_37_a is applicable. Allowed values available hereone of
NOEEI_30_37_aNOEEI_30_37_hNOEEI_30_37_fNOEEI_30_36AES_ITN exporter_identificationobject- Extra exporter identification some countries require, as an object with an eori_number or a tax_id (type and number).
exporter_referencestring- Exporter reference of an export shipment.
importer_referencestring- Importer reference of an import shipment.
incotermstring- The incoterm reference of the shipment. FCA is available for DHL Express and FedEx only. eDAP is available for DPD UK only. DAP is available for DHL Express, FedEx, and DPD UK. If expecting DAP for other carriers, please use DDU. Allowed values: DDP, DDU, FCA, DAP, eDAP.one of
DDPDDUFCADAPeDAP invoicestring- Invoice reference of the shipment.
is_vat_collectedboolean- Indicates whether the shipment's destination VAT has been collected. May be required for some destinations.
licensestring- License reference of the shipment.
metadatastring- Free-text note of up to 100 characters stored on the object, for example your own order or reference number.
notesstring- Additional notes to be included in the customs declaration.
recipient_is_businessboolean- Indicates the shipment goes to a business (B2B) rather than a consumer. Newly created declarations default to false when the field is not provided; declarations created before the field existed return null, which is treated as false.
testboolean- Set true to mark the object as a test object.
shippo_create_customs_itemCreate a customs item that describes one line of goods for a customs declaration.WriteCreate Customs Item
Create a customs item that describes one line of goods for a customs declaration. Returns the item with object_id, description, quantity, net_weight, value_amount and origin_country. Use to keep a standalone item record. shippo_create_customs_declaration takes its items inline as objects.
Inputs
descriptionstringrequired- Text description of your item.
mass_unitstringrequired- The unit used for weight. Allowed values: g, kg, lb, oz.one of
gkglboz net_weightstringrequired- Total net weight of all units of this item as a decimal string, in the unit given by mass_unit.
origin_countrystringrequired- ISO 3166-1 alpha-2 country code where the item was made, for example US or DE.
quantityintegerrequired- Number of units of this item in the shipment. Must be greater than 0.
value_amountstringrequired- Total value of all units of this item as a decimal string, in the currency given by value_currency.
value_currencystringrequired- Currency used for value_amount. The official ISO 4217 currency codes are used, e.g. USD or EUR.
eccn_ear99string- Export Control Classification Number, required on some exports from the United States.
eu_exempt_categoryboolean- Marks the item as belonging to an EU-exempt product category. Exempt items do not need product identifiers on shipments that meet the EU product identifier conditions (EU destination, non-EU origin, MERCHANDISE contents, recipient not a business).
hs_codestring- HS code of the item, which is required by some carriers. If tariff_number is not provided, hs_code will be used. If both hs_code and tariff_number are provided, tariff_number will be used. 50 character limit.
manufacturer_codestring- Product identifier assigned by the manufacturer. Up to 100 characters; some carriers accept fewer and reject longer values at label purchase. Required together with sku_code on every non-exempt item when the shipment meets the EU product identifier conditions.
manufacturer_standard_codestring- Standardized product identifier such as a GTIN. Up to 100 characters. Never required, but recommended for EU-bound shipments when one exists.
metadatastring- Free-text note of up to 100 characters stored on the object, for example your own order or reference number.
sku_codestring- SKU or merchant-assigned product code of the item. Up to 100 characters; some carriers accept fewer and reject longer values at label purchase.
tariff_numberstring- The tariff number of the item. If tariff_number is not provided, hs_code will be used. If both hs_code and tariff_number are provided, tariff_number will be used. 12 character limit.
shippo_create_label_from_ratePurchase a shipping label using a rate that was previously returned for a shipment.WriteCreate Label from Rate
Purchase a shipping label using a rate that was previously returned for a shipment. Returns the transaction with object_id, status, tracking_number, tracking_url_provider and label_url. This spends money in live mode. Use after picking a rate from shippo_create_shipment or shippo_list_shipment_rates. Use shippo_create_label_from_shipment to buy without a prior rate.
Inputs
ratestringrequired- Object ID of the rate to purchase, taken from a shipment rates array.
asyncboolean- If true, the request returns immediately and Shippo finishes processing in the background; poll the object afterwards to see its final status. Leave unset for a synchronous call.
label_file_typestring- Print format of the label. Allowed values: PNG, PNG_2.3x7.5, PDF, PDF_2.3x7.5, PDF_4x6, PDF_4x8, PDF_A4, PDF_A5, PDF_A6, ZPLII.one of
PNGPNG_2.3x7.5PDFPDF_2.3x7.5PDF_4x6PDF_4x8PDF_A4PDF_A5PDF_A6ZPLII metadatastring- Free-text note of up to 100 characters stored on the object, for example your own order or reference number.
orderstring- Optional object ID of a Shippo order to attach the label to.
shippo_create_label_from_shipmentCreate and purchase a label in one call from shipment details, a carrier account and a service level token.WriteCreate Label from Shipment Details
Create and purchase a label in one call from shipment details, a carrier account and a service level token. Returns the transaction with object_id, status, tracking_number and label_url. This spends money in live mode. Use when you already know the carrier account and service level. Use shippo_create_label_from_rate after rate shopping.
Inputs
carrier_accountstringrequired- Object ID of the carrier account that will ship the package.
servicelevel_tokenstringrequired- Token of the service level to buy, for example usps_priority or ups_ground.
shipmentobjectrequired- Shipment details as an object with address_from, address_to and parcels (and optionally customs_declaration and extra), as accepted by shippo_create_shipment.
asyncboolean- If true, the request returns immediately and Shippo finishes processing in the background; poll the object afterwards to see its final status. Leave unset for a synchronous call.
label_file_typestring- Print format of the label. Allowed values: PNG, PNG_2.3x7.5, PDF, PDF_2.3x7.5, PDF_4x6, PDF_4x8, PDF_A4, PDF_A6, ZPLII.one of
PNGPNG_2.3x7.5PDFPDF_2.3x7.5PDF_4x6PDF_4x8PDF_A4PDF_A6ZPLII metadatastring- Free-text note of up to 100 characters stored on the object, for example your own order or reference number.
orderstring- Optional object ID of a Shippo order to attach the label to.
shippo_create_manifestCreate a manifest (end-of-day SCAN form) that closes out the labels shipped on a day for one carrier account.WriteCreate Manifest
Create a manifest (end-of-day SCAN form) that closes out the labels shipped on a day for one carrier account. Returns the manifest with object_id, status, documents and any errors. Use at the end of the shipping day for carriers that need a manifest. Creation can be asynchronous; poll with shippo_get_manifest.
Inputs
address_fromobjectrequired- Pickup address as an address object or the object_id of an existing address.
carrier_accountstringrequired- Object ID of the carrier account to close out.
shipment_datestringrequired- Day whose shipments are closed out, in ISO 8601 format.
asyncboolean- If true, the request returns immediately and Shippo finishes processing in the background; poll the object afterwards to see its final status. Leave unset for a synchronous call.
transactionsarray- Optional list of label object_ids to include. When empty, all labels of that day for the carrier account are included.
shippo_create_orderCreate an order record in Shippo from a recipient address and line items.WriteCreate Order
Create an order record in Shippo from a recipient address and line items. Returns the order with object_id, order_number, order_status, addresses and line_items. Use to track a customer order before shipping. Attach a label to it by passing its object_id as order in the label tools.
Inputs
placed_atstringrequired- Date and time the order was placed, in ISO 8601 format.
to_addressobjectrequired- Recipient address as an address object, or the object_id of an existing address.
currencystring- ISO 4217 currency code of total_price and total_tax. Required when total_price is set.
from_addressobject- Sender address as an address object, or the object_id of an existing address.
line_itemsarray- List of items in the order. Each has a title, quantity, sku, total_price, currency, weight and weight_unit.
notesstring- Custom buyer- or seller-provided notes about the order.
order_numberstring- An alphanumeric identifier for the order used by the seller/buyer. This identifier doesn't need to be unique.
order_statusstring- Current state of the order. Allowed values: UNKNOWN, AWAITPAY, PAID, REFUNDED, CANCELLED, PARTIALLY_FULFILLED, SHIPPED.one of
UNKNOWNAWAITPAYPAIDREFUNDEDCANCELLEDPARTIALLY_FULFILLEDSHIPPED shipping_coststring- Amount paid by the buyer for shipping. This amount can be different from the price the seller will actually pay for shipping.
shipping_cost_currencystring- ISO 4217 currency code of shipping_cost. Required when shipping_cost is set.
shipping_methodstring- Shipping method (carrier + service or other free text description) chosen by the buyer. This value can be different from the shipping method the seller will actually choose.
subtotal_pricestring- Amount paid by the buyer for the items before shipping and tax, as a decimal string.
total_pricestring- Total amount paid by the buyer for this order.
total_taxstring- Total tax amount paid by the buyer for this order.
weightstring- Total weight of the order.
weight_unitstring- The unit used for weight. Allowed values: g, kg, lb, oz.one of
gkglboz
shippo_create_parcelCreate a parcel object with dimensions and weight, or from a carrier parcel template plus weight.WriteCreate Parcel
Create a parcel object with dimensions and weight, or from a carrier parcel template plus weight. Returns the parcel with object_id, dimensions, weight and units. Use to define a package before creating a shipment. Provide either length, width, height and distance_unit, or a template.
Inputs
mass_unitstringrequired- The unit used for weight. Allowed values: g, kg, lb, oz.one of
gkglboz weightstringrequired- Weight of the parcel as a decimal string (up to six digits before and four after the decimal point), in the unit given by mass_unit.
distance_unitstring- Unit for length, width and height. Needed unless template is set. Allowed values: cm, in, ft, m, mm, yd.one of
cminftmmmyd extraobject- Optional extra services for this parcel as an object, for example reference_1, reference_2, insurance or COD.
heightstring- Height of the parcel as a decimal string, in the unit given by distance_unit. Needed unless template is set.
lengthstring- Length of the parcel as a decimal string, in the unit given by distance_unit. Needed unless template is set.
metadatastring- Free-text note of up to 100 characters stored on the object, for example your own order or reference number.
templatestring- Carrier parcel template token such as USPS_FlatRateEnvelope. When set, length, width, height and distance_unit must be left empty.
widthstring- Width of the parcel as a decimal string, in the unit given by distance_unit. Needed unless template is set.
shippo_create_pickupSchedule a carrier pickup for purchased labels (USPS and DHL Express only).WriteCreate Pickup
Schedule a carrier pickup for purchased labels (USPS and DHL Express only). Returns the pickup with object_id, status, confirmation_code and the confirmed time window. Use after buying labels when a carrier should collect the packages from a location.
Inputs
carrier_accountstringrequired- Object ID of your USPS or DHL Express carrier account.
locationobjectrequired- Pickup location as an object with building_location_type (for example Front Door), an address object and optionally building_type and instructions.
requested_end_timestringrequired- Latest time the parcels are available, in ISO 8601 format.
requested_start_timestringrequired- Earliest time the parcels are ready, in ISO 8601 format.
transactionsarrayrequired- List of label (transaction) object_ids to be picked up.
metadatastring- Free-text note of up to 100 characters stored on the object, for example your own order or reference number.
shippo_create_refundRequest a refund for an unused shipping label.WriteCreate Refund
Request a refund for an unused shipping label. Returns the refund with object_id, status (QUEUED, PENDING, SUCCESS or ERROR) and the transaction id. Use for labels that were never scanned by the carrier; eligibility depends on carrier policy.
Inputs
transactionstringrequired- Object ID of the label (transaction) to refund, as returned by shippo_create_label_from_rate.
asyncboolean- If true, the request returns immediately and Shippo finishes processing in the background; poll the object afterwards to see its final status. Leave unset for a synchronous call.
shippo_create_service_groupCreate a service group that defines a checkout shipping option (live rate, flat rate or free shipping).WriteCreate Service Group
Create a service group that defines a checkout shipping option (live rate, flat rate or free shipping). Returns the service group with object_id and its settings. Use to configure live rates at checkout; see shippo_create_live_rates.
Inputs
descriptionstringrequired- Description for the service group
namestringrequired- Name for the service group that will be shown to customers in the response
service_levelsarrayrequired- List of service levels in the group. Each is an object with account_object_id (the carrier account object_id) and service_level_token (for example usps_priority).
typestringrequired- LIVE_RATE (Shippo rates the shipment), FLAT_RATE (fixed price) or FREE_SHIPPING (free above a threshold). Allowed values: LIVE_RATE, FLAT_RATE, FREE_SHIPPING.one of
LIVE_RATEFLAT_RATEFREE_SHIPPING flat_ratestring- String representation of an amount to be returned as the flat rate if 1. The service group is of type LIVE_RATE and no matching rates were found; or 2. The service group is of type FLAT_RATE. Either integers or decimals are accepted. Required unless type is FREE_SHIPPING
flat_rate_currencystring- required unless type is FREE_SHIPPING. (ISO 4217 currency)
free_shipping_threshold_currencystring- optional unless type is FREE_SHIPPING. (ISO 4217 currency)
free_shipping_threshold_minstring- For service groups of type FREE_SHIPPING, this field must be required to configure the minimum cart total (total cost of items in the cart) for this service group to be returned for rates at checkout. Optional unless type is FREE_SHIPPING
rate_adjustmentinteger- The amount in percent (%) that the service group's returned rate should be adjusted. For example, if this field is set to 5 and the matched rate price is $5.00, the returned value of the service group will be $5.25.
shippo_create_shipmentCreate a shipment from sender, recipient and parcels; Shippo then calculates the available shipping rates.WriteCreate Shipment
Create a shipment from sender, recipient and parcels; Shippo then calculates the available shipping rates. Returns the shipment with object_id, status, messages and a rates array (each rate has object_id, provider, servicelevel, amount, currency, estimated_days). Use to rate shop. Buy a label from a chosen rate with shippo_create_label_from_rate. Use shippo_create_label_from_shipment to rate and buy in one call.
Inputs
address_fromobjectrequired- Sender address. Either the object_id of an existing address or an address object with name, street1, city, state, zip and country.
address_toobjectrequired- Recipient address. Either the object_id of an existing address or an address object with name, street1, city, state, zip and country.
parcelsarrayrequired- List of parcels to ship. Each item is either the object_id of an existing parcel or a parcel object with length, width, height, distance_unit, weight and mass_unit.
address_returnobject- Optional return address. Either the object_id of an existing address or an address object; defaults to the sender address.
asyncboolean- If true, the request returns immediately and Shippo finishes processing in the background; poll the object afterwards to see its final status. Leave unset for a synchronous call.
carrier_accountsarray- Optional list of carrier account object_ids to rate with. When empty, all your active carrier accounts are used.
customs_declarationobject- Customs declaration for international shipments: the object_id returned by shippo_create_customs_declaration, or a customs declaration object.
extraobject- Optional extra services as an object, for example signature_confirmation, insurance, reference_1, saturday_delivery.
metadatastring- Free-text note of up to 100 characters stored on the object, for example your own order or reference number.
shipment_datestring- Date and time the shipment will be handed to the carrier, in ISO 8601 format.
shippo_create_user_parcel_templateSave a reusable parcel template, either custom dimensions or based on a carrier preset.WriteCreate User Parcel Template
Save a reusable parcel template, either custom dimensions or based on a carrier preset. Returns the template with object_id, name, dimensions and weight. Use to store common box sizes. Send name, length, width, height and distance_unit for a custom one, or template for a carrier preset.
Inputs
distance_unitstring- The measure unit used for length, width and height. Allowed values: cm, in, ft, m, mm, yd.one of
cminftmmmyd heightstring- The height of the package, in units specified by the distance_unit attribute. Required, but if using a preset carrier template then this field must be empty.
lengthstring- The length of the package, in units specified by the distance_unit attribute. Required, but if using a preset carrier template then this field must be empty.
namestring- Name of the template. Required for a custom template.
templatestring- Carrier parcel template token to base this on, for example USPS_FlatRateEnvelope. Leave empty for a fully custom template.
weightstring- The weight of the package, in units specified by the weight_unit attribute.
weight_unitstring- The unit used for weight. Allowed values: g, kg, lb, oz.one of
gkglboz widthstring- The width of the package, in units specified by the distance_unit attribute. Required, but if using a preset carrier template then this field must be empty.
shippo_purchase_batchPurchase all labels of a batch whose status is VALID.WritePurchase Batch
Purchase all labels of a batch whose status is VALID. Returns the batch with status PURCHASING; it becomes PURCHASED when all labels are bought. This spends money in live mode. Use after shippo_create_batch has reached VALID. Poll with shippo_get_batch.
Inputs
batch_idstringrequired- Object ID of the batch to purchase.
shippo_remove_shipments_from_batchRemove batch shipments from an existing batch.WriteRemove Shipments from Batch
Remove batch shipments from an existing batch. Returns the updated batch. Use to drop invalid or unwanted shipments before purchase. Pass the object_ids of the batch shipments, not of the underlying shipments.
Inputs
batch_idstringrequired- Object ID of the batch.
shipmentsarrayrequired- List of batch shipment object_ids to remove.
shippo_update_address_book_entryReplace the values of an existing address book entry.WriteUpdate Address Book Entry
Replace the values of an existing address book entry. Returns the updated address book entry. Use to correct a saved address. The name, address_line_1 and country_code fields are always required, so send the full address.
- Idempotent
Inputs
address_idstringrequired- Object ID of the address book entry to update.
address_line_1stringrequired- The first line of the address
country_codestringrequired- The ISO 3166 country code
namestringrequired- The name of the addressee
address_line_2string- The second line of the address. Must be percent encoded when passed as a query parameter (e.g. #200 → %23200).
address_typestring- The category of the address. It may affect how certain carriers charge for a delivery/pickup.It is recommended to specify it, if it is known. Allowed values: unknown, residential, commercial, po_box, military.one of
unknownresidentialcommercialpo_boxmilitary city_localitystring- The city or locality of the address
emailstring- The email of the addressee
organizationstring- The organization of the addressee
phonestring- The phone number of the addressee
postal_codestring- The postal code or zip code
state_provincestring- The state, province, county, or municipal division
shippo_update_carrier_accountUpdate the active flag, parameters or metadata of a carrier account.WriteUpdate Carrier Account
Update the active flag, parameters or metadata of a carrier account. Returns the updated carrier account. Use to enable, disable or re-credential an account. carrier and account_id identify the account and cannot be changed, but must be sent.
- Idempotent
Inputs
account_idstringrequired- Identifier of the account at the carrier. It cannot be changed but must be sent.
carrierstringrequired- Shippo carrier token of the account, for example usps. It cannot be changed but must be sent.
carrier_account_idstringrequired- Object ID of the carrier account to update.
activeboolean- Whether the carrier account is active. Inactive accounts are not used when rating shipments.
parametersstring- Carrier-specific credentials and settings as an object. The needed keys differ per carrier.
shippo_update_service_groupUpdate an existing service group, identified by object_id in the body.WriteUpdate Service Group
Update an existing service group, identified by object_id in the body. Returns the updated service group. Use to rename a group, change its price or switch it on or off. All required fields must be sent again.
- Idempotent
Inputs
descriptionstringrequired- Description for the service group
is_activebooleanrequired- True if the service group is enabled, false otherwise.
namestringrequired- Name for the service group that will be shown to customers in the response
object_idstringrequired- Object ID of the service group to update.
service_levelsarrayrequired- List of service levels in the group. Each is an object with account_object_id (the carrier account object_id) and service_level_token (for example usps_priority).
typestringrequired- The type of the service group. - LIVE_RATE: Shippo will make a rating request and return real-time rates for the shipping group, only falling back to the specified flat rate amount if no rates match a service level in the service group. Allowed values: LIVE_RATE, FLAT_RATE, FREE_SHIPPING.one of
LIVE_RATEFLAT_RATEFREE_SHIPPING flat_ratestring- String representation of an amount to be returned as the flat rate if 1. The service group is of type LIVE_RATE and no matching rates were found; or 2. The service group is of type FLAT_RATE. Either integers or decimals are accepted. Required unless type is FREE_SHIPPING
flat_rate_currencystring- required unless type is FREE_SHIPPING. (ISO 4217 currency)
free_shipping_threshold_currencystring- optional unless type is FREE_SHIPPING. (ISO 4217 currency)
free_shipping_threshold_minstring- For service groups of type FREE_SHIPPING, this field must be required to configure the minimum cart total (total cost of items in the cart) for this service group to be returned for rates at checkout. Optional unless type is FREE_SHIPPING
rate_adjustmentinteger- The amount in percent (%) that the service group's returned rate should be adjusted. For example, if this field is set to 5 and the matched rate price is $5.00, the returned value of the service group will be $5.25.
shippo_update_user_parcel_templateUpdate a saved parcel template.WriteUpdate User Parcel Template
Update a saved parcel template. Returns the updated template. Use to change a template size or weight. name, length, width, height and distance_unit are always required.
- Idempotent
Inputs
distance_unitstringrequired- The measure unit used for length, width and height. Allowed values: cm, in, ft, m, mm, yd.one of
cminftmmmyd heightstringrequired- The height of the package, in units specified by the distance_unit attribute. Required, but if using a preset carrier template then this field must be empty.
lengthstringrequired- The length of the package, in units specified by the distance_unit attribute. Required, but if using a preset carrier template then this field must be empty.
namestringrequired- The name of the User Parcel Template
user_parcel_template_object_idstringrequired- Object ID of the template to update.
widthstringrequired- The width of the package, in units specified by the distance_unit attribute. Required, but if using a preset carrier template then this field must be empty.
weightstring- The weight of the package, in units specified by the weight_unit attribute.
weight_unitstring- The unit used for weight. Allowed values: g, kg, lb, oz.one of
gkglboz
shippo_delete_address_book_entryRemove an address from the Shippo address book by its object ID.DestructiveDelete Address Book Entry
Remove an address from the Shippo address book by its object ID. Returns an empty response on success. Use only when the saved address is no longer needed; shipments that already used it are not affected.
- Idempotent
Inputs
address_idstringrequired- Object ID of the address book entry to delete.
shippo_delete_service_groupDelete a service group by its object ID.DestructiveDelete Service Group
Delete a service group by its object ID. Returns an empty response on success. Use only when the checkout option is no longer offered.
- Idempotent
Inputs
service_group_idstringrequired- Object ID of the service group to delete.
shippo_delete_user_parcel_templateDelete a saved parcel template by its object ID.DestructiveDelete User Parcel Template
Delete a saved parcel template by its object ID. Returns an empty response on success. Use only when the template is no longer needed.
- Idempotent
Inputs
user_parcel_template_object_idstringrequired- Object ID of the template to delete.
No tools match.
