> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # shippo-management > Shippo Management - carrier accounts, customs, tracking, templates, webhooks, and service groups **Server path:** `/shippo-management` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | | [`shippo_management_create_carrier_account`](#shippo_management_create_carrier_account) | Create a new carrier account | | [`shippo_management_create_customs_declaration`](#shippo_management_create_customs_declaration) | Create a new customs declaration | | [`shippo_management_create_customs_item`](#shippo_management_create_customs_item) | Create a new customs item | | [`shippo_management_create_service_group`](#shippo_management_create_service_group) | Create a new service group | | [`shippo_management_create_shippo_account`](#shippo_management_create_shippo_account) | Create a Shippo Account | | [`shippo_management_create_track`](#shippo_management_create_track) | Register a tracking webhook | | [`shippo_management_create_user_parcel_template`](#shippo_management_create_user_parcel_template) | Create a new user parcel template | | [`shippo_management_create_webhook`](#shippo_management_create_webhook) | Create a new webhook | | [`shippo_management_delete_service_group`](#shippo_management_delete_service_group) | Delete a service group | | [`shippo_management_delete_user_parcel_template`](#shippo_management_delete_user_parcel_template) | Delete a user parcel template | | [`shippo_management_delete_webhook`](#shippo_management_delete_webhook) | Delete a specific webhook | | [`shippo_management_get_account`](#shippo_management_get_account) | Retrieve a Shippo Account | | [`shippo_management_get_carrier_account`](#shippo_management_get_carrier_account) | Retrieve a carrier account | | [`shippo_management_get_carrier_parcel_template`](#shippo_management_get_carrier_parcel_template) | Retrieve a carrier parcel templates | | [`shippo_management_get_carrier_registration_status`](#shippo_management_get_carrier_registration_status) | Get Carrier Registration status | | [`shippo_management_get_customs_declaration`](#shippo_management_get_customs_declaration) | Retrieve a customs declaration | | [`shippo_management_get_customs_item`](#shippo_management_get_customs_item) | Retrieve a customs item | | [`shippo_management_get_track`](#shippo_management_get_track) | Get a tracking status | | [`shippo_management_get_user_parcel_template`](#shippo_management_get_user_parcel_template) | Retrieves a user parcel template | | [`shippo_management_get_webhook`](#shippo_management_get_webhook) | Retrieve a specific webhook | | [`shippo_management_initiate_oauth2signin`](#shippo_management_initiate_oauth2signin) | Connect an existing carrier account using OAuth 2.0 | | [`shippo_management_list_carrier_accounts`](#shippo_management_list_carrier_accounts) | List all carrier accounts | | [`shippo_management_list_carrier_parcel_templates`](#shippo_management_list_carrier_parcel_templates) | List all carrier parcel templates | | [`shippo_management_list_customs_declarations`](#shippo_management_list_customs_declarations) | List all customs declarations | | [`shippo_management_list_customs_items`](#shippo_management_list_customs_items) | List all customs items | | [`shippo_management_list_service_groups`](#shippo_management_list_service_groups) | List all service groups | | [`shippo_management_list_shippo_accounts`](#shippo_management_list_shippo_accounts) | List all Shippo Accounts | | [`shippo_management_list_user_parcel_templates`](#shippo_management_list_user_parcel_templates) | List all user parcel templates | | [`shippo_management_list_webhooks`](#shippo_management_list_webhooks) | List all webhooks | | [`shippo_management_register_carrier_account`](#shippo_management_register_carrier_account) | Add a Shippo carrier account | | [`shippo_management_update_carrier_account`](#shippo_management_update_carrier_account) | Update a carrier account | | [`shippo_management_update_service_group`](#shippo_management_update_service_group) | Update an existing service group | | [`shippo_management_update_shippo_account`](#shippo_management_update_shippo_account) | Update a Shippo Account | | [`shippo_management_update_user_parcel_template`](#shippo_management_update_user_parcel_template) | Update an existing user parcel template | | [`shippo_management_update_webhook`](#shippo_management_update_webhook) | Update an existing webhook | *** ## shippo\_management\_create\_carrier\_account Create a new carrier account **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `SHIPPO-API-VERSION` | string | No | — | Optional string used to pick a non-default API version to use. See our \ guide. | | `account_id` | string | Yes | — | Account Id | | `active` | boolean | No | — | The active value | | `carrier` | string | Yes | — | The carrier value | | `metadata` | string | No | — | The metadata value | | `parameters` | object | Yes | — | The parameters value | | `test` | boolean | No | — | The test value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "SHIPPO-API-VERSION": { "type": "string", "description": "Optional string used to pick a non-default API version to use. See our API version guide." }, "account_id": { "type": "string", "description": "Account Id" }, "active": { "type": "boolean", "description": "The active value" }, "carrier": { "type": "string", "description": "The carrier value" }, "metadata": { "type": "string", "description": "The metadata value" }, "parameters": { "description": "The parameters value" }, "test": { "type": "boolean", "description": "The test value" } }, "required": [ "PCID", "account_id", "carrier", "parameters" ] } ``` *** ## shippo\_management\_create\_customs\_declaration Create a new customs declaration **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `SHIPPO-API-VERSION` | string | No | — | Optional string used to pick a non-default API version to use. See our \ guide. | | `address_importer` | object | No | — | Object that represents the address of the importer | | `aes_itn` | string | No | — | **required if eel\_pfc is `AES_ITN`**\
AES / ITN reference of the shipment. | | `b13a_filing_option` | object | No | — | B13a Filing Option | | `b13a_number` | string | No | — | **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`. | | `certificate` | string | No | — | Certificate reference of the shipment. | | `certify` | boolean | Yes | — | Expresses that the certify\_signer has provided all information of this customs declaration truthfully. | | `certify_signer` | string | Yes | — | Name of the person who created the customs declaration and is responsible for the validity of all information provided. | | `commercial_invoice` | boolean | No | — | Commercial Invoice | | `contents_explanation` | string | No | — | **required if contents\_type is `OTHER`**\
Explanation of the type of goods of the shipment. | | `contents_type` | object | Yes | — | Contents Type | | `disclaimer` | string | No | — | Disclaimer for the shipment and customs information that have been provided. **Carrier-Specific Constraints:** \| Carrier \| Constraints \| \|:---\|:---\| \| FedEx \| Max 554 characters \| | | `duties_payor` | object | No | — | Specifies who will pay the duties for the shipment. Only accepted for FedEx shipments. | | `eel_pfc` | object | No | — | Eel Pfc | | `exporter_identification` | object | No | — | Additional exporter identification that may be required to ship in certain countries | | `exporter_reference` | string | No | — | Exporter reference of an export shipment. | | `importer_reference` | string | No | — | Importer reference of an import shipment. | | `incoterm` | object | No | — | The incoterm value | | `invoice` | string | No | — | Invoice reference of the shipment. | | `is_vat_collected` | boolean | No | — | Indicates whether the shipment's destination VAT has been collected. May be required for some destinations. | | `items` | any\[] | Yes | — | The items value | | `license` | string | No | — | License reference of the shipment. | | `metadata` | string | No | — | A string of up to 100 characters that can be filled with any additional information you want to attach to the object. | | `non_delivery_option` | object | Yes | — | Non Delivery Option | | `notes` | string | No | — | Additional notes to be included in the customs declaration. | | `test` | boolean | No | — | The test value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "SHIPPO-API-VERSION": { "type": "string", "description": "Optional string used to pick a non-default API version to use. See our API version guide." }, "address_importer": { "type": "object", "description": "Object that represents the address of the importer", "properties": { "name": { "type": "string", "description": "First and Last Name of the addressee" }, "company": { "type": "string", "description": "Company Name" }, "street1": { "type": "string", "description": "First street line, 35 character limit. Usually street number and street name (except for DHL Germany, see street_no)." }, "street2": { "type": "string", "description": "Second street line, 35 character limit." }, "street3": { "type": "string", "description": "Third street line, 35 character limit. Only accepted for USPS international shipments, UPS domestic and UPS international shipments." }, "street_no": { "type": "string", "description": "Street number of the addressed building. This field can be included in street1 for all carriers except for DHL Germany." }, "city": { "type": "string", "description": "Name of a city" }, "state": { "type": "string", "description": "**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. Most carriers only accept two or three character state abbreviations." }, "zip": { "type": "string", "description": "Postal code of an Address." }, "country": { "type": "string", "description": "Example: `US` or `DE`. All accepted values can be found on the Official ISO Website. Sending a country is always required." }, "phone": { "type": "string", "description": "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." }, "email": { "type": "string", "description": "E-mail address of the contact person, RFC3696/5321-compliant." }, "is_residential": { "type": "boolean", "description": "Indicates whether the address provided is a residential address or not." } } }, "aes_itn": { "type": "string", "description": "**required if eel_pfc is `AES_ITN`**
AES / ITN reference of the shipment." }, "b13a_filing_option": { "description": "B13a Filing Option" }, "b13a_number": { "type": "string", "description": "**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`." }, "certificate": { "type": "string", "description": "Certificate reference of the shipment." }, "certify": { "type": "boolean", "description": "Expresses that the certify_signer has provided all information of this customs declaration truthfully." }, "certify_signer": { "type": "string", "description": "Name of the person who created the customs declaration and is responsible for the validity of all information provided." }, "commercial_invoice": { "type": "boolean", "description": "Commercial Invoice" }, "contents_explanation": { "type": "string", "description": "**required if contents_type is `OTHER`**
Explanation of the type of goods of the shipment." }, "contents_type": { "description": "Contents Type" }, "disclaimer": { "type": "string", "description": "Disclaimer for the shipment and customs information that have been provided. **Carrier-Specific Constraints:** | Carrier | Constraints | |:---|:---| | FedEx | Max 554 characters |" }, "duties_payor": { "type": "object", "description": "Specifies who will pay the duties for the shipment. Only accepted for FedEx shipments.", "properties": { "account": { "type": "string", "description": "Account number to be billed for duties." }, "type": { "description": "Party to be billed for duties.", "enum": [ "SENDER", "RECIPIENT", "THIRD_PARTY" ] }, "address": { "type": "object", "description": "The address value" } } }, "eel_pfc": { "description": "Eel Pfc" }, "exporter_identification": { "type": "object", "description": "Additional exporter identification that may be required to ship in certain countries", "properties": { "eori_number": { "type": "string", "description": "Economic Operators' Registration and Identification (EORI) number. Must start with a 2 character country code followed by a 6-17 character alphanumeric identifier (e.g. PL1234567890ABCDE). More information on EORI." }, "tax_id": { "type": "object", "description": "Tax identification that may be required to ship in certain countries. Typically used to assess duties on goods that are crossing a border." } } }, "exporter_reference": { "type": "string", "description": "Exporter reference of an export shipment." }, "importer_reference": { "type": "string", "description": "Importer reference of an import shipment." }, "incoterm": { "description": "The incoterm value" }, "invoice": { "type": "string", "description": "Invoice reference of the shipment." }, "is_vat_collected": { "type": "boolean", "description": "Indicates whether the shipment's destination VAT has been collected. May be required for some destinations." }, "items": { "type": "array", "description": "The items value" }, "license": { "type": "string", "description": "License reference of the shipment." }, "metadata": { "type": "string", "description": "A string of up to 100 characters that can be filled with any additional information you want to attach to the object." }, "non_delivery_option": { "description": "Non Delivery Option" }, "notes": { "type": "string", "description": "Additional notes to be included in the customs declaration." }, "test": { "type": "boolean", "description": "The test value" } }, "required": [ "PCID", "certify", "certify_signer", "contents_type", "items", "non_delivery_option" ] } ``` *** ## shippo\_management\_create\_customs\_item Create a new customs item **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `SHIPPO-API-VERSION` | string | No | — | Optional string used to pick a non-default API version to use. See our \ guide. | | `description` | string | Yes | — | Text description of your item. | | `eccn_ear99` | string | No | — | Export Control Classification Number, required on some exports from the United States. | | `hs_code` | string | No | — | 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. | | `mass_unit` | string | Yes | — | The unit used for weight. | | `metadata` | string | No | — | A string of up to 100 characters that can be filled with any additional information you want to attach to the object. | | `net_weight` | string | Yes | — | Total weight of this item, i.e. quantity \* weight per item. | | `origin_country` | string | Yes | — | Country of origin of the item. Example: `US` or `DE`. All accepted values can be found on the \Official ISO Website\. | | `quantity` | integer | Yes | — | Quantity of this item in the shipment you send. Must be greater than 0. | | `sku_code` | string | No | — | SKU code of the item, which is required by some carriers. | | `tariff_number` | string | No | — | 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. | | `value_amount` | string | Yes | — | Total value of this item, i.e. quantity \* value per item. | | `value_currency` | string | Yes | — | Currency used for value\_amount. The \official ISO 4217\ currency codes are used, e.g. `USD` or `EUR`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "SHIPPO-API-VERSION": { "type": "string", "description": "Optional string used to pick a non-default API version to use. See our API version guide." }, "description": { "type": "string", "description": "Text description of your item." }, "eccn_ear99": { "type": "string", "description": "Export Control Classification Number, required on some exports from the United States." }, "hs_code": { "type": "string", "description": "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." }, "mass_unit": { "type": "string", "description": "The unit used for weight.", "enum": [ "g", "kg", "lb", "oz" ] }, "metadata": { "type": "string", "description": "A string of up to 100 characters that can be filled with any additional information you want to attach to the object." }, "net_weight": { "type": "string", "description": "Total weight of this item, i.e. quantity * weight per item." }, "origin_country": { "type": "string", "description": "Country of origin of the item. Example: `US` or `DE`. All accepted values can be found on the Official ISO Website." }, "quantity": { "type": "integer", "description": "Quantity of this item in the shipment you send. Must be greater than 0." }, "sku_code": { "type": "string", "description": "SKU code of the item, which is required by some carriers." }, "tariff_number": { "type": "string", "description": "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." }, "value_amount": { "type": "string", "description": "Total value of this item, i.e. quantity * value per item." }, "value_currency": { "type": "string", "description": "Currency used for value_amount. The official ISO 4217 currency codes are used, e.g. `USD` or `EUR`." } }, "required": [ "PCID", "description", "mass_unit", "net_weight", "origin_country", "quantity", "value_amount", "value_currency" ] } ``` *** ## shippo\_management\_create\_service\_group Create a new service group **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `SHIPPO-API-VERSION` | string | No | — | Optional string used to pick a non-default API version to use. See our \ guide. | | `description` | string | Yes | — | Description for the service group | | `flat_rate` | string | No | — | 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_currency` | string | No | — | required unless type is `FREE_SHIPPING`. (ISO 4217 currency) | | `free_shipping_threshold_currency` | string | No | — | optional unless type is `FREE_SHIPPING`. (ISO 4217 currency) | | `free_shipping_threshold_min` | string | No | — | 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` | | `name` | string | Yes | — | Name for the service group that will be shown to customers in the response | | `rate_adjustment` | integer | No | — | 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. Negative integers are also accepted and will discount the rate price by the defined percentage amount. | | `service_levels` | object\[] | Yes | — | Service Levels | | `type` | string | Yes | — | 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.\
`FLAT_RATE` - Returns a shipping option with the specified flat rate amount.\
`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` | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "SHIPPO-API-VERSION": { "type": "string", "description": "Optional string used to pick a non-default API version to use. See our API version guide." }, "description": { "type": "string", "description": "Description for the service group" }, "flat_rate": { "type": "string", "description": "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_currency": { "type": "string", "description": "required unless type is `FREE_SHIPPING`. (ISO 4217 currency)" }, "free_shipping_threshold_currency": { "type": "string", "description": "optional unless type is `FREE_SHIPPING`. (ISO 4217 currency)" }, "free_shipping_threshold_min": { "type": "string", "description": "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`" }, "name": { "type": "string", "description": "Name for the service group that will be shown to customers in the response" }, "rate_adjustment": { "type": "integer", "description": "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. Negative integers are also accepted and will discount the rate price by the defined percentage amount." }, "service_levels": { "type": "array", "items": { "type": "object", "properties": { "account_object_id": { "type": "string", "description": "ID of a Carrier Account object" }, "service_level_token": { "type": "string", "description": "Service level token, e.g. `usps_priority` or `fedex_ground`.
See Service Levels." } } }, "description": "Service Levels" }, "type": { "type": "string", "description": "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.
`FLAT_RATE` - Returns a shipping option with the specified flat rate amount.
`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`", "enum": [ "LIVE_RATE", "FLAT_RATE", "FREE_SHIPPING" ] } }, "required": [ "PCID", "description", "name", "service_levels", "type" ] } ``` *** ## shippo\_management\_create\_shippo\_account Create a Shippo Account **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `SHIPPO-API-VERSION` | string | No | — | Optional string used to pick a non-default API version to use. See our \ guide. | | `company_name` | string | Yes | — | Company Name | | `email` | string | Yes | — | The email value | | `first_name` | string | Yes | — | First Name | | `last_name` | string | Yes | — | Last Name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "SHIPPO-API-VERSION": { "type": "string", "description": "Optional string used to pick a non-default API version to use. See our API version guide." }, "company_name": { "type": "string", "description": "Company Name" }, "email": { "type": "string", "description": "The email value" }, "first_name": { "type": "string", "description": "First Name" }, "last_name": { "type": "string", "description": "Last Name" } }, "required": [ "PCID", "company_name", "email", "first_name", "last_name" ] } ``` *** ## shippo\_management\_create\_track Register a tracking webhook **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `SHIPPO-API-VERSION` | string | No | — | Optional string used to pick a non-default API version to use. See our \ guide. | | `carrier` | string | Yes | — | Name of the carrier of the shipment to track. | | `metadata` | string | No | — | A string of up to 100 characters that can be filled with any additional information you want to attach to the object. | | `tracking_number` | string | Yes | — | Tracking number to track. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "SHIPPO-API-VERSION": { "type": "string", "description": "Optional string used to pick a non-default API version to use. See our API version guide." }, "carrier": { "type": "string", "description": "Name of the carrier of the shipment to track." }, "metadata": { "type": "string", "description": "A string of up to 100 characters that can be filled with any additional information you want to attach to the object." }, "tracking_number": { "type": "string", "description": "Tracking number to track." } }, "required": [ "PCID", "carrier", "tracking_number" ] } ``` *** ## shippo\_management\_create\_user\_parcel\_template Create a new user parcel template **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `SHIPPO-API-VERSION` | string | No | — | Optional string used to pick a non-default API version to use. See our \ guide. | | `body` | object | Yes | — | Request body | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "SHIPPO-API-VERSION": { "type": "string", "description": "Optional string used to pick a non-default API version to use. See our API version guide." }, "body": { "description": "Request body" } }, "required": [ "PCID", "body" ] } ``` *** ## shippo\_management\_create\_webhook Create a new webhook **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | -------------------------------------------------------- | | `active` | boolean | No | — | Determines whether the webhook is active or not. | | `event` | string | Yes | — | Type of event that triggered the webhook. | | `is_test` | boolean | No | — | Determines whether the webhook is a test webhook or not. | | `url` | string | Yes | — | URL webhook events are sent to. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "active": { "type": "boolean", "description": "Determines whether the webhook is active or not." }, "event": { "type": "string", "description": "Type of event that triggered the webhook.", "enum": [ "transaction_created", "transaction_updated", "track_updated", "batch_created", "batch_purchased", "all" ] }, "is_test": { "type": "boolean", "description": "Determines whether the webhook is a test webhook or not." }, "url": { "type": "string", "description": "URL webhook events are sent to." } }, "required": [ "PCID", "event", "url" ] } ``` *** ## shippo\_management\_delete\_service\_group Delete a service group **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `ServiceGroupId` | string | Yes | — | Object ID of the service group | | `SHIPPO-API-VERSION` | string | No | — | Optional string used to pick a non-default API version to use. See our \ guide. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ServiceGroupId": { "type": "string", "description": "Object ID of the service group" }, "SHIPPO-API-VERSION": { "type": "string", "description": "Optional string used to pick a non-default API version to use. See our API version guide." } }, "required": [ "PCID", "ServiceGroupId" ] } ``` *** ## shippo\_management\_delete\_user\_parcel\_template Delete a user parcel template **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `UserParcelTemplateObjectId` | string | Yes | — | Object ID of the user parcel template | | `SHIPPO-API-VERSION` | string | No | — | Optional string used to pick a non-default API version to use. See our \ guide. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "UserParcelTemplateObjectId": { "type": "string", "description": "Object ID of the user parcel template" }, "SHIPPO-API-VERSION": { "type": "string", "description": "Optional string used to pick a non-default API version to use. See our API version guide." } }, "required": [ "PCID", "UserParcelTemplateObjectId" ] } ``` *** ## shippo\_management\_delete\_webhook Delete a specific webhook **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ---------------------------------- | | `webhookId` | string | Yes | — | Object ID of the webhook to delete | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "webhookId": { "type": "string", "description": "Object ID of the webhook to delete" } }, "required": [ "PCID", "webhookId" ] } ``` *** ## shippo\_management\_get\_account Retrieve a Shippo Account **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `ShippoAccountId` | string | Yes | — | Object ID of the ShippoAccount | | `SHIPPO-API-VERSION` | string | No | — | Optional string used to pick a non-default API version to use. See our \ guide. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ShippoAccountId": { "type": "string", "description": "Object ID of the ShippoAccount" }, "SHIPPO-API-VERSION": { "type": "string", "description": "Optional string used to pick a non-default API version to use. See our API version guide." } }, "required": [ "PCID", "ShippoAccountId" ] } ``` *** ## shippo\_management\_get\_carrier\_account Retrieve a carrier account **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `CarrierAccountId` | string | Yes | — | Object ID of the carrier account | | `SHIPPO-API-VERSION` | string | No | — | Optional string used to pick a non-default API version to use. See our \ guide. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "CarrierAccountId": { "type": "string", "description": "Object ID of the carrier account" }, "SHIPPO-API-VERSION": { "type": "string", "description": "Optional string used to pick a non-default API version to use. See our API version guide." } }, "required": [ "PCID", "CarrierAccountId" ] } ``` *** ## shippo\_management\_get\_carrier\_parcel\_template Retrieve a carrier parcel templates **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `CarrierParcelTemplateToken` | string | Yes | — | The unique string representation of the carrier parcel template | | `SHIPPO-API-VERSION` | string | No | — | Optional string used to pick a non-default API version to use. See our \ guide. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "CarrierParcelTemplateToken": { "type": "string", "description": "The unique string representation of the carrier parcel template" }, "SHIPPO-API-VERSION": { "type": "string", "description": "Optional string used to pick a non-default API version to use. See our API version guide." } }, "required": [ "PCID", "CarrierParcelTemplateToken" ] } ``` *** ## shippo\_management\_get\_carrier\_registration\_status Get Carrier Registration status **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `carrier` | string | Yes | — | filter by specific carrier | | `SHIPPO-API-VERSION` | string | No | — | Optional string used to pick a non-default API version to use. See our \ guide. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "carrier": { "type": "string", "description": "filter by specific carrier", "enum": [ "ups", "usps", "canada_post" ] }, "SHIPPO-API-VERSION": { "type": "string", "description": "Optional string used to pick a non-default API version to use. See our API version guide." } }, "required": [ "PCID", "carrier" ] } ``` *** ## shippo\_management\_get\_customs\_declaration Retrieve a customs declaration **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `CustomsDeclarationId` | string | Yes | — | Object ID of the customs declaration | | `page` | integer | No | — | The page number you want to select | | `SHIPPO-API-VERSION` | string | No | — | Optional string used to pick a non-default API version to use. See our \ guide. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "CustomsDeclarationId": { "type": "string", "description": "Object ID of the customs declaration" }, "page": { "type": "integer", "description": "The page number you want to select" }, "SHIPPO-API-VERSION": { "type": "string", "description": "Optional string used to pick a non-default API version to use. See our API version guide." } }, "required": [ "PCID", "CustomsDeclarationId" ] } ``` *** ## shippo\_management\_get\_customs\_item Retrieve a customs item **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `CustomsItemId` | string | Yes | — | Object ID of the customs item | | `page` | integer | No | — | The page number you want to select | | `SHIPPO-API-VERSION` | string | No | — | Optional string used to pick a non-default API version to use. See our \ guide. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "CustomsItemId": { "type": "string", "description": "Object ID of the customs item" }, "page": { "type": "integer", "description": "The page number you want to select" }, "SHIPPO-API-VERSION": { "type": "string", "description": "Optional string used to pick a non-default API version to use. See our API version guide." } }, "required": [ "PCID", "CustomsItemId" ] } ``` *** ## shippo\_management\_get\_track Get a tracking status **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `TrackingNumber` | string | Yes | — | Tracking number | | `Carrier` | string | Yes | — | Name of the carrier | | `SHIPPO-API-VERSION` | string | No | — | Optional string used to pick a non-default API version to use. See our \ guide. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "TrackingNumber": { "type": "string", "description": "Tracking number" }, "Carrier": { "type": "string", "description": "Name of the carrier" }, "SHIPPO-API-VERSION": { "type": "string", "description": "Optional string used to pick a non-default API version to use. See our API version guide." } }, "required": [ "PCID", "TrackingNumber", "Carrier" ] } ``` *** ## shippo\_management\_get\_user\_parcel\_template Retrieves a user parcel template **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `UserParcelTemplateObjectId` | string | Yes | — | Object ID of the user parcel template | | `SHIPPO-API-VERSION` | string | No | — | Optional string used to pick a non-default API version to use. See our \ guide. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "UserParcelTemplateObjectId": { "type": "string", "description": "Object ID of the user parcel template" }, "SHIPPO-API-VERSION": { "type": "string", "description": "Optional string used to pick a non-default API version to use. See our API version guide." } }, "required": [ "PCID", "UserParcelTemplateObjectId" ] } ``` *** ## shippo\_management\_get\_webhook Retrieve a specific webhook **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ------------------------------------ | | `webhookId` | string | Yes | — | Object ID of the webhook to retrieve | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "webhookId": { "type": "string", "description": "Object ID of the webhook to retrieve" } }, "required": [ "PCID", "webhookId" ] } ``` *** ## shippo\_management\_initiate\_oauth2signin Connect an existing carrier account using OAuth 2.0 **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------ | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `CarrierAccountObjectId` | string | Yes | — | The carrier account ID (UUID) to start a signin process. | | `redirect_uri` | string | Yes | — | Callback URL. The URL that tells the authorization server where to send the user back to after they approve the request. | | `state` | string | No | — | A 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-API-VERSION` | string | No | — | Optional string used to pick a non-default API version to use. See our \ guide. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "CarrierAccountObjectId": { "type": "string", "description": "The carrier account ID (UUID) to start a signin process." }, "redirect_uri": { "type": "string", "description": "Callback URL. The URL that tells the authorization server where to send the user back to after they approve the request." }, "state": { "type": "string", "description": "A 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-API-VERSION": { "type": "string", "description": "Optional string used to pick a non-default API version to use. See our API version guide." } }, "required": [ "PCID", "CarrierAccountObjectId", "redirect_uri" ] } ``` *** ## shippo\_management\_list\_carrier\_accounts List all carrier accounts **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `service_levels` | boolean | No | — | Appends the property `service_levels` to each returned carrier account | | `carrier` | string | No | — | Filter the response by the specified carrier | | `account_id` | string | No | — | Filter the response by the specified carrier account Id | | `page` | integer | No | — | The page number you want to select | | `results` | integer | No | — | The number of results to return per page (max 100, default 5) | | `SHIPPO-API-VERSION` | string | No | — | Optional string used to pick a non-default API version to use. See our \ guide. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "service_levels": { "type": "boolean", "description": "Appends the property `service_levels` to each returned carrier account" }, "carrier": { "type": "string", "description": "Filter the response by the specified carrier", "enum": [ "airterra", "apc_postal", "apg", "aramex", "asendia_us", "australia_post", "axlehire", "better_trucks", "borderguru", "boxberry", "bring", "canada_post", "chronopost", "collect_plus", "correios_br", "correos_espana", "colissimo", "deutsche_post", "dhl_benelux", "dhl_ecommerce", "dhl_express", "dhl_germany_c2c", "dhl_germany", "dpd_de", "dpd_uk", "estafeta", "fastway_australia", "fedex", "globegistics", "gls_us", "gophr", "gso", "hermes_germany_b2c", "hermes_uk", "hongkong_post", "lasership", "lso", "mondial_relay", "new_zealand_post", "nippon_express", "ontrac", "parcelforce", "passport", "pcf", "poste_italiane", "posti", "purolator", "royal_mail", "royal_mail_sf", "rr_donnelley", "russian_post", "skypostal", "stuart", "swyft", "uds", "ups", "usps", "veho" ] }, "account_id": { "type": "string", "description": "Filter the response by the specified carrier account Id" }, "page": { "type": "integer", "description": "The page number you want to select" }, "results": { "type": "integer", "description": "The number of results to return per page (max 100, default 5)" }, "SHIPPO-API-VERSION": { "type": "string", "description": "Optional string used to pick a non-default API version to use. See our API version guide." } }, "required": [ "PCID" ] } ``` *** ## shippo\_management\_list\_carrier\_parcel\_templates List all carrier parcel templates **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `include` | string | No | — | filter by user or enabled | | `carrier` | string | No | — | filter by specific carrier | | `SHIPPO-API-VERSION` | string | No | — | Optional string used to pick a non-default API version to use. See our \ guide. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "include": { "type": "string", "description": "filter by user or enabled", "enum": [ "all", "user", "enabled" ] }, "carrier": { "type": "string", "description": "filter by specific carrier" }, "SHIPPO-API-VERSION": { "type": "string", "description": "Optional string used to pick a non-default API version to use. See our API version guide." } }, "required": [ "PCID" ] } ``` *** ## shippo\_management\_list\_customs\_declarations List all customs declarations **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `page` | integer | No | — | The page number you want to select | | `results` | integer | No | — | The number of results to return per page (max 100, default 5) | | `SHIPPO-API-VERSION` | string | No | — | Optional string used to pick a non-default API version to use. See our \ guide. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "The page number you want to select" }, "results": { "type": "integer", "description": "The number of results to return per page (max 100, default 5)" }, "SHIPPO-API-VERSION": { "type": "string", "description": "Optional string used to pick a non-default API version to use. See our API version guide." } }, "required": [ "PCID" ] } ``` *** ## shippo\_management\_list\_customs\_items List all customs items **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `page` | integer | No | — | The page number you want to select | | `results` | integer | No | — | The number of results to return per page (max 100) | | `SHIPPO-API-VERSION` | string | No | — | Optional string used to pick a non-default API version to use. See our \ guide. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "The page number you want to select" }, "results": { "type": "integer", "description": "The number of results to return per page (max 100)" }, "SHIPPO-API-VERSION": { "type": "string", "description": "Optional string used to pick a non-default API version to use. See our API version guide." } }, "required": [ "PCID" ] } ``` *** ## shippo\_management\_list\_service\_groups List all service groups **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `SHIPPO-API-VERSION` | string | No | — | Optional string used to pick a non-default API version to use. See our \ guide. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "SHIPPO-API-VERSION": { "type": "string", "description": "Optional string used to pick a non-default API version to use. See our API version guide." } }, "required": [ "PCID" ] } ``` *** ## shippo\_management\_list\_shippo\_accounts List all Shippo Accounts **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `page` | integer | No | — | The page number you want to select | | `results` | integer | No | — | The number of results to return per page (max 100) | | `SHIPPO-API-VERSION` | string | No | — | Optional string used to pick a non-default API version to use. See our \ guide. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "page": { "type": "integer", "description": "The page number you want to select" }, "results": { "type": "integer", "description": "The number of results to return per page (max 100)" }, "SHIPPO-API-VERSION": { "type": "string", "description": "Optional string used to pick a non-default API version to use. See our API version guide." } }, "required": [ "PCID" ] } ``` *** ## shippo\_management\_list\_user\_parcel\_templates List all user parcel templates **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `SHIPPO-API-VERSION` | string | No | — | Optional string used to pick a non-default API version to use. See our \ guide. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "SHIPPO-API-VERSION": { "type": "string", "description": "Optional string used to pick a non-default API version to use. See our API version guide." } }, "required": [ "PCID" ] } ``` *** ## shippo\_management\_list\_webhooks List all webhooks ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## shippo\_management\_register\_carrier\_account Add a Shippo carrier account **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `SHIPPO-API-VERSION` | string | No | — | Optional string used to pick a non-default API version to use. See our \ guide. | | `body` | object | Yes | — | The body of the request. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "SHIPPO-API-VERSION": { "type": "string", "description": "Optional string used to pick a non-default API version to use. See our API version guide." }, "body": { "description": "The body of the request." } }, "required": [ "PCID", "body" ] } ``` *** ## shippo\_management\_update\_carrier\_account Update a carrier account **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `CarrierAccountId` | string | Yes | — | Object ID of the carrier account | | `SHIPPO-API-VERSION` | string | No | — | Optional string used to pick a non-default API version to use. See our \ guide. | | `account_id` | string | Yes | — | Unique identifier of the account. Please check the \ page for the `account_id` per carrier.\
To protect account information, this field will be masked in any API response. | | `active` | boolean | No | — | Determines 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. | | `carrier` | string | Yes | — | Carrier token, see \Carriers\\
Please check the \ page for all supported carriers. | | `parameters` | object | No | — | The parameters value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "CarrierAccountId": { "type": "string", "description": "Object ID of the carrier account" }, "SHIPPO-API-VERSION": { "type": "string", "description": "Optional string used to pick a non-default API version to use. See our API version guide." }, "account_id": { "type": "string", "description": "Unique identifier of the account. Please check the carrier accounts tutorial page for the `account_id` per carrier.
To protect account information, this field will be masked in any API response." }, "active": { "type": "boolean", "description": "Determines 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." }, "carrier": { "type": "string", "description": "Carrier token, see Carriers
Please check the carrier accounts tutorial page for all supported carriers." }, "parameters": { "description": "The parameters value" } }, "required": [ "PCID", "CarrierAccountId", "account_id", "carrier" ] } ``` *** ## shippo\_management\_update\_service\_group Update an existing service group **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `SHIPPO-API-VERSION` | string | No | — | Optional string used to pick a non-default API version to use. See our \ guide. | | `description` | string | Yes | — | Description for the service group | | `flat_rate` | string | No | — | 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_currency` | string | No | — | required unless type is `FREE_SHIPPING`. (ISO 4217 currency) | | `free_shipping_threshold_currency` | string | No | — | optional unless type is `FREE_SHIPPING`. (ISO 4217 currency) | | `free_shipping_threshold_min` | string | No | — | 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` | | `is_active` | boolean | Yes | — | True if the service group is enabled, false otherwise. | | `name` | string | Yes | — | Name for the service group that will be shown to customers in the response | | `object_id` | string | Yes | — | The unique identifier of the given Service Group object. | | `rate_adjustment` | integer | No | — | 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. Negative integers are also accepted and will discount the rate price by the defined percentage amount. | | `service_levels` | object\[] | Yes | — | Service Levels | | `type` | string | Yes | — | 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.\
`FLAT_RATE` - Returns a shipping option with the specified flat rate amount.\
`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` | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "SHIPPO-API-VERSION": { "type": "string", "description": "Optional string used to pick a non-default API version to use. See our API version guide." }, "description": { "type": "string", "description": "Description for the service group" }, "flat_rate": { "type": "string", "description": "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_currency": { "type": "string", "description": "required unless type is `FREE_SHIPPING`. (ISO 4217 currency)" }, "free_shipping_threshold_currency": { "type": "string", "description": "optional unless type is `FREE_SHIPPING`. (ISO 4217 currency)" }, "free_shipping_threshold_min": { "type": "string", "description": "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`" }, "is_active": { "type": "boolean", "description": "True if the service group is enabled, false otherwise." }, "name": { "type": "string", "description": "Name for the service group that will be shown to customers in the response" }, "object_id": { "type": "string", "description": "The unique identifier of the given Service Group object." }, "rate_adjustment": { "type": "integer", "description": "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. Negative integers are also accepted and will discount the rate price by the defined percentage amount." }, "service_levels": { "type": "array", "items": { "type": "object", "properties": { "account_object_id": { "type": "string", "description": "ID of a Carrier Account object" }, "service_level_token": { "type": "string", "description": "Service level token, e.g. `usps_priority` or `fedex_ground`.
See Service Levels." } } }, "description": "Service Levels" }, "type": { "type": "string", "description": "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.
`FLAT_RATE` - Returns a shipping option with the specified flat rate amount.
`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`", "enum": [ "LIVE_RATE", "FLAT_RATE", "FREE_SHIPPING" ] } }, "required": [ "PCID", "description", "is_active", "name", "object_id", "service_levels", "type" ] } ``` *** ## shippo\_management\_update\_shippo\_account Update a Shippo Account **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `ShippoAccountId` | string | Yes | — | Object ID of the ShippoAccount | | `SHIPPO-API-VERSION` | string | No | — | Optional string used to pick a non-default API version to use. See our \ guide. | | `company_name` | string | Yes | — | Company Name | | `email` | string | Yes | — | The email value | | `first_name` | string | Yes | — | First Name | | `last_name` | string | Yes | — | Last Name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ShippoAccountId": { "type": "string", "description": "Object ID of the ShippoAccount" }, "SHIPPO-API-VERSION": { "type": "string", "description": "Optional string used to pick a non-default API version to use. See our API version guide." }, "company_name": { "type": "string", "description": "Company Name" }, "email": { "type": "string", "description": "The email value" }, "first_name": { "type": "string", "description": "First Name" }, "last_name": { "type": "string", "description": "Last Name" } }, "required": [ "PCID", "ShippoAccountId", "company_name", "email", "first_name", "last_name" ] } ``` *** ## shippo\_management\_update\_user\_parcel\_template Update an existing user parcel template **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `UserParcelTemplateObjectId` | string | Yes | — | Object ID of the user parcel template | | `SHIPPO-API-VERSION` | string | No | — | Optional string used to pick a non-default API version to use. See our \ guide. | | `distance_unit` | string | Yes | — | The measure unit used for length, width and height. | | `height` | string | Yes | — | 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. | | `length` | string | Yes | — | 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. | | `name` | string | Yes | — | The name of the User Parcel Template | | `weight` | string | No | — | The weight of the package, in units specified by the weight\_unit attribute. | | `weight_unit` | string | No | — | The unit used for weight. | | `width` | string | Yes | — | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "UserParcelTemplateObjectId": { "type": "string", "description": "Object ID of the user parcel template" }, "SHIPPO-API-VERSION": { "type": "string", "description": "Optional string used to pick a non-default API version to use. See our API version guide." }, "distance_unit": { "type": "string", "description": "The measure unit used for length, width and height.", "enum": [ "cm", "in", "ft", "m", "mm", "yd" ] }, "height": { "type": "string", "description": "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." }, "length": { "type": "string", "description": "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." }, "name": { "type": "string", "description": "The name of the User Parcel Template" }, "weight": { "type": "string", "description": "The weight of the package, in units specified by the weight_unit attribute." }, "weight_unit": { "type": "string", "description": "The unit used for weight.", "enum": [ "g", "kg", "lb", "oz" ] }, "width": { "type": "string", "description": "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." } }, "required": [ "PCID", "UserParcelTemplateObjectId", "distance_unit", "height", "length", "name", "width" ] } ``` *** ## shippo\_management\_update\_webhook Update an existing webhook **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------- | -------- | ------- | -------------------------------------------------------- | | `webhookId` | string | Yes | — | Object ID of the webhook to retrieve | | `active` | boolean | No | — | Determines whether the webhook is active or not. | | `event` | string | Yes | — | Type of event that triggered the webhook. | | `is_test` | boolean | No | — | Determines whether the webhook is a test webhook or not. | | `url` | string | Yes | — | URL webhook events are sent to. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "webhookId": { "type": "string", "description": "Object ID of the webhook to retrieve" }, "active": { "type": "boolean", "description": "Determines whether the webhook is active or not." }, "event": { "type": "string", "description": "Type of event that triggered the webhook.", "enum": [ "transaction_created", "transaction_updated", "track_updated", "batch_created", "batch_purchased", "all" ] }, "is_test": { "type": "boolean", "description": "Determines whether the webhook is a test webhook or not." }, "url": { "type": "string", "description": "URL webhook events are sent to." } }, "required": [ "PCID", "webhookId", "event", "url" ] } ```