/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.
Notera
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 |
Creates a new sender in the address book.
Notera
The system will return a unique sender ID that identifies the sender.
{
"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": "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"
}{
"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 |
Fetches information about senders from the address book.
Notera
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 |
{
"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 |
Updates information on a sender.
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"
}{
"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 |
Updates a sender by replacing it.
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"
}
]
}{
"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",
}Delete a sender
DELETE |
Deletes a sender.
Notera
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 |
Creates a new receiver in the address book.
Notera
The system will return a unique receiver ID that identifies the receiver.
{
"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"
}{
"href": "https://api.unifaun.com/ufoweb-prod-202112131037/rs-extapi/v1/addresses/receiver/1648032",
"id": 1648032,
"quickId": "TEST2",
"profileGroup": "INTRO",
"created": "2015-06-03T13:18:30.904+0000",
"changed": "2015-06-03T13:18:30.904+0000",
}Fetch receiver information
GET |
Fetches information about receivers from the address book.
Notera
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 |
{
"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"
}
]
}Update a receiver
PATCH |
Updates information on a receiver.
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"
}{
"href": "https://api.unifaun.com/ufoweb-prod-202112131037/rs-extapi/v1/addresses/receiver/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 receiver
PUT |
Updates a receiver by replacing it.
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"
}
]
}{
"href": "https://api.unifaun.com/ufoweb-prod-202112131037/rs-extapi/v1/addresses/receiver/1648032",
"id": 1648032,
"quickId": "TEST2",
"profileGroup": "INTRO",
"created": "2015-06-03T13:18:30.904+0000",
"changed": "2015-06-03T13:18:30.904+0000",
}Delete a receiver
DELETE |
Deletes a receiver.
Notera
No response body is returned when a receiver is successfully deleted.
The receiver will be completely deleted from the system. No further operation will be possible on the receiver ID.
URI parameters
Parameter | Type | Description | Category |
|---|---|---|---|
receiverId | number | Identifies the receiver | Required |
Tips
For schema and testing, please refer to https://api.unifaun.com/rs-docs/.
For description of properties, please refer to the Property reference guide.
For information about some crucial objects, please refer to REST API Objects.
I detta avsnitt: