Authentication

# With shell, you can just pass the correct header with each request
curl "api_endpoint_here" \
  -H "x-api-key: {API-Key}"

profairs expects for the API key to be included in all API requests to the server in a header that looks like the following:

x-api-key: {API-Key}

You must replace {API-Key} with your personal API key.

Acquisition

Get acquisition

curl --location --request GET '{baseurl}/acquisition' \
--header 'X-API-KEY: {API-Key}' \

{
    "acquisition": [
        {
            "date": "September, 09 2021 00:00:00",
            "contact_type": 2,
            "note": "",
            "contact_person": "2823",
            "id": 1,
            "interested_exhibitor_id": 5,
            "is_followup": true
        },
        {
            "date": "August, 30 2021 00:00:00",
            "contact_type": 1,
            "note": "Wir versuchen es auf jeden Fall, das Unternehmen zur Teilnahme zu bewegen.",
            "contact_person": "2823",
            "id": 2,
            "interested_exhibitor_id": 5,
            "is_followup": false
        }
    ]
}

HTTP request

GET {baseurl}/acquisition/

Query Parameters

Parameter	Type	required	Default	Description
fairid	numeric	false

Get acquisition by ID

curl --location --request GET '{baseurl}/acquisition/{acquisitionid}' \
--header 'X-API-KEY: {API-Key}' \

{
    "acquisition": [
        {
            "date": "September, 09 2021 00:00:00",
            "contact_type": 2,
            "note": "",
            "contact_person": "2823",
            "id": 1,
            "interested_exhibitor_id": 5,
            "is_followup": true
        }
    ]
}

HTTP request

GET {baseurl}/acquisition/{acquisitionid}

URL Parameters

Parameter	Type	required	Default	Description
acquisitionid	numeric	true

Set acquisition

curl --location --request POST '{baseurl}/acquisition/' \
--header 'X-API-KEY: {API-Key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "interested_exhibitor_id": 1337,
    "contact_type": 2,
    "contact_person_id": 1337,
    "date": "2022-03-21",
    "note": "Lorem Impsum",
    "is_followup": true
}'

{
    "acquisitionid": "25",
    "error": false
}

HTTP request

PUT {baseurl}/acquisition/{acquisitionid}

Parameters

Parameter	Type	required	Default
acquisitionid	numeric	true
date	date	true
contact_type	String	true
contact_person_id	numeric	true
interested_exhibitor_id	numeric	true
note	String	false
is_followup	Boolean	true	false

Update acquisition

curl --location --request PUT '{baseurl}/acquisition/{acquisitionid}' \
--header 'X-API-KEY: {API-Key}' \
--header 'Content-Type: text/json' \
--data-raw '{
    "contact_type": 3,
    "contact_person_id": 123,
    "date": "2022-03-22",
    "note": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.",
    "is_followup": false
}'

{
    "acquisitionid": "25",
    "error": false
}

HTTP request

PUT {baseurl}/acquisition/{acquisitionid}

URL Parameters

Parameter	Type	required	Default	Description
acquisitionid	numeric	true

Parameters

Parameter	Type	required	Default
date	date	false
contact_type	String	false
contact_person_id	numeric	false
interested_exhibitor_id	numeric	false
note	String	false
is_followup	Boolean	true	false

Delete acquisition

curl --location --request DELETE '{baseurl}/acquisition/{acquisitionid}' \
--header 'X-API-KEY: {API-Key}' \

{
    "acquisitionid": "25",
    "error": false
}

HTTP request

DELETE {baseurl}/acquisition/{acquisitionid}

URL Parameters

Parameter	Type	required	Default	Description
acquisitionid	numeric	true

Booths

Get booths

curl --location --request GET '{baseurl}/booths/' \
--header 'X-API-Key: {API-Key}' \

{
    "error": false,
    {
    "booths": [
        {
            "articleid": "",
            "change_user": 999,
            "create_user": 999,
            "change_date": "February, 03 2022 10:48:33",
            "boothwidth": "3.0",
            "boothnumber": "2-634",
            "boothtype": 0,
            "create_date": "February, 02 2022 10:44:02",
            "syncstatus": 0,
            "boothsize": "15.0",
            "fairid": 7,
            "boothid": 30,
            "boothdepth": "5.0"
        },
        {
            "articleid": "",
            "change_user": 999,
            "create_user": 999,
            "change_date": "February, 03 2022 10:48:33",
            "boothwidth": "4.00",
            "boothnumber": "2-614",
            "boothtype": "",
            "create_date": "February, 02 2022 10:44:02",
            "syncstatus": 0,
            "boothsize": "",
            "fairid": 7,
            "boothid": 29,
            "boothdepth": "3.00"
        }
    ]
}

HTTP request

GET {baseurl}/booths/

Query Parameters

Parameter	Type	required
fairid	numeric	false
boothid	numeric	false
exhibitorboothid	numeric	false

Set booth

curl --location --request POST '{baseurl}/booths/' \
--header 'X-API-Key: {API-Key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fairid": 7,
    "boothnumber": "A-1337",
    "boothwidth": 5,
    "boothdepth": 3,
    "boothsize": 15,
    "articleid": 1337,
    "boothtype": 1
}'

{
    "error": false,
    "boothid": "1553"
}

HTTP request

POST {baseurl}/booths/

Parameters

Parameter	Type	required
boothnumber	String	true
boothwidth	numeric	true
boothdepth	numeric	true
fairid	numeric	false
boothsize	numeric	false
articleid	numeric	false
boothtype	numeric	false

Delete booth

curl --location --request DELETE '{baseurl}/booths/{boothid}' \
--header 'X-API-Key: {API-Key}' \

{
    "error": false,
    "boothid": "1551"
}

HTTP request

DELETE {baseurl}/booths/{boothid}

URL Parameters

Parameter	Type	required	Default	Description
boothid	numeric	true

Update booth

curl --location --request PUT '{baseurl}/booths/{boothid}' \
--header 'X-API-Key: {API-Key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fairid": 7,
    "boothnumber": "A-1338",
    "boothwidth": 5,
    "boothdepth": 3,
    "boothsize": 15,
    "articleid": 1337,
    "boothtype": 1
}'

{
    "error": false,
    "boothid": 1551
}

HTTP request

PUT {baseurl}/booths/{boothid}

URL Parameters

Parameter	Type	required	Default	Description
boothid	numeric	true

Parameters

Parameter	Type	required
boothnumber	String	false
boothwidth	numeric	false
boothdepth	numeric	false
fairid	numeric	false
boothsize	numeric	false
articleid	numeric	false
boothtype	numeric	false

Get booth types

curl --location --request GET '{baseurl}/booths/types/' \
--header 'X-API-Key: {API-Key}' \

{
    "error": false,
    "type": [
        {
            "id": 1,
            "type": "Reihenstand 21"
        },
        {
            "id": 2,
            "type": "Eckstand"
        }
    ]
}

HTTP request

GET {baseurl}/booths/types/

Query Parameters

Parameter	Type	required	Default	Description
id	numeric	false
language	String	true	de_DE

Get exhibitor booth assignments

curl --location --request GET '{baseurl}/booths/exhibitor/' \
--header 'X-API-Key: {API-Key}' \

{
    "error": false,
    "assingments": [
        {
            "boothassignment": "",
            "create_date": "April, 05 2019 15:05:04",
            "change_user": 999,
            "exhibitorboothid": 1108,
            "syncstatus": 0,
            "create_user": 999,
            "note": "",
            "mainexhibitorid": 2279,
            "boothid": 26,
            "change_date": "April, 05 2019 15:05:04",
            "exhibitorfairid": 2280
        },
        {
            "boothassignment": "",
            "create_date": "June, 25 2019 17:03:19",
            "change_user": 667,
            "exhibitorboothid": 1121,
            "syncstatus": 0,
            "create_user": 667,
            "note": "",
            "mainexhibitorid": 0,
            "boothid": 562,
            "change_date": "June, 25 2019 17:03:19",
            "exhibitorfairid": 2305
        }
    ]
}

HTTP request

GET {baseurl}/booths/exhibitor/

Query Parameters

Parameter	Type	required	Default
fairid	numeric	false
exhibitorid	numeric	false
exhibitorfairid	numeric	false
exhibitorboothid	numeric	false
mainexhibitorid	numeric	false
language	String	false	de_DE

Set exhibitor booth assignment

curl --location --request POST '{baseurl}/booths/exhibitor/{boothid}/' \
--header 'X-API-Key: {API-Key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fairid": 7,
    "exhibitorfairid": 96
}'

{
    "exhibitorboothid": "1405",
    "error": false
}

HTTP request

POST {baseurl}/booths/exhibitor/{boothid}/

URL Parameters

Parameter	Type	required	Default	Description
boothid	numeric	true

Parameters

Parameter	Type	required	Default	Description
fairid	numeric	true
exhibitorfairid	numeric	true
mainexhibitor	numeric	true	0
note	String	false
postingdate	date	false
boothassignment	String	false
variantid	numeric	false		Specified variant is ordered when creating

Delete exhibitor booth assignment

curl --location --request DELETE '{baseurl}/booths/exhibitor/{exhibitorboothid}/' \
--header 'X-API-Key: API-Key' \

{
    "exhibitorboothid": "1401",
    "error": false
}

HTTP request

DELETE {baseurl}/booths/exhibitor/{exhibitorboothid}/

URL Parameters

Parameter	Type	required	Default	Description
exhibitorboothid	numeric	true

Contacts

Get contacts

curl
  --location --request GET '{baseurl}/contacts/' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: {API-Key}'

{
    "contacts": [
      {
        "postalcode": "12345",
        "telephone": "+497082-98616282",
        "job_title": "Developer",
        "firstname": "Max",
        "street": "Musterstraße 4",
        "email": "max@mustermann.de",
        "comment": "",
        "company": "",
        "contactid": 1,
        "city": "Musterstadt",
        "country": "Deutschland",
        "salutation": "Herr",
        "lastname": "Mustermann",
        "fairtypeid": "1",
        "title": "Dr.",
        "additional_address": "Etage 1",
        "hasnewsletterapproval": false,
        "exhibitorid": 1,
        "mobile": "+49176-98616282"
      }
    ]
    "error": false
}

HTTP request

GET {baseurl}/contacts/

Query parameters

Parameter	Type	required	Default
exhibitorid	numeric	false
contactid	numeric	false
typeid	numeric	false
language	String	false	"de_DE"
receivesNewsletter	Boolean	false	false
fairtypeid	numeric	false

Retreive contact

curl --location --request GET '{baseurl}/contacts/{contactid}' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: {API-Key}'

{
    "contacts": [
        {
            "postalcode": "",
            "telephone": "",
            "job_title": "",
            "firstname": "Kevin",
            "street": "",
            "email": "kevin@webcontact.de",
            "contactid": 1,
            "comment": "",
            "company": "",
            "city": "",
            "country": "Deutschland",
            "salutation": "Herr",
            "lastname": "Thiel",
            "fairtypeid": "",
            "title": "",
            "additional_address": "",
            "hasnewsletterapproval": false,
            "exhibitorid": 1,
            "mobile": "017684407551"
        }
    ],
    "error": false
}

