mirror of
https://github.com/LukeHagar/speakeasy-playground.git
synced 2025-12-09 20:57:44 +00:00
14 KiB
14 KiB
ServiceLevel
Contains details regarding the service level for the given rate.
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
name |
Optional[str] | ➖ | Name of the Rate's servicelevel, e.g. International Priority or Standard Post. A servicelevel commonly defines the transit time of a Shipment (e.g., Express vs. Standard), along with other properties. These names vary depending on the provider. |
Priority Mail Express |
terms |
Optional[str] | ➖ | Further clarification of the service. | |
service_level_token |
Optional[str] | ➖ | Token of the Rate's servicelevel, e.g. usps_priority or fedex_ground. See servicelevels. |
usps_priority_express |
extended_token |
Optional[str] | ➖ | Unique, extended version of the Service Level "token". Guaranteed to be unique across all Service Levels, and may help offer insight into the specific Service Level it describes. |
|
parent_servicelevel |
Optional[str] | ➖ | Used for some Service Levels to link to the more "generic" version of this Service Level - for example, if this Service Level is a variation specific to shipments to Europe("ups_saver_eu"), the "parent" is the fully generic version ("ups_saver"). Helpful when displaying Service Levels to users. Has the same structure of the servicelevel - "name", "token", "terms", and "extended_token", or it is otherwise null. |