Code lists via API is a support function that optimizes the usage of APIConnect and simplifies customer integration. It makes it easy to scale and customize information about services on a per-customer basis thus enhancing the overall customer experience.

Code lists via API use a REST API framework for communication, with JSON as the data carrier. The REST API endpoints are only accessible via HTTPS and are located at api.unifaun.com.

 

https://api.unifaun.com/rs-extapi/v1

Before getting started you need to know your developer ID and create an API key. For schema and testing, please refer to https://api.unifaun.com/rs-docs/.

How it works

With Code lists API you can easily filter available services for a specific customer. Once called, the service returns information containing service codes, package codes, routing information, additional services, and supported address parties. The service also supports filtering via Printing favorites.

Receiver carrier and service information available on a customer account. 

Fetch carrier and service information

GET /meta/lists/partners

Fetches a list of meta data about carriers and their services.

Query parameters

Response example

[{
  "id": "PLAB",
  "description": "PostNord Sverige AB",
  "services": [{
    "id": "P53",
    "subId": null,
    "description": "PostNord Pallet Special",
    "uniqueDescription": "PostNord Pallet Special",
    "addons": [{
      "id": "NDLV",
      "description": "Ny utkörning",
      "routes": null,
      "values":null
    }],
    "options": [{
      "id": "ENOT",
      "description": "Föravisering (E-post)",
      "routes": null,
      "values": null
    }, {
      "id": "LNKPRTN",
      "description": "Länk till utskrift (tur)",
      "routes": null,
      "values": null
    }],
    "packageCodes": [{
      "id": "PC",
      "description": "Paket (PC)"
    }, {
      "id": "CW",
      "description": "Bur (CW)"
    }, {
      "id": "PE",
      "description": "Pall EUR (PE)"
    }, {
      "id": "AF",
      "description": "Halvpall EUR (AF)"
    }, {
      "id": "OA",
      "description": "Kvartspall (OA)"
    }, {
      "id": "OF",
      "description": "Specialpall (OF)"
    }],
    "routes": [{
      "from": ["SE"],
      "to": ["SE"]
    }],
    "sender": {
      "valid": true,
      "description": "Avsändare"
    },
    "dispatch": {
      "valid": false,
      "description": "Upphämtningsadress"
    },
    "receiver": {
      "valid": true,
      "description": "Mottagare"
    },
    "delivery": {
      "valid": false,
      "description": "Leveransadress"
    },
    "returnPart": {
      "valid": false,
      "description": "Returadress"
    },
    "freightPayer": {
      "valid": false,
      "description": "Betalare, frakt"
    },
    "taxPayer": {
      "valid": false,
      "description": "Betalare, skatt"
    },
    "customsPayer": {
     "valid": false,
      "description": "Tullbetalare"
    }
  }]
}]

For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /meta/lists/partners GET.