Api Endpoints

Access

Endpoints

Metric

apiV1MetricPurchaseintentionPost

POST /api/v1/metric/purchaseintention

Add metric information for the purchase intention.

Description

This endpoint can be used to announce a purchase intension to the system.

Body Parameter
Name Description Required Default Pattern

AddPurchaseIntentionMetric

AddPurchaseIntentionMetric

-
Return Type

Metric

Content Type

  • application/json

Responses
Table 1. HTTP Response Codes
Code Message Datatype

200

OK

Metric

401

Unauthorized

ProblemDetails

403

Forbidden

ProblemDetails

404

Not Found

ErrorMessage

422

Unprocessable Content

ValidationProblem

500

Internal Server Error

ErrorMessageWithId

Product

apiV1ProductGet

GET /api/v1/product

Get all products with pagination.

Description

This endpoint returns a list of products. The list is divided into several queries using pagination. More information about pagination can be found in the header.

Parameters
Query Parameters
Name Description Required Default Pattern

PageNumber

The page number

-

null

PageSize

The page size

-

null
Return Type

array[Product]

Return Header

x-pagination PaginationHeader

Content Type

  • application/json

Responses
Table 2. HTTP Response Codes
Code Message Datatype

200

OK

List[Product]

401

Unauthorized

ProblemDetails

403

Forbidden

ProblemDetails

500

Internal Server Error

ErrorMessageWithId

401

Unauthorized

ProblemDetails

403

Forbidden

ProblemDetails

500

Internal Server Error

ErrorMessageWithId

apiV1ProductIdDeliverytimeGet

GET /api/v1/product/{id}/deliverytime

Get the product delivery time information

Description

This endpoint returns the delivery time for a product. This function is currently an experimental feature.

Parameters
Path Parameters
Name Description Required Default Pattern

id

The id for which the product delivery time should be requested

X

null
Return Type

array[ProductDeliveryTime]

Content Type

  • application/json

Responses
Table 3. HTTP Response Codes
Code Message Datatype

200

OK

List[ProductDeliveryTime]

401

Unauthorized

ProblemDetails

403

Forbidden

ProblemDetails

404

Not Found

ErrorMessage

422

Unprocessable Content

ValidationProblem

500

Internal Server Error

ErrorMessageWithId

apiV1ProductIdGet

GET /api/v1/product/{id}

Get a product by id

Description

This endpoint returns a specific product for a given unique ID.

Parameters
Path Parameters
Name Description Required Default Pattern

id

X

null
Return Type

Product

Content Type

  • application/json

Responses
Table 4. HTTP Response Codes
Code Message Datatype

200

OK

Product

401

Unauthorized

ProblemDetails

403

Forbidden

ProblemDetails

404

Not Found

ErrorMessage

422

Unprocessable Content

ValidationProblem

500

Internal Server Error

ErrorMessageWithId

apiV1ProductInformationGet

GET /api/v1/product/information

Get all product information with pagination.

Description

This endpoint returns a list of short product information. The list is divided into several queries using pagination. More information about pagination can be found in the header.

Parameters
Query Parameters
Name Description Required Default Pattern

PageNumber

The page number

-

null

PageSize

The page size

-

null
Return Type

array[ShortProductInformation]

Return Header

x-pagination PaginationHeader

Content Type

  • application/json

Responses
Table 5. HTTP Response Codes
Code Message Datatype

200

OK

List[ShortProductInformation]

401

Unauthorized

ProblemDetails

403

Forbidden

ProblemDetails

500

Internal Server Error

ErrorMessageWithId

apiV1ProductQueryPost

POST /api/v1/product/query

Queries a product by a number. The number could be a OemNumber or a IamNumber.

Description

This endpoint allows you to search for a product. An OemNumber or a IamNumber can be used as a search parameter.

Parameters
Body Parameter
Name Description Required Default Pattern

QueryByNumber

QueryByNumber

-
Return Type

Product

