---
title: "List shipping methods"
method: GET
path: "/api/v1/shippingMethods"
tags: ["Shipping Methods"]
---

# List shipping methods

`GET /api/v1/shippingMethods`

Lists existing shipping methods

## Query parameters

- `page` object
  - `number` string, required — Page number should be an integer greater than or equal to 1
  - `size` string, required — Page size should usually be an integer between 10 and 50.

## Response `200`

Shipping method list

- object
  - `data` object[], required — Response data containing list of Shipping Methods
    - `id` string, required — Resource identifier.
    - `module` string, required — Module used by the given Shipping Method
    - `type` string, required — Type of the given Shipping Method
    - `designation` string, required — Description given to a particular Shipping Method
    - `project` object, nullable, required — Nullable reference to another resource
      - `id` string, required — Resource identifier.
    - `shippingLabelPrinter` object — Reference to another resource
      - `id` string, required — Resource identifier.
    - `exportDocumentPrinter` object — Reference to another resource
      - `id` string, required — Resource identifier.
    - `shippingEmailBehaviour` 'default behaviour' | 'no dispatch email' | 'custom text template' — Email behavior for shipping notifications
    - `textTemplate` object, nullable — The text template used for shipping notifications
      - `id` string — ID of the text template used for custom emails
      - `type` string — Type of the text template
    - `supportDeliveries` boolean — Whether this shipping method supports deliveries
    - `supportReturns` boolean — Whether this shipping method supports returns
  - `extra` object, required
    - `totalCount` integer, required — the total count of all items
    - `page` object, required — The pagination object containing the current page number and size
      - `number` integer, required — The current page number
      - `size` integer, required — The size of the pages

## Other responses

- `401` — Unable to authenticate the client
- `403` — Unable to authorize the client
- `404` — Resource was not found or not enough access privileges
- `406` — Requested resource representation does not exist.
- `429` — Too many API calls made.

---

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