Sign in

v1

latestOpenAPI 3.0.02026-07-266521,3121.2 MB
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

post/api/PostalServices/CreatePostalService

Request body

Example request

{
  "PostalServiceDetails": {
    "id": "00000000-0000-0000-0000-000000000000",
    "Channels": [
      {
        "pkPostalServiceId": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "ShippingServices": [
      {
        "pkPostalServiceId": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "pkPostalServiceId": "00000000-0000-0000-0000-000000000000",
    "IntegratedServiceId": "00000000-0000-0000-0000-000000000000"
  }
}

Response

OK

PostalServiceNamestring
PostalServiceTagstring
ServiceCountrystring
PostalServiceCodestring
Vendorstring
PrintModulestring
PrintModuleTitlestring
pkPostalServiceIdstring uuid

Postal service ID

TrackingNumberRequiredboolean

If tracking number required for this service

WeightRequiredboolean

If weight required for this service

IgnorePackagingGroupboolean

If packaging group can be ignored

fkShippingAPIConfigIdinteger
IntegratedServiceIdstring uuid

Example response

{
  "pkPostalServiceId": "00000000-0000-0000-0000-000000000000",
  "IntegratedServiceId": "00000000-0000-0000-0000-000000000000"
}