Integration via API - /addresses – nShift

Addresses is how you synchronize your address book with your cloud-based CRM or ERP system, letting you manage and update your address book in one place.

Go to:

Create a sender
Fetch sender information
Update a sender
Replace a sender
Delete a sender
Create a receiver
Fetch receiver information
Update a receiver
Replace a receiver
Delete a receiver

/addresses

Addresses is how you synchronize your address book with your cloud-based CRM or ERP system, letting you manage and update your address book in one place.

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.

Create a sender

POST /addresses/senders

Creates a new sender in the address book.

Specifications

The system will return a unique sender ID that identifies the sender.

Body example

{
  "accounts": [
    {
      "account": "900-2031",
      "referenceType": "Test",
      "type": "BGTXT" 
    }
  ],
  "defaultCodReference": "cod ref",
  "defaultMailTemplate": "mail template",
  "defaultRcvReference": "rcv ref",
  "defaultSndReference": "snd ref",
  "deliveryAddress": {
    "addition": "addtion",
    "address1": "Address 1",
    "address2": "Address 2",
    "city": "Gothenburg",
    "contact": "Contact",
    "country": "SE",
    "doorCode": "1234",
    "email": "test@test.com",
    "fax": "04444444",
    "houseNumber": "",
    "mobile": "0777777777",
    "name": "name",
    "phone": "0311111111",
    "quickId": "1",
    "state": "",
    "zipcode": "44444"
  },
  "freeText1": "free 1",
  "freeText2": "free 2",
  "freeText3": "free 3",
  "freeText4": "free 4",
  "ibanAccount": {
    "account": "SE3550000000054910000003",
    "bic": "DABAIE2D"
  },
  "invoiceAddress": {
    "addition": "addition",
    "address1": "Address 1",
    "address2": "Address 2",
    "city": "Gothenburg",
    "contact": "Contact",
    "country": "SE",
    "doorCode": "1234",
    "email": "test@test.com",
    "fax": "04444444",
    "houseNumber": "",
    "mobile": "0777777777",
    "name": "name",
    "phone": "0311111111",
    "quickId": "1",
    "state": "",
    "zipcode": "44444"
  },
  "orgNo": "5565463717",
  "partnerData": [
    {
      "custNo": "123456",
      "id": "DHLROAD"
    },
    {
      "custNo": "1051051058",
      "id": "PLAB"
    }
  ],
  "postalAddress": {
    "addition": "addition",
    "address1": "Address 1",
    "address2": "Address 2",
    "city": "Gothenburg",
    "contact": "Contact",
    "country": "SE",
    "doorCode": "1234",
    "email": "test@test.com",
    "fax": "04444444",
    "houseNumber": "",
    "mobile": "0777777777",
    "name": "name",
    "phone": "0311111111",
    "quickId": "1",
    "state": "",
    "zipcode": "44444"
  },
  "profileGroup": "test",
  "quickId": "TEST",
  "route": "route",
  "typeCode1": "type code 1",
  "typeCode2": "type code 2",
  "typeCode3": "type code 3",
  "typeNo1": "1",
  "typeNo2": "2",
  "typeNo3": "3",
  "vatNo": "SE556546371701"
}

Response example

{
  "href": "https://api.unifaun.com/ufoweb-prod-202112131037/rs-extapi/v1/addresses/senders/1648032",
  "id": 1648032,
  "quickId": "TEST2",
  "profileGroup": "INTRO",
  "created": "2015-06-03T13:18:30.904+0000",
  "changed": "2015-06-03T13:18:30.904+0000",
}

Fetch sender information

GET addresses/senders

Fetches information about senders from the address book.

Specifications

Note: Checking of Swedish postal codes is not supported.

Query parameters

Parameter	Type	Description	Category
page	number	Result pages that provides a way to page through the complete result. Contains max. 50 senders. Starts at 0 (zero) and increments upwards.	Required
quickId	string	Sender's quick ID	Optional
senderId	number	Identifies the sender	Optional
since	string	Returns senders that have been changed since a specified date. Valid formats: yyyyMMddHHmmss, yyyyMMddHHmm, yyyyMMdd or yyMMdd	Optional

