Skip to main content
Server path: /shippo-management | Type: Application | PCID required: Yes

Tools

ToolDescription
shippo_management_create_carrier_accountCreate a new carrier account
shippo_management_create_customs_declarationCreate a new customs declaration
shippo_management_create_customs_itemCreate a new customs item
shippo_management_create_service_groupCreate a new service group
shippo_management_create_shippo_accountCreate a Shippo Account
shippo_management_create_trackRegister a tracking webhook
shippo_management_create_user_parcel_templateCreate a new user parcel template
shippo_management_create_webhookCreate a new webhook
shippo_management_delete_service_groupDelete a service group
shippo_management_delete_user_parcel_templateDelete a user parcel template
shippo_management_delete_webhookDelete a specific webhook
shippo_management_get_accountRetrieve a Shippo Account
shippo_management_get_carrier_accountRetrieve a carrier account
shippo_management_get_carrier_parcel_templateRetrieve a carrier parcel templates
shippo_management_get_carrier_registration_statusGet Carrier Registration status
shippo_management_get_customs_declarationRetrieve a customs declaration
shippo_management_get_customs_itemRetrieve a customs item
shippo_management_get_trackGet a tracking status
shippo_management_get_user_parcel_templateRetrieves a user parcel template
shippo_management_get_webhookRetrieve a specific webhook
shippo_management_initiate_oauth2signinConnect an existing carrier account using OAuth 2.0
shippo_management_list_carrier_accountsList all carrier accounts
shippo_management_list_carrier_parcel_templatesList all carrier parcel templates
shippo_management_list_customs_declarationsList all customs declarations
shippo_management_list_customs_itemsList all customs items
shippo_management_list_service_groupsList all service groups
shippo_management_list_shippo_accountsList all Shippo Accounts
shippo_management_list_user_parcel_templatesList all user parcel templates
shippo_management_list_webhooksList all webhooks
shippo_management_register_carrier_accountAdd a Shippo carrier account
shippo_management_update_carrier_accountUpdate a carrier account
shippo_management_update_service_groupUpdate an existing service group
shippo_management_update_shippo_accountUpdate a Shippo Account
shippo_management_update_user_parcel_templateUpdate an existing user parcel template
shippo_management_update_webhookUpdate an existing webhook

shippo_management_create_carrier_account

Create a new carrier account Parameters:
ParameterTypeRequiredDefaultDescription
account_idstringYesAccount Id
activebooleanNoThe active value
carrierstringYesThe carrier value
metadatastringNoThe metadata value
parametersobjectYesThe parameters value
testbooleanNoThe test value

shippo_management_create_customs_declaration

Create a new customs declaration Parameters:
ParameterTypeRequiredDefaultDescription
address_importerobjectNoObject that represents the address of the importer
aes_itnstringNorequired if eel_pfc is AES_ITN<br> AES / ITN reference of the shipment.
b13a_filing_optionobjectNoB13a Filing Option
b13a_numberstringNomust be provided if and only if b13a_filing_option is provided<br> Represents:<br> the Proof of Report (POR) Number when b13a_filing_option is FILED_ELECTRONICALLY;<br> the Summary ID Number when b13a_filing_option is SUMMARY_REPORTING;<br> or the Exemption Number when b13a_filing_option is NOT_REQUIRED.
certificatestringNoCertificate reference of the shipment.
certifybooleanYesExpresses that the certify_signer has provided all information of this customs declaration truthfully.
certify_signerstringYesName of the person who created the customs declaration and is responsible for the validity of all information provided.
commercial_invoicebooleanNoCommercial Invoice
contents_explanationstringNorequired if contents_type is OTHER<br> Explanation of the type of goods of the shipment.
contents_typeobjectYesContents Type
disclaimerstringNoDisclaimer for the shipment and customs information that have been provided. Carrier-Specific Constraints: | Carrier | Constraints | |:---|:---| | FedEx | Max 554 characters |
duties_payorobjectNoSpecifies who will pay the duties for the shipment. Only accepted for FedEx shipments.
eel_pfcobjectNoEel Pfc
exporter_identificationobjectNoAdditional exporter identification that may be required to ship in certain countries
exporter_referencestringNoExporter reference of an export shipment.
importer_referencestringNoImporter reference of an import shipment.
incotermobjectNoThe incoterm value
invoicestringNoInvoice reference of the shipment.
is_vat_collectedbooleanNoIndicates whether the shipment’s destination VAT has been collected. May be required for some destinations.
itemsany[]YesThe items value
licensestringNoLicense reference of the shipment.
metadatastringNoA string of up to 100 characters that can be filled with any additional information you want to attach to the object.
non_delivery_optionobjectYesNon Delivery Option
notesstringNoAdditional notes to be included in the customs declaration.
testbooleanNoThe test value

shippo_management_create_customs_item