HTTP request

GET {baseurl}/contacts/{contactid}

URL parameters

Parameter	Type	required	Default	Description
contactid	string	true

Create contact person

HTTP request

POST {baseurl}/contacts/

curl --location --request POST '{baseurl}/contacts/' \
--header 'X-API-Key: {API-Key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "salutation" : "Herr",
    "title" : "Dr.",
    "job_title" : "Developer",
    "firstname" : "Max",
    "lastname" : "Mustermann",
    "exhibitorid" : "1337",
    "telephone" : "+49 12345 6789",
    "mobile" : "+49 1234567890",
    "email" : "max.mustermann@gmail.com",
    "newsletter" : true,
    "comment" : "Lorem Ipsum",
    "company" : "Muster GmbH",
    "street" : "Musterstraße 123",
    "additional_address" : "Lorem Ipsum",
    "postalcode" : "12345",
    "city" : "Mustercity",
    "country" : "Deutschland",
    "fairtypeid" : "1"
}'

{
    "error": false,
    "contactid": "2840"
}

Parameters

Parameter	Type	required	Default
salutation	string	true
title	string	false
job_title	string	false
firstname	string	true
lastname	string	true
exhibitorid	numeric	true
telephone	string	false
mobile	string	false
email	string	true
newsletter	boolean	true	false
comment	string	false
company	string	false
street	string	false
additional_address	string	false
postalcode	string	false
city	string	false
country	string	false
fairtypeid	numeric	false

Upload contact person image

curl --location --request POST '{baseurl}/contacts/upload/' \
--header 'X-API-Key: {API-Key}' \
--form 'file=@"{file_path}"' \
--form 'file_name="{file_name}"' \
--form 'contactid="{contactid}"' \
--form 'type="image"'

{
    "error": false,
    "contactid": "2838"
}

HTTP request

POST {baseurl}/contactpersons/upload/

Parameters

Parameter	Type	required
contactid	numeric	true
file	binary	true
file_name	string	true
type	string	true

Update contact person

curl --location --request PUT '{baseurl}/contacts/{contactid}' \
--header 'X-API-Key: {API-Key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "salutation" : "Herr",
    "title" : "Dr.",
    "job_title" : "Developer",
    "firstname" : "Max",
    "lastname" : "Mustermann",
    "exhibitorid" : "1337",
    "telephone" : "+49 12345 6789",
    "mobile" : "+49 1234567890",
    "email" : "max.mustermann@gmail.com",
    "newsletter" : true,
    "comment" : "Lorem Ipsum",
    "company" : "Muster GmbH",
    "street" : "Musterstraße 123",
    "additional_address" : "Lorem Ipsum",
    "postalcode" : "12345",
    "city" : "Mustercity",
    "country" : "Deutschland",
    "fairtypeid" : "1"
}'

{
    "error": false,
    "contactid": 2838
}

HTTP request

PUT {baseurl}/contactpersons/{contactid}/

URL Parameters

Parameter	Type	required	Default	Description
contactid	numeric	true

Parameters

Parameter	Type	required	Default
salutation	string	true
title	string	false
job_title	string	false
firstname	string	true
lastname	string	true
exhibitorid	numeric	true
telephone	string	false
mobile	string	false
email	string	true
newsletter	boolean	true	false
comment	string	false
company	string	false
street	string	false
additional_address	string	false
postalcode	string	false
city	string	false
country	string	false
fairtypeid	numeric	false

Delete contact person

curl --location --request DELETE '{baseurl}/contacts/{contactid}' \
--header 'X-API-Key: {API-Key}' \

{
    "error": false,
    "contactid": 2838
}

HTTP request

DELETE {baseurl}/contactperson/{contactid}/

URL Parameters

Parameter	Type	required	Default	Description
contactid	numeric	true

Exhibitors

Get exhibitors

curl "{baseurl}/exhibitors/" \
  -H "x-api-key: {API-Key}" \
  -X GET \

{
    "exhibitors": [
        {
            "postalcode": "L24 6SH",
            "telephone": "01708-724957",
            "customer_number": "",
            "address_verified": false,
            "lock": false,
            "remarks": "",
            "street": "4 Sherwood St",
            "email": "rebbeca_rubinstein@hotmail.com",
            "vat_identification_number": "",
            "company": "Cullen, Jack J Esq",
            "order_title": "Cullen, Jack J Esq",
            "city": "Speke-Garston Ward",
            "country": "",
            "external_id": "",
            "newsletter": false,
            "homepage": "http://www.cullenjackjesq.co.uk",
            "additional_address": "Merseyside",
            "id": 3202
        },
        {
            "postalcode": "OL15 0JP",
            "telephone": "01919-731224",
            "customer_number": "",
            "address_verified": false,
            "lock": false,
            "remarks": "",
            "street": "2 Seacombe St",
            "email": "keneth_stpierrie@hotmail.com",
            "vat_identification_number": "",
            "company": "Mueller Repro Blue Printg",
            "order_title": "Mueller Repro Blue Printg",
            "city": "Littleborough Lakeside Ward",
            "country": "",
            "external_id": "",
            "newsletter": false,
            "homepage": "http://www.muellerreproblueprintg.co.uk",
            "additional_address": "Greater Manchester",
            "id": 3216
        }
    ]
}

This endpoint retrieves all exhibitors.

HTTP Request

GET {baseurl}/exhibitors/

Query Parameters

Parameter	Type	required	Default	Description
fairid	numeric	false		If set returns exhibitors from a specific fair.
exhibitorid	numeric	false
exhibitorfairid	numeric	false
mainexhibitorid	numeric	false
industryid	numeric	false
industryids	list	false
shop_categorie	numeric	false
interestcode	String	false
locked	Boolean	true	false
external_id	String	false
exhibitortypeid	numeric	false
getBooths	Boolean	true	false	Adds booths to the exhibitors. If set to true, fairid is required.
getContacts	Boolean	true	false	Adds contacts to the exhibitors.

Create an Exhibitor

curl "{baseurl}/exhibitors/" \
  -H "x-api-key: {API-Key}" \
  -H "Content-Type: application/json" \
  -X POST \
  -d '{
    "company": "company",
    "sorttitle": "sorttitle",
    "street": "street",
    "postalcode": "postalcode",
    "city": "city",
    "country": "country",
    "additional_address": "additional_address",
    "latitude": "latitude",
    "longitude": "longitude",
    "telephone": "telephone",
    "email": "email",
    "homepage": "homepage",
    "customer_number": "customer_number",
    "vat_identification_number": "vat_identification_number",
    "remarks": "remarks",
    "username": "username",
    "password": "password",
    "address_verified": false,
    "lock": true,
    "newsletter": false,
    "external_id": "EID_123"
}'

{
    "error": false,
    "exhibitorid": 1337
}

This endpoint creates an exhibitor.

HTTP Request

POST {baseurl}/exhibitors/

Parameters

Parameter	Type	required
external_id	string	false
company	string	true
sorttitle	string	true
street	string	true
postalcode	string	true
city	string	true
additional_address	string	false
country	string	false
latitude	string	false
longitude	string	false
telephone	string	true
email	string	true
homepage	string	false
customer_number	string	false
vat_identification_number	string	false
remarks	string	false
username	string	false
password	string	false
address_verified	boolean	false
lock	boolean	false
newsletter	boolean	false
external_id	String	false

Delete an Exhibitor

curl "{baseurl}/exhibitors/{exhibitorid}" \
  -H "x-api-key: {API-Key}" \
  -X DELETE

{
    "error": false,
    "exhibitorid": 1337
}

This endpoint deletes an exhibitor.

HTTP Request

DELETE {baseurl}/exhibitors/{exhibitorid}

URL Parameters

Parameter	Type	required	Default	Description
exhibitorid	numeric	true

Query Parameters

Parameter	Type	required	Default	Description
forum_sync	boolean	true	false

Update an Exhibitor

curl "{baseurl}/exhibitors/{exhibitorid}" \
  -H "x-api-key: {API-Key}" \
  -H "Content-Type: application/json" \
  -X PUT \
  -d '{
    "company": "company123",
    "sorttitle": "sorttitle",
    "street": "street",
    "postalcode": "postalcode",
    "city": "city",
    "country": "country",
    "additional_address": "additional_address",
    "latitude": "latitude",
    "longitude": "longitude",
    "telephone": "telephone",
    "email": "email",
    "homepage": "homepage",
    "customer_number": "customer_number",
    "vat_identification_number": "vat_identification_number",
    "remarks": "remarks",
    "username": "username",
    "password": "password",
    "address_verified": false,
    "lock": true,
    "external_id": "EID_123",
    "newsletter": false
}'

{
    "error": false,
    "exhibitorid": 1337
}

This endpoint updates an exhibitor.

HTTP Request

PUT {baseurl}/exhibitors/{exhibitorid}

URL Parameters

Parameter	Type	required	Default	Description
exhibitorid	numeric	true

Parameters

Parameter	Type	required	Default
external_id	string	false
company	string	false
sorttitle	string	false
street	string	false
postalcode	string	false
city	string	false
additional_address	string		false
country	string	false
latitude	string	false
longitude	string	false
telephone	string	false
email	string	false
homepage	string	false
customer_number	string	false
vat_identification_number	string	false
remarks	string	false
username	string	false
password	string	false
address_verified	boolean	false
lock	boolean	false
newsletter	boolean	false
external_id	String	false

Generate access data

curl --location --request GET '{baseurl}/exhibitors/generate-access-data/' \
--header 'X-API-KEY: {API-Key}' \

{
    "error": false
}

This endpoint generates username and password for all exhibitors from a specific fair.

HTTP Request

GET {baseurl}/exhibitors/generate-access-data/

Query Parameters

Parameter	Type	required	Default	Description
fairid	numeric	true

Generate catchall code

curl --location --request GET '{baseurl}/exhibitors/generate-catchall-code/' \
--header 'X-API-KEY: {API-Key}' \

{
    "error": false
}

HTTP Request

GET {baseurl}/exhibitors/generate-catchall-code/

Query Parameters

Parameter	Type	required	Description
fairid	numeric	true
code	String	false
exhibitorid	String	false	required when code is set

Generate interest code

curl --location --request GET '{baseurl}/exhibitors/generate-access-data/' \
--header 'X-API-KEY: {API-Key}' \

{
    "error": false
}

HTTP Request

GET {baseurl}/exhibitors/generate-access-data/

Exhibitors fair assignment

Get exhibitor fair assignments

curl --location --request GET '{baseurl}/exhibitor-fair-assignments/' \
--header 'X-API-Key: {API-Key}' \

