Service Inventory API

Communication diagram

The diagrams below illustrate communication between the server and the client in Service Inventory model. The example showcases the interaction within the actions performed on the Customer entity.

Response body is in JSON format and is described in getCustomerById section.

The callback request body for POST request in JSON format is described in postCustomerCreateEventListener section.

API

Customer

getCustomerById

GET /customer/{id}

Retrieves a Customer by its ID.

Parameters

Name	In	Type	Required	Description
id	path	string	true	Identifier of the Customer

Responses

Status	Meaning	Description	Schema
200	Success	Customer retrieved successfully	JSON
400	Bad Request	Bad request	JSON
401	Unauthorized	Access token is missing or invalid	JSON
403	Forbidden	Access is forbidden	JSON
404	Not Found	Customer not found	JSON
405	Method Not Allowed	HTTP method is not allowed	JSON
409	Conflict	Conflict occurred while processing	JSON
500	Internal Server Error	Internal server error	JSON

Example Response

200 Response:

{
  "id": "e1d59a8d-7534-40ac-8d87-621468888a17",
  "href": "http://localhost/serviceInventory/api/v1/customer/e1d59a8d-7534-40ac-8d87-621468888a17",
  "name": "string"
}

deleteCustomer

DELETE /customer/{id}

Deletes a Customer entity.

Parameters

Name	In	Type	Required	Description
X-Request-Id	header	string	true	A unique identifier (UUID)
X-Callback-Url	header	string	true	A callback URL
id	path	string	true	Identifier of the Customer

Responses

Status	Meaning	Description	Schema
202	Accepted	Customer deletion accepted	None
400	Bad Request	Bad request	JSON
401	Unauthorized	Access token is missing or invalid	JSON
403	Forbidden	Access is forbidden	JSON
404	Not Found	Customer not found	JSON
405	Method Not Allowed	HTTP method is not allowed	JSON
409	Conflict	Conflict occurred while processing	JSON
500	Internal Server Error	Internal server error	JSON

Example Error Response

{
  "code": "404",
  "reason": "Not Found",
  "message": "string"
}

createCustomer

POST /customer

Creates a Customer.

Parameters

Name	In	Type	Required	Description
X-Request-Id	header	string	true	A unique identifier (UUID)
X-Callback-Url	header	string	true	A callback URL

Request Body

The Customer entity to be created.

Example:

{
  "id": "CRM Customer ID",
  "name": "Name of Customer"
}

Responses

Status	Meaning	Description	Schema
202	Accepted	Customer creation accepted	None
400	Bad Request	Bad request	JSON
401	Unauthorized	Access token is missing or invalid	JSON
403	Forbidden	Access is forbidden	JSON
405	Method Not Allowed	HTTP method is not allowed	JSON
409	Conflict	Conflict occurred while processing	JSON
500	Internal Server Error	Internal server error	JSON

Service

createService

POST /service

Creates a Service entity.

Parameters

Name	In	Type	Required	Description
X-Request-Id	header	string	true	A unique identifier (UUID)
X-Callback-Url	header	string	true	A callback URL

Request Body

The Service entity to be created.

Example:

{
  "category": "cfs",
  "isBundled": false,
  "place": [
    {
      "role": "INSTALLATION_ADDRESS",
      "address": {
        "country": "POLSKA",
        "locality": "GORZÓW WIELKOPOLSKI",
        "localNr": "4",
        "postcode": "66-400",
        "stateOrProvince": "LUBUSKIE",
        "streetName": "KURATOWSKIEJ",
        "streetNr": "43B",
        "streetType": "UL.",
        "type": "INSTALLATION_ADDRESS",
        "city": "GORZÓW WIELKOPOLSKI"
      }
    }
  ],
  "relatedParty": [
    {
      "id": "e1d59a8d-7534-40ac-8d87-621468888a17",
      "role": "OWNER"
    }
  ],
  "serviceCharacteristic": [
    {
      "name": "servedOperator",
      "value": "4"
    },
    {
      "name": "technology",
      "value": "FTTH"
    }
  ],
  "serviceRelationship": [
    {
      "relationshipType": "DEPENDS_ON",
      "service": {
        "id": "14768e4e-862c-431c-832a-1a5fd0f34e2d"
      }
    }
  ],
  "serviceSpecification": {
    "id": "CFS_Access",
    "name": "CFS_Access",
    "version": "1.0"
  }
}

