nShift Delivery Help Center

Receivers

Add, update and delete receivers.

POST /addresses/receivers

Creates a new receiver in the address book.

Notera

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

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 /addresses/receivers POST.

GET addresses/receivers

Fetches information about receivers from the address book.

Notera

Check of Swedish zip codes is not supported.

Query parameters

page

number

Result pages containing max. 50 senders

Required

Provides a way to page through the complete result.

Starts at zero and increments upwards.

quickId

string

Receiver's quick ID

Optional

receiverId

number

Unique receiver identification

Optional

since

string

Returns receivers that have been changed since a specified date.

Optional

Valid formats: yyyyMMddHHmmss, yyyyMMddHHmm, yyyyMMdd or yyMMdd

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 /addresses/receivers GET.

PATCH/addresses/receivers/{receiverId}

Updates information on a receiver.

URI parameters

Receiver ID

string

The receiver's ID

Required

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 /addresses/receivers/{receiverId} PATCH.

PUT/addresses/receivers/{receiverId}

Updates a receiver by replacing it.

URI parameters

Receiver ID

string

The receiver's ID

Required

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 /addresses/receivers/{receiverId} PUT.

DELETE /addresses/receivers/{receiverId}

Deletes a receiver.

Notera

The receiver will be completely deleted from the system. No further operation will be possible on the receiver ID.

URI parameters

Receiver ID

string

The receiver's ID

Required

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 /addresses/receivers/{receiverId} DELETE.