Content Type

  • application/json

Responses
Table 6. HTTP Response Codes
Code Message Datatype

200

OK

Product

401

Unauthorized

ProblemDetails

403

Forbidden

ProblemDetails

404

Not Found

ErrorMessage

422

Unprocessable Content

ValidationProblem

500

Internal Server Error

ErrorMessageWithId

Resource

apiV1ResourceDownloadIdGet

GET /api/v1/resource/download/{id}

Get the resource content

Description

This endpoint allows downloading a resource file. The parameter is a resource ID of a product. Meta information about the file is returned in the header.

Parameters
Path Parameters
Name Description Required Default Pattern

id

the resource id

X

null
Return Type

[File]

Return Header

ContentHeader

Content Type

  • text/plain

  • application/json

  • text/json

Responses
Table 7. HTTP Response Codes
Code Message Datatype

200

OK

[File]

401

Unauthorized

ProblemDetails

403

Forbidden

ProblemDetails

404

Not Found

ErrorMessage

422

Unprocessable Content

ValidationProblem

500

Internal Server Error

ErrorMessageWithId

Models

AddPurchaseIntentionMetric

The add purchase intention metric

Field Name Required Nullable Type Description Format

IamNumber

X

String

The IamNumber

CustomerInformation

X

[AddPurchaseIntentionMetric_CustomerInformation]

AddPurchaseIntentionMetricCustomerInformation

The customer information

Field Name Required Nullable Type Description Format

Identifier

X

String

The identifier. Use an anonymized identifier

Origin

X

String

The origin

Language

X

String

The language

BooleanValue

This class describes a boolean value

Field Name Required Nullable Type Description Format

Value

Boolean

The value e.g. '5.0'

CustomerInformation

CustomerInformation information

Field Name Required Nullable Type Description Format

Identifier

X

String

The identifier. Use an anonymized identifier

Origin

X

String

The origin

Language

X

String

The language

DownloadableFileResource

Resource as url

Field Name Required Nullable Type Description Format

ResourceId

UUID

Culture specific resource id

uuid

MimeType

X

String

The mime type of the resource

FileName

X

String

The file name

ErrorMessage

Field Name Required Nullable Type Description Format

Status

X

String

Message

X

String

ErrorMessageWithId

Field Name Required Nullable Type Description Format

Status

X

String

Message

X

String

ErrorId

X

String

FileResource

The file resource information. Each file resource could contains culture specific resource files

Field Name Required Nullable Type Description Format

ResourceType

X

String

The resource type

LocalizedResources

X

List of MultiLocaleResource

A list of culture specific resources

Metric

The product metric

Field Name Required Nullable Type Description Format

IamNumber

X

String

The IamNumber

Data

X

[Metric_Data]

CreatedAt

Date

The creation time

date-time

Id

X

String

The product query id

MetricData

The metric base object

Field Name Required Nullable Type Description Format

CustomerInformation

X

[oneOf<CustomerInformation]>

The customer

MultiLocaleResource

The multi locale resource

Field Name Required Nullable Type Description Format

Language

X

String

Language e.g. &quot;US&quot;, &quot;DE&quot;, US-EN&quot;

FileResource

DownloadableFileResource

Title

X

String

The title of the file

MultiLocaleText

The multi locale text

Field Name Required Nullable Type Description Format

Language

X

String

Language e.g. &quot;US&quot;, &quot;DE&quot;, US-EN&quot;

Text

X

String

Culture specific text

NumberValue

The number value

Field Name Required Nullable Type Description Format

Value

Double

The value e.g. '5.0'

double

PhysicalValue

This class describes a physical value

Field Name Required Nullable Type Description Format

Value

Double

The value e.g. '5.0'

double

Unit

X

String

The unit name e.g. 'centimeter'

Quantity

X

String

The quantity name e.g. 'Length'

ProblemDetails

Field Name Required Nullable Type Description Format

type

X

String

title

X

String

status

X

Integer