Responses

Status	Meaning	Description	Schema
202	Accepted	Service creation accepted	None
400	Bad Request	Bad request	JSON
401	Unauthorized	Access token is missing or invalid	JSON
403	Forbidden	Access is forbidden	JSON
405	Method Not Allowed	HTTP method is not allowed	JSON
409	Conflict	Conflict occurred while processing	JSON
500	Internal Server Error	Internal server error	JSON

getListOrFindServiceObjects

GET /service

Lists or finds Service entities.

Parameters

Name	In	Type	Required	Description
customerId	query	string	true	Query using customerId of service
offset	query	integer	false	Requested index for start of resources in response
limit	query	integer	false	Requested number of resources in response

Responses

Status	Meaning	Description	Schema
200	Success	A JSON array of Service objects	List
400	Bad Request	Bad request	JSON
401	Unauthorized	Access token is missing or invalid	JSON
403	Forbidden	Access is forbidden	JSON
404	Not Found	No matching Service objects found	JSON
405	Method Not Allowed	HTTP method is not allowed	JSON
409	Conflict	Conflict occurred while processing	JSON
500	Internal Server Error	Internal server error	JSON

Example Response

200 Response:

[
  {
    "id": "string",
    "href": "string",
    "category": "cfs",
    "description": "string",
    "endDate": "2024-11-21T13:42:01.089Z",
    "isBundle": true,
    "name": "string",
    "serviceDate": "2024-11-21T13:42:01.089Z",
    "startDate": "2024-11-21T13:42:01.089Z",
    "place": [
      {
        "id": "string",
        "name": "string",
        "role": "string",
        "address": {
          "type": "string",
          "community": "string",
          "country": "string",
          "district": "string",
          "internalAddress": "string",
          "latitude": "string",
          "locality": "string",
          "longitude": "string",
          "localNr": "string",
          "postcode": "string",
          "stateOrProvince": "string",
          "streetName": "string",
          "streetType": "string",
          "streetNr": "string",
          "city": "string"
        }
      }
    ],
    "relatedParty": [
      {
        "id": "string",
        "name": "string",
        "role": "string"
      }
    ],
    "serviceCharacteristic": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "serviceRelationship": [
      {
        "relationshipType": "implements",
        "service": {
          "id": "string",
          "href": "string"
        }
      }
    ],
    "serviceSpecification": {
      "id": "string",
      "name": "string",
      "version": "string"
    },
    "state": "created"
  }
]

Headers

Name	Description	Type
X-Total-Count	Total number of items matching criteria	integer
X-Result-Count	Actual number of items returned in response	integer

Responses

Status	Meaning	Description	Schema
200	Success	A JSON array of Service objects	List
400	Bad Request	Bad request	JSON
401	Unauthorized	Access token is missing or invalid	JSON
403	Forbidden	Access is forbidden	JSON
404	Not Found	No matching Service objects found	JSON
405	Method Not Allowed	HTTP method is not allowed	JSON
409	Conflict	Conflict occurred while processing	JSON
500	Internal Server Error	Internal server error	JSON

updateService

PUT /service/{id}

Modifies a Service entity.

Parameters

Name	In	Type	Required	Description
X-Request-Id	header	string	true	A unique identifier (UUID)
X-Callback-Url	header	string	true	A callback URL
id	path	string	true	Identifier of the Service

Request Body

The Service entity to be modified.

Example:

