---
title: "View shipping method"
method: GET
path: "/api/v1/shippingMethods/{id}"
tags: ["Shipping Methods"]
---

# View shipping method

`GET /api/v1/shippingMethods/{id}`

Shows the details of a Shipping Method

## Path parameters

- `id` string, required — Resource identifier.

## Response `200`

Operation completed successfully.

- object
  - `type` 'genericCarrier' — The type of the carrier
  - `isActive` boolean — Determines whether the shipping Method is currently active.
  - `name` string — The human readable name you would like to give to this carrier
  - `project` object — Reference to another resource
    - `id` string, required — Resource identifier.
  - `carrier` object — Details of the carrier providing the shipping service.
    - `credentials` union
      - object — Credentials can be either basic, bearer or OAuth Client Credentials authentication.
        - `basic` object, required
          - `username` string, required — Username used to authenticate at carrier's.
          - `password` string, required — Password used to authenticate at carrier's.
      - object — Credentials can be either basic, bearer or OAuth Client Credentials authentication.
        - `bearer` object, required
          - `token` string, required — API token used to authenticate at carrier's.
      - object — Credentials can be either basic, bearer or OAuth Client Credentials authentication.
        - `oauthClientCredentials` object, required
          - `tokenUrl` string, required — URL used to exchange authorization codes or credentials for an access token at carrier's.
          - `username` string, required — Username used to authenticate at carrier's.
          - `password` string, required — Password used to authenticate at carrier's.
          - `audience` string — Application or service that requests access to protected resources on behalf of itself.
    - `serviceUrl` string — The base URL at which the Carrier Service that you want to connect to can be reached.
    - `extra` object — Additional fields for the carrier or service.
      - `field1` string — An extra field for custom data.
      - `field2` string — Another extra field for custom data.
    - `id` string — The unique identifier of the carrier.
    - `product` object — A shipping product is a specific service offered by a carrier.
      - `id` string — The shipping product ID.
    - `shipmentType` 'outbound' | 'return' — A type of shipment: outbound or return.
  - `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

## Other responses

- `400` — IETF RFC 9457 Problem API compliant response
- `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)