> ## Documentation Index
> Fetch the complete documentation index at: https://developer.jtl-software.com/llms.txt
> Use this file to discover all available pages before exploring further.

# ShippingMethod

> A shipping method with all its settings. Texts per language are under translations.



**Kind**: `object`

## Fields

**`id`**: `ID!`

The ID of the shipping method.

---

**`name`**: `String`

The name in the default language.

---

**`isActive`**: `Boolean!`

Whether the shipping method can be chosen for new orders.

---

**`origin`**: `ShippingMethodOrigin!`

Who created the shipping method.

---

**`exportMode`**: `String!`

How shipping data is handed over to the carrier. Stable key in UPPER_SNAKE. Known values: NONE, TEMPLATE, JTL_SHIPPING, SELLER_FULFILLED_PRIME, SHIPPING_PLATFORM, FFN_PRIME, SHIPPING_APP. New values can be added; a client that does not know a value ignores or tolerates it.

---

**`grossPrice`**: `Decimal!`

The shipping costs, gross.

---

**`freeShippingFromOrderValue`**: `Decimal`

From this order value on, shipping is free. Absent when there is no such limit.

---

**`additionalWeight`**: `Decimal!`

The weight of the packaging that is added to the weight of the goods.

---

**`netPurchasePrice`**: `Decimal!`

What the shipping costs the merchant, net.

---

**`taxClassId`**: `ID`

The tax class of the shipping costs. Empty when the tax rate is determined from the order.

---

**`taxRateDetermination`**: `String!`

How the tax rate of the shipping costs is determined. Stable key in UPPER_SNAKE. Known values: TAX_CLASS, HIGHEST_GROSS_POSITION, HIGHEST_VAT_POSITION. New values can be added; a client that does not know a value ignores or tolerates it.

---

**`priority`**: `Int!`

The priority of the shipping method, from -5 to 5.

---

**`weighingRequirement`**: `String`

Whether and how packages have to be weighed. Stable key in UPPER_SNAKE. Known values: NONE, WITH_PRESET, WITHOUT_PRESET, WITH_SCALE, EVEN_DISTRIBUTION. New values can be added; a client that does not know a value ignores or tolerates it.

---

**`trackingIdEntry`**: `String`

How the tracking ID is entered. Stable key in UPPER_SNAKE. Known values: NONE, MANUAL, VIA_SHIPPING_DATA_IMPORT. New values can be added; a client that does not know a value ignores or tolerates it.

---

**`trackingIdPattern`**: `String`

A regular expression the tracking ID has to match.

---

**`trackingIdCutFrom`**: `Int`

The tracking ID is cut from this position on. Absent, together with trackingIdCutTo, when the tracking ID is not cut.

---

**`trackingIdCutTo`**: `Int`

The tracking ID is cut up to this position. Absent, together with trackingIdCutFrom, when the tracking ID is not cut.

---

**`trackingUrlTemplate`**: `String`

The link to the tracking page.

---

**`sendShippingMail`**: `Boolean!`

Whether a shipping mail is sent to the customer.

---

**`printLabels`**: `Boolean`

Whether labels are printed on dispatch.

---

**`askLabelStartPosition`**: `Boolean`

Whether the start position on the label sheet is asked before printing.

---

**`marketplaces`**: `ShippingMethodMarketplaces!`

What marketplaces are told about the shipping method.

---

**`isAmazonPrime`**: `Boolean!`

Whether the shipping method is suitable for Amazon Prime. It follows from the export mode.

---

**`mainShippingMethodId`**: `ID`

For an automatically created shipping method: the own shipping method it is mapped to. Orders and packages of the automatic one are then handled as the own one.