{
  "id": "37bfe36a-c9d5-4554-9897-42a039856e5f",
  "href": "http://localhost/serviceInventory/api/v1/service/37bfe36a-c9d5-4554-9897-42a039856e5f",
  "category": "cfs",
  "isBundled": false,
  "state": "active",
  "place": [
    {
      "role": "INSTALLATION_ADDRESS",
      "address": {
        "country": "POLSKA",
        "locality": "GORZÓW WIELKOPOLSKI",
        "localNr": "4",
        "postcode": "66-400",
        "stateOrProvince": "LUBUSKIE",
        "streetName": "KURATOWSKIEJ",
        "streetNr": "43B",
        "streetType": "UL.",
        "type": "INSTALLATION_ADDRESS",
        "city": "GORZÓW WIELKOPOLSKI"
      }
    }
  ],
  "relatedParty": [
    {
      "id": "e1d59a8d-7534-40ac-8d87-621468888a17",
      "name": "B2O Customer Name",
      "role": "OWNER"
    }
  ],
  "serviceCharacteristic": [
    {
      "name": "servedOperator",
      "value": "4"
    },
    {
      "name": "technology",
      "value": "FTTH"
    }
  ],
  "serviceRelationship": [
    {
      "relationshipType": "DEPENDS_ON",
      "service": {
        "id": "14768e4e-862c-431c-832a-1a5fd0f34e2d"
      }
    }
  ],
  "serviceSpecification": {
    "id": "CFS_Access",
    "name": "CFS_Access",
    "version": "1.0"
  }
}

Responses

Status	Meaning	Description	Schema
202	Accepted	Service modification accepted	None
400	Bad Request	Bad request	JSON
401	Unauthorized	Access token is missing or invalid	JSON
403	Forbidden	Access is forbidden	JSON
405	Method Not Allowed	HTTP method is not allowed	JSON
409	Conflict	Conflict occurred while processing	JSON
500	Internal Server Error	Internal server error	JSON

Extensions

Field	Value
x-codegen-request-body-name	"service"

getServiceById

GET /service/{id}

Retrieves a Service entity by its ID. Attribute selection is enabled for all first-level attributes.

Parameters

Name	In	Type	Required	Description
id	path	string	true	Identifier of the Service

Responses

Status	Meaning	Description	Schema
200	Success	Service retrieved successfully	JSON
400	Bad Request	Bad request	JSON
401	Unauthorized	Access token is missing or invalid	JSON
403	Forbidden	Access is forbidden	JSON
404	Not Found	Service not found	JSON
405	Method Not Allowed	HTTP method is not allowed	JSON
409	Conflict	Conflict occurred while processing	JSON
500	Internal Server Error	Internal server error	JSON

Example Response

200 Response:

{
  "id": "37bfe36a-c9d5-4554-9897-42a039856e5f",
  "href": "http://localhost/serviceInventory/api/v1/service/37bfe36a-c9d5-4554-9897-42a039856e5f",
  "category": "cfs",
  "isBundled": false,
  "state": "active",
  "place": [
    {
      "role": "INSTALLATION_ADDRESS",
      "address": {
        "country": "POLSKA",
        "locality": "GORZÓW WIELKOPOLSKI",
        "localNr": "4",
        "postcode": "66-400",
        "stateOrProvince": "LUBUSKIE",
        "streetName": "KURATOWSKIEJ",
        "streetNr": "43B",
        "streetType": "UL.",
        "type": "INSTALLATION_ADDRESS",
        "city": "GORZÓW WIELKOPOLSKI"
      }
    }
  ],
  "relatedParty": [
    {
      "id": "e1d59a8d-7534-40ac-8d87-621468888a17",
      "name": "B2O Customer Name",
      "role": "OWNER"
    }
  ],
  "serviceCharacteristic": [
    {
      "name": "servedOperator",
      "value": "4"
    },
    {
      "name": "technology",
      "value": "FTTH"
    }
  ],
  "serviceRelationship": [
    {
      "relationshipType": "DEPENDS_ON",
      "service": {
        "id": "14768e4e-862c-431c-832a-1a5fd0f34e2d"
      }
    }
  ],
  "serviceSpecification": {
    "id": "CFS_Access",
    "name": "CFS_Access",
    "version": "1.0"
  }
}