Create a new customs item Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringYesText description of your item.
eccn_ear99stringNoExport Control Classification Number, required on some exports from the United States.
hs_codestringNoHS 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.
mass_unitstringYesThe unit used for weight.
metadatastringNoA string of up to 100 characters that can be filled with any additional information you want to attach to the object.
net_weightstringYesTotal weight of this item, i.e. quantity * weight per item.
origin_countrystringYesCountry of origin of the item. Example: US or DE. All accepted values can be found on the <a href=“http://www.iso.org/” target=“_blank”>Official ISO Website</a>.
quantityintegerYesQuantity of this item in the shipment you send. Must be greater than 0.
sku_codestringNoSKU code of the item, which is required by some carriers.
tariff_numberstringNoThe 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.
value_amountstringYesTotal value of this item, i.e. quantity * value per item.
value_currencystringYesCurrency used for value_amount. The <a href=“http://www.xe.com/iso4217.php”&gt;official ISO 4217</a> currency codes are used, e.g. USD or EUR.

shippo_management_create_service_group

Create a new service group Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringYesDescription for the service group
flat_ratestringNoString 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_currencystringNorequired unless type is FREE_SHIPPING. (ISO 4217 currency)
free_shipping_threshold_currencystringNooptional unless type is FREE_SHIPPING. (ISO 4217 currency)
free_shipping_threshold_minstringNoFor 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
namestringYesName for the service group that will be shown to customers in the response
rate_adjustmentintegerNoThe 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,thereturnedvalueoftheservicegroupwillbe5.00, the returned value of the service group will be 5.25. Negative integers are also accepted and will discount the rate price by the defined percentage amount.
service_levelsobject[]YesService Levels
typestringYesThe type of the service group.<br> 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.<br> FLAT_RATE - Returns a shipping option with the specified flat rate amount.<br> FREE_SHIPPING - Returns a shipping option with a price of $0 only if the total cost of items exceeds the amount defined by free_shipping_threshold_min

shippo_management_create_shippo_account

Create a Shippo Account Parameters:
ParameterTypeRequiredDefaultDescription
company_namestringNoCompany Name
emailstringNoThe email value
first_namestringNoFirst Name
last_namestringNoLast Name

shippo_management_create_track

Register a tracking webhook Parameters:
ParameterTypeRequiredDefaultDescription
carrierstringYesName of the carrier of the shipment to track.
metadatastringNoA string of up to 100 characters that can be filled with any additional information you want to attach to the object.
tracking_numberstringYesTracking number to track.

shippo_management_create_user_parcel_template

Create a new user parcel template Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectYesRequest body

shippo_management_create_webhook

Create a new webhook Parameters:
ParameterTypeRequiredDefaultDescription
activebooleanNoDetermines whether the webhook is active or not.
eventstringYesType of event that triggered the webhook.
is_testbooleanNoDetermines whether the webhook is a test webhook or not.
urlstringYesURL webhook events are sent to.

shippo_management_delete_service_group

Delete a service group Parameters:
ParameterTypeRequiredDefaultDescription
ServiceGroupIdstringYesObject ID of the service group

shippo_management_delete_user_parcel_template

Delete a user parcel template Parameters:
ParameterTypeRequiredDefaultDescription
UserParcelTemplateObjectIdstringYesObject ID of the user parcel template

shippo_management_delete_webhook

Delete a specific webhook Parameters:
ParameterTypeRequiredDefaultDescription
webhookIdstringYesObject ID of the webhook to delete

shippo_management_get_account

Retrieve a Shippo Account Parameters:
ParameterTypeRequiredDefaultDescription
ShippoAccountIdstringYesObject ID of the ShippoAccount

shippo_management_get_carrier_account

Retrieve a carrier account Parameters:
ParameterTypeRequiredDefaultDescription
CarrierAccountIdstringYesObject ID of the carrier account

shippo_management_get_carrier_parcel_template

Retrieve a carrier parcel templates Parameters:
ParameterTypeRequiredDefaultDescription
CarrierParcelTemplateTokenstringYesThe unique string representation of the carrier parcel template

shippo_management_get_carrier_registration_status

Get Carrier Registration status Parameters:
ParameterTypeRequiredDefaultDescription
carrierstringYesfilter by specific carrier

shippo_management_get_customs_declaration

Retrieve a customs declaration Parameters:
ParameterTypeRequiredDefaultDescription
CustomsDeclarationIdstringYesObject ID of the customs declaration
pageintegerNoThe page number you want to select

shippo_management_get_customs_item

Retrieve a customs item Parameters:
ParameterTypeRequiredDefaultDescription
CustomsItemIdstringYesObject ID of the customs item
pageintegerNoThe page number you want to select

shippo_management_get_track

Get a tracking status Parameters:
ParameterTypeRequiredDefaultDescription
TrackingNumberstringYesTracking number
CarrierstringYesName of the carrier

shippo_management_get_user_parcel_template

Retrieves a user parcel template Parameters:
ParameterTypeRequiredDefaultDescription
UserParcelTemplateObjectIdstringYesObject ID of the user parcel template

shippo_management_get_webhook

Retrieve a specific webhook Parameters:
ParameterTypeRequiredDefaultDescription
webhookIdstringYesObject ID of the webhook to retrieve

