Schema

ShippingCarrier

A carrier service available for a destination, with its computed price.

Fields

  • idstring
    Carrier service identifier to pass as carrierServiceId when creating an order.
  • namestring
    Human-readable carrier service name.
  • codestring
    Internal carrier code.
  • hasServicePointsboolean
    Whether this service delivers to service points (relay points / lockers).
  • apiProviderstring
    Backend provider handling this carrier.
  • countriesarray of string
  • enabledCountriesarray of string
    Destination countries this service is enabled for ('*' means all).
  • pricenumber (float)
    Price for the requested destination and weight, in EUR. Only services with a price greater than 0 are returned.
  • weightTierinteger, nullable
    Weight threshold (in grams) of the matched price tier.
  • priceTiersobject
    Raw price tiers for this service. For weight-based providers the keys are weight thresholds in grams; for Sendcloud-based providers the keys are country codes.
  • minWeightinteger
    Minimum supported weight in grams.
  • maxWeightinteger
    Maximum supported weight in grams.
Example
{
  "id": "lpf_standard",
  "name": "La Poste - Lettre Suivie",
  "code": "laposte",
  "hasServicePoints": false,
  "apiProvider": "laposte",
  "countries": [
    "FR",
    "BE"
  ],
  "enabledCountries": [
    "FR",
    "BE",
    "LU"
  ],
  "price": 2.3,
  "weightTier": 0,
  "priceTiers": {
    "0": 2.3,
    "250": 3
  },
  "minWeight": 0,
  "maxWeight": 3000
}