---
title: "Create shipping method"
method: POST
path: "/api/v1/shippingMethods"
tags: ["Shipping Methods"]
---

# Create shipping method

`POST /api/v1/shippingMethods`

Creates new shipping method.

## Request body

- object
  - `isActive` boolean — Indicates if the shipping method is active.
  - `name` string — The name of the shipping method.
  - `project` object, nullable — Nullable 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.
  - `printers` object — Details about the printers used for shipping labels and documents
    - `label` object — Reference to another resource
      - `id` string, required — Resource identifier.
    - `document` object — Reference to another resource
      - `id` string, required — Resource identifier.
  - `parcel` object
    - `defaultDimensions` object
      - `length` object
        - `value` number
        - `unit` 'cm'
      - `width` object
        - `value` number
        - `unit` 'cm'
      - `height` object
        - `value` number
        - `unit` 'cm'
    - `minimumWeight` object — The minimum weight of the parcel. If the weight of the parcel is less than this value, this value will be submitted to the carrier.
      - `value` number
      - `unit` 'kg'
  - `sender` object
    - `name` string
    - `address` string
    - `city` string
    - `state` string
    - `zip` string
    - `country` string
    - `email` string
    - `phone` string

## Response `201`

Resource successfully created response

## Other responses

- `400` — IETF RFC 9457 Problem API compliant response
- `415` — Resource representation send in the request is not supported.
- `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)