Applications

Create a user account in nShift Delivery with corresponding agreements.

Fetch applications

GET onboarding/applications/{language}

Fetches application codes and products that are available.

Path parameters

language

string

Language code for descriptions

Valid values:

da|en|fi|no|sv

Required

Query parameters

domain

string

Domain/region code for the application

Valid values:

UNIFAUN-DK|UNIFAUN-FI|UNIFAUN-NO|UNIFAUN-SE

Required

{
  "applications": [
    {
      "code": "INT_UOPLUS_UWO_RESELLER",
      "name": "nShift Delivery Plus and OrderConnect",
      "description": "Highlight the carriers the customer intends to use. The customer can, when confirming your order, complete with carrier customer number.\n\nnShift Delivery Plus in combination with OrderConnect to control the order information to nShift Delivery.",
      "extraDescription": "",
      "invoiceInfo": null,
      "mainProducts": [
      {
        "code": "UWO-10",
        "description": "OrderConnect for nShift Delivery, 2500 SEK",
        "description2": null,
        "partners": []
      },
      {
        "code": "UWO-20",
        "description": "User agreeement for OrderConnect - 2000 SEK/year",
        "description2": null,
        "partners": []
      }
      ],
      "selectableProducts": [
      {
        "code": "UF-BAS-22",
        "description": "nShift Delivery Standard",
        "description2": null,
        "partners": [
        {
          "code": "PNL",
          "name": "Bring Parcels AB",
          "fields": [
          {
            "code": "CUSTNO"
          }
          ]
        },
        {
          "code": "PNLNO",
          "name": "Bring Parcels Norge (international)",
          "fields": [
          {
            "code": "CUSTNO"
          }
          ]
        },
    }
  ]

For description of properties, please refer to the Property reference guide.

For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /onboarding/applications/{language} GET.

Create a user account

POST /applications/{applicationCode}

Creates an nShift Delivery user account with agreements based on selected products.

Note

The system will return user ID and an API key that can be used for posting order data.

A customer account must be unique. If customer data matches an already existing account, an error will be returned.

In addition to supplying application code and selected products, customer data, such as company name, VAT number, delivery, postal and invoice addresses as well as contact information, must also be provided.

URI parameters

applicationCode

string

The application code selected by the customer.

Required

{
  "language": "sv",
  "kLevel": "2500",
   "company": {
     "name": "nShift Gbg",
     "orgNo": "5565463717",
     "vatNo": "SE5565463717",
     "deliveryAddress": {
       "address1": "Skeppsbron 5-6",
       "zipcode": "41121",
       "city": "GÖTEBORG",
       "country": "SE"
     },
    "postalAddress": {
      "address1": "Skeppsbron 5-6",
      "zipcode": "41121",
      "city": "GÖTEBORG",
      "country": "SE"
     },
    "invoiceAddress": {
      "address1": "Skeppsbron 5-6",
      "zipcode": "41121",
      "city": "GÖTEBORG",
      "country": "SE"
    },
    "invoiceEmail": "email@email.com",
    "contact1": {
      "name": "Contact1",
      "phone": "1234567",
      "sms": "1234567",
      "email": "contact1@email.com"
    }
  },
  "products": [{
    "code": "UF-BAS-22"
  }],
  "partners": [{
    "code": "SBTL",
    "customerNumber": "123456"
  }]
}

For description of properties, please refer to the Property reference guide.

For schema and testing, please refer to https://api.unifaun.com/rs-docs/ and navigate to /onboarding/applications/{applicationCode} POST.

In this section:

Applications

Fetch applications

Path parameters

Query parameters

Create a user account

Note

URI parameters

Search results