Responses

Status	Meaning	Description	Schema
200	Success	Service retrieved successfully	JSON
400	Bad Request	Bad request	JSON
401	Unauthorized	Access token is missing or invalid	JSON
403	Forbidden	Access is forbidden	JSON
404	Not Found	Service not found	JSON
405	Method Not Allowed	HTTP method is not allowed	JSON
409	Conflict	Conflict occurred while processing	JSON
500	Internal Server Error	Internal server error	JSON

deleteService

DELETE /service/{id}

Deletes a Service entity.

Parameters

Name	In	Type	Required	Description
X-Request-Id	header	string	true	A unique identifier (UUID)
X-Callback-Url	header	string	true	A callback URL
id	path	string	true	Identifier of the Service

Responses

Status	Meaning	Description	Schema
202	Accepted	Service deletion accepted	None
400	Bad Request	Bad request	JSON
401	Unauthorized	Access token is missing or invalid	JSON
403	Forbidden	Access is forbidden	JSON
404	Not Found	Service not found	JSON
405	Method Not Allowed	HTTP method is not allowed	JSON
409	Conflict	Conflict occurred while processing	JSON
500	Internal Server Error	Internal server error	JSON

updateServiceState

PUT /service/{id}/state

Modifies the state of a Service entity.

Parameters

Name	In	Type	Required	Description
X-Request-Id	header	string	true	A unique identifier (UUID)
X-Callback-Url	header	string	true	A callback URL
id	path	string	true	Identifier of the Service

Request Body

The state to be set for the Service.

Example:

{
  "state": "created"
}

Responses

Status	Meaning	Description	Schema
202	Accepted	Service state modification accepted	None
400	Bad Request	Bad request	JSON
401	Unauthorized	Access token is missing or invalid	JSON
403	Forbidden	Access is forbidden	JSON
405	Method Not Allowed	HTTP method is not allowed	JSON
409	Conflict	Conflict occurred while processing	JSON
500	Internal Server Error	Internal server error	JSON

Client API

Customer notification event (callback)

Customer notification event is used to inform about modifications related to customer entity, such as:

Creation
Deletion

postCustomerCreateEventListener

POST /listener/customerCreateEvent

Client listener for entity CustomerCreateEvent.

Parameters

This endpoint has no parameters.

Request Body

The event data to be notified.

Example:

{
  "event": {
    "id": "e1d59a8d-7534-40ac-8d87-621468888a17",
    "href": "http://localhost/serviceInventory/api/v1/customer/e1d59a8d-7534-40ac-8d87-621468888a17",
    "name": "string"
  },
  "eventId": "string",
  "eventTime": "2024-11-21T13:28:44.388Z",
  "eventType": "string",
  "eventResult": "success",
  "correlationId": "string"
}

Responses

Status	Meaning	Description	Schema
201	Notified	Event notification successfully received	None
400	Bad Request	Bad request	None
401	Unauthorized	Access token is missing or invalid	None
403	Forbidden	Access is forbidden	None
404	Not Found	Listener endpoint not found	None
405	Method Not Allowed	HTTP method is not allowed	None
500	Internal Server Error	Internal server error	None

postCustomerCreateEventListener

POST /listener/customerDeleteEvent

Client listener for entity CustomerDeleteEvent.

Parameters

This endpoint has no parameters.

Request Body

The event data to be notified.

Example:

{
  "event": {
    "id": "e1d59a8d-7534-40ac-8d87-621468888a17",
    "href": "http://localhost/serviceInventory/api/v1/customer/e1d59a8d-7534-40ac-8d87-621468888a17",
    "name": "string"
  },
  "eventId": "string",
  "eventTime": "2024-11-21T13:30:49.160Z",
  "eventType": "string",
  "eventResult": "success",
  "correlationId": "string"
}