Response example

{
  "page": 0,
  "totalPages": 1,
  "senderReceiverData": [
    {
      "accounts": [],
      "defaultCodReference": "cod ref",
      "defaultMailTemplate": "mail template",
      "defaultRcvReference": "rcv ref",
      "defaultSndReference": "snd ref",
      "deliveryAddress": {
        "addition": "addition",
        "address1": "Address 1",
        "address2": "Address 2",
        "city": "GOTHENBURG",
        "contact": "Contact",
        "country": "SE",
        "doorCode": "1234",
        "email": "test@test.com",
        "fax": "04444444",
        "houseNumber": "",
        "mobile": "0777777777",
        "name": "name",
        "phone": "0311111111",
        "state": "",
        "zipcode": "44444"
      },
      "freeText1": "free 1",
      "freeText2": "free 2",
      "freeText3": "free 3",
      "freeText4": "free 4",
      "ibanAccount": null,
      "id": 893290,
      "invoiceAddress": {
        "addition": "addition",
        "address1": "Address 1",
        "address2": "Address 2",
        "city": "GOTHENBURG",
        "contact": "Contact",
        "country": "SE",
        "doorCode": "1234",
        "email": "test@test.com",
        "fax": "04444444",
        "houseNumber": "",
        "mobile": "0777777777",
        "name": "name",
        "phone": "0311111111",
        "state": "",
        "zipcode": "44444"
      },
      "orgNo": "5565463717",
      "partnerData": [
        {
          "custNo": "123456",
          "id": "DHLROAD",
          "infoCode": null
        },
        {
          "custNo": "1051051058",
          "id": "PLAB",
          "infoCode": null
        }
      ],
      "postalAddress": {
        "addition": "addition",
        "address1": "Address 1",
        "address2": "Address 2",
        "city": "GOTHENBURG",
        "contact": "Contact",
        "country": "SE",
        "doorCode": "1234",
        "email": "test@test.com",
        "fax": "04444444",
        "houseNumber": "",
        "mobile": "0777777777",
        "name": "name",
        "phone": "0311111111",
        "state": "",
        "zipcode": "44444"
      },
      "profileGroup": "Test",
      "quickId": "TEST",
      "route": "route",
      "typeCode1": "type code 1",
      "typeCode2": "type code 2",
      "typeCode3": "type code 3",
      "typeNo1": 1,
      "typeNo2": 2,
      "typeNo3": 3,
      "vatNo": "SE556546371701"
    }
  ]
}{
  "accounts": [{
    "companyName": "nShift AB",
    "userId": "xxxxxxx",
    "orgNo": "xxxxxxxxxx",
    "vatNo": "xxxxxxxxxx"
  }]
}

Update a sender

PATCH/addresses/senders/{senderId}

Updates information on a sender.

Specifications

URI parameters

Parameter	Type	Description	Category
senderId	number	Identifies the sender	Required

Body example

