Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

PostalServices /CreatePostalService

Allows 150 calls per minute

Response: PostalService



Adds a new postal service to the database

Parameters

NameTypeDescription
PostalServiceDetailsPostalService_WithChannelAndShippingLinksInformation about postal service

Permissions

GlobalPermissions.ShippingService.PostalServicesNode

Example Request

The following request format is required for this method.

Endpoint URL

POST https://eu-ext.linnworks.net/api/PostalServices/CreatePostalService

Headers

Connection: keep-alive
Accept: application/json
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

Request Body

This is an example of the request structure. Results will vary depending on your data.

PostalServiceDetails={
  "id": "9ffb1f5d-8a6e-4864-a5c1-c1cb603fd531",
  "hasMappedShippingService": true,
  "Channels": [
    {
      "pkPostalServiceId": "965cf2c2-80d6-480b-839b-40dc41188b1d",
      "PostalServiceName": "sample string 2",
      "Source": "sample string 3",
      "SubSource": "sample string 4"
    }
  ],
  "ShippingServices": [
    {
      "pkPostalServiceId": "3eeb27b3-97af-4e2e-9a52-e6e9e09b1244",
      "PostalServiceName": "sample string 2",
      "vendor": "sample string 3",
      "accountid": "sample string 4",
      "vendorFriendlyName": "sample string 5"
    }
  ],
  "PostalServiceName": "sample string 2",
  "PostalServiceTag": "sample string 3",
  "ServiceCountry": "sample string 4",
  "PostalServiceCode": "sample string 5",
  "Vendor": "sample string 6",
  "PrintModule": "sample string 7",
  "PrintModuleTitle": "sample string 8",
  "pkPostalServiceId": "9ffb1f5d-8a6e-4864-a5c1-c1cb603fd531",
  "TrackingNumberRequired": true,
  "WeightRequired": true,
  "IgnorePackagingGroup": true,
  "fkShippingAPIConfigId": 13,
  "IntegratedServiceId": "8741b948-9c40-4a5f-b892-6ed68dd4c8a4"
}

Response

This is an example of the response JSON. Results will vary depending on your data.

{
  "PostalServiceName": "sample string 1",
  "PostalServiceTag": "sample string 2",
  "ServiceCountry": "sample string 3",
  "PostalServiceCode": "sample string 4",
  "Vendor": "sample string 5",
  "PrintModule": "sample string 6",
  "PrintModuleTitle": "sample string 7",
  "pkPostalServiceId": "14360e9d-7850-4a0a-8c60-a60d0252679a",
  "TrackingNumberRequired": true,
  "WeightRequired": true,
  "IgnorePackagingGroup": true,
  "fkShippingAPIConfigId": 12,
  "IntegratedServiceId": "7110a14d-ae13-46dd-8e1f-a12431ab1878"
}