Skip to content

Latest commit

 

History

History
18 lines (15 loc) · 31 KB

servicegroup.md

File metadata and controls

18 lines (15 loc) · 31 KB

ServiceGroup

Fields

Field Type Required Description Example
description str ✔️ Description for the service group USPS shipping options
name str ✔️ Name for the service group that will be shown to customers in the response USPS Shipping
type components.ServiceGroupTypeEnum ✔️ 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
FLAT_RATE
object_id str ✔️ The unique identifier of the given Service Group object. 80feb1633d4a43c898f005850
service_levels List[components.ServiceGroupAccountAndServiceLevel] ✔️ N/A
flat_rate Optional[str] 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
5
flat_rate_currency Optional[str] required unless type is FREE_SHIPPING. (ISO 4217 currency) USD
free_shipping_threshold_currency Optional[str] optional unless type is FREE_SHIPPING. (ISO 4217 currency) USD
free_shipping_threshold_min Optional[str] 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
5
rate_adjustment Optional[int] 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. 15
is_active Optional[bool] True if the service group is enabled, false otherwise. true