Responses

Status	Meaning	Description	Schema
201	Notified	Event notification successfully received	None
400	Bad Request	Bad request	None
401	Unauthorized	Access token is missing or invalid	None
403	Forbidden	Access is forbidden	None
404	Not Found	Listener endpoint not found	None
405	Method Not Allowed	HTTP method is not allowed	None
500	Internal Server Error	Internal server error	None

Service notification event (callback)

Service notification event is used to inform about modifications related to service entity, such as:

Creation
Update
State change
Deletion

postServiceCreateEventListener

POST /listener/serviceCreateEvent

Client listener for entity ServiceCreateEvent.

Parameters

This endpoint has no parameters.

Request Body

The event data to be notified.

Example:

{
  "event": {
    "id": "string",
    "href": "string",
    "category": "cfs",
    "description": "string",
    "endDate": "2024-11-21T15:50:01.384Z",
    "isBundle": true,
    "name": "string",
    "serviceDate": "2024-11-21T15:50:01.384Z",
    "startDate": "2024-11-21T15:50:01.384Z",
    "place": [
      {
        "id": "string",
        "name": "string",
        "role": "string",
        "address": {
          "type": "string",
          "community": "string",
          "country": "string",
          "district": "string",
          "internalAddress": "string",
          "latitude": "string",
          "locality": "string",
          "longitude": "string",
          "localNr": "string",
          "postcode": "string",
          "stateOrProvince": "string",
          "streetName": "string",
          "streetType": "string",
          "streetNr": "string",
          "city": "string"
        }
      }
    ],
    "relatedParty": [
      {
        "id": "string",
        "name": "string",
        "role": "string"
      }
    ],
    "serviceCharacteristic": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "serviceRelationship": [
      {
        "relationshipType": "implements",
        "service": {
          "id": "string",
          "href": "string"
        }
      }
    ],
    "serviceSpecification": {
      "id": "string",
      "name": "string",
      "version": "string"
    },
    "state": "created"
  },
  "eventId": "string",
  "eventTime": "2024-11-21T15:50:01.385Z",
  "eventType": "string",
  "eventResult": "success",
  "correlationId": "string"
}

Responses

Status	Meaning	Description	Schema
201	Notified	Event notification successfully received	None
400	Bad Request	Bad request	None
401	Unauthorized	Access token is missing or invalid	None
403	Forbidden	Access is forbidden	None
404	Not Found	Listener endpoint not found	None
405	Method Not Allowed	HTTP method is not allowed	None
500	Internal Server Error	Internal server error	None

Extensions

Field	Value
x-codegen-request-body-name	"data"

postServiceChangeEventListener

POST /listener/serviceChangeEvent

Client listener for entity ServiceAttributeValueChangeEvent.

Parameters

This endpoint has no parameters.

Request Body

The event data to be notified.

Example:

{
  "event": {
    "id": "string",
    "href": "string",
    "category": "cfs",
    "description": "string",
    "endDate": "2024-11-21T15:52:45.241Z",
    "isBundle": true,
    "name": "string",
    "serviceDate": "2024-11-21T15:52:45.241Z",
    "startDate": "2024-11-21T15:52:45.241Z",
    "place": [
      {
        "id": "string",
        "name": "string",
        "role": "string",
        "address": {
          "type": "string",
          "community": "string",
          "country": "string",
          "district": "string",
          "internalAddress": "string",
          "latitude": "string",
          "locality": "string",
          "longitude": "string",
          "localNr": "string",
          "postcode": "string",
          "stateOrProvince": "string",
          "streetName": "string",
          "streetType": "string",
          "streetNr": "string",
          "city": "string"
        }
      }
    ],
    "relatedParty": [
      {
        "id": "string",
        "name": "string",
        "role": "string"
      }
    ],
    "serviceCharacteristic": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "serviceRelationship": [
      {
        "relationshipType": "implements",
        "service": {
          "id": "string",
          "href": "string"
        }
      }
    ],
    "serviceSpecification": {
      "id": "string",
      "name": "string",
      "version": "string"
    },
    "state": "created"
  },
  "eventId": "string",
  "eventTime": "2024-11-21T15:52:45.241Z",
  "eventType": "string",
  "eventResult": "success",
  "correlationId": "string"
}

