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

# CreateShippingMethodCommandRequestInput

> Creates an active, own shipping method. The shipping method has no shipping data export (export mode None). Shipping methods with the Shipping app are created with their own call. errorCode is one of: SHIPPING_METHOD_TAX_CLASS_REQUIRED, SHIPPING_METHOD_TAX_CLASS_NOT_ALLOWED, SHIPPING_METHOD_TRACKING_ID_PATTERN_INVALID, SHIPPING_METHOD_NAME_ALREADY_EXISTS. - Request



**Kind**: `input`

## Fields

**`name`**: `String!` (required)

The name of the shipping method, at most 255 characters. It must be unique among all shipping methods.

---

**`grossPrice`**: `Decimal`

The shipping costs, gross. Not negative.

---

**`freeShippingFromOrderValue`**: `Decimal`

From this order value on, shipping is free. Omit the property to leave it unchanged; null removes the limit (no free shipping from an order value). Not negative; 0 is stored as no limit and read back as absent.

---

**`additionalWeight`**: `Decimal`

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

---

**`netPurchasePrice`**: `Decimal`

What the shipping costs the merchant, net. Not negative.

---

**`taxClassId`**: `ID`

The tax class of the shipping costs. Required when the tax rate determination is TaxClass and not allowed otherwise (error codes SHIPPING_METHOD_TAX_CLASS_REQUIRED, SHIPPING_METHOD_TAX_CLASS_NOT_ALLOWED).

---

**`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. It has to be a valid regular expression that works without backtracking, so without back references and look-around (error code SHIPPING_METHOD_TRACKING_ID_PATTERN_INVALID). Such an expression is matched in time proportional to the length of the tracking ID.

---

**`trackingIdCutFrom`**: `Int`

The tracking ID is cut from this position on. Omit the property to leave it unchanged; null for both positions means the tracking ID is not cut.

---

**`trackingIdCutTo`**: `Int`

The tracking ID is cut up to this position. null for both positions means the tracking ID is not cut.

---

**`trackingUrlTemplate`**: `String`

The link to the tracking page: an absolute http or https address without quotation marks, angle brackets or blanks. The placeholders #IdentCode# (tracking ID), #PLZ# (postal code), #Tag# (day), #Monat# (month) and #Jahr# (year) are replaced; their values are URL-encoded.

---

**`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. Only has an effect when labels are printed.

---

**`marketplaces`**: `ShippingMethodMarketplacesInput`

What marketplaces are told about the shipping method. The value replaces what was there as a whole.

---

**`idempotencyKey`**: `String`

Client-supplied idempotency key. When provided, a repeated request with the same key and payload replays the original result instead of re-executing the mutation.