GET /shipping-rates/{id}.json

GET /shipping-rates/{id}.json

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • allowList boolean | null Required

      This rate will be shown in the allow list or rates that can be selected by vendors in the dropship portal.

      Default value is false.

    • 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

      Provider

    • pushFallbackRate string | null Required

      Push fallback rate

      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

      Use service filtering endpoint

    • 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.

GET /shipping-rates/{id}.json
curl \
 --request GET 'http://api.example.com/v1/shipping-rates/{id}.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "allowList": false,
  "cacheInternalRates": false,
  "code": "string",
  "createdAt": "2025-05-04T09:42:00Z",
  "customCarriers": "all",
  "days": 42,
  "defaultWeight": 0,
  "dhlExpressServiceLevels": [],
  "distanceUnit": "in",
  "domesticBandType": "price",
  "enableDiscountedDhlExpressRates": true,
  "enableDiscountedParcelforceRates": true,
  "enableDiscountedUspsRates": true,
  "freeShippingOverride": true,
  "freeShippingOverrideScope": "value",
  "freeShippingTags": [],
  "freeShippingThreshold": 42.0,
  "handlingFee": 42.0,
  "id": 42,
  "integrationFilteringEndpoint": "string",
  "label": "string",
  "maxPrice": 42,
  "maxPriceUnit": "fixed",
  "maximumOrderValue": 42.0,
  "name": "string",
  "parcelDepth": 0,
  "parcelHeight": 0,
  "parcelWidth": 0,
  "parcelforceServiceLevels": [],
  "price": 0,
  "priceIncrease": 0,
  "priceType": "fixed",
  "provider": "string",
  "providerCode": "string",
  "providerId": "string",
  "pushFallbackRate": "never",
  "ratePreference": "cheapest",
  "restOfWorldBandType": "price",
  "serviceFilteringEndpoint": "string",
  "serviceLevel": "string",
  "serviceLevelTerms": "string",
  "serviceLevelToken": "string",
  "signatureRequired": true,
  "source": "Jetti",
  "status": "active",
  "updatedAt": "2025-05-04T09:42:00Z",
  "useFallbackRate": "always",
  "useIntegrationFilteringEndpoint": true,
  "useServiceFilteringEndpoint": true,
  "uspsServiceLevels": [],
  "weightMultiplication": "per_item"
}