{
    "error": false,
    "exhibitor_fair_assignments": [
        {
            "create_date": "April, 11 2016 10:57:00",
            "terms_and_conditions_confirmed": "",
            "change_user": 999,
            "mail_order_confirmation": "",
            "create_user": 35,
            "fairid": 3,
            "exhibitorfairid": 7,
            "userid": "",
            "change_date": "February, 06 2021 19:46:47",
            "exhibitorid": 5
        },
        {
            "create_date": "June, 11 2016 13:33:57",
            "terms_and_conditions_confirmed": "",
            "change_user": 999,
            "mail_order_confirmation": "",
            "create_user": 999,
            "fairid": 3,
            "exhibitorfairid": 15,
            "userid": "",
            "change_date": "June, 11 2016 13:33:57",
            "exhibitorid": 10
        }
    ]
}

HTTP Request

GET {baseurl}/exhibitor-fair-assignments/

Query Parameters

Parameter	Type	required
fairtypeid	numeric	false
fairid	numeric	false
exhibitorid	numeric	false
exhibitorfairid	numeric	false

Create exhibitor fair assignment

curl --location --request POST '{baseurl}/exhibitor-fair-assignments/' \
--header 'X-API-Key: {API-Key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "exhibitorid": 1337,
    "fairid": 10
}'

{
    "error": false,
    "exhibitorfairid": "2610"
}

HTTP Request

POST {baseurl}/exhibitor-fair-assignments/

Parameters

Parameter	Type	required	Default	Description
exhibitorid	numeric	true
fairid	numeric	true

Delete exhibitor fair assignment

curl --location --request DELETE '{baseurl}/exhibitor-fair-assignments/{exhibitorid}/' \
--header 'X-API-Key: {API-Key}' \

{
    "error": false,
    "exhibitorid": "1337"
}

HTTP Request

DELETE {baseurl}/exhibitor-fair-assignments/{exhibitorid}/

URL Parameters

Parameter	Type	required	Default	Description
exhibitorid	numeric	true

Query Parameters

Parameter	Type	required	Default	Description
fairid	numeric	false

Exhibitors industry assignment

Get exhibitor industry assignments

curl --location --request GET '{baseurl}/exhibitor-industry/' \
--header 'X-API-Key: {API-Key}' \

{
    "exhibitor_industry_assignments": [
        {
            "language": "de_DE",
            "create_date": "February, 25 2022 14:58:53",
            "change_user": 667,
            "industry": "Digital",
            "create_user": 667,
            "exhibitor": "12345",
            "industryid": 73,
            "change_date": "February, 25 2022 14:58:53",
            "exhibitorid": 2299
        },
        {
            "language": "de_DE",
            "create_date": "February, 25 2022 14:58:38",
            "change_user": 667,
            "industry": "Print",
            "create_user": 667,
            "exhibitor": "12345",
            "industryid": 72,
            "change_date": "February, 25 2022 14:58:38",
            "exhibitorid": 2299
        }
    ],
    "error": false
}

HTTP Request

GET {baseurl}/exhibitor-industry/

Query Parameters

Parameter	Type	required	Default
exhibitorid	numeric	true
fairtypeid	numeric	false
industryid	numeric	false
language	String	true	"de_DE"
showLockedIndustries	Boolean	true	false

Create exhibitor industry assignment

curl --location --request POST '{baseurl}/exhibitor-industry/' \
--header 'X-API-Key: {API-Key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "exhibitorid": 1337,
    "industryid": 20
}'

{
    "error": false,
    "industryid": 20,
    "exhibitorid": 1337
}

HTTP Request

POST {baseurl}/exhibitor-industry/

Parameters

Parameter	Type	required	Default	Description
exhibitorid	numeric	true
industryid	numeric	true

Delete exhibitor industry assignment

curl --location --request DELETE '{baseurl}/exhibitor-industry/{exhibitorid}' \
--header 'X-API-Key: {API-Key}' \

{
    "error": false,
    "industryid": "20",
    "exhibitorid": "1337"
}

HTTP Request

DELETE {baseurl}/exhibitor-industry/{exhibitorid}

URL Parameters

Parameter	Type	required	Default	Description
exhibitorid	numeric	true

Query Parameters

Parameter	Type	required	Default	Description
industryid	numeric	true

Exhibitor types

Get exhibitor types

curl --location --request GET '{baseurl}/exhibitors/exhibitor-type/' \
--header 'X-API-Key: {API-Key}' \

{
    "error": false,
    "exhibitortypes": [
        {
            "fair_type_id": 2,
            "exhibitor_type_id": 1,
            "name": "Typ 1"
        },
        {
            "fair_type_id": 2,
            "exhibitor_type_id": 2,
            "name": "Typ 2"
        },
        {
            "fair_type_id": 2,
            "exhibitor_type_id": 3,
            "name": "Typ 3"
        }
    ]
}

HTTP Request

GET {baseurl}/exhibitors/exhibitor-type/

Query Parameters

Parameter	Type	required	Default	Description
fair_type_id	numeric	false		If set returns exhibitor-types from a specific fairtype.
exhibitor_type_id	numeric	false

Get exhibitor type assignments

curl --location --request GET '{baseurl}/exhibitors/exhibitor-type-assignment/' \
--header 'X-API-Key: {API-Key}' \

{
    "error": false,
    "exhibitortypes": {
        "exhibitor_fair_id": "2285",
        "exhibitor_type_ids": "1,2,3,4"
    }
}

HTTP Request

GET {baseurl}/exhibitors/exhibitor-type-assignment/

Query Parameters

Parameter	Type	required	Default	Description
exhibitor_fair_id	numeric	true

Set exhibitor type assignments

curl --location --request POST '{baseurl}/exhibitors/exhibitor-type-assignment/' \
--header 'X-API-Key: {API-Key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "exhibitor_type_id": "1,2,3",
    "exhibitor_fair_id": "1234"
}'

{
    "error": false,
    "exhibitor_type_assignment": {
        "exhibitor_fair_id": "1234",
        "exhibitor_type_id": "1,2,3"
    }
}

HTTP Request

POST {baseurl}/exhibitors/exhibitor-type-assignment/

Parameters

Parameter	Type	required	Default	Description
exhibitor_fair_id	numeric	true
exhibitor_type_id	List	true

Fairs

Get fairs

curl --location --request GET '{baseurl}/fairs/' \
--header '{API-Key}' \

{
    "fairs": [
        {
            "location": "",
            "fair": "Karrieremesse 2022",
            "date_from": "2023-11-30 12:00:00",
            "fairid": 2,
            "fair_type_id": 2,
            "shop_closes": "2023-04-30 12:00:00",
            "shop_no_cancellations": "2023-04-26 12:00:00",
            "date_to": "2023-11-30 12:00:00"
        },
        {
            "location": "Mittelerde",
            "fair": "Demofair 2022",
            "date_from": "2022-11-08 12:00:00",
            "fairid": 1,
            "fair_type_id": 1,
            "shop_closes": "2022-03-31 12:00:00",
            "shop_no_cancellations": "2022-03-16 12:00:00",
            "date_to": "2022-11-10 12:00:00"
        }
    ],
    "error": false
}

HTTP request

GET {baseurl}/fairs/

Query Parameters

Parameter	Type	required	Default	Description
fairtypeid	numeric	false
showLocked	boolean	true	true

Get fair

curl --location --request GET '{baseurl}/fairs/{fairid}' \
--header 'X-API-Key: {API-Key}' \

{
    "fairs": [
        {
            "location": "",
            "fair": "Karrieremesse 2022",
            "date_from": "2023-11-30 12:00:00",
            "fairid": 2,
            "fair_type_id": 2,
            "shop_closes": "2023-04-30 12:00:00",
            "shop_no_cancellations": "2023-04-26 12:00:00",
            "date_to": "2023-11-30 12:00:00"
        }
    ],
    "error": false
}

HTTP request

GET {baseurl}/fairs/{fairid}

URL Parameters

Parameter	Type	required	Default	Description
fairid	numeric	true

Query Parameters

Parameter	Type	required	Default	Description
logo	boolean	true	false
motion	boolean	true	false

Create fair

curl --location --request POST '{baseurl}/fairs/' \
--header 'X-API-Key: {API-Key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fair": "Musterfair",
    "fairtypeid": "1",
    "location": "Pforzheim",
    "shop_no_cancellations": "2021-12-31 15:00:00",
    "shop_closes": "2022-01-31 15:00:00",
    "url_logout": "https://...",
    "css": "profairs-default",
    "price_per_voucher": "10.00",
    "date_from": "2022-02-13 00:00:00",
    "date_to": "2022-02-15 00:00:00"
}'

{
    "fairid": "27",
    "error": false
}

HTTP request

POST {baseurl}/fairs/

Parameters

Parameter	Type	required	Default
fair	string	false
fairtypeid	numeric	false
location	string	false
shop_no_cancellations	string	false
shop_closes	string	false
css	string	true	profairs-default
url_logout	string	false
price_per_voucher	string	false
date_from	string	false
date_to	string	false

Upload file

curl --location --request POST '{baseurl}/fairs/upload/' \
--header 'X-API-Key: {API-Key}' \
--form 'file=@"{img_path}"' \
--form 'fairid="26"' \
--form 'type="motion"'

{
    "fairid": "26",
    "error": false
}

HTTP request

POST {baseurl}/fairs/upload/

Parameters

Parameter	Type	required
type	string	true
file	binary	true
fairid	numeric	true

Update fair

curl --location --request PUT '{baseurl}/fairs/{fairid}' \
--header 'X-API-Key: {API-Key}' \
--header 'Content-Type: text/plain' \
--data-raw '{
    "fair": "Musterfair2",
    "fairtypeid": "1",
    "location": "Pforzheim",
    "shop_no_cancellations": "2021-12-31 15:00:00",
    "shop_closes": "2022-01-31 15:00:00",
    "url_logout": "https://...",
    "css": "profairs-default",
    "price_per_voucher": "10.00",
    "date_from": "2022-02-13 00:00:00",
    "date_to": "2022-02-15 00:00:00"
}'

{
    "fairid": "25",
    "error": false
}

HTTP request

PUT {baseurl}/fairs/{fairid}

URL Parameters

Parameter	Type	required	Default	Description
fairid	string	true

Parameters

Parameter	Type	required	Default
fair	string	false
fairtypeid	numeric	false
location	string	false
shop_no_cancellations	string	false
shop_closes	string	false
css	string	true	profairs-default
url_logout	string	false
price_per_voucher	string	false
date_from	string	false
date_to	string	false

Delete fair

curl --location --request DELETE '{baseurl}/fairs/{fairid}' \
--header 'X-API-Key: {API-Key}' \

{
    "fairid": 26,
    "error": false,
    "deleted": true
}

HTTP request

DELETE {baseurl}/fairs/{fairid}

URL Parameters

Parameter	Type	required	Default	Description
fairid	numeric	true

Fair types

Get fair types

curl --location --request GET '{baseurl}/fair_types/' \
--header 'X-API-Key: {API-Key}'