int32

detail

X

String

instance

X

String

Product

The product, this class is used in the web api

Field Name Required Nullable Type Description Format

Id

X

String

The id of the product

BnrShortText

X

List of [Product_BnrShortText_inner]

The bnr short text contains a short text for different cultures

MaterialShortText

X

List of [Product_BnrShortText_inner]

The material short text could contain a short text for different cultures

IamNumber

X

String

The IAM-Number

Image

DownloadableFileResource

Properties

X

List of [Product_Properties_inner]

The properties of the product

Resources

X

List of FileResource

List of all resources which are available for the product

SparePartInformation

SparePartInformation

ProductBnrShortTextInner

The multi locale text

Field Name Required Nullable Type Description Format

Language

X

String

Language e.g. &quot;US&quot;, &quot;DE&quot;, US-EN&quot;

Text

X

String

Culture specific text

ProductDeliveryTime

ProductDeliveryTime

Field Name Required Nullable Type Description Format

current

X

Integer

Current standard delivery time in working days

int32

planned

X

Integer

Scheduled standard delivery time in working days

int32

maxQuantity

X

Double

Maximum order quantity (for which delivery time is guaranteed)

double

ProductPropertiesInner

This class presents a property. A property could have different value types e.g. NumberValue, TextValue

Field Name Required Nullable Type Description Format

Name

X

String

Property Name

Value

X

[Property_Value]

Property

This class presents a property. A property could have different value types e.g. NumberValue, TextValue

Field Name Required Nullable Type Description Format

Name

X

String

Property Name

Value

X

[Property_Value]

PropertyValue

The value of the property

Field Name Required Nullable Type Description Format

Value

X

String

The value e.g. '5.0'

Unit

X

String

The unit name e.g. 'centimeter'

Quantity

X

String

The quantity name e.g. 'Length'

PurchaseIntentionMetric

PurchaseIntentionMetric

Field Name Required Nullable Type Description Format

CustomerInformation

X

[oneOf<CustomerInformation]>

The customer

QueryByNumber

The query by number class

Field Name Required Nullable Type Description Format

Number

X

String

The expected number. Could be a Oem- or a Iam number

MachineType

X

String

The Machine type

ShortProductInformation

Short product information

Field Name Required Nullable Type Description Format

IamNumber

X

String

The IAM-Number

MaterialShortText

X

String

The material short text could contain a short text for different cultures

SparePart

The spare part

Field Name Required Nullable Type Description Format

IamNumber

X

String

The IamNumber of the spare part

Pos

X

String

The position number

Amount

X

String

The amount of the spare part

BnrShortText

X

List of [Product_BnrShortText_inner]

The Bnr short text could contain a short text for different cultures

MaterialShortText

X

List of [Product_BnrShortText_inner]

The material short text could contain a short text for different cultures

SparePartInformation

SparePartInformation

SparePartInformation

The spare part group

Field Name Required Nullable Type Description Format

SpareParts

X

List of SparePart

The list of all spare parts

InstallationDrawing

DownloadableFileResource

TextValue

This class describes a physical value

Field Name Required Nullable Type Description Format

Value

X

String

The value e.g. '5.0'

ValidationProblem

Field Name Required Nullable Type Description Format

Title

X

String

Status

Integer

int32

Errors

X

Map of [array]

PaginationHeader

Key Type Description

TotalCount

long

The total count of entries.

PageSize

long

The current page size, the page size could be changed by the api if the requested page size greater than maximum page size.

CurrentPage

long

The current page info.

TotalPages

long

The total pages count with the given page size.

HasNext

bool

Is 'true' if there are next pages otherwise 'false'.

HasPrevious

bool

Is 'true' if there are prevoius pages otherwise 'false'.

ContentHeader

Key Type Description

content-disposition

string

Contains information about the filename.

content-length

long

The current page size, the page size could be changed by the api if the requested page size greater than maximum page size.

content-type

string

The mime type of the content.