---
title: "CreatePostalService"
method: POST
path: "/api/PostalServices/CreatePostalService"
tags: ["PostalServices"]
---

# CreatePostalService

`POST /api/PostalServices/CreatePostalService`

Adds a new postal service to the database
<b>Permissions Required: </b> GlobalPermissions.ShippingService.PostalServicesNode
<b>Rate limit: </b><span style="background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;"><b>150</b></span> / minute

## Request body

- PostalServicesCreatePostalServiceRequest
  - `PostalServiceDetails` PostalServiceWithChannelAndShippingLinks — Class which exposes only those elements required by linnworks.net front end
    - `id` string, uuid — Postal service ID
    - `hasMappedShippingService` boolean — If there is channel linking with shipping service
    - `Channels` Channel[] — Channel information
      - `pkPostalServiceId` string, uuid — Postal service ID
      - `PostalServiceName` string — Postal service name
      - `Source` string — ChannelName/Source (e.g. EBAY)
      - `SubSource` string — Subsource name (e.g. EBAY1)
    - `ShippingServices` ShippingService[] — Shipping service information
      - `pkPostalServiceId` string, uuid — Postal service ID
      - `PostalServiceName` string — Postal service name
      - `vendor` string — Courier name (e.g. Royal Mail)
      - `accountid` string — Shipping account ID
      - `vendorFriendlyName` string — Courier Friendly Name (e.g. FedEx (US) for ShipEngine)
    - `PostalServiceName` string
    - `PostalServiceTag` string
    - `ServiceCountry` string
    - `PostalServiceCode` string
    - `Vendor` string
    - `PrintModule` string
    - `PrintModuleTitle` string
    - `pkPostalServiceId` string, uuid — Postal service ID
    - `TrackingNumberRequired` boolean — If tracking number required for this service
    - `WeightRequired` boolean — If weight required for this service
    - `IgnorePackagingGroup` boolean — If packaging group can be ignored
    - `fkShippingAPIConfigId` integer
    - `IntegratedServiceId` string, uuid

## Response `200`

OK

- PostalService
  - `PostalServiceName` string
  - `PostalServiceTag` string
  - `ServiceCountry` string
  - `PostalServiceCode` string
  - `Vendor` string
  - `PrintModule` string
  - `PrintModuleTitle` string
  - `pkPostalServiceId` string, uuid — Postal service ID
  - `TrackingNumberRequired` boolean — If tracking number required for this service
  - `WeightRequired` boolean — If weight required for this service
  - `IgnorePackagingGroup` boolean — If packaging group can be ignored
  - `fkShippingAPIConfigId` integer
  - `IntegratedServiceId` string, uuid

---

[API](https://skmtc.net/linnworks/apis/authenticate-api.md) · [All operations](https://skmtc.net/linnworks/apis/authenticate-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/linnworks/authenticate-api/revisions/0123569a22fb/schema)
