Responses

• • 200

  Successful response

  Hide response attributes Show response attributes object

  • cacheInternalRates boolean | null Required

    Cache internal rates

    Default value is false.

  • code string Required

    Code

  • createdAt string(date-time)

    Created at

  • customCarriers string | null

    Custom carriers

    Values are all, selected, or none.

  • days integer(int32) | null

    Days

  • defaultWeight integer(int32) | null Required

    Default weight

    Default value is 0.

  • dhlExpressServiceLevels array[string] | null Required

    Dhl express service levels

    Default value is [] (empty).

  • distanceUnit string | null Required

    Distance unit

    Values are in or cm. Default value is in.

  • domesticBandType string | null Required

    Domestic band type

    Values are weight or price. Default value is price.

  • enableDiscountedDhlExpressRates boolean | null Required

    Enable discounted dhl express rates

    Default value is true.

  • enableDiscountedParcelforceRates boolean | null Required

    Enable discounted parcelforce rates

    Default value is true.

  • enableDiscountedUspsRates boolean | null Required

    Enable discounted usps rates

    Default value is true.

  • freeShippingOverride boolean | null

    Free shipping override

  • freeShippingOverrideScope string | null Required

    Free shipping override scope

    Values are value or tags. Default value is value.

  • freeShippingTags array[string] | null Required

    Free shipping tags

    Default value is [] (empty).

  • freeShippingThreshold number | null

    Free shipping threshold

  • handlingFee number | null

    Handling fee

  • id integer(int32)

    Id

  • integrationFilteringEndpoint string | null

    Integration filtering endpoint

  • label string | null

    Label

  • maxPrice integer(int32) | null

    Max price

  • maxPriceUnit string | null Required

    Max price unit

    Values are fixed or percentage. Default value is fixed.

  • maximumOrderValue number | null

    Maximum order value

  • name string Required

    Name

  • parcelDepth number | null Required

    Parcel depth

    Default value is 0.

  • parcelHeight number | null Required

    Parcel height

    Default value is 0.

  • parcelWidth number | null Required

    Parcel width

    Default value is 0.

  • parcelforceServiceLevels array[string] | null Required

    Parcelforce service levels

    Default value is [] (empty).

  • price number Required

    Price

    Default value is 0.

  • priceIncrease number | null Required

    Price increase

    Default value is 0.

  • priceType string | null Required

    Price type

    Values are carrier, fixed, fixed_per_item, weight, banded, banded_price, product_type, or zones. Default value is fixed.

  • provider string | null

    Provider

  • providerCode string | null

    Provider code

  • providerId string | null

    A system or internal ID of the provider.

  • pushFallbackRate string | null Required

    When / if to include the fallback rate within the list of alternative shipments.

    Values are always, noRates, or never. Default value is never.

  • ratePreference string | null Required

    Rate preference

    Values are cheapest, best_value, or fastest. Default value is cheapest.

  • restOfWorldBandType string | null Required

    Rest of world band type

    Values are weight or price. Default value is price.

  • serviceFilteringEndpoint string | null

    Service filtering endpoint

  • serviceLevel string | null

    Service level

  • serviceLevelTerms string | null

    Service level terms

  • serviceLevelToken string | null

    Service level token

  • signatureRequired boolean | null

    Signature required

  • source string Required

    Source

    Default value is Jetti.

  • status string | null Required

    Status

    Values are active or archived. Default value is active.

  • updatedAt string(date-time)

    Updated at

  • useFallbackRate string | null Required

    Use fallback rate

    Values are always or never. Default value is always.

  • useIntegrationFilteringEndpoint boolean | null

    Use integration filtering endpoint

  • useServiceFilteringEndpoint boolean | null

    For advanced adjustment and filtering of rates, use the Service Levels API Pipeline to automatically handle the service levels generated through this shipping rate. For example, use a serverless function to automatically remove or refine return service levels based on your own advaned business logic.

  • uspsServiceLevels array[string] | null Required

    Usps service levels

    Default value is [] (empty).

  • weightMultiplication string | null Required

    Weight multiplication

    Values are per_shipment or per_item. Default value is per_item.