shippo_management_initiate_oauth2signin

Connect an existing carrier account using OAuth 2.0 Parameters:
ParameterTypeRequiredDefaultDescription
CarrierAccountObjectIdstringYesThe carrier account ID (UUID) to start a signin process.
redirect_uristringYesCallback URL. The URL that tells the authorization server where to send the user back to after they approve the request.
statestringNoA random string generated by the consuming application and included in the request to prevent CSRF attacks. The consuming application checks that the same value is returned after the user authorizes Shippo.

shippo_management_list_carrier_accounts

List all carrier accounts Parameters:
ParameterTypeRequiredDefaultDescription
service_levelsbooleanNoAppends the property service_levels to each returned carrier account
carrierstringNoFilter the response by the specified carrier
account_idstringNoFilter the response by the specified carrier account Id
pageintegerNoThe page number you want to select
resultsintegerNoThe number of results to return per page (max 100, default 5)

shippo_management_list_carrier_parcel_templates

List all carrier parcel templates Parameters:
ParameterTypeRequiredDefaultDescription
includestringNofilter by user or enabled
carrierstringNofilter by specific carrier

shippo_management_list_customs_declarations

List all customs declarations Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoThe page number you want to select
resultsintegerNoThe number of results to return per page (max 100, default 5)

shippo_management_list_customs_items

List all customs items Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoThe page number you want to select
resultsintegerNoThe number of results to return per page (max 100)

shippo_management_list_service_groups

List all service groups

shippo_management_list_shippo_accounts

List all Shippo Accounts Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoThe page number you want to select
resultsintegerNoThe number of results to return per page (max 100)

shippo_management_list_user_parcel_templates

List all user parcel templates

shippo_management_list_webhooks

List all webhooks

shippo_management_register_carrier_account

Add a Shippo carrier account Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectYesThe body of the request.

shippo_management_update_carrier_account

Update a carrier account Parameters:
ParameterTypeRequiredDefaultDescription
CarrierAccountIdstringYesObject ID of the carrier account
account_idstringYesUnique identifier of the account. Please check the <a href=“https://docs.goshippo.com/docs/carriers/carrieraccounts/“&gt;carrier accounts tutorial</a> page for the account_id per carrier.<br> To protect account information, this field will be masked in any API response.
activebooleanNoDetermines whether the account is active. When creating a shipment, if no carrier_accounts are explicitly passed Shippo will query all carrier accounts that have this field set. By default, this is set to True.
carrierstringYesCarrier token, see <a href=“/shippoapi/public-api/carriers”>Carriers</a><br> Please check the <a href=“https://docs.goshippo.com/docs/carriers/carrieraccounts/“&gt;carrier accounts tutorial</a> page for all supported carriers.
parametersobjectNoThe parameters value

shippo_management_update_service_group

Update an existing service group Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringYesDescription for the service group
flat_ratestringNoString 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_currencystringNorequired unless type is FREE_SHIPPING. (ISO 4217 currency)
free_shipping_threshold_currencystringNooptional unless type is FREE_SHIPPING. (ISO 4217 currency)
free_shipping_threshold_minstringNoFor 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
is_activebooleanYesTrue if the service group is enabled, false otherwise.
namestringYesName for the service group that will be shown to customers in the response
object_idstringYesThe unique identifier of the given Service Group object.
rate_adjustmentintegerNoThe 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,thereturnedvalueoftheservicegroupwillbe5.00, the returned value of the service group will be 5.25. Negative integers are also accepted and will discount the rate price by the defined percentage amount.
service_levelsobject[]YesService Levels
typestringYesThe type of the service group.<br> 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.<br> FLAT_RATE - Returns a shipping option with the specified flat rate amount.<br> FREE_SHIPPING - Returns a shipping option with a price of $0 only if the total cost of items exceeds the amount defined by free_shipping_threshold_min

shippo_management_update_shippo_account

Update a Shippo Account Parameters:
ParameterTypeRequiredDefaultDescription
ShippoAccountIdstringYesObject ID of the ShippoAccount
company_namestringNoCompany Name
emailstringNoThe email value
first_namestringNoFirst Name
last_namestringNoLast Name

shippo_management_update_user_parcel_template

Update an existing user parcel template Parameters:
ParameterTypeRequiredDefaultDescription
UserParcelTemplateObjectIdstringYesObject ID of the user parcel template
distance_unitstringYesThe measure unit used for length, width and height.
heightstringYesThe 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.
lengthstringYesThe 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.
namestringYesThe name of the User Parcel Template
weightstringNoThe weight of the package, in units specified by the weight_unit attribute.
weight_unitstringNoThe unit used for weight.
widthstringYesThe 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_management_update_webhook

Update an existing webhook Parameters:
ParameterTypeRequiredDefaultDescription
webhookIdstringYesObject ID of the webhook to retrieve
activebooleanNoDetermines whether the webhook is active or not.
eventstringYesType of event that triggered the webhook.
is_testbooleanNoDetermines whether the webhook is a test webhook or not.
urlstringYesURL webhook events are sent to.