Unifaun Online Help Center

Code lists API

Code lists API is a support functionality that optimizes usage of APIConnect and simplifies customer integration. With Code lists API you can easily filter available services for a specific customer when integrating. Once called, the service returns information containing service codes, routing information, additional services and supported address parties. The service also supports filtering via Printing favorites. Code lists API makes it easy to scale and customize information about services on a per customer basis thus enhancing the overall customer experience.

Code lists API is free to use and available for our partners and customers that have APIConnect.

Endpoint

https://api.unifaun.com/rs-extapi/v1/meta/lists/partners

Authorization

Basic authentication using an API key or custom bearer token based on API key.

Query parameters

language

The language code to use for any description texts. One of: sv, en, fi, da, no

favorite

The name of a printing favorite to use. Any filters configured in the favorite will be applied to the result of this call.

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

More information

For more information and test possibilities, visit https://api.unifaun.com/rs-docs/ and navigate to /meta/lists/partners method GET.