Schema

ShippingRate

A carrier service available for a set of items, with its computed price.

Fields

  • idstring
    Carrier service identifier to pass as carrierServiceId when creating an order.
  • namestring
  • codestring
  • serviceCodestring, nullable
    Stable code of the service within its carrier (for example chrono_13, chrono_18). Use it to pick a service without parsing its name, which is generated from the carrier catalogue.
  • hasServicePointsboolean
  • pricenumber (float)
    Price for the computed weight and destination, in EUR.
  • weightTierinteger, nullable
    Weight threshold (in grams) of the matched price tier.
Example
{
  "id": "lpf_standard",
  "name": "La Poste - Lettre Suivie",
  "code": "laposte",
  "serviceCode": "chrono_18",
  "hasServicePoints": false,
  "price": 3,
  "weightTier": 250
}