{
  "accounts": [
    {
      "account": "900-2031", 
      "referenceType": "Test", 
      "type": "BGTXT" (for possible types, see below)
    }
  ], 
  "defaultCodReference": "cod ref", 
  "defaultMailTemplate": "mail template", 
  "defaultRcvReference": "rcv ref", 
  "defaultSndReference": "snd ref", 
  "deliveryAddress": {
    "addition": "addtion", 
    "address1": "Address 1", 
    "address2": "Address 2", 
    "city": "Gothenburg", 
    "contact": "Contact", 
    "country": "SE", 
    "doorCode": "1234", 
    "email": "test@test.com", 
    "fax": "04444444", 
    "houseNumber": "", 
    "mobile": "0777777777", 
    "name": "name", 
    "phone": "0311111111", 
    "quickId": "1", 
    "state": "", 
    "zipcode": "44444"
  }, 
  "freeText1": "free 1", 
  "freeText2": "free 2", 
  "freeText3": "free 3", 
  "freeText4": "free 4", 
  "ibanAccount": {
    "account": "SE3550000000054910000003", 
    "bic": "DABAIE2D"
  }, 
  "invoiceAddress": {
    "addition": "addtion", 
    "address1": "Address 1", 
    "address2": "Address 2", 
    "city": "Gothenburg", 
    "contact": "Contact", 
    "country": "SE", 
    "doorCode": "1234", 
    "email": "test@test.com", 
    "fax": "04444444", 
    "houseNumber": "", 
    "mobile": "0777777777", 
    "name": "name", 
    "phone": "0311111111", 
    "quickId": "1", 
    "state": "", 
    "zipcode": "44444"
  }, 
  "orgNo": "5565463717", 
  "partnerData": [
    {
      "custNo": "123456", 
      "id": "DHLROAD"
    }, 
    {
      "custNo": "1051051058", 
      "id": "PLAB"
    }
  ], 
  "postalAddress": {
    "addition": "addtion", 
    "address1": "Address 1", 
    "address2": "Address 2", 
    "city": "Gothenburg", 
    "contact": "Contact", 
    "country": "SE", 
    "doorCode": "1234", 
    "email": "test@test.com", 
    "fax": "04444444", 
    "houseNumber": "", 
    "mobile": "0777777777", 
    "name": "name", 
    "phone": "0311111111", 
    "quickId": "1", 
    "state": "", 
    "zipcode": "44444"
  }, 
  "profileGroup": "test", 
  "quickId": "TEST", 
  "route": "route", 
  "typeCode1": "type code 1", 
  "typeCode2": "type code 2", 
  "typeCode3": "type code 3", 
  "typeNo1": "1", 
  "typeNo2": "2", 
  "typeNo3": "3", 
  "vatNo": "SE556546371701"
}

Response example

{
  "href": "https://api.unifaun.com/ufoweb-prod-202112131037/rs-extapi/v1/addresses/senders/1648032",
  "id": 1648032,
  "quickId": "TEST2",
  "profileGroup": "INTRO",
  "created": "2015-06-03T13:18:30.904+0000",
  "changed": "2015-06-03T13:18:30.904+0000",
}

Replace a sender

PUT/addresses/senders/{senderId}

Updates a sender by replacing it.

Specifications

URI parameters

Parameter	Type	Description	Category
senderId	number	Identifies the sender	Required

Body example

{
  "page": 0,
  "totalPages": 1,
  "senderReceiverData": [
    {
      "accounts": [],
      "defaultCodReference": "cod ref",
      "defaultMailTemplate": "mail template",
      "defaultRcvReference": "rcv ref",
      "defaultSndReference": "snd ref",
      "deliveryAddress": {
        "addition": "addtion",
        "address1": "Address 1",
        "address2": "Address 2",
        "city": "GOTHENBURG",
        "contact": "Contact",
        "country": "SE",
        "doorCode": "1234",
        "email": "test@test.com",
        "fax": "04444444",
        "houseNumber": "",
        "mobile": "0777777777",
        "name": "name",
        "phone": "0311111111",
        "state": "",
        "zipcode": "44444"
      },
      "freeText1": "free 1",
      "freeText2": "free 2",
      "freeText3": "free 3",
      "freeText4": "free 4",
      "ibanAccount": null,
      "id": 893290,
      "invoiceAddress": {
        "addition": "addtion",
        "address1": "Address 1",
        "address2": "Address 2",
        "city": "GOTHENBURG",
        "contact": "Contact",
        "country": "SE",
        "doorCode": "1234",
        "email": "test@test.com",
        "fax": "04444444",
        "houseNumber": "",
        "mobile": "0777777777",
        "name": "name",
        "phone": "0311111111",
        "state": "",
        "zipcode": "44444"
      },
      "orgNo": "5565463717",
      "partnerData": [
        {
          "custNo": "123456",
          "id": "DHLROAD",
          "infoCode": null
        },
        {
          "custNo": "1051051058",
          "id": "PLAB",
          "infoCode": null
        }
      ],
      "postalAddress": {
        "addition": "addtion",
        "address1": "Address 1",
        "address2": "Address 2",
        "city": "GOTHENBURG",
        "contact": "Contact",
        "country": "SE",
        "doorCode": "1234",
        "email": "test@test.com",
        "fax": "04444444",
        "houseNumber": "",
        "mobile": "0777777777",
        "name": "name",
        "phone": "0311111111",
        "state": "",
        "zipcode": "44444"
      },
      "profileGroup": "Test",
      "quickId": "TEST",
      "route": "route",
      "typeCode1": "type code 1",
      "typeCode2": "type code 2",
      "typeCode3": "type code 3",
      "typeNo1": 1,
      "typeNo2": 2,
      "typeNo3": 3,
      "vatNo": "SE556546371701"
    }
  ]
}

