Headers
-
X-Correlation-Id string
Unique identifier to allow referencing a particular transaction or event chain
Minimum length is
1
. -
Accept-Language string
Returns the requested resources translated according to the passed languages (see translatable resources)
Minimum length is
1
.
Body Required
-
externalId string | null
Minimum length is
1
, maximum length is255
. -
active boolean | null
Default value is
true
. -
timeZone string | null
Minimum length is
1
. -
location object | null
Responses
-
201 application/json
Successful operation
-
422 application/json
Business validation failed
LOCATION_GEOCODING_FAILED
LOCATION_TIME_ZONE_RESOLUTION_FAILED
See Error codes
POST /listings
curl \
-X POST https://api.development.pexipengage.com/enterprises/acme/listings \
-H "Content-Type: application/json" \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
-H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002" \
-H "Accept-Language: en *" \
-d '{"externalId":"ABCD1234","active":true,"tags":["string"],"translations":{"name":[{"language":"en","value":"Lorem ipsum"}],"description":[{"language":"en","value":"Lorem ipsum"}]},"timeZone":"Europe/Brussels","location":{"postalCode":"9000","countryCode":"BE","geolocation":{"latitude":51.0479466,"longitude":3.6912248},"translations":{"city":[{"language":"en","value":"Lorem ipsum"}],"state":[{"language":"en","value":"Lorem ipsum"}],"street1":[{"language":"en","value":"Lorem ipsum"}],"street2":[{"language":"en","value":"Lorem ipsum"}]}}}'
Request examples
# Headers
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002
Accept-Language: en *
# Payload
{
"externalId": "ABCD1234",
"active": true,
"tags": [
"string"
],
"translations": {
"name": [
{
"language": "en",
"value": "Lorem ipsum"
}
],
"description": [
{
"language": "en",
"value": "Lorem ipsum"
}
]
},
"timeZone": "Europe/Brussels",
"location": {
"postalCode": "9000",
"countryCode": "BE",
"geolocation": {
"latitude": 51.0479466,
"longitude": 3.6912248
},
"translations": {
"city": [
{
"language": "en",
"value": "Lorem ipsum"
}
],
"state": [
{
"language": "en",
"value": "Lorem ipsum"
}
],
"street1": [
{
"language": "en",
"value": "Lorem ipsum"
}
],
"street2": [
{
"language": "en",
"value": "Lorem ipsum"
}
]
}
}
}
Response examples (201)
{
"data": {
"id": "123",
"name": {
"language": "en",
"value": "Lorem ipsum"
},
"description": {
"language": "en",
"value": "Lorem ipsum"
},
"externalId": "ABCD1234",
"active": true,
"tags": [
"string"
],
"timeZone": "Europe/Brussels",
"createdAt": "2022-08-17T19:05:21.362Z",
"updatedAt": "2022-08-17T19:05:21.362Z",
"deletedAt": "2022-08-17T19:05:21.362Z",
"location": {
"city": {
"language": "en",
"value": "Lorem ipsum"
},
"state": {
"language": "en",
"value": "Lorem ipsum"
},
"street1": {
"language": "en",
"value": "Lorem ipsum"
},
"street2": {
"language": "en",
"value": "Lorem ipsum"
},
"postalCode": "9000",
"countryCode": "BE",
"formattedAddress": "string",
"geolocation": {
"latitude": 51.0479466,
"longitude": 3.6912248
},
"translations": {
"city": [
{
"language": "en",
"value": "Lorem ipsum"
}
],
"state": [
{
"language": "en",
"value": "Lorem ipsum"
}
],
"street1": [
{
"language": "en",
"value": "Lorem ipsum"
}
],
"street2": [
{
"language": "en",
"value": "Lorem ipsum"
}
]
}
},
"translations": {
"name": [
{
"language": "en",
"value": "Lorem ipsum"
}
],
"description": [
{
"language": "en",
"value": "Lorem ipsum"
}
]
}
}
}
Response examples (422)
{
"errors": [
{
"message": "string",
"code": "string",
"type": "string",
"statusCode": "string",
"arguments": {}
}
]
}