Equivalents for a reference
Articles the TecDoc catalogue considers equivalent to the given reference, with the OfficeGest article code of each one that already exists locally. The reference itself is never listed as an equivalent of itself; what it resolved to travels in meta as reference_article_code (the local article, if any) and reference_article_id (its catalogue id, which is what the detail endpoint takes). When the tenant has no TecDoc credentials the answer is an empty list with meta.tecdoc_configured = false, which is how a consumer tells "not configured" from "no equivalents".
In: header
Query Parameters
Article reference to look up in the TecDoc catalogue. Matched against the catalogue article number; spacing is ignored when deciding whether a returned row is the reference itself rather than an equivalent of it.
Response Body
curl -X GET "https://og-tenant1.test:8003/api/v2/stocks/tecdoc/equivalents?reference=string"{
"data": [
{
"article_number": "string",
"article_id": "string",
"article_name": "string",
"brand_name": "string",
"brand_number": "string",
"og_article_code": "string"
}
]
}{
"data": {
"code": "VALIDATION_FAILED",
"message": "The given data was invalid.",
"errors": {
"email": [
"The email field is required."
]
}
},
"meta": {
"trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
}
}{
"data": {
"code": "VALIDATION_FAILED",
"message": "The given data was invalid.",
"errors": {
"email": [
"The email field is required."
]
}
},
"meta": {
"trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
}
}{
"data": {
"code": "VALIDATION_FAILED",
"message": "The given data was invalid.",
"errors": {
"email": [
"The email field is required."
]
}
},
"meta": {
"trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
}
}{
"data": {
"code": "VALIDATION_FAILED",
"message": "The given data was invalid.",
"errors": {
"email": [
"The email field is required."
]
}
},
"meta": {
"trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
}
}