Delete a sender

DELETE /addresses/senders/{senderId}

Deletes a sender.

Specifications

Note: No response body is returned when a sender is successfully deleted. The sender will be completely deleted from the system. No further operation will be possible on the sender ID.

URI parameters

Parameter	Type	Description	Category
senderId	number	Identifies the sender	Required

Create a receiver

POST /addresses/receivers

Creates a new receiver in the address book.

Specifications

Note: The system will return a unique receiver ID that identifies the receiver.

Fetch receiver information

GET addresses/receivers

Fetches information about receivers from the address book.

Specifications

Checking of Swedish postal codes is not supported.

Query parameters

Parameter	Type	Description	Category
page	number	Result pages that provides a way to page through the complete result. Contains max. 50 receivers. Starts at 0 (zero) and increments upwards.	Required
quickId	string	Receiver's quick ID	Optional
receiverId	number	Identifies the receiver	Optional
since	string	Returns receivers that have been changed since a specified date. Valid formats: yyyyMMddHHmmss, yyyyMMddHHmm, yyyyMMdd or yyMMdd	Optional

Update a receiver

PATCH/addresses/receivers/{receiverId}

Updates information on a receiver.

Specifications

URI parameters

Parameter	Type	Description	Category
receiverId	number	Identifies the receiver	Required

Body example

{
  "accounts": [
    {
      "account": "900-2031", 
      "referenceType": "Test", 
      "type": "BGTXT" (for possible types, see below)
    }
  ], 
  "defaultCodReference": "cod ref", 
  "defaultMailTemplate": "mail template", 
  "defaultRcvReference": "rcv ref", 
  "defaultSndReference": "snd ref", 
  "deliveryAddress": {
    "addition": "addtion", 
    "address1": "Address 1", 
    "address2": "Address 2", 
    "city": "Gothenburg", 
    "contact": "Contact", 
    "country": "SE", 
    "doorCode": "1234", 
    "email": "test@test.com", 
    "fax": "04444444", 
    "houseNumber": "", 
    "mobile": "0777777777", 
    "name": "name", 
    "phone": "0311111111", 
    "quickId": "1", 
    "state": "", 
    "zipcode": "44444"
  }, 
  "freeText1": "free 1", 
  "freeText2": "free 2", 
  "freeText3": "free 3", 
  "freeText4": "free 4", 
  "ibanAccount": {
    "account": "SE3550000000054910000003", 
    "bic": "DABAIE2D"
  }, 
  "invoiceAddress": {
    "addition": "addtion", 
    "address1": "Address 1", 
    "address2": "Address 2", 
    "city": "Gothenburg", 
    "contact": "Contact", 
    "country": "SE", 
    "doorCode": "1234", 
    "email": "test@test.com", 
    "fax": "04444444", 
    "houseNumber": "", 
    "mobile": "0777777777", 
    "name": "name", 
    "phone": "0311111111", 
    "quickId": "1", 
    "state": "", 
    "zipcode": "44444"
  }, 
  "orgNo": "5565463717", 
  "partnerData": [
    {
      "custNo": "123456", 
      "id": "DHLROAD"
    }, 
    {
      "custNo": "1051051058", 
      "id": "PLAB"
    }
  ], 
  "postalAddress": {
    "addition": "addtion", 
    "address1": "Address 1", 
    "address2": "Address 2", 
    "city": "Gothenburg", 
    "contact": "Contact", 
    "country": "SE", 
    "doorCode": "1234", 
    "email": "test@test.com", 
    "fax": "04444444", 
    "houseNumber": "", 
    "mobile": "0777777777", 
    "name": "name", 
    "phone": "0311111111", 
    "quickId": "1", 
    "state": "", 
    "zipcode": "44444"
  }, 
  "profileGroup": "test", 
  "quickId": "TEST", 
  "route": "route", 
  "typeCode1": "type code 1", 
  "typeCode2": "type code 2", 
  "typeCode3": "type code 3", 
  "typeNo1": "1", 
  "typeNo2": "2", 
  "typeNo3": "3", 
  "vatNo": "SE556546371701"
}

