---
title: "List all shipment templates"
method: GET
path: "/shipment_templates"
tags: ["Shipment templates"]
---

# List all shipment templates

`GET /shipment_templates`

Returns a list of shipment templates.

## Query parameters

- `id` integer
- `sender_country` string
- `receiver_country` string
- `per_page` integer
- `page` integer

## Response `200`

Successful.

- ShipmentTemplate[]
  - `id` integer — ID of the shipment template. Used when referencing a specific template in other requests.
  - `name` string — Given name of the template.
  - `default` boolean — Whether or not the template is the default to be used when no other is selected.
  - `product_code` string — Code for the product that is booked when using the template.
  - `own_agreement` boolean — Whether or not the shipments are booked with the template is using own agreement or Shipmondo agreement.
  - `customer_number` string — The customer number that is attached to the template.
  - `service_codes` string — Comma-separated string of service codes referring to which services that is booked when using the template.
  - `sender` object
    - `country_code` string — Country code of the sender country.
  - `receiver` object
    - `country_code` string — Country code for the receiver country.
  - `parcels` ParcelAdvanced[]
    - `quantity` integer — Number of parcels of this kind. Maximum quantity depends on the product.
    - `weight` integer, required — Weight in grams per colli.
    - `length` integer — Length in cm
    - `width` integer — Width in cm
    - `height` integer — Height in cm
    - `volume` number — Volume in cubic metres
    - `running_metre` number — Running metre in metre
    - `description` string — Describes the contents of the parcel.
    - `packaging` string — Package type for the parcel. Must be a valid package type for the customer.
    - `stackable` boolean — Whether the parcel can be stacked.
    - `dangerous_goods` DangerousGood[]
      - `class` string — ADR class of the dangerous goods.
      - `un_number` string — UN number of the dangerous goods.
      - `net_weight` integer — Net weight in grams of the dangerous goods. Use either this or net_weight_kg.
      - `net_weight_kg` number — Net weight in kilograms of the dangerous goods. Use either this or net_weight.
      - `gross_weight` integer — Gross weight in grams of the dangerous goods. Use either this or gross_weight_kg.
      - `gross_weight_kg` number — gross weight in kilograms of the dangerous goods. Maximum 3 decimal places. Use either this or gross_weight.
      - `quantity` integer — Number of pieces of this kind of dangerous goods.
      - `packaging` string — Packaging the dangerous goods are contained in.
      - `description` string — Description of the dangerous goods.
      - `tunnel_restriction_code` string — Tunnel restriction code that applies to the dangerous goods.
      - `packing_group` string — Packing group that applies to the dangerous goods.
      - `environmentally_hazardous` boolean — Whether or not the dangerous goods are hazardous to the environment.
    - `declared_value` DeclaredValue, nullable — Value of the goods in the parcel. Used in terms of insurance for certain carriers.
      - `amount` number — Valued amount.
      - `currency_code` string — Currency code for the currency of the amount.
    - `attributes` DynamicAttribute[] — Attributes for the parcel. Used for additional information.
      - `name` string, required — Name of the attribute.
      - `value` string, required — Value of the attribute.

## Other responses

- `401` — Unauthorized.
- `404` — Resource not found.

---

[API](https://skmtc.net/shipmondo/apis/shipmondo-api.md) · [All operations](https://skmtc.net/shipmondo/apis/shipmondo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shipmondo/shipmondo-api/versions/dbe9a4ea0826/schema)