Responses

Status	Meaning	Description	Schema
201	Notified	Event notification successfully received	None
400	Bad Request	Bad request	None
401	Unauthorized	Access token is missing or invalid	None
403	Forbidden	Access is forbidden	None
404	Not Found	Listener endpoint not found	None
405	Method Not Allowed	HTTP method is not allowed	None
500	Internal Server Error	Internal server error	None

postServiceStateChangeEvent

POST /listener/serviceStateChangeEvent

Client listener for entity ServiceStateChangeEvent.

Parameters

This endpoint has no parameters.

Request Body

The event data to be notified.

Example:

{
  "event": {
    "id": "string",
    "href": "string",
    "category": "cfs",
    "description": "string",
    "endDate": "2024-11-21T15:57:30.815Z",
    "isBundle": true,
    "name": "string",
    "serviceDate": "2024-11-21T15:57:30.815Z",
    "startDate": "2024-11-21T15:57:30.815Z",
    "place": [
      {
        "id": "string",
        "name": "string",
        "role": "string",
        "address": {
          "type": "string",
          "community": "string",
          "country": "string",
          "district": "string",
          "internalAddress": "string",
          "latitude": "string",
          "locality": "string",
          "longitude": "string",
          "localNr": "string",
          "postcode": "string",
          "stateOrProvince": "string",
          "streetName": "string",
          "streetType": "string",
          "streetNr": "string",
          "city": "string"
        }
      }
    ],
    "relatedParty": [
      {
        "id": "string",
        "name": "string",
        "role": "string"
      }
    ],
    "serviceCharacteristic": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "serviceRelationship": [
      {
        "relationshipType": "implements",
        "service": {
          "id": "string",
          "href": "string"
        }
      }
    ],
    "serviceSpecification": {
      "id": "string",
      "name": "string",
      "version": "string"
    },
    "state": "created"
  },
  "eventId": "string",
  "eventTime": "2024-11-21T15:57:30.815Z",
  "eventType": "string",
  "eventResult": "success",
  "correlationId": "string"
}

Responses

Status	Meaning	Description	Schema
201	Notified	Event notification successfully received	None
400	Bad Request	Bad request	None
401	Unauthorized	Access token is missing or invalid	None
403	Forbidden	Access is forbidden	None
404	Not Found	Listener endpoint not found	None
405	Method Not Allowed	HTTP method is not allowed	None
500	Internal Server Error	Internal server error	None

postServiceDeleteEvent

POST /listener/serviceDeleteEvent

Client listener for entity ServiceDeleteEvent.

Parameters

This endpoint has no parameters.

Request Body

The event data to be notified.

Example:

{
  "event": {
    "id": "string",
    "href": "string",
    "category": "cfs",
    "description": "string",
    "endDate": "2024-11-21T16:04:11.977Z",
    "isBundle": true,
    "name": "string",
    "serviceDate": "2024-11-21T16:04:11.977Z",
    "startDate": "2024-11-21T16:04:11.977Z",
    "place": [
      {
        "id": "string",
        "name": "string",
        "role": "string",
        "address": {
          "type": "string",
          "community": "string",
          "country": "string",
          "district": "string",
          "internalAddress": "string",
          "latitude": "string",
          "locality": "string",
          "longitude": "string",
          "localNr": "string",
          "postcode": "string",
          "stateOrProvince": "string",
          "streetName": "string",
          "streetType": "string",
          "streetNr": "string",
          "city": "string"
        }
      }
    ],
    "relatedParty": [
      {
        "id": "string",
        "name": "string",
        "role": "string"
      }
    ],
    "serviceCharacteristic": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "serviceRelationship": [
      {
        "relationshipType": "implements",
        "service": {
          "id": "string",
          "href": "string"
        }
      }
    ],
    "serviceSpecification": {
      "id": "string",
      "name": "string",
      "version": "string"
    },
    "state": "created"
  },
  "eventId": "string",
  "eventTime": "2024-11-21T16:04:11.977Z",
  "eventType": "string",
  "eventResult": "success",
  "correlationId": "string"
}