Replace a receiver

PUT/addresses/receivers/{receiverId}

Updates a receiver by replacing it.

Specifications

URI parameters

Parameter	Type	Description	Category
receiverId	number	Identifies the receiver	Required

Body example

{
  "page": 0,
  "totalPages": 1,
  "senderReceiverData": [
    {
      "accounts": [],
      "defaultCodReference": "cod ref",
      "defaultMailTemplate": "mail template",
      "defaultRcvReference": "rcv ref",
      "defaultSndReference": "snd ref",
      "deliveryAddress": {
        "addition": "addtion",
        "address1": "Address 1",
        "address2": "Address 2",
        "city": "GOTHENBURG",
        "contact": "Contact",
        "country": "SE",
        "doorCode": "1234",
        "email": "test@test.com",
        "fax": "04444444",
        "houseNumber": "",
        "mobile": "0777777777",
        "name": "name",
        "phone": "0311111111",
        "state": "",
        "zipcode": "44444"
      },
      "freeText1": "free 1",
      "freeText2": "free 2",
      "freeText3": "free 3",
      "freeText4": "free 4",
      "ibanAccount": null,
      "id": 893290,
      "invoiceAddress": {
        "addition": "addtion",
        "address1": "Address 1",
        "address2": "Address 2",
        "city": "GOTHENBURG",
        "contact": "Contact",
        "country": "SE",
        "doorCode": "1234",
        "email": "test@test.com",
        "fax": "04444444",
        "houseNumber": "",
        "mobile": "0777777777",
        "name": "name",
        "phone": "0311111111",
        "state": "",
        "zipcode": "44444"
      },
      "orgNo": "5565463717",
      "partnerData": [
        {
          "custNo": "123456",
          "id": "DHLROAD",
          "infoCode": null
        },
        {
          "custNo": "1051051058",
          "id": "PLAB",
          "infoCode": null
        }
      ],
      "postalAddress": {
        "addition": "addtion",
        "address1": "Address 1",
        "address2": "Address 2",
        "city": "GOTHENBURG",
        "contact": "Contact",
        "country": "SE",
        "doorCode": "1234",
        "email": "test@test.com",
        "fax": "04444444",
        "houseNumber": "",
        "mobile": "0777777777",
        "name": "name",
        "phone": "0311111111",
        "state": "",
        "zipcode": "44444"
      },
      "profileGroup": "Test",
      "quickId": "TEST",
      "route": "route",
      "typeCode1": "type code 1",
      "typeCode2": "type code 2",
      "typeCode3": "type code 3",
      "typeNo1": 1,
      "typeNo2": 2,
      "typeNo3": 3,
      "vatNo": "SE556546371701"
    }
  ]
}

Delete a receiver

DELETE /addresses/receivers/{receiverId}

Deletes a receiver.

Specifications

URI parameters

Parameter	Type	Description	Category
receiverId	number	Identifies the receiver	Required

For schema and testing, please refer to https://api.unifaun.com/rs-docs/.

For a description of properties, please see the Property reference guide.

For information about some crucial objects, please refer to REST API Objects.

nShift Help Center

/addresses

Create a sender

Specifications

Fetch sender information

Specifications

Update a sender

Specifications

Replace a sender

Specifications

Delete a sender

Specifications

Create a receiver

Specifications

Fetch receiver information

Specifications

Update a receiver

Specifications

Replace a receiver

Specifications

Delete a receiver

Specifications

Related articles