{
    "fair_types": [
       {
            "telephone": "+49 12345 6789",
            "fairtypeid": 1,
            "redirect_error": "http://",
            "contactid": "",
            "fair_type": "MyEvent",
            "redirect": "http://"
        },
        {
            "telephone": "",
            "fairtypeid": 4,
            "redirect_error": "http://",
            "contactid": "",
            "fair_type": "DemoFair",
            "redirect": "http://"
        }
    ],
    "error": false
}

HTTP request

GET {baseurl}/fair_types/

Query Parameters

Parameter	Type	required
fairid	numeric	false
fair_type_id	numeric	false
not_fair_type_id	numeric	false

Create new fair type

curl --location --request POST '{baseurl}/fair_types/' \
--header 'X-API-Key: {API-Key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fair_type": "Messetyp",
    "email": "mustermann@musterfirma.com",
    "telephone": "+49 12345 6789",
    "redirect": "https://...",
    "redirect_error": "https://error...",
    "contactid": "1"
}'

{
    "fairtypeid": 3,
    "error": false
}

HTTP request

POST {baseurl}/fair_types/

Parameters

Parameter	Type	required	Default
fair_type	string	true
email	string	true
telephone	string	true
redirect	string	true	https://
redirect_error	string	true	https://
contactid	numeric	false

Update fair type

curl --location --request PUT '{baseurl}/fair_types/{fairtypeid}' \
--header 'X-API-Key: {API-Key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fair_type": "Fairtype 123",
    "email": "mustermann@musterfirma.de",
    "telephone": "+49 12345 6789",
    "redirect": "https://...",
    "redirect_error": "https://error...",
    "contactid": "1"
}'

{
    "fairtypeid": 14,
    "error": false
}

HTTP request

PUT {baseurl}/fair_types/{fairtypeid}

URL Parameters

Parameter	Type	required	Default	Description
fairtypeid	numeric	true

Parameters

Parameter	Type	required	Default
fair_type	string	false
email	string	false
telephone	string	false
redirect	string	false	https://
redirect_error	string	false	https://
contactid	numeric	false

Delete fair type

curl --location --request DELETE '{baseurl}/fair_types/{fairtypeid}' \
--header 'X-API-Key: {API-Key}' \

{
    "fairtypeid": 3,
    "error": false,
    "deleted": true
}

HTTP request

DELETE {baseurl}/fair_types/{fairtypeid}

URL Parameters

Parameter	Type	required	Default	Description
fairtypeid	numeric	true

Industries

Get industries

curl --location --request GET '{baseurl}/industries/?fairtypeid=2' \
--header 'X-API-Key: {API-Key}' \

{
    "industries": [
        {
            "language": "de_DE",
            "industry": "Architektur",
            "industryid": 34
        },
        {
            "language": "de_DE",
            "industry": "Betriebswirtschaftslehre",
            "industryid": 35
        },
        {
            "language": "de_DE",
            "industry": "Maschinenbau",
            "industryid": 45
        },
        {
            "language": "de_DE",
            "industry": "Mathematik",
            "industryid": 46
        },
        {
            "language": "de_DE",
            "industry": "Technik- und Management ",
            "industryid": 54
        }
    ],
    "error": false
}

HTTP request

GET {baseurl}/industries/

Query Parameters

Parameter	Type	required	Default
fairtypeid	numeric	true
language	string	false
parentid	numeric	true	0
exhibitorid	numeric	false
showlocked	boolean	false

Get industrie

curl --location --request GET '{baseurl}/industries/2/' \
--header 'X-API-Key: {API-Key}' \

{
    "industries": [
        {
            "language": "de_DE",
            "industry": "Webentwicklung",
            "industryid": 2
        }
    ],
    "error": false
}

HTTP request

GET {baseurl}/industries/{industryid}

URL Parameters

Parameter	Type	required	Default	Description
idustryid	numeric	true

Query Parameters

Parameter	Type	required	Default	Description
language	string	false		/>

Create industrie

curl --location --request POST '{baseurl}/industries/' \
--header 'X-API-Key: {API-Key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "parentid": 1,
    "fairtypeid": 1,
    "languages": [
        {
            "industry": "Musterbranch",
            "language": "de_DE"
        },
        {
            "industry": "Musterbranch EN",
            "language": "en_GB"
        }
    ]
}'

{
    "error": false,
    "industryid": "68"
}

HTTP request

POST {baseurl}/industries/

Parameters

Parameter	Type	required
parentid	numeric	true
messetypid	numeric	true
languages	array of objects	true

Languages details

Parameter	Type	required	Default	Description
language	string	true
industry	string	true

Update industrie

curl --location --request PUT '{basepath}/industries/{idustryid}/' \
--header 'X-API-Key: {API-Key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "parentid": 1,
    "fairtypeid": 1,
    "languages": [
        {
            "industry": "Musterbranch Updated",
            "language": "de_DE"
        },
        {
            "industry": "Musterbranch EN Updated",
            "language": "en_GB"
        }
    ]
}'

{
    "error": false,
    "industryid": 67
}

HTTP request

PUT {baseurl}/industries/{industryid}

URL Parameters

Parameter	Type	required	Default	Description
industryid	numeric	true

Parameters

Parameter	Type	required
parentid	numeric	true
messetypid	numeric	true
languages	array of objects	true

Languages details

Parameter	Type	required	Default	Description
language	string	true
industry	string	true

Delete industrie

curl --location --request DELETE '{baseurl}/industries/{industryid}/' \
--header 'X-API-Key: {API-Key}' \

{
    "error": false,
    "industryid": 66,
    "deleted": true
}

HTTP request

DELETE {baseurl}/industries/{industryid}

Parameters

Parameter	Type	required	Default	Description
industryid	numeric	true

Interested exhibitors

Get interested exhibitors

curl --location --request GET '{baseurl}/acquisition/interested-exhibitors' \
--header 'X-API-KEY: {API-Key}' \

{
    "interested-exhibitors": [
        {
            "interesse_code": "s8WSf4",
            "lexwareid": "",
            "longitude": "11.5868931",
            "email": "mail@unpainted.net",
            "vat_identification_number": "",
            "sevdeskid": "",
            "comment": "www.unpainted.net",
            "country": "DE",
            "fairid": "",
            "newsletter": true,
            "homepage": "http://www.unpainted.net/",
            "username": "99artfairs",
            "id": 5,
            "sorttitle": "-",
            "postalcode": "80202",
            "telephone": "-",
            "bexioid": "",
            "locked": false,
            "customer_number": "",
            "labelid": "32",
            "street": "Ohmstraße 22",
            "adress_verified": false,
            "company": "99artfairs GmbH",
            "city": "München",
            "password": "G2yU",
            "fairtypeid": 1,
            "additional_address": "",
            "latitude": "48.153304",
            "exhibitorid": 54
        },
        {
            "interesse_code": "7Kf4dS",
            "lexwareid": "",
            "longitude": "",
            "email": "oskar@keineahnung.de",
            "vat_identification_number": "",
            "sevdeskid": "",
            "comment": "www.gallery-weekend-berlin.de",
            "country": "DE",
            "fairid": "",
            "newsletter": true,
            "homepage": "",
            "username": "abc",
            "id": 6,
            "sorttitle": "-",
            "postalcode": "10785",
            "telephone": "+49 (0)30 7003 8771",
            "bexioid": "",
            "locked": false,
            "customer_number": "",
            "labelid": "32",
            "street": "Potsdamer Straße 93",
            "adress_verified": false,
            "company": "abc-gwb Veranstaltungs UG",
            "city": "Berlin",
            "password": "3x3H",
            "fairtypeid": 1,
            "additional_address": "",
            "latitude": "",
            "exhibitorid": 55
        }
    ],
    "error": false
}

HTTP request

GET {baseurl}/acquisition/interested-exhibitors/

Query Parameters

Parameter	Type	required	Default	Description
fairtypeid	numeric	true

Get interested exhibitor

curl --location --request GET '{baseurl}/acquisition/interested-exhibitors/{interestedexhibitorid}' \
--header 'X-API-KEY: {API-Key}' \

{
    "interested-exhibitors": [
        {
            "interesse_code": "s8WSf4",
            "lexwareid": "",
            "longitude": "11.5868931",
            "email": "mail@unpainted.net",
            "vat_identification_number": "",
            "sevdeskid": "",
            "comment": "www.unpainted.net",
            "country": "DE",
            "fairid": "",
            "newsletter": true,
            "homepage": "http://www.unpainted.net/",
            "username": "99artfairs",
            "id": 5,
            "sorttitle": "-",
            "postalcode": "80202",
            "telephone": "-",
            "bexioid": "",
            "locked": false,
            "customer_number": "",
            "labelid": "32",
            "street": "Ohmstraße 22",
            "adress_verified": false,
            "company": "99artfairs GmbH",
            "city": "München",
            "password": "G2yU",
            "fairtypeid": 1,
            "additional_address": "",
            "latitude": "48.153304",
            "exhibitorid": 54
        }
    ],
    "error": false
}

HTTP request

GET {baseurl}/acquisition/interested-exhibitors/{interestedexhibitorid}

URL Parameters

Parameter	Type	required	Default	Description
interestedexhibitorid	numeric	true

Set interested exhibitor

curl --location --request POST '{baseurl}/acquisition/interested-exhibitors/' \
--header 'X-API-Key: {API-Key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "exhibitorid": 1337,
    "fairtypeid": 1
}'

{
    "error": false,
    "interested_exhibitor_id": "37"
}

HTTP request

POST {baseurl}/acquisition/interested-exhibitors/

Parameters

Parameter	Type	required	Default	Description
exhibitorid	numeric	true
fairtypeid	numeric	true

Delete interested exhibitor

curl --location --request DELETE '{baseurl}/acquisition/interested-exhibitors/{exhibitorid}' \
--header 'X-API-KEY: {API-Key}' \

{
    "error": false,
    "interested_exhibitor_id": "37"
}

HTTP request

DELETE {baseurl}/acquisition/interested-exhibitors/{exhibitorid}

URL Parameters

Parameter	Type	required	Default	Description
exhibitorid	numeric	true

Query Parameters

Parameter	Type	required	Default	Description
fairtypeid	numeric	true

Labels

Get labels

curl --location --request GET '{baseurl}/label/  ' \
--header 'X-API-Key: {API-Key}' \

{
    "error": false,
    "labels": [
        {
            "de_DE": "Storniert",
            "module": "shop",
            "color": "#d62e2e",
            "en_GB": "Storniert",
            "id": 40
        },
        {
            "de_DE": "Erledigt",
            "module": "shop",
            "color": "#4fdf01",
            "en_GB": "Done",
            "id": 42
        }
    ]
}

HTTP request

GET {baseurl}/label/

Query Parameters

Parameter	Type	required	Default	Description
module	String	true		Either "akquise" or "shop"

Set label

