Sign in

v1

latestOpenAPI 3.0.02026-07-266521,3121.2 MB
PostalServices

GetPostalServices

Gets a list of the users postal services and information on channels and couriers linked to each service <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

get/api/PostalServices/GetPostalServices

Response

OK

idstring uuid

Postal service ID

hasMappedShippingServiceboolean

If there is channel linking with shipping service

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

[
  {
    "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"
  }
]