mirror of
https://github.com/LukeHagar/speakeasy-playground.git
synced 2025-12-07 20:57:47 +00:00
16 lines
26 KiB
Markdown
16 lines
26 KiB
Markdown
# ServiceGroupCreateRequest
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `description` | *str* | :heavy_check_mark: | Description for the service group | USPS shipping options |
|
|
| `name` | *str* | :heavy_check_mark: | Name for the service group that will be shown to customers in the response | USPS Shipping |
|
|
| `service_levels` | List[[components.ServiceLevel](../../models/components/servicelevel.md)] | :heavy_check_mark: | N/A | |
|
|
| `type` | [components.ServiceGroupCreateRequestType](../../models/components/servicegroupcreaterequesttype.md) | :heavy_check_mark: | The 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` | FLAT_RATE |
|
|
| `flat_rate` | *Optional[str]* | :heavy_minus_sign: | String representation of an amount to be returned as the flat rate<br/>if 1. The service group is of type `LIVE_RATE` and no matching rates<br/>were found; or 2. The service group is of type `FLAT_RATE`. Either<br/>integers or decimals are accepted. Required unless type is<br/>`FREE_SHIPPING` | 5 |
|
|
| `flat_rate_currency` | *Optional[str]* | :heavy_minus_sign: | required unless type is `FREE_SHIPPING`. (ISO 4217 currency) | USD |
|
|
| `free_shipping_threshold_currency` | *Optional[str]* | :heavy_minus_sign: | optional unless type is `FREE_SHIPPING`. (ISO 4217 currency) | USD |
|
|
| `free_shipping_threshold_min` | *Optional[str]* | :heavy_minus_sign: | 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]* | :heavy_minus_sign: | 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 | |