Schemas

Error

Description: Represents an error response.

Field	Type	Description
code*	string	Error code
reason*	string	Reason for the error
message	string	Additional details

Service

Description: Represents a Service entity.

Field	Type	Description
id	string	Unique identifier of the Service
href	string	Reference URL for the Service
category*	string	Category of the Service
description	string	Service description
endDate	string (date-time)	End date of the Service
isBundle	boolean	Indicates if the Service is a bundle
name	string	Name of the Service
serviceDate	string (date-time)	Service date
startDate	string (date-time)	Start date of the Service
place	Array of Place	Place(s) associated with the Service
relatedParty	Array of RelatedParty	Related parties involved in the Service
serviceCharacteristic	Array of Characteristic	Characteristics of the Service
serviceRelationship	Array of ServiceRelationship	Relationships between Services
serviceSpecification	ServiceSpecification	Specification of the Service
state	ServiceStateType	Lifecycle state of the Service

ServiceStateType

Description: Valid values for the lifecycle state of the service.

Enum Values:

created
active
suspended
terminated
in-progress
on-hold
failed
cancelled

Place

Description: Represents a place entity.

Field	Type	Description
id*	string	Unique identifier
name	string	Name of the place
role*	string	Role of the place
address	Address	Address of the place

Address

Description: Object representing an Address.

Field	Type	Description
type	string	Address type
community	string	Community
country	string	Country
district	string	District
internalAddress	string	Internal address details
latitude	string	Latitude coordinates
locality	string	Locality
longitude	string	Longitude coordinates
localNr	string	Local number
postcode	string	Postal code
stateOrProvince	string	State or province
streetName	string	Street name
streetType	string	Street type
streetNr	string	Street number
city	string	City

RelatedParty

Description: Represents a related party entity.

Field	Type	Description
id*	string	Unique identifier
name	string	Name of the related party
role*	string	Role of the related party

Characteristic

Description: Describes a characteristic of an object or entity.

Field	Type	Description
name*	string	Name of the characteristic
value*	string	Value of the characteristic

ServiceRef

Description: Reference to a Service.

Field	Type	Description
id*	string	Unique identifier
href	string	Reference URL of the Service

ServiceRelationship

Description: Represents a relationship between Services.

Field	Type	Description
relationshipType*	string	Type of relationship
service*	ServiceRef	Related Service entity

ServiceSpecification

Description: Represents a Service specification.

Field	Type	Description
id*	string	Unique identifier
name	string	Name of the specification
version	string	Version of the specification

ServiceEvent

Description: Represents a Service event.

Field	Type	Description
event	Service	Service details
eventId	string	Unique identifier of the event
eventTime	string (date-time)	Time the event occurred
eventType	string	Type of event
eventResult	string	Result of the event
correlationId	string	Correlation identifier

ErrorEvent

Description: Represents an Error event.

Field	Type	Description
event	Error	Error details
eventId	string	Unique identifier of the event
eventTime	string (date-time)	Time the event occurred
eventType	string	Type of event
eventResult	string	Result of the event
correlationId	string	Correlation identifier

CustomerEvent

Description: Represents a Customer event.

Field	Type	Description
event	Customer	Customer details
eventId	string	Unique identifier of the event
eventTime	string (date-time)	Time the event occurred
eventType	string	Type of event
eventResult	string	Result of the event
correlationId	string	Correlation identifier

Customer

Description: Represents a Customer entity.

Field	Type	Description
id*	string	Unique identifier
href	string	Reference URL of the Customer
name	string	Name of the Customer

Product Inventory API