curl --location --request POST '{baseur}/label/' \
--header 'X-API-KEY: {baseurl}' \
--header 'Content-Type: text/plain' \
--data-raw '{
    "module": "shop",
    "de_DE": "Test DE",
    "en_GB": "Test EN",
    "color": "#000"
}'

{
    "error": false,
    "boothid": "70"
}

HTTP request

POST {baseurl}/label/

Parameters

Parameter	Type	required	Description
module	String	true	Either "akquise" or "shop"
de_DE	String	true
en_DE	String	true
color	String	true	Color as Hex-Code

Delete label

curl --location --request DELETE '{baseurl}/label/{labelid}' \
--header 'X-API-Key: {API-Key}' \

{
    "error": false
}

HTTP request

DELETE {baseurl}/label/{labelid}

URL Parameters

Parameter	Type	required	Default	Description
labelid	numeric	true

Set exhibitor label assignment

curl --location --request POST '{baseur}/exhibitors/assign-label/' \
--header 'X-API-KEY: {baseurl}' \
--header 'Content-Type: text/plain' \
--data-raw '{
    "exhibitorid": 2300,
    "labelid": "1,2",
    "fairid": 41
}'

{
    "error": false
}

HTTP request

POST {baseurl}/exhibitors/assign-label

Parameters

Parameter	Type	required	Description
exhibitorid	numeric	true
labelid	list	true	Empty String to remove the assignment
fairid	numeric	true

Set order label assignment

curl --location --request POST '{baseurl}/shop/orders/assign-label/' \
--header 'X-API-Key: {API-Key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "labelid": "1",
    "orderid": 123
}'

{
    "error": false
}

HTTP request

POST {baseurl}/shop/orders/assign-label/

Parameters

Parameter	Type	required	Default	Description
labelid	list	true		Empty String to remove the assignment
orderid	numeric	true

curl --location --request GET '{baseurl}/newsletter/  ' \
--header 'X-API-Key: {API-Key}' \

{
    "newsletter": [
        {
            "text_html": "<p>*ANREDE*<br />\r\n*VORNAME*<br />\r\n*NAME*<br />\r\n*ID*<br />\r\n*BENUTZERNAME*<br />\r\n*PASSWORT*<br />\r\n*INTERESSE_CODE*<br />\r\n*CATCHALL*</p>\r\n",
            "reciver_pool_type": "1",
            "change_user": 60,
            "regard": "sdds",
            "send_at": "",
            "create_user": 61,
            "sender": "yannick@webcontact.de",
            "text": "fff",
            "change_date": "January, 19 2021 14:59:20",
            "create_date": "February, 15 2018 13:40:47",
            "reciver_pool_contactperson": "",
            "fairid": 4,
            "istest": 0,
            "reciver_pool": "1",
            "id": 1,
            "email_type": "html",
            "reciver_pool_acquisition": ""
        },
        {
            "text_html": "",
            "reciver_pool_type": "1",
            "change_user": 50,
            "regard": "С 30 апреля будет поднята стоимость на доп услуги",
            "send_at": "",
            "create_user": 50,
            "sender": "messeleitung@myevent.de",
            "text": "Уважаемы участники выставки Kubex, с 30 апреля будет поднята цена на допуслуги. Успейте приобрести необходимые услуги в разделе Вашего личного кабинета \"Магазин\" по самой низкой цене.",
            "change_date": "April, 02 2018 09:03:09",
            "create_date": "April, 02 2018 08:35:32",
            "reciver_pool_contactperson": "",
            "fairid": 9,
            "istest": 0,
            "reciver_pool": "1",
            "id": 2,
            "email_type": "html",
            "reciver_pool_acquisition": ""
        }
    ],
    "error": false
}

HTTP request

GET {baseurl}/newsletter/

Query Parameters

Parameter	Type	required
fairid	numeric	false
newsletterid	numeric	false
sended	Boolean	false
pooltype	String	false
poolcontact	String	false
order	String	false
poolTyp	String	false

curl --location --request POST '{baseurl}/newsletter/' \
--header 'X-API-Key: {API-Key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fairid": 7,
    "sender": "yannick@webcontact.de",
    "regard": "Newsletter über API",
    "text_html": "<h1>Text über API</h1><p>Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.</p>",
    "email_type": "html",
    "pool": "t_1, t_2, a_23, a_32, akquise_32, akquise_2"
}'

{
    "newsletter": "25",
    "error": false
}

HTTP request

POST {baseurl}/newsletter/

Parameters

Parameter	Type	required	Default
fairid	numeric	true
sender	String	true
regard	String	true
text_html	String	false
text	String	false
email_type	String	true
istest	Boolean	true	false

curl --location --request DELETE '{baseurl}/newsletter/{newsletterid}' \
--header 'X-API-Key: {API-Key}' \

{
    "error": false
}

HTTP request

DELETE {baseurl}/newsletter/

Query Parameters

Parameter	Type	required	Default	Description
newsletterid	numeric	true

Publications

Get online medias

curl --location --request GET '{baseurl}/publications/online/' \
--header 'X-API-Key: {API-Key}' \

{
    "error": false,
    "online_media": [
        {
            "language": "de_DE",
            "logo_preview": "sandbox.profairs2.tom.webcontact.de/downloads/get.cfm?component=com_publikation&method=getAusstellerMesseWebsite&fieldNameFile=logo_vorschau&fieldNameFileName=logo_name&fieldNameFileMimeType=logo_mimetype&aussteller_messen_id=7&type=attachment",
            "description": "Eintrag Onlinemedien (Ihr Text)",
            "video_url": "",
            "logo": "sandbox.profairs2.tom.webcontact.de/downloads/get.cfm?component=com_publikation&method=getAusstellerMesseWebsite&fieldNameFile=logo&fieldNameFileName=logo_name&fieldNameFileMimeType=logo_mimetype&aussteller_messen_id=7&type=attachment",
            "logo_name": "cms-640x640.jpg",
            "contactid": "",
            "logo_mimetype": "image/jpeg",
            "exhibitor_fairid": 7,
            "company_description": ""
        }
    ]
}

HTTP request

GET {baseurl}/publications/online/

Query Parameters

Parameter	Type	required	Default	Description
fairid	numeric	false

Get online media

curl --location --request GET '{baseurl}/publications/online/{exhibitor_fairid}' \
--header 'X-API-Key: {API-Key}' \

{
    "error": false,
    "online_media": [
        {
            "language": "de_DE",
            "logo_preview": "sandbox.profairs2.tom.webcontact.de/downloads/get.cfm?component=com_publikation&method=getAusstellerMesseWebsite&fieldNameFile=logo_vorschau&fieldNameFileName=logo_name&fieldNameFileMimeType=logo_mimetype&aussteller_messen_id=766&type=attachment",
            "description": "ProFairs ist eine webbasierte Eventmanagement-Software für Messen, die die Kommunikation mit den Ausstellern vereinfacht. Das war's.",
            "video_url": "",
            "logo": "sandbox.profairs2.tom.webcontact.de/downloads/get.cfm?component=com_publikation&method=getAusstellerMesseWebsite&fieldNameFile=logo&fieldNameFileName=logo_name&fieldNameFileMimeType=logo_mimetype&aussteller_messen_id=766&type=attachment",
            "logo_name": "logo webcontact.jpg",
            "contactid": "",
            "logo_mimetype": "image/jpeg",
            "exhibitor_fairid": 766,
            "company_description": ""
        }
    ]
}

HTTP request

GET {baseurl}/publications/online/{exhibitor_fairid}

URL Parameters

Parameter	Type	required	Default	Description
exhibitor_fairid	numeric	true

Create online media

curl --location --request POST '{baseurl}/publications/online/' \
--header 'X-API-Key: {API-Key}' \
--form 'file=@"{file_path}"' \
--form 'file_preview=@"{file_path}"' \
--form 'exhibitor_fairid="1337"' \
--form 'language="de_DE"' \
--form 'description="Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod"' \
--form 'company_description="Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod"' \
--form 'file_name="{file_name}"' \
--form 'file_mimetype="{file_mimetype}"' \
--form 'video_url="https://..."' \
--form 'contactid="1337"'

{
    "language": "de_DE",
    "error": false,
    "exhibitor_fairid": "1337"
}

HTTP request

POST {baseurl}/publications/online/

Parameters

Parameter	Type	required
exhibitor_fairid	numeric	true
language	string	true
description	string	false
company_description	string	false
logo	binary	false
logo_name	string	false
logo_mimetype	string	false
logo_preview	binary	false
logo_mimetype	string	false
video_url	string	false
contactid	numeric	false

Shop items

Get items

curl --location --request GET '{baseurl}/shop/items' \
--header 'X-API-Key: {API-Key}' \

{
    "error": false,
    "items": [
       {
            "language": "de_DE",
            "locked": false,
            "unit": "",
            "booth-specific": true,
            "categoryid": 39,
            "remarks": "",
            "article_typ_id": 1,
            "description": "",
            "upload": false,
            "sort": 1,
            "introduction": "Buchbar pro Stromabschluss. Wird der Artikel nicht bestellt, wird der Strombverbrauch pauschal berechnet.",
            "title": "Stromverbrauch f&uuml;r einen bestellten Stromanschluss",
            "closedate": "",
            "itemid": 140
        },
        {
            "language": "de_DE",
            "locked": false,
            "unit": "",
            "booth-specific": false,
            "categoryid": 80,
            "remarks": "",
            "article_typ_id": 1,
            "description": "",
            "upload": false,
            "sort": 1,
            "introduction": "Buchbar pro Stromabschluss. Wird der Artikel nicht bestellt, wird der Strombverbrauch pauschal berechnet.",
            "title": "Stromverbrauch f&uuml;r einen bestellten Stromanschluss",
            "closedate": "",
            "itemid": 186
        }
    ]
}

HTTP request

GET {baseurl}/shop/items/

Query Parameters

Parameter	Type	required	Default
categoryid	numeric	false
itemnr	string	false
language	string	true	de_DE
itemid	numeric	false
fairid	numeric	false
enddate	string	false
showlocked	boolean	true	true
showcoupon	boolean	false
showcatchall	boolean	false
showspecial_coupon	boolean	false
userroleadmin	boolean	false
userroles	string	false
exhibitortypes	string	false

Get item

curl --location --request GET '{baseurl}/shop/items/{itemid}' \
--header 'X-API-Key: {API-Key}' \

{
    "error": false,
    "items": [
        {
            "language": "de_DE",
            "locked": false,
            "unit": "",
            "booth-specific": false,
            "categoryid": 14,
            "remarks": "",
            "article_typ_id": 4,
            "description": "",
            "upload": false,
            "sort": 0,
            "introduction": "",
            "title": "E-Gutschein",
            "closedate": "",
            "itemid": 23
        }
    ]
}

HTTP request

GET {baseurl}/shop/items/{itemid}

URL Parameters

Parameter	Type	required	Default	Description
itemid	string	true

Query Parameters

