Senders

Attributes

Name Type Required Description
id string generated Unique reference
name string required Name of sender profile
company_name string optional Company name of sender
first_name string required First name of sender
last_name string required Last name of sender
street string required Street name of sender
house_number string required House number of sender
house_number_extension string optional House number extension of sender
zipcode string required Zipcode of sender
city string required City of sender
state string optional State of sender
country string required Country of sender (needs to be ISO 3166 2-char code)
email string required E-mail address  of sender
phone string required Phone number  of recipient

Get all senders

GEThttps://dashboard.pakketpartner.nl/api/v1/senders
response

HTTP/1.1 200 OK
{
    "count": 2,
    "data": [
        {
            "id": "s_peSAdCNLSknf3x4hImjA",
            "name": "Standaard profiel",
            "company_name": "eConcepts",
            "first_name": "Jan",
            "last_name": "Jansen",
            "street": "Kerkstraat",
            "house_number": "42",
            "house_number_extension": null,
            "zipcode": "6941AH",
            "city": "Didam",
            "state": null,
            "country": "NL",
            "email": "info@pakketpartner.nl",
            "phone": ""
        },
        {
            "id": "s_IySssysdfVJPEZoKE",
            "name": "Pakketpartner",
            "company_name": "Pakketpartner",
            "first_name": "Jan",
            "last_name": "Jansen",
            "street": "Kerkstraat",
            "house_number": "42",
            "house_number_extension": null,
            "zipcode": "6941AH",
            "city": "Didam",
            "state": null,
            "country": "NL",
            "email": "info@pakketpartner.nl",
            "phone": "0123456789"
        }
    ]
}

Get single sender

GEThttps://dashboard.pakketpartner.nl/api/v1/senders/{sender_id}
response

HTTP/1.1 200 OK
{
    "data": {
        "id": "s_IyoMNyGGVJPEZoKE",
        "name": "Pakketpartner",
        "company_name": "Pakketpartner",
        "first_name": "Jan",
        "last_name": "Jansen",
        "street": "Kerkstraat",
        "house_number": "42",
        "house_number_extension": null,
        "zipcode": "6941AH",
        "city": "Didam",
        "state": null,
        "country": "NL",
        "email": "info@pakketpartner.nl",
        "phone": "0123456789"
    }
}