Parameter	Type	required	Default
itemid	string	true
categoryid	numeric	true
itemnr	string	false
language	string	false
fairid	numeric	false
end_date	string	false
showlocked	boolean	true	true
showcoupon	boolean	false
showcatchall	boolean	false
showspecialcoupon	boolean	false
userroleadmin	boolean	false
userroles	string	false
exhibitortypes	string	false

Create item

curl --location --request POST '{baseurl}/shop/items' \
--header 'X-API-Key: {API-Key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type_id": 1,
    "categoryid": 2,
    "itemnr": "AR1234",
    "booth_specific": false,
    "comment": "optional",
    "sort": 10,
    "lock": false,
    "item_units": "10, 20, 30, 50",
    "unit_of_measurement": "cm",
    "upload": false,
    "recommended": true,
    "enddate": "2021-12-31",
    "languages": [
        {
            "language": "de_DE",
            "title": "Lorem Ipsum",
            "introduction": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore",
            "description": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore",
            "comment": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore"
        },
        {
            "language": "en_GB",
            "title": "Lorem Ipsum",
            "introduction": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore",
            "description": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore",
            "comment": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore"
        }
    ]
}'

{
    "error": false,
    "itemid": "371"
}

HTTP request

POST {baseurl}/shop/items/

Parameters

Parameter	Type	required	Default
type_id	numeric	false
categoryid	numeric	false
itemnr	string	false
booth_specific	boolean	true	false
comment	string	false
sort	string	false
lock	boolean	true	false
end_date	string	false
item_units	string	true
unit_of_measurement	string	true
item_title	string	false
upload	boolean	true	false
recommended	boolean	true	false
languages	array of objects	true
crossselling	string	false
dependence	string	false
exhibitor_types	string	false

Languages details

Parameter	Type	required
language	string	true
title	string	true
introduction	string	true
description	string	true
comment	string	true

Update item

curl --location --request PUT '{baseurl}/shop/items/{itemid)' \
--header 'X-API-Key: {API-Key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type_id": 1,
    "categoryid": 2,
    "itemnr": "AR1234",
    "booth_specific": false,
    "comment": "optional",
    "sort": 10,
    "lock": false,
    "item_units": "10, 20, 30, 50",
    "unit_of_measurement": "cm",
    "upload": false,
    "recommended": true,
    "enddate": "2021-12-31",
    "languages": [
        {
            "language": "de_DE",
            "title": "Lorem Ipsum 123",
            "introduction": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore",
            "description": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore",
            "comment": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore"
        },
        {
            "language": "en_GB",
            "title": "Lorem Ipsum 123",
            "introduction": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore",
            "description": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore",
            "comment": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore"
        }
    ]
}'

{}

HTTP request

PUT {baseurl}/shop/items/{itemid}

URL Parameters

Parameter	Type	required	Default	Description
itemid	numeric	true

Parameters

Parameter	Type	required	Default
type_id	numeric	false
categoryid	numeric	false
itemnr	string	false
booth_specific	boolean	true	false
comment	string	false
sort	string	false
lock	boolean	true	false
end_date	string	false
item_units	string	false
unit_of_measurement	string	false
item_title	string	false
upload	boolean	true	false
recommended	boolean	true	false
languages	array ob objects	true	false
crossselling	string	false
dependence	string	false
exhibitor_types	string	false

Languages details

Parameter	Type	required
language	string	true
title	string	true
introduction	string	true
description	string	true
comment	string	true

Upload item file

curl --location --request POST '{baseurl}/shop/items/upload/' \
--header 'X-API-Key: {API-Key}' \
--form 'file=@"{file_path}"' \
--form 'file_name="{file_name}"' \
--form 'file_title="Lorum Ipsum"' \
--form 'language="de_DE"' \
--form 'itemid="{itemid}"' \
--form 'type="pdf"'

{
    "error": false,
    "itemid": "370"
}

HTTP request

POST {baseurl}/shop/items/upload/

Parameters

Parameter	Type	required
file	binary	true
file_name	string	true
file_title	string	true
itemid	numeric	true
language	string	true
type	string	true

Delete item

curl --location --request DELETE '{baseurl}/shop/items/{itemid}' \
--header 'X-API-Key: {API-Key}' \

{
    "error": false,
    "itemid": 363,
    "deleted": true
}

HTTP request

DELETE {baseurl}/shop/items/{itemid}

URL Parameters

Parameter	Type	required	Default	Description
itemid	numeric	true

Shop categories

Get categories

curl --location --request GET '{baseurl}/shop/categories?fairid={fairid}' \
--header 'X-API-Key: {API-Key}' \

{
    "error": false,
    "categories": [
      {
            "language": "de_DE",
            "infobox_title": "",
            "locked": false,
            "description": "&lt;p&gt;Im Folgenden haben Sie die M&ouml;glichkeit &lt;strong&gt;Sonderwerbeformen &lt;&#x2f;strong&gt;zu bestellen.&amp;nbsp&#x3b;Alle Preise in Euro zuz&uuml;glich der gesetzlichen MwSt.&lt;&#x2f;p&gt;&#xd;&#xa;",
            "category": "Sonderwerbeformen",
            "contactid": "",
            "id": 42,
            "infobox_description": "",
            "parentid": 47
        },
        {
            "language": "de_DE",
            "infobox_title": "",
            "locked": false,
            "description": "&lt;p&gt;Die Standausstattung muss separat gebucht werden.&lt;&#x2f;p&gt;&#xd;&#xa;",
            "category": "Standausstattung",
            "contactid": "",
            "id": 27,
            "infobox_description": "",
            "parentid": 32
        }
    ]
}

HTTP request

GET {baseurl}/shop/categories/

Query Parameters

Parameter	Type	required	Default
fairid	numeric	false
language	string	true	de_DE
show_disabled	boolean	true	false
hide_coupon	boolean	true	true

Get categorie

curl --location --request GET '{baseurl}/shop/categories/{categoryid}' \
--header 'X-API-Key: {API-Key}' \

{
    "error": false,
    "categories": [
        {
            "language": "de_DE",
            "infobox_title": "",
            "locked": false,
            "description": "&lt;p&gt;Die Standausstattung muss separat gebucht werden.&lt;/p&gt;\n",
            "category": "Standausstattung",
            "contactid": "",
            "id": 27,
            "infobox_description": "",
            "parentid": 32
        }
    ]
}

HTTP request

GET {baseurl}/shop/categories/{categoryid}

URL Parameters

Parameter	Type	required	Default	Description
categoryid	string	true

Query Parameters

Parameter	Type	required	Default	Description
language	string	false
fairid	numeric	false

Create categroie

curl --location --request POST '{baseurl}/shop/categories/' \
--header 'X-API-Key: {API-Key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "parentid": 0,
    "contactid": 12,
    "permissions_group_id": 1,
    "fairid": 7,
    "show_coupons_link": true,
    "order": 10,
    "lock": false,
    "languages": [
        {
            "language": "de_DE",
            "title": "Lorem Ipsum",
            "description": "Lorem Ipsum",
            "infobox_headline": "Lorem Ipsum",
            "infobox_description": "Lorem Ipsum"
        },
        {
            "language": "en_GB",
            "title": "Lorem Ipsum",
            "description": "Lorem Ipsum",
            "infobox_headline": "Lorem Ipsum",
            "infobox_description": "Lorem Ipsum"
        }
    ]
}
'

{
    "categoryid": "171",
    "error": false
}

HTTP request

POST {baseurl}/shop/categories/

Parameters

Parameter	Type	required	Default
parentid	numeric	false	0
contactid	numeric	false
permissions_group_id	numeric	false
fairid	numeric	false
show_coupons_link	boolean	true	false
order	numeric	false
lock	boolean	true	false
languages	array of objects	false

Languages details

Parameter	Type	required
language	string	true
title	string	true
description	string	true
infobox_headline	string	true
infobox_description	string	true

Update categorie

curl --location --request PUT '{baseurl}/shop/categories/{categoryid}' \
--header 'X-API-Key: {API-Key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "parentid": 0,
    "contactid": 12,
    "permissions_group_id": 1,
    "fairid": 7,
    "show_coupons_link": true,
    "order": 10,
    "lock": false,
    "languages": [
        {
            "language": "de_DE",
            "title": "Lorem Ipsum",
            "description": "Lorem Ipsum",
            "infobox_headline": "Lorem Ipsum",
            "infobox_description": "Lorem Ipsum"
        },
        {
            "language": "en_GB",
            "title": "Lorem Ipsum",
            "description": "Lorem Ipsum",
            "infobox_headline": "Lorem Ipsum",
            "infobox_description": "Lorem Ipsum"
        }
    ]
}
'

{
    "categoryid": 166,
    "error": false
}

HTTP request

PUT {baseurl}/shop/categories/{categoryid}

URL Parameters

Parameter	Type	required	Default	Description
categoryid	numeric	true

Parameters

Parameter	Type	required	Default
parentid	numeric	false	0
contactid	numeric	false
permissions_group_id	numeric	false
fairid	numeric	false
show_coupons_link	boolean	true	false
order	numeric	false
lock	boolean	true	false
languages	array of objects	false

Languages details

Parameter	Type	required
language	string	true
title	string	true
description	string	true
infobox_headline	string	true
infobox_description	string	true

Delete categorie

curl --location --request DELETE '{baseurl}/shop/categories/{categoryid}' \
--header 'X-API-Key: {API-Key}' \

{
    "categoryid": 170,
    "error": false,
    "deleted": true
}

HTTP request

DELETE {baseurl}/shop/categories/{categoryid}

URL Parameters

Parameter	Type	required	Default	Description
categoryid	numeric	true

Shop variants

Get variants

curl --location --request GET '{baseurl}/shop/variants?itemid={itemid}' \
--header 'X-API-Key: {API-Key}' \

{
    "variants": [
        {
            "language": "de_DE",
            "variantid": 593,
            "price": 39.0,
            "amount": "",
            "orders": "",
            "title": "weiß - T06w",
            "text": "",
            "itemid": 337
        },
        {
            "language": "de_DE",
            "variantid": 594,
            "price": 39.0,
            "amount": "",
            "orders": "",
            "title": "schwarz - T06s",
            "text": "",
            "itemid": 337
        }
    ],
    "error": false
}

HTTP request

GET {baseurl}/shop/variants/

Query Parameters

Parameter	Type	required	Default
itemid	numeric	true
locked	boolean	true	false
ordered_variants	boolean	true	false

Get variant

curl --location --request GET '{baseurl}/shop/variants/{variantid}' \
--header 'X-API-Key: {API-Key}' \

{
    "variants": [
        {
            "language": "de_DE",
            "price": 39.0,
            "amount": "",
            "orders": "",
            "title": "weiß - T06w",
            "text": "",
            "id": 593,
            "itemid": 337
        }
    ],
    "error": false
}

HTTP request

GET {baseurl}/shop/variants/{variantid}

URL Parameters

Parameter	Type	required	Default	Description
variants_id	numeric	true

Query Parameters

Parameter	Type	required	Default	Description
locked	boolean	true	false
ordered_variants	boolean	true	false

Create variant

curl --location --request POST '{baseurl}/shop/variants/' \
--header 'X-API-Key: {API-Key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "itemid": 1337,
    "price": 100,
    "number_of_pieces": 999,
    "lock": false,
    "languages": [
        {
            "language": "de_DE",
            "title": "Lorem Ipsum",
            "description": "Lorem Ipsum"
        },
        {
            "language": "en_GB",
            "title": "Lorem Ipsum",
            "description": "Lorem Ipsum"
        }
    ]
}
'

{
    "variantid": "617",
    "error": false
}

HTTP request

POST {baseurl}/shop/variants/

Parameters

Parameter	Type	required	Default
itemid	numeric	true
number_of_pieces	numeric	true
price	numeric	true
lock	boolean	true	false
languages	any	true

Upload files

curl --location --request POST '{baseurl}/shop/variants/upload/' \
--header 'X-API-Key: {API-Key}' \
--form 'file=@"{file_path}"' \
--form 'file_name="{file_name"' \
--form 'file_title="{file_title}"' \
--form 'variantid="{variantid}"' \
--form 'language="de_DE"'

{
    "variantid": "616",
    "updated": true,
    "error": false
}

HTTP request

POST {baseurl}/shop/variants/upload/

Parameters

Parameter	Type	required
file	binary	true
file_name	string	true
file_title	string	true
variantsid	numeric	true
language	string	true

Update variant

curl --location --request PUT '{baseurl}/shop/variants/{variantid}' \
--header 'X-API-Key: {API-Key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "itemid": 1337,
    "price": 100,
    "number_of_pieces": 999,
    "lock": false,
    "languages": [
        {
            "language": "de_DE",
            "title": "Lorem Ipsum",
            "description": "Lorem Ipsum"
        },
        {
            "language": "en_GB",
            "title": "Lorem Ipsum",
            "description": "Lorem Ipsum"
        }
    ]
}
'

{
    "variantid": 1337,
    "error": false
}

HTTP request

PUT {baseurl}/shop/variants/{variantid}

URL Parameters

Parameter	Type	required	Default	Description
variantid	numeric	true

Parameters

Parameter	Type	required	Default
itemid	numeric	true
number_of_pieces	numeric	true
price	numeric	true
lock	boolean	true	false
languages	any	true

Delete variant

curl --location --request DELETE '{baseurl}/shop/variants/{variantid}' \
--header 'X-API-Key: {API-Key}' \

{}

HTTP request

DELETE {baseurl}/shop/variants/{variantid}

URL Parameters

Parameter	Type	required	Default	Description
variantid	numeric	true

Shop orders

Get orders

curl --location --request GET '{baseurl}/shop/orders/' \
--header 'X-API-Key: {API-Key}' \

{
    "orders": [
        {
            "orderid": 2674,
            "variantid": 661,
            "price": 0.0,
            "amount": 20.0,
            "canceled": false,
            "labelid": "",
            "remarks": "",
            "shippingdate": "March, 28 2022 00:00:00",
            "boothid": 0,
            "exhibitorfairid": 2604
        },
        {
            "orderid": 2670,
            "variantid": 74,
            "price": 0.0,
            "amount": 1.0,
            "canceled": false,
            "labelid": "",
            "remarks": "CatchAllGutschein-Bestellung",
            "shippingdate": "March, 11 2022 00:00:00",
            "boothid": 0,
            "exhibitorfairid": 751
        }
    ],
    "error": false
}

HTTP request

GET {baseurl}/shop/orders/

Query Parameters

Parameter	Type	required	Default	Description
language	string	true
order	boolean	true	true	Sorts the orders by the modification date
hideVouchers	boolean	false		Removes all ordered vouchers
fairid	numeric	false
usergroupid	numeric	false

Get order

curl --location --request GET '{baseurl}/shop/orders/{orderid}/' \
--header 'X-API-Key: {API-Key}' \

{
    "orders": [
        {
            "orderid": 2674,
            "variantid": 661,
            "price": 0.0,
            "amount": 20.0,
            "canceled": false,
            "labelid": "",
            "remarks": "",
            "shippingdate": "March, 28 2022 00:00:00",
            "boothid": 0,
            "exhibitorfairid": 2604
        }
    ],
    "error": false
}

HTTP request

GET {baseurl}/shop/orders/{orderid}

URL Parameters

Parameter	Type	required	Default	Description
orderid	numeric	true

Query Parameters

Parameter	Type	required	Default	Description
language	string	true
order	boolean	true	true	Sorts the orders by the modification date
hideVouchers	boolean	false		Removes all ordered vouchers
fairid	numeric	false
usergroupid	numeric	false

Create order

curl --location --request POST '{baseurl}/shop/orders/' \
--header 'X-API-KEY: {API-Key}' \
--header 'Content-Type: application/json' \\
--data-raw '{
    "variantid": 1337,
    "amount": 10,
    "price": "199.00",
    "exhibitorfairid": 2900,
    "boothid": 1337,
    "remarks": "Lorem Ipsum Lorem Ipsum Lorem Ipsum Lorem Ipsum Lorem Ipsum Lorem Ipsum Lorem Ipsum ",
    "shippingdate": "2022-03-17 14:00:00",
    "canceled": 0
}'

{
    "orderid": "2677",
    "error": false
}

HTTP request

POST {baseurl}/shop/orders/

Parameters

Parameter	Type	required	Default	Description
variantid	numeric	true
amount	numeric	true
price	numeric	true
exhibitorfairid	numeric	true
boothid	numeric	false
remarks	String	false
shippingdate	Date	false
unhide	boolean	true	true	The order will be shown in the exhibitor area
canceled	boolean	true	false

Update order

curl --location --request PUT '{baseurl}/shop/orders/{orderid}' \
--header 'X-API-KEY: {API-Key}' \
--header 'Content-Type: application/json' \\
--data-raw '{
    "amount": 5,
    "price": 1000,
    "boothid": 7331,
    "remarks": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna",
    "shippingdate": "2022-03-17 17:30:00",
    "unhide": false,
    "canceled": 0
}'

{
    "orderid": "2675",
    "error": false
}

HTTP request

PUT {baseurl}/shop/orders/

URL Parameters

Parameter	Type	required	Default	Description
orderid	numeric	true

Parameters

Parameter	Type	required	Description
amount	numeric	false
price	numeric	false
boothid	numeric	false
remarks	String	false
shippingdate	Date	false
unhide	boolean	false	The order will be shown in the exhibitor area
canceled	boolean	false

Delete order

curl --location --request DELETE '{baseurl}/shop/orders/{orderid}' \
--header 'X-API-KEY: {API-Key}' \

{
    "orderid": "2676",
    "error": false
}

HTTP request

DELETE {baseurl}/shop/orders/{orderid}

URL Parameters

Parameter	Type	required	Default	Description
orderid	numeric	true

Shop discounts

Get discount

curl --location --request GET '{baseurl}/shop/discounts/' \
--header 'X-API-Key: {API-Key}' \

{
    "error": false,
    "discount": [
        {
            "exhibitorgroupid": 123,
            "variantid": 321,
            "discount": 50
        },
        {
            "exhibitorgroupid": 1337,
            "variantid": 7331,
            "discount": 100
        }
    ]
}

HTTP request

GET {baseurl}/shop/discounts/

Query Parameters

Parameter	Type	required	Default	Description
exhibitorgroupid	numeric	true
variantid	numeric	true

Create discount

curl --location --request POST '{baseurl}/shop/discounts/' \
--header 'X-API-Key: {API-Key}' \
--header 'Content-Type: application/json' \\

--data-raw '{
    "exhibitorgroupid": "1337",
    "variantid": "7331",
    "discount": "100"
}'

{
    "error": false
}

HTTP request

POST {baseurl}/shop/discounts/

Parameters

Parameter	Type	required
variantid	numeric	true
exhibitorgroupid	numeric	true
discount	numeric	true

Delete order

curl --location --request DELETE '{baseurl}/shop/discounts/' \
--header 'X-API-KEY: {API-Key}' \

{
    "error": false
}

HTTP request

DELETE {baseurl}/shop/discounts/

Query Parameters

Parameter	Type	required	Default	Description
exhibitorgroupid	numeric	true
variantid	numeric	true

Texts

Get text categories

curl --location --request GET '{baseurl}/text/categories/' \
--header 'X-API-Key: {API-Key}' \

{
    "error": false,
    "categories": [
        {
            "de_DE": "Automatischer Mailversand Bestellbestätigung",
            "en_GB": "Automatischer Mailversand Bestellbestätigung",
            "id": 64
        },
        {
            "de_DE": "Einstellungen Einleitung",
            "en_GB": "Einstellungen Einleitung",
            "id": 63
        }
    ]
}

HTTP request

GET {baseurl}/text/

Get texts

curl --location --request GET '{baseurl}/text/' \
--header 'X-API-Key: {API-Key}' \

{
    "texts": [
        {
            "language": "de_DE",
            "locked": false,
            "change_user": 667,
            "date_from": "February, 24 2022 00:00:00",
            "create_user": 667,
            "categorieid": 65,
            "change_date": "February, 24 2022 16:10:36",
            "create_date": "February, 24 2022 16:10:36",
            "fairtypeid": 1,
            "introduction": "<p>Danke für Ihre Anmeldung!</p>",
            "title": "Test web://contact",
            "id": 137,
            "date_to": "September, 21 2022 00:00:00"
        },
        {
            "language": "de_DE",
            "locked": false,
            "change_user": 666,
            "date_from": "July, 15 2020 00:00:00",
            "create_user": 666,
            "categorieid": 35,
            "change_date": "August, 27 2021 16:02:32",
            "create_date": "August, 27 2021 16:02:32",
            "fairtypeid": 1,
            "introduction": "<p>Hier könnte ein Einleitungstext für die Job-Wall stehen, u.a. auch was für Dateitypen hochgeladen werden und in welcher Auflösung (DPI, Farbraum, ...)</p>\r\n",
            "title": "Stellenausschreibungen Job-Wall",
            "id": 122,
            "date_to": "December, 31 2030 00:00:00"
        },
    ],
    "error": false
}

HTTP request

POST {baseurl}/text/

Query Parameters

Parameter	Type	required
fairtypeid	numeric	true
fairid	numeric	false
categorieid	numeric	false

Set text

curl --location --request POST '{baseurl}/text/' \
--header 'X-API-Key: {API-Key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fairtypeid": 1,
    "title": "Text über API",
    "introduction": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. ",
    "categorie": 1,
    "date_from": "2022-04-04 10:00:00",
    "date_to": "2023-04-04 10:00:00",
    "language": "de_DE",
    "locked": 0
}'

{
    "textid": "142",
    "error": false
}

HTTP request

POST {baseurl}/text/{textid}

Parameters

Parameter	Type	required
fairtypeid	numeric	true
title	String	true
introduction	String	true
categorie	numeric	true
date_from	date	true
date_to	date	true
language	String	true

Update text

curl --location --request PUT '{baseurl}/text/{textid}' \
--header 'X-API-Key: {API-Key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fairtypeid": 1,
    "title": "Text über API",
    "introduction": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. ",
    "categorie": 1,
    "date_from": "2022-04-04 10:00:00",
    "date_to": "2023-04-04 10:00:00",
    "language": "en_GB",
    "locked": 0
}'

{
    "textid": "142",
    "error": false
}

HTTP request

PUT {baseurl}/text/{textid}

URL Parameters

Parameter	Type	required	Default	Description
textid	numeric	true

Parameters

Parameter	Type	required
fairtypeid	numeric	false
title	String	false
introduction	String	false
categorie	numeric	false
date_from	date	false
date_to	date	false
language	String	false

Delete text

curl --location --request DELETE '{baseurl}/text/{textid}' \
--header 'X-API-Key: {API-Key}' \

{
    "textid": "142",
    "error": false
}

HTTP request

DELETE {baseurl}/text/{textid}

URL Parameters

Parameter	Type	required	Default	Description
textid	numeric	true

Users

Get users

curl --location --request GET '{baseurl}/user/' \
--header 'X-API-Key: {API-Key}' \

{
    "error": false,
    "users": [
        {
            "group": "admin",
            "locked": false,
            "username": "alf",
            "firstname": "Thomas",
            "id": 59,
            "name": "Alf"
        },
        {
            "group": "scanner",
            "locked": false,
            "username": "scanner",
            "firstname": "scanner",
            "id": 42,
            "name": "barcode"
        }
    ]
}

HTTP request

GET {baseurl}/users/

Get user

curl --location --request GET '{baseurl}/user/{userid}' \
--header 'X-API-Key: {API-Key}' \

{
    "error": false,
    "users": [
        {
            "group": "admin",
            "locked": false,
            "username": "alf",
            "firstname": "Thomas",
            "id": 59,
            "name": "Alf"
        }
    ]
}

HTTP request

GET {baseurl}/users/{userid}

URL Parameters

Parameter	Type	required	Default	Description
userid	numeric	true

Set user

curl --location --request POST '{baseurl}/user/' \
--header 'X-API-Key: {API-Key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "salutation": "Herr",
    "title": "Dr.",
    "firstname": "Max",
    "name": "Mustermann",
    "username": "username",
    "password": "password",
    "email": "max-mustermann@gmail.com",
    "telephone": "+49 12345 123",
    "address": "",
    "printnode_printer_id": "123456789",
    "printnode_api_key": "987654321",
    "group": 1
}'

{
    "error": false,
    "userid": 1337
}

HTTP request

POST {baseurl}/users/

Parameters

Parameter	Type	required	Default
salutation	String	true
firstname	String	true
name	String	true
username	String	true
password	String	true
email	String	true
group	numeric	true
locked	boolean	true	false
title	String	false
telephone	String	false
address	String	false
printnode_printer_id	String	false
printnode_api_key	String	false

Delete user

curl --location --request DELETE '{baseurl}/user/{userid}/' \
--header 'X-API-Key: {API-Key}' \

{
    "error": false,
    "usersid": 1337
}

HTTP request

DELETE {baseurl}/users/{userid}

URL Parameters

Parameter	Type	required	Default	Description
userid	numeric	true

Get user-groups

curl --location --request GET '{baseurl}/groups' \
--header 'X-API-Key: {API-Key}' \

{
    "error": false,
    "users": [
        {
            "group": "admin",
            "create_date": "March, 17 2016 11:02:15",
            "change_user": 999,
            "create_user": 999,
            "fairid": 0,
            "id": 1,
            "change_date": "March, 17 2016 11:02:15"
        },
        {
            "group": "Admin",
            "create_date": "March, 18 2016 14:49:36",
            "change_user": "",
            "create_user": 999,
            "fairid": 1,
            "id": 3,
            "change_date": ""
        }
    ]
}

HTTP request

GET {baseurl}/groups

Query Parameters

Parameter	Type	required	Default	Description
fairid	numeric	false

Set user-groups

curl --location --request POST '{baseurl}/groups' \
--header 'X-API-Key: {API-Key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "group": "API Group",
    "fairid": 7,
    "shipping": true
}'

{
    "users_group_id": "31",
    "error": false
}

HTTP request

POST {baseurl}/groups

Parameters

Parameter	Type	required	Default
group	String	true
shipping	Boolean	true	false
fairid	numeric	false

Get shop categories by user

curl --location --request GET '{baseurl}/user/{userid}/shop_categories/ \
--header 'X-API-Key: {API-Key}' \

{
    "shop_categories": [
        {
            "create_date": "February, 25 2022 15:29:30",
            "locked": false,
            "change_user": 666,
            "parentid": 0,
            "fair": "Testmesse 2022",
            "usergroupid": 28,
            "create_user": 666,
            "id": 194,
            "categorie": "Standmöbel",
            "change_date": "February, 25 2022 16:21:32",
            "contactid": ""
        }
    ],
    "error": false
}

HTTP request

GET {baseurl}/user/{userid}/shop_categories/

URL Parameters

Parameter	Type	required	Default	Description
userid	numeric	true

Query Parameters

Parameter	Type	required	Default	Description
language	String	true

Visitors

Get visitors

curl --location --request GET '{baseurl}/visitors/' \
--header 'X-API-KEY: {API-Key}' \

{
    "visitors": [
        {
            "zip": "1111",
            "telephone": "",
            "mobil": "",
            "codeid": 550,
            "longitude": "",
            "firstname": "Martin",
            "street": "XXX, 1",
            "email": "test5@expodat.pro",
            "company": "Test5 GmbH",
            "city": "Test Stadt",
            "country": "",
            "salutation": "Herr",
            "lastname": "Test",
            "newsletter": false,
            "title": "",
            "id": 85,
            "latitude": "",
            "externalid": ""
        }
    ]
}

HTTP request

GET {baseurl}/visitors/

Query parameters

Parameter	Type	required	Default	Description
fairid	numeric	false

Get visitor

curl --location --request GET '{baseurl}/visitors/{visitorid}' \
--header 'X-API-KEY: {API-Key}' \

{
    "zip": "12345",
    "telephone": "+49 12345 6789",
    "mobil": "+49 12345 67890",
    "codeid": 1,
    "visitorid": 110,
    "longitude": "7.56737",
    "firstname": "Max",
    "street": "Musterstraße 123",
    "email": "max.mustermann@gmail.com",
    "company": "Muster GmbH 2",
    "city": "Mustercity",
    "country": "Deutschland",
    "salutation": "Herr",
    "lastname": "Mustermann",
    "newsletter": true,
    "title": "Dr.",
    "error": "false",
    "latitude": "-48.62420",
    "externalid": "A1C2"
}

HTTP request

GET {baseurl}/visitors/{visitorid}

URL Parameters

Parameter	Type	required	Default	Description
visitorid	numeric	true

Query Parameters

Parameter	Type	required	Default	Description
fairid	numeric	false
external	boolean	false	false

Create visitor

curl --location --request POST '{baseurl}/visitors/' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: {API-Key}' \
--data-raw '{
    "external_id": "A1C2",
    "company": "Muster GmbH",
    "title": "Dr.",
    "salutation": "Herr",
    "firstname": "Max",
    "lastname": "Mustermann",
    "street": "Musterstraße 123",
    "postalcode": "12345",
    "city": "Mustercity",
    "country": "Deutschland",
    "latitude": "-48.62420",
    "longitude": "7.56737",
    "telephone": "+49 12345 6789",
    "mobil": "+49 12345 67890",
    "email": "max.mustermann@gmail.com",
    "codeid": "1",
    "newsletter": true
}'

{
    "visitorid": "108",
    "error": "false"
}

HTTP request

POST {baseurl}/visitors/

Parameters

Parameter	Type	required	Default
external_id	string	false
codeid	numeric	false
company	string	false
title	string	false
salutation	string	false
firstname	string	false
lastname	string	false
street	string	false
postalcode	string	false
city	string	false
country	string	false	Deutschland
telephone	string	false
mobil	string	false
latitude	string	false
longitude	string	false
email	string	false
newsletter	boolean	false	false

Update visitor

curl --location --request PUT '{baseurl}/visitors/{visitorid}' \
--header 'X-API-Key: {API-Key}' \
--header 'Content-Type: text/plain' \
--data-raw '{
    "externalid": "A1C2",
    "company": "Muster GmbH 2",
    "title": "Dr.",
    "salutation": "Herr",
    "firstname": "Max",
    "lastname": "Mustermann",
    "street": "Musterstraße 123",
    "postalcode": "12345",
    "city": "Mustercity",
    "country": "Deutschland",
    "latitude": "-48.62420",
    "longitude": "7.56737",
    "telephone": "+49 12345 6789",
    "mobil": "+49 12345 67890",
    "email": "max.mustermann@gmail.com",
    "codeid": "1",
    "newsletter": true
}'

{
    "visitorid": "110",
    "error": "false"
}

HTTP request

PUT {baseurl}/visitors/{visitorid}

URL Parameters

Parameter	Type	required	Default	Description
visitorid	numeric	true

Parameters

Parameter	Type	required	Default
external	boolean	true	false
codeid	numeric	true
company	string	false
title	string	false
salutation	string	false
firstname	string	false
lastname	string	false
street	string	false
postalcode	string	false
city	string	false
country	string	false	Deutschland
telephone	string	false
mobil	string	false
latitude	string	false
longitude	string	false
email	string	false
newsletter	boolean	false	false

Delete visitor

curl --location --request DELETE '{baseurl}/visitors/{visitorid}' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: {API-Key}' \

{
    "visitorid": "111",
    "error": false,
    "deleted": true
}

HTTP request

DELETE {baseurl}/visitors/{visitorid}

URL Parameters

Parameter	Type	required	Default	Description
visitorid	numeric	true

Parameters

Parameter	Type	required	Default	Description
external	boolean	true	false

Errors

This error section is stored in a separate file in includes/_errors.md. Slate allows you to optionally separate out your docs into many files...just save them to the includes folder and add them to the top of your index.md's frontmatter. Files are included in the order listed.

The Kittn API uses the following error codes:

Error Code	Meaning
400	Bad Request -- Your request is invalid.
401	Unauthorized -- Your API key is wrong.
403	Forbidden -- The request is hidden for administrators only.
404	Not Found -- The specified method could not be found.
405	Method Not Allowed -- You tried to access a function with an invalid method.
406	Not Acceptable -- You requested a format that isn't json.
410	Gone -- The data requested has been removed from our servers.
500	Internal Server Error -- We had a problem with our server. Try again later.
503	Service Unavailable -- We're temporarily offline for maintenance. Please try again later.