Provides services to obtain batches of product data with incremental updates.
Synchronize Product Information Graph V3
Provides an API to synchronize / query products which have changed since the last sync in the product information graph for the given portal.
GET
JSON
/portals/api/v3/products/changed
Parameters
| Name | Description | Example | |
|---|---|---|---|
|
accessToken
Required
|
Access token for non-public portals. When submitting a user or roles, the respective values need to be considered during the computation of the token. See Authentifizierung for details. | d0765f518ff0cab426dbbd6d467c9967 | |
|
apiToken
Required
|
The ID of the portal's API-Token to use for this request. The API-Token also needs to be considered during the computation of the access token. See Authentifizierung for details. | KJ9M1HEM2KEVRQS2KQFPO2TRS8 | |
|
portal
Required
|
Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page. | 9999999 | |
|
syncStart
Required
|
A date and time that indicates, when the sync was started. | 2022-11-23 10:19:42 | |
|
user
Required
|
User name | john.doe | |
| blocks | A comma-separated string deciding which blocks should be included in the response. The PRICES block is only available in selected portals. | DETAILS,CLASSIFICATIONS,FEATURES,PROPERTIES,TEXTS,IMAGES,ATTACHMENTS,PRICES,RELATIONSHIPS,MEASUREMENTS,PACKAGES | |
| classificationLabelLanguages | The language codes to which classification and feature codes will be translated. No classification labels will be returned if this parameter is not set. | en,de | |
| continuationToken | If the query result is too large for one response, this indicates the id of the product where the next query should continue. If the returned value is "-", the query reached the last block of data and no more products are available. | K58LMG8E9SI5PR9LR8NBHMO9K8 | |
| filterCountry | The country to filter by. Provide a two-letter ISO code. Note that internationalisation is a paid feature that needs to be purchased and enabled separately. | de | |
| filterLanguage | The language to filter by in case of multi language portals. Provide a two-letter ISO code. Note that internationalisation is a paid feature that needs to be purchased and enabled separately. | de | |
| language | Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code. | de | |
| roles | Comma-separated list of roles assigned to the user. Can be omitted if roles are not in use, or if the portal is public. | Heating,Electronics,Top-Customer | |
| supplierNumber | Specifies the number of the supplier to filter by. | 0815 | |
Responses
| Description | Example |
|---|---|
|
200
A list of products.
Content-Type:
application/json
|
{
"success": true,
"error": false,
"products": [
{
"id": "VHPKG8BLQEKO58DKT2LEDD55EC",
"uniqueIdentifier": "b04e82e9fb7c7a4b4cac6201ca2349e8",
"visibleItemNumber": "ST.001.A",
"itemNumber": "ST.001.A",
"gtin": "00012345600012",
"model": "ST 001 A",
"supplierNumber": "1351",
"supplierNumbers": [
"1351, 1352, 1353"
],
"lang": "de",
"countries": [
"de",
"at"
],
"details": {
"productGroup": "product_group_code",
"productGroupName": "product_group_name",
"lifecycle": "ACTIVE",
"brand": {
"id": "DIS0LA5ACOU1IC717VV3I614CS",
"name": "ST Sanitär",
"slogan": "",
"mediumImageUrl": "https://oxomi.com/dasd/cv/tenants/12a92bfe3b2034486fd4aead68919f37/tenant-medium/HNO1Q2SULBJG4K7NIA2LCRGQKO.png",
"manufacturerName": "ST Sanitary Inc",
"manufacturerPostalAddress": "ST Sanitary, 69 W 14th St, 10011 New York, US",
"manufacturerElectronicAddress": "st-sanitary@oxomi.local",
"distributorName": "ST Sanitär Europa GmbH",
"distributorPostalAddress": "ST Sanitär, Sanitärstrasse 1, 73630 Remshalden, GERMANY",
"distributorElectronicAddress": "st-sanitaer-eu@oxomi.local"
},
"seriesCode": "ST-CeramX",
"seriesNormalizedCode": "st-ceramx",
"seriesName": "ST-CeramX",
"series": {
"name": "ST-CeramX",
"slogan": "",
"marketingText": "",
"previewImageUrl": "https://oxomi.com/dasd/cv/series/e92f41b798d4c638b98cb5f85fef056c/series-image-medium/4AIFG0TFLD16CTHA6GCBV97HFO.jpg",
"mediumImageUrl": "https://oxomi.com/dasd/p/series/bc6dcf5b301b36734563223c67d5252b/4AIFG0TFLD16CTHA6GCBV97HFO/7N58C0OMOMTP5BM74AKJ34BEH8.jpg"
},
"shortText": "Halbeinbauwaschtisch weiß mit Tisch schwarz",
"previewImageUrl": "https://oxomi.com/dasd/cv/attachments/709ca1f160f101961dd1f4707063439d/product-image-preview/JCBACKBR3GL10V95SFNSMC75U8.jpg",
"mediumImageUrl": "https://oxomi.com/dasd/cv/attachments/2fed30507966c3d484a6a345c1373f61/product-image-medium/JCBACKBR3GL10V95SFNSMC75U8.jpg",
"hdImageUrl": "https://oxomi.com/dasd/cv/attachments/b0dc3031cfbd17b829573a5c59a4a8d9/product-image-hd/JCBACKBR3GL10V95SFNSMC75U8.jpg",
"type": "PRODUCT",
"variantGroup": "WT3690",
"variantPriority": 100,
"variantMaster": {
"filename": "WT3690.png",
"description": "",
"previewImageUrl": "https://oxomi.com/dasd/cv/attachments/709ca1f160f101961dd1f4707063439d/product-image-preview/JCBACKBR3GL10V95SFNSMC75U8.jpg",
"mediumImageUrl": "https://oxomi.com/dasd/cv/attachments/2fed30507966c3d484a6a345c1373f61/product-image-medium/JCBACKBR3GL10V95SFNSMC75U8.jpg",
"hdImageUrl": "https://oxomi.com/dasd/cv/attachments/b0dc3031cfbd17b829573a5c59a4a8d9/product-image-hd/JCBACKBR3GL10V95SFNSMC75U8.jpg",
"previewIsVariantImage": true
},
"orderUnit": "PCE",
"priceQuantity": "1",
"minOrderQuantity": "1",
"orderStep": "1",
"contentUnit": "PCE",
"packageQuantity": "1",
"vat": "FULL_TAXATION"
},
"measurements": {
"length_mm": "600",
"width_mm": "450",
"height_mm": "150",
"weight_kg": "4.5",
"diameter_mm": null,
"volume_cm3": "40500"
},
"classifications": [
{
"classificationSystem": "ETIM-9",
"classificationCode": "EC011550",
"groupCode": "EG017110",
"labels": {
"classificationCode": {
"de": "Waschbecken",
"en": "Washbasin"
},
"groupCode": {
"de": "Sanitärkeramiken",
"en": "(Wastewater) reception devices"
}
}
},
{
"classificationSystem": "CUSTOM",
"classificationCode": "-"
}
],
"features": [
{
"classificationSystem": "CUSTOM",
"code": "Made-To-Order",
"value": "false",
"value2": null,
"unit": null
},
{
"classificationSystem": "ETIM-9",
"code": "EF002169",
"value": "EV000572",
"value2": null,
"unit": null,
"effectiveUnit": null,
"labels": {
"code": {
"de": "Werkstoff",
"en": "Material"
},
"value": {
"de": "Keramik",
"en": "Ceramics"
}
}
},
{
"classificationSystem": "ETIM-9",
"code": "EF020348",
"value": "true",
"value2": null,
"unit": null,
"effectiveUnit": null,
"labels": {
"code": {
"de": "Mit Überlauf",
"en": "With overflow"
},
"value": {
"de": "Ja",
"en": "Yes"
}
}
},
{
"classificationSystem": "ETIM-9",
"code": "EF020710",
"value": "4",
"value2": null,
"unit": null,
"effectiveUnit": "EU570448",
"labels": {
"code": {
"de": "Durchmesser Ablaufloch",
"en": "Diameter of drain hole"
},
"effectiveUnit": {
"de": "mm",
"en": "mm"
}
}
}
],
"properties": [
{
"code": "COUNTRY_OF_ORIGIN",
"value": "de",
"value2": null
}
],
"texts": [
{
"type": "DESCRIPTION",
"lang": "de",
"textOriginal": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
}
],
"images": [
{
"type": "COLORED_IMAGE",
"filename": "item_thumbnail_large.jpg",
"priority": 1,
"previewImageUrl": "https://oxomi.com/dasd/cv/attachments/d36c132820dc57343fa350a9c2836cc3/product-image-preview/J4DGE7N3OQQIT64MGU542OE2CG.jpg",
"mediumImageUrl": "https://oxomi.com/dasd/cv/attachments/ff54d388b2af51ff9869be6dcd24f2f0/product-image-medium/J4DGE7N3OQQIT64MGU542OE2CG.jpg",
"hdImageUrl": "https://oxomi.com/dasd/cv/attachments/2d946a64f7d6fc6ba359e269a5c5c260/product-image-hd/J4DGE7N3OQQIT64MGU542OE2CG.jpg"
}
],
"attachments": [
{
"type": "BROCHURE",
"filename": "external_file.pdf",
"url": "https://example.com/external_file.pdf",
"external": true,
"priority": 40
},
{
"type": "INSTALLATION_MANUAL",
"filename": "installation_manual.pdf",
"url": "https://oxomi.com/dasd/pd/attachments/12e1d4314c3afe29e750b72c8c3e9b63/M119BM49VBK9A2I2Q2FGC7MV34/FQ2KDGARVFKADDOE79RN04ADU0/katalog_as_arbeitsschutz_en.pdf",
"external": false,
"priority": 50
}
],
"pricing": {
"discountGroup": "discount_group_code",
"bonusGroup": "bonus_group_code",
"prices": [
{
"type": "LIST_EXCL_VAT",
"amount": "15.00",
"currency": "EUR",
"priceLine": null,
"lowerBound": 1,
"validFrom": "2024-01-01",
"validUntil": null
},
{
"type": "RRP_INCL_VAT",
"amount": "39.99",
"currency": "EUR",
"priceLine": null,
"lowerBound": 1,
"validFrom": "2024-01-01",
"validUntil": null
}
]
},
"relationships": [
{
"type": "ACCESSORY",
"visibleItemNumber": "ST.100.Z",
"priority": 100,
"amount": "1",
"description": "Seifenspender"
},
{
"type": "SPARE_PART",
"visibleItemNumber": "ST.900.S",
"priority": 1,
"amount": "1",
"description": null
}
],
"packages": [
{
"type": "BX",
"description": null,
"gtin": "1234567890123",
"gs128BarCode": "AB-C-DE-F",
"minContents": "1",
"maxContents": "1",
"separable": null,
"measurements": {
"length_mm": "610",
"width_mm": "500",
"height_mm": "200",
"weight_kg": "5.5",
"diameter_mm": null,
"volume_cm3": "61000"
}
},
{
"type": "PF",
"description": "Nur Großhandel",
"gtin": "1234567890124",
"gs128BarCode": null,
"minContents": "20",
"maxContents": "40",
"separable": false,
"measurements": {
"length_mm": "1200",
"width_mm": "800",
"height_mm": "1000",
"weight_kg": "230",
"diameter_mm": null,
"volume_cm3": null
}
}
]
}
],
"continuationToken": "-"
}
Download Schema
|
|
400
Missing parameter or malformed request
Content-Type:
application/json
|
{
"success": false,
"error": true,
"message": "The parameter {missingParameter} must be filled."
}
|
|
401
Authentication required but none provided
Content-Type:
application/json
|
|
|
403
Invalid authentication or missing permission
Content-Type:
application/json
|
|
|
404
Resource not found
Content-Type:
application/json
|
|
|
405
Incorrect request method, e.g. GET instead of POST
Content-Type:
application/json
|
|
|
500
Unexpected server-side error
Content-Type:
application/json
|
Synchronize Product Information Graph V2 Deprecated
Provides an API to synchronize / query products which have changed since the last sync in the product information graph for the given portal.
GET
JSON
/portals/api/v2/products/changed
Parameters
| Name | Description | Example | |
|---|---|---|---|
|
accessToken
Required
|
Access token for non-public portals. When submitting a user or roles, the respective values need to be considered during the computation of the token. See Authentifizierung for details. | d0765f518ff0cab426dbbd6d467c9967 | |
|
apiToken
Required
|
The ID of the portal's API-Token to use for this request. The API-Token also needs to be considered during the computation of the access token. See Authentifizierung for details. | KJ9M1HEM2KEVRQS2KQFPO2TRS8 | |
|
portal
Required
|
Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page. | 9999999 | |
|
syncStart
Required
|
A date and time that indicates, when the sync was started. | 2022-11-23 10:19:42 | |
|
user
Required
|
User name | john.doe | |
| blocks | A comma-separated string deciding which blocks should be included in the response. The PRICES block is only available in selected portals. | CLASSIFICATIONS,FEATURES,PROPERTIES,TEXTS,IMAGES,ATTACHMENTS,PRICES | |
| classificationLabelLanguages | The language codes to which classification and feature codes will be translated. No classification labels will be returned if this parameter is not set. | en,de | |
| continuationToken | If the query result is too large for one response, this indicates the id of the product where the next query should continue. If the returned value is "-", the query reached the last block of data and no more products are available. | K58LMG8E9SI5PR9LR8NBHMO9K8 | |
| filterCountry | The country to filter by. Provide a two-letter ISO code. Note that internationalisation is a paid feature that needs to be purchased and enabled separately. | de | |
| filterLanguage | The language to filter by in case of multi language portals. Provide a two-letter ISO code. Note that internationalisation is a paid feature that needs to be purchased and enabled separately. | de | |
| language | Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code. | de | |
| roles | Comma-separated list of roles assigned to the user. Can be omitted if roles are not in use, or if the portal is public. | Heating,Electronics,Top-Customer | |
| supplierNumber | Specifies the number of the supplier to filter by. | 0815 | |
Responses
| Description | Example |
|---|---|
|
200
A list of products.
Content-Type:
application/json
|
{
"success": true,
"error": false,
"products": [
{
"id": "VHPKG8BLQEKO58DKT2LEDD55EC",
"visibleItemNumber": "ST.001.A",
"itemNumber": "ST.001.A",
"gtin": "00012345600012",
"model": "ST 001 A",
"supplierNumber": "1351",
"supplierNumbers": ["1351, 1352, 1353"],
"productGroup": "product_group_code",
"productGroupName": "product_group_name",
"lang": "de",
"countries": ["de", "at"],
"lifecycle": "ACTIVE",
"brand": {
"id": "DIS0LA5ACOU1IC717VV3I614CS",
"name": "ST Sanitär",
"slogan": "",
"mediumImageUrl": "https://oxomi.com/dasd/cv/tenants/12a92bfe3b2034486fd4aead68919f37/tenant-medium/HNO1Q2SULBJG4K7NIA2LCRGQKO.png",
"manufacturerName": "ST Sanitary Inc",
"manufacturerPostalAddress": "ST Sanitary, 69 W 14th St, 10011 New York, US",
"manufacturerElectronicAddress": "st-sanitary@oxomi.local",
"distributorName": "ST Sanitär Europa GmbH",
"distributorPostalAddress": "ST Sanitär, Sanitärstrasse 1, 73630 Remshalden, GERMANY",
"distributorElectronicAddress": "st-sanitaer-eu@oxomi.local"
},
"seriesCode": "ST-CeramX",
"seriesNormalizedCode": "st-ceramx",
"seriesName": "ST-CeramX",
"series": {
"name": "ST-CeramX",
"slogan": "",
"marketingText": "",
"previewImageUrl": "https://oxomi.com/dasd/cv/series/e92f41b798d4c638b98cb5f85fef056c/series-image-medium/4AIFG0TFLD16CTHA6GCBV97HFO.jpg",
"mediumImageUrl": "https://oxomi.com/dasd/p/series/bc6dcf5b301b36734563223c67d5252b/4AIFG0TFLD16CTHA6GCBV97HFO/7N58C0OMOMTP5BM74AKJ34BEH8.jpg"
},
"shortText": "Halbeinbauwaschtisch weiß mit Tisch schwarz",
"type": "PRODUCT",
"variantGroup": "WT3690",
"variantPriority": 100,
"variantMaster": {
"filename": "WT3690.png",
"description": "",
"previewImageUrl": "https://oxomi.com/dasd/cv/attachments/709ca1f160f101961dd1f4707063439d/product-image-preview/JCBACKBR3GL10V95SFNSMC75U8.jpg",
"mediumImageUrl": "https://oxomi.com/dasd/cv/attachments/2fed30507966c3d484a6a345c1373f61/product-image-medium/JCBACKBR3GL10V95SFNSMC75U8.jpg",
"hdImageUrl": "https://oxomi.com/dasd/cv/attachments/b0dc3031cfbd17b829573a5c59a4a8d9/product-image-hd/JCBACKBR3GL10V95SFNSMC75U8.jpg",
"previewIsVariantImage": true
},
"classifications": [
{
"classificationSystem": "ETIM-9",
"classificationCode": "EC011550",
"groupCode": "EG017110",
"labels": {
"classificationCode": {
"de": "Waschbecken",
"en": "Washbasin"
},
"groupCode": {
"de": "Sanitärkeramiken",
"en": "(Wastewater) reception devices"
}
}
},
{
"classificationSystem": "CUSTOM",
"classificationCode": "-"
}
],
"features": [
{
"classificationSystem": "CUSTOM",
"code": "Made-To-Order",
"value": "false",
"value2": null,
"unit": null
},
{
"classificationSystem": "ETIM-9",
"code": "EF002169",
"value": "EV000572",
"value2": null,
"unit": null,
"effectiveUnit": null,
"labels": {
"code": {
"de": "Werkstoff",
"en": "Material"
},
"value": {
"de": "Keramik",
"en": "Ceramics"
}
}
},
{
"classificationSystem": "ETIM-9",
"code": "EF020348",
"value": "true",
"value2": null,
"unit": null,
"effectiveUnit": null,
"labels": {
"code": {
"de": "Mit Überlauf",
"en": "With overflow"
},
"value": {
"de": "Ja",
"en": "Yes"
}
}
},
{
"classificationSystem": "ETIM-9",
"code": "EF020710",
"value": "4",
"value2": null,
"unit": null,
"effectiveUnit": "EU570448",
"labels": {
"code": {
"de": "Durchmesser Ablaufloch",
"en": "Diameter of drain hole"
},
"effectiveUnit": {
"de": "mm",
"en": "mm"
}
}
}
],
"properties": [
{
"code": "COUNTRY_OF_ORIGIN",
"value": "de",
"value2": null
}
],
"texts": [
{
"type": "DESCRIPTION",
"lang": "de",
"textOriginal": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
}
],
"images": [
{
"type": "COLORED_IMAGE",
"filename": "item_thumbnail_large.jpg",
"priority": 1,
"previewImageUrl": "https://oxomi.com/dasd/cv/attachments/d36c132820dc57343fa350a9c2836cc3/product-image-preview/J4DGE7N3OQQIT64MGU542OE2CG.jpg",
"mediumImageUrl": "https://oxomi.com/dasd/cv/attachments/ff54d388b2af51ff9869be6dcd24f2f0/product-image-medium/J4DGE7N3OQQIT64MGU542OE2CG.jpg",
"hdImageUrl": "https://oxomi.com/dasd/cv/attachments/2d946a64f7d6fc6ba359e269a5c5c260/product-image-hd/J4DGE7N3OQQIT64MGU542OE2CG.jpg"
}
],
"attachments": [
{
"type": "BROCHURE",
"filename": "external_file.pdf",
"url": "https://example.com/external_file.pdf"
},
{
"type": "INSTALLATION_MANUAL",
"filename": "installation_manual.pdf",
"url": "https://oxomi.com/dasd/pd/attachments/12e1d4314c3afe29e750b72c8c3e9b63/M119BM49VBK9A2I2Q2FGC7MV34/FQ2KDGARVFKADDOE79RN04ADU0/katalog_as_arbeitsschutz_en.pdf"
}
],
"pricing": {
"discountGroup": "discount_group_code",
"bonusGroup": "bonus_group_code",
"prices": [
{
"type": "LIST_EXCL_VAT",
"amount": "15.00",
"currency": "EUR",
"priceLine": null,
"lowerBound": 1,
"validFrom": "2024-01-01",
"validUntil": null
},
{
"type": "RRP_INCL_VAT",
"amount": "39.99",
"currency": "EUR",
"priceLine": null,
"lowerBound": 1,
"validFrom": "2024-01-01",
"validUntil": null
}
]
}
}
],
"continuationToken": "-"
}
Download Schema
|
|
400
Missing parameter or malformed request
Content-Type:
application/json
|
{
"success": false,
"error": true,
"message": "The parameter {missingParameter} must be filled."
}
|
|
401
Authentication required but none provided
Content-Type:
application/json
|
|
|
403
Invalid authentication or missing permission
Content-Type:
application/json
|
|
|
404
Resource not found
Content-Type:
application/json
|
|
|
405
Incorrect request method, e.g. GET instead of POST
Content-Type:
application/json
|
|
|
500
Unexpected server-side error
Content-Type:
application/json
|
Synchronize Product Information Graph V1 Deprecated
Provides an API to synchronize / query products which have changed since the last sync in the product information graph for the given portal.
GET
JSON
/portals/api/v1/products/changed
Parameters
| Name | Description | Example | |
|---|---|---|---|
|
accessToken
Required
|
Access token for non-public portals. When submitting a user or roles, the respective values need to be considered during the computation of the token. See Authentifizierung for details. | d0765f518ff0cab426dbbd6d467c9967 | |
|
apiToken
Required
|
The ID of the portal's API-Token to use for this request. The API-Token also needs to be considered during the computation of the access token. See Authentifizierung for details. | KJ9M1HEM2KEVRQS2KQFPO2TRS8 | |
|
portal
Required
|
Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page. | 9999999 | |
|
syncStart
Required
|
A date and time that indicates, when the sync was started. | 2022-11-23 10:19:42 | |
|
user
Required
|
User name | john.doe | |
| blocks | A comma-separated string deciding which blocks should be included in the response. | CLASSIFICATIONS,FEATURES,PROPERTIES,TEXTS,IMAGES,ATTACHMENTS | |
| classificationLabelLanguages | The language codes to which classification and feature codes will be translated. No classification labels will be returned if this parameter is not set. | en,de | |
| continuationToken | If the query result is too large for one response, this indicates the id of the product where the next query should continue. If the returned value is "-", the query reached the last block of data and no more products are available. | K58LMG8E9SI5PR9LR8NBHMO9K8 | |
| filterCountry | The country to filter by. Provide a two-letter ISO code. Note that internationalisation is a paid feature that needs to be purchased and enabled separately. | de | |
| filterLanguage | The language to filter by in case of multi language portals. Provide a two-letter ISO code. Note that internationalisation is a paid feature that needs to be purchased and enabled separately. | de | |
| language | Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code. | de | |
| roles | Comma-separated list of roles assigned to the user. Can be omitted if roles are not in use, or if the portal is public. | Heating,Electronics,Top-Customer | |
| supplierNumber | Specifies the number of the supplier to filter by. | 0815 | |
Responses
| Description | Example |
|---|---|
|
200
A list of products.
Content-Type:
application/json
|
{
"success": true,
"error": false,
"products": [
{
"id": "VHPKG8BLQEKO58DKT2LEDD55EC",
"visibleItemNumber": "ST.001.A",
"itemNumber": "ST.001.A",
"gtin": "00012345600012",
"model": "ST 001 A",
"supplierNumber": "1351",
"lang": "de",
"countries": ["de", "at"],
"lifecycle": "ACTIVE",
"brand": {
"id": "DIS0LA5ACOU1IC717VV3I614CS",
"name": "ST Sanitär",
"slogan": "",
"mediumImageUrl": "https://oxomi.com/dasd/cv/tenants/12a92bfe3b2034486fd4aead68919f37/tenant-medium/HNO1Q2SULBJG4K7NIA2LCRGQKO.png",
"manufacturerName": "ST Sanitary Inc",
"manufacturerPostalAddress": "ST Sanitary, 69 W 14th St, 10011 New York, US",
"manufacturerElectronicAddress": "st-sanitary@oxomi.local",
"distributorName": "ST Sanitär Europa GmbH",
"distributorPostalAddress": "ST Sanitär, Sanitärstrasse 1, 73630 Remshalden, GERMANY",
"distributorElectronicAddress": "st-sanitaer-eu@oxomi.local"
},
"seriesCode": "ST-CeramX",
"seriesNormalizedCode": "st-ceramx",
"seriesName": "ST-CeramX",
"series": {
"name": "ST-CeramX",
"slogan": "",
"marketingText": "",
"previewImageUrl": "https://oxomi.com/dasd/cv/series/e92f41b798d4c638b98cb5f85fef056c/series-image-medium/4AIFG0TFLD16CTHA6GCBV97HFO.jpg",
"mediumImageUrl": "https://oxomi.com/dasd/p/series/bc6dcf5b301b36734563223c67d5252b/4AIFG0TFLD16CTHA6GCBV97HFO/7N58C0OMOMTP5BM74AKJ34BEH8.jpg"
},
"shortText": "Halbeinbauwaschtisch weiß mit Tisch schwarz",
"type": "PRODUCT",
"variantGroup": "WT3690",
"variantPriority": 100,
"variantMaster": {
"filename": "WT3690.png",
"description": "",
"previewImageUrl": "https://oxomi.com/dasd/cv/attachments/709ca1f160f101961dd1f4707063439d/product-image-preview/JCBACKBR3GL10V95SFNSMC75U8.jpg",
"mediumImageUrl": "https://oxomi.com/dasd/cv/attachments/2fed30507966c3d484a6a345c1373f61/product-image-medium/JCBACKBR3GL10V95SFNSMC75U8.jpg",
"hdImageUrl": "https://oxomi.com/dasd/cv/attachments/b0dc3031cfbd17b829573a5c59a4a8d9/product-image-hd/JCBACKBR3GL10V95SFNSMC75U8.jpg",
"previewIsVariantImage": true
},
"classifications": [
{
"classificationSystem": "ETIM-9",
"classificationCode": "EC011550",
"groupCode": "EG017110",
"labels": {
"classificationCode": {
"de": "Waschbecken",
"en": "Washbasin"
},
"groupCode": {
"de": "Sanitärkeramiken",
"en": "(Wastewater) reception devices"
}
}
},
{
"classificationSystem": "CUSTOM",
"classificationCode": "-"
}
],
"features": [
{
"classificationSystem": "CUSTOM",
"code": "Made-To-Order",
"value": "false",
"value2": null,
"unit": null
},
{
"classificationSystem": "ETIM-9",
"code": "EF002169",
"value": "EV000572",
"value2": null,
"unit": null,
"effectiveUnit": null,
"labels": {
"code": {
"de": "Werkstoff",
"en": "Material"
},
"value": {
"de": "Keramik",
"en": "Ceramics"
}
}
},
{
"classificationSystem": "ETIM-9",
"code": "EF020348",
"value": "true",
"value2": null,
"unit": null,
"effectiveUnit": null,
"labels": {
"code": {
"de": "Mit Überlauf",
"en": "With overflow"
},
"value": {
"de": "Ja",
"en": "Yes"
}
}
},
{
"classificationSystem": "ETIM-9",
"code": "EF020710",
"value": "4",
"value2": null,
"unit": null,
"effectiveUnit": "EU570448",
"labels": {
"code": {
"de": "Durchmesser Ablaufloch",
"en": "Diameter of drain hole"
},
"effectiveUnit": {
"de": "mm",
"en": "mm"
}
}
}
],
"properties": [
{
"code": "COUNTRY_OF_ORIGIN",
"value": "de",
"value2": null
}
],
"texts": [
{
"type": "DESCRIPTION",
"lang": "de",
"textOriginal": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
}
],
"image": [
{
"type": "COLORED_IMAGE",
"filename": "item_thumbnail_large.jpg",
"priority": 1,
"previewImageUrl": "https://oxomi.com/dasd/cv/attachments/d36c132820dc57343fa350a9c2836cc3/product-image-preview/J4DGE7N3OQQIT64MGU542OE2CG.jpg",
"mediumImageUrl": "https://oxomi.com/dasd/cv/attachments/ff54d388b2af51ff9869be6dcd24f2f0/product-image-medium/J4DGE7N3OQQIT64MGU542OE2CG.jpg",
"hdImageUrl": "https://oxomi.com/dasd/cv/attachments/2d946a64f7d6fc6ba359e269a5c5c260/product-image-hd/J4DGE7N3OQQIT64MGU542OE2CG.jpg"
}
],
"attachments": [
{
"type": "BROCHURE",
"filename": "external_file.pdf",
"url": "https://example.com/external_file.pdf"
},
{
"type": "INSTALLATION_MANUAL",
"filename": "installation_manual.pdf",
"url": "https://oxomi.com/dasd/pd/attachments/12e1d4314c3afe29e750b72c8c3e9b63/M119BM49VBK9A2I2Q2FGC7MV34/FQ2KDGARVFKADDOE79RN04ADU0/katalog_as_arbeitsschutz_en.pdf"
}
]
}
],
"continuationToken": "-"
}
|
|
400
Missing parameter or malformed request
Content-Type:
application/json
|
{
"success": false,
"error": true,
"message": "The parameter {missingParameter} must be filled."
}
|
|
401
Authentication required but none provided
Content-Type:
application/json
|
|
|
403
Invalid authentication or missing permission
Content-Type:
application/json
|
|
|
404
Resource not found
Content-Type:
application/json
|
|
|
405
Incorrect request method, e.g. GET instead of POST
Content-Type:
application/json
|
|
|
500
Unexpected server-side error
Content-Type:
application/json
|
Fetch individual products in SPX format V3
With the provided itemNumber and/or GTIN.
GET
JSON
/portals/api/v3/products/spx
Parameters
| Name | Description | Example | |
|---|---|---|---|
|
accessToken
Required
|
Access token for non-public portals. When submitting a user or roles, the respective values need to be considered during the computation of the token. See Authentifizierung for details. | d0765f518ff0cab426dbbd6d467c9967 | |
|
apiToken
Required
|
The ID of the portal's API-Token to use for this request. The API-Token also needs to be considered during the computation of the access token. See Authentifizierung for details. | KJ9M1HEM2KEVRQS2KQFPO2TRS8 | |
|
portal
Required
|
Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page. | 9999999 | |
|
user
Required
|
User name | john.doe | |
| blocks | A comma-separated string deciding which blocks should be included in the response. The PRICES block is only available in selected portals. | DETAILS,CLASSIFICATIONS,FEATURES,PROPERTIES,TEXTS,IMAGES,ATTACHMENTS,PRICES,RELATIONSHIPS,MEASUREMENTS,PACKAGES | |
| classificationLabelLanguages | The language codes to which classification and feature codes will be translated. No classification labels will be returned if this parameter is not set. | en,de | |
| filterCountry | The country to filter by. Provide a two-letter ISO code. Note that internationalisation is a paid feature that needs to be purchased and enabled separately. | de | |
| filterLanguage | The language to filter by in case of multi language portals. Provide a two-letter ISO code. Note that internationalisation is a paid feature that needs to be purchased and enabled separately. | de | |
| gtin | Specifies the GTIN to filter by. Required if no 'itemNumber' is provided. | 00012345600012 | |
| itemNumber | Specifies the item number to filter by. Required if no 'gtin' is provided. | ST.001.A | |
| language | Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code. | de | |
| roles | Comma-separated list of roles assigned to the user. Can be omitted if roles are not in use, or if the portal is public. | Heating,Electronics,Top-Customer | |
| supplierNumber | Specifies the number of the supplier to filter by. | 0815 | |
Responses
| Description | Example |
|---|---|
|
200
A list of products.
Content-Type:
application/json
|
{
"success": true,
"error": false,
"products": [
{
"id": "VHPKG8BLQEKO58DKT2LEDD55EC",
"uniqueIdentifier": "b04e82e9fb7c7a4b4cac6201ca2349e8",
"visibleItemNumber": "ST.001.A",
"itemNumber": "ST.001.A",
"gtin": "00012345600012",
"model": "ST 001 A",
"supplierNumber": "1351",
"supplierNumbers": [
"1351, 1352, 1353"
],
"lang": "de",
"countries": [
"de",
"at"
],
"details": {
"productGroup": "product_group_code",
"productGroupName": "product_group_name",
"lifecycle": "ACTIVE",
"brand": {
"id": "DIS0LA5ACOU1IC717VV3I614CS",
"name": "ST Sanitär",
"slogan": "",
"mediumImageUrl": "https://oxomi.com/dasd/cv/tenants/12a92bfe3b2034486fd4aead68919f37/tenant-medium/HNO1Q2SULBJG4K7NIA2LCRGQKO.png",
"manufacturerName": "ST Sanitary Inc",
"manufacturerPostalAddress": "ST Sanitary, 69 W 14th St, 10011 New York, US",
"manufacturerElectronicAddress": "st-sanitary@oxomi.local",
"distributorName": "ST Sanitär Europa GmbH",
"distributorPostalAddress": "ST Sanitär, Sanitärstrasse 1, 73630 Remshalden, GERMANY",
"distributorElectronicAddress": "st-sanitaer-eu@oxomi.local"
},
"seriesCode": "ST-CeramX",
"seriesNormalizedCode": "st-ceramx",
"seriesName": "ST-CeramX",
"series": {
"name": "ST-CeramX",
"slogan": "",
"marketingText": "",
"previewImageUrl": "https://oxomi.com/dasd/cv/series/e92f41b798d4c638b98cb5f85fef056c/series-image-medium/4AIFG0TFLD16CTHA6GCBV97HFO.jpg",
"mediumImageUrl": "https://oxomi.com/dasd/p/series/bc6dcf5b301b36734563223c67d5252b/4AIFG0TFLD16CTHA6GCBV97HFO/7N58C0OMOMTP5BM74AKJ34BEH8.jpg"
},
"shortText": "Halbeinbauwaschtisch weiß mit Tisch schwarz",
"previewImageUrl": "https://oxomi.com/dasd/cv/attachments/709ca1f160f101961dd1f4707063439d/product-image-preview/JCBACKBR3GL10V95SFNSMC75U8.jpg",
"mediumImageUrl": "https://oxomi.com/dasd/cv/attachments/2fed30507966c3d484a6a345c1373f61/product-image-medium/JCBACKBR3GL10V95SFNSMC75U8.jpg",
"hdImageUrl": "https://oxomi.com/dasd/cv/attachments/b0dc3031cfbd17b829573a5c59a4a8d9/product-image-hd/JCBACKBR3GL10V95SFNSMC75U8.jpg",
"type": "PRODUCT",
"variantGroup": "WT3690",
"variantPriority": 100,
"variantMaster": {
"filename": "WT3690.png",
"description": "",
"previewImageUrl": "https://oxomi.com/dasd/cv/attachments/709ca1f160f101961dd1f4707063439d/product-image-preview/JCBACKBR3GL10V95SFNSMC75U8.jpg",
"mediumImageUrl": "https://oxomi.com/dasd/cv/attachments/2fed30507966c3d484a6a345c1373f61/product-image-medium/JCBACKBR3GL10V95SFNSMC75U8.jpg",
"hdImageUrl": "https://oxomi.com/dasd/cv/attachments/b0dc3031cfbd17b829573a5c59a4a8d9/product-image-hd/JCBACKBR3GL10V95SFNSMC75U8.jpg",
"previewIsVariantImage": true
},
"orderUnit": "PCE",
"priceQuantity": "1",
"minOrderQuantity": "1",
"orderStep": "1",
"contentUnit": "PCE",
"packageQuantity": "1",
"vat": "FULL_TAXATION"
},
"measurements": {
"length_mm": "600",
"width_mm": "450",
"height_mm": "150",
"weight_kg": "4.5",
"diameter_mm": null,
"volume_cm3": "40500"
},
"classifications": [
{
"classificationSystem": "ETIM-9",
"classificationCode": "EC011550",
"groupCode": "EG017110",
"labels": {
"classificationCode": {
"de": "Waschbecken",
"en": "Washbasin"
},
"groupCode": {
"de": "Sanitärkeramiken",
"en": "(Wastewater) reception devices"
}
}
},
{
"classificationSystem": "CUSTOM",
"classificationCode": "-"
}
],
"features": [
{
"classificationSystem": "CUSTOM",
"code": "Made-To-Order",
"value": "false",
"value2": null,
"unit": null
},
{
"classificationSystem": "ETIM-9",
"code": "EF002169",
"value": "EV000572",
"value2": null,
"unit": null,
"effectiveUnit": null,
"labels": {
"code": {
"de": "Werkstoff",
"en": "Material"
},
"value": {
"de": "Keramik",
"en": "Ceramics"
}
}
},
{
"classificationSystem": "ETIM-9",
"code": "EF020348",
"value": "true",
"value2": null,
"unit": null,
"effectiveUnit": null,
"labels": {
"code": {
"de": "Mit Überlauf",
"en": "With overflow"
},
"value": {
"de": "Ja",
"en": "Yes"
}
}
},
{
"classificationSystem": "ETIM-9",
"code": "EF020710",
"value": "4",
"value2": null,
"unit": null,
"effectiveUnit": "EU570448",
"labels": {
"code": {
"de": "Durchmesser Ablaufloch",
"en": "Diameter of drain hole"
},
"effectiveUnit": {
"de": "mm",
"en": "mm"
}
}
}
],
"properties": [
{
"code": "COUNTRY_OF_ORIGIN",
"value": "de",
"value2": null
}
],
"texts": [
{
"type": "DESCRIPTION",
"lang": "de",
"textOriginal": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
}
],
"images": [
{
"type": "COLORED_IMAGE",
"filename": "item_thumbnail_large.jpg",
"priority": 1,
"previewImageUrl": "https://oxomi.com/dasd/cv/attachments/d36c132820dc57343fa350a9c2836cc3/product-image-preview/J4DGE7N3OQQIT64MGU542OE2CG.jpg",
"mediumImageUrl": "https://oxomi.com/dasd/cv/attachments/ff54d388b2af51ff9869be6dcd24f2f0/product-image-medium/J4DGE7N3OQQIT64MGU542OE2CG.jpg",
"hdImageUrl": "https://oxomi.com/dasd/cv/attachments/2d946a64f7d6fc6ba359e269a5c5c260/product-image-hd/J4DGE7N3OQQIT64MGU542OE2CG.jpg"
}
],
"attachments": [
{
"type": "BROCHURE",
"filename": "external_file.pdf",
"url": "https://example.com/external_file.pdf",
"external": true,
"priority": 40
},
{
"type": "INSTALLATION_MANUAL",
"filename": "installation_manual.pdf",
"url": "https://oxomi.com/dasd/pd/attachments/12e1d4314c3afe29e750b72c8c3e9b63/M119BM49VBK9A2I2Q2FGC7MV34/FQ2KDGARVFKADDOE79RN04ADU0/katalog_as_arbeitsschutz_en.pdf",
"external": false,
"priority": 50
}
],
"pricing": {
"discountGroup": "discount_group_code",
"bonusGroup": "bonus_group_code",
"prices": [
{
"type": "LIST_EXCL_VAT",
"amount": "15.00",
"currency": "EUR",
"priceLine": null,
"lowerBound": 1,
"validFrom": "2024-01-01",
"validUntil": null
},
{
"type": "RRP_INCL_VAT",
"amount": "39.99",
"currency": "EUR",
"priceLine": null,
"lowerBound": 1,
"validFrom": "2024-01-01",
"validUntil": null
}
]
},
"relationships": [
{
"type": "ACCESSORY",
"visibleItemNumber": "ST.100.Z",
"priority": 100,
"amount": "1",
"description": "Seifenspender"
},
{
"type": "SPARE_PART",
"visibleItemNumber": "ST.900.S",
"priority": 1,
"amount": "1",
"description": null
}
],
"packages": [
{
"type": "BX",
"description": null,
"gtin": "1234567890123",
"gs128BarCode": "AB-C-DE-F",
"minContents": "1",
"maxContents": "1",
"separable": null,
"measurements": {
"length_mm": "610",
"width_mm": "500",
"height_mm": "200",
"weight_kg": "5.5",
"diameter_mm": null,
"volume_cm3": "61000"
}
},
{
"type": "PF",
"description": "Nur Großhandel",
"gtin": "1234567890124",
"gs128BarCode": null,
"minContents": "20",
"maxContents": "40",
"separable": false,
"measurements": {
"length_mm": "1200",
"width_mm": "800",
"height_mm": "1000",
"weight_kg": "230",
"diameter_mm": null,
"volume_cm3": null
}
}
]
}
],
"continuationToken": "-"
}
Download Schema
|
|
400
Missing parameter or malformed request
Content-Type:
application/json
|
{
"success": false,
"error": true,
"message": "The parameter {missingParameter} must be filled."
}
|
|
401
Authentication required but none provided
Content-Type:
application/json
|
|
|
403
Invalid authentication or missing permission
Content-Type:
application/json
|
|
|
404
Resource not found
Content-Type:
application/json
|
|
|
405
Incorrect request method, e.g. GET instead of POST
Content-Type:
application/json
|
|
|
500
Unexpected server-side error
Content-Type:
application/json
|
Fetch individual products in SPX format V2 Deprecated
With the provided itemNumber and/or GTIN.
GET
JSON
/portals/api/v2/products/spx
Parameters
| Name | Description | Example | |
|---|---|---|---|
|
accessToken
Required
|
Access token for non-public portals. When submitting a user or roles, the respective values need to be considered during the computation of the token. See Authentifizierung for details. | d0765f518ff0cab426dbbd6d467c9967 | |
|
apiToken
Required
|
The ID of the portal's API-Token to use for this request. The API-Token also needs to be considered during the computation of the access token. See Authentifizierung for details. | KJ9M1HEM2KEVRQS2KQFPO2TRS8 | |
|
portal
Required
|
Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page. | 9999999 | |
|
user
Required
|
User name | john.doe | |
| blocks | A comma-separated string deciding which blocks should be included in the response. The PRICES block is only available in selected portals. | CLASSIFICATIONS,FEATURES,PROPERTIES,TEXTS,IMAGES,ATTACHMENTS,PRICES | |
| classificationLabelLanguages | The language codes to which classification and feature codes will be translated. No classification labels will be returned if this parameter is not set. | en,de | |
| filterCountry | The country to filter by. Provide a two-letter ISO code. Note that internationalisation is a paid feature that needs to be purchased and enabled separately. | de | |
| filterLanguage | The language to filter by in case of multi language portals. Provide a two-letter ISO code. Note that internationalisation is a paid feature that needs to be purchased and enabled separately. | de | |
| gtin | Specifies the GTIN to filter by. Required if no 'itemNumber' is provided. | 00012345600012 | |
| itemNumber | Specifies the item number to filter by. Required if no 'gtin' is provided. | ST.001.A | |
| language | Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code. | de | |
| roles | Comma-separated list of roles assigned to the user. Can be omitted if roles are not in use, or if the portal is public. | Heating,Electronics,Top-Customer | |
| supplierNumber | Specifies the number of the supplier to filter by. | 0815 | |
Responses
| Description | Example |
|---|---|
|
200
A list of products.
Content-Type:
application/json
|
{
"success": true,
"error": false,
"products": [
{
"id": "VHPKG8BLQEKO58DKT2LEDD55EC",
"visibleItemNumber": "ST.001.A",
"itemNumber": "ST.001.A",
"gtin": "00012345600012",
"model": "ST 001 A",
"supplierNumber": "1351",
"supplierNumbers": ["1351, 1352, 1353"],
"productGroup": "product_group_code",
"productGroupName": "product_group_name",
"lang": "de",
"countries": ["de", "at"],
"lifecycle": "ACTIVE",
"brand": {
"id": "DIS0LA5ACOU1IC717VV3I614CS",
"name": "ST Sanitär",
"slogan": "",
"mediumImageUrl": "https://oxomi.com/dasd/cv/tenants/12a92bfe3b2034486fd4aead68919f37/tenant-medium/HNO1Q2SULBJG4K7NIA2LCRGQKO.png",
"manufacturerName": "ST Sanitary Inc",
"manufacturerPostalAddress": "ST Sanitary, 69 W 14th St, 10011 New York, US",
"manufacturerElectronicAddress": "st-sanitary@oxomi.local",
"distributorName": "ST Sanitär Europa GmbH",
"distributorPostalAddress": "ST Sanitär, Sanitärstrasse 1, 73630 Remshalden, GERMANY",
"distributorElectronicAddress": "st-sanitaer-eu@oxomi.local"
},
"seriesCode": "ST-CeramX",
"seriesNormalizedCode": "st-ceramx",
"seriesName": "ST-CeramX",
"series": {
"name": "ST-CeramX",
"slogan": "",
"marketingText": "",
"previewImageUrl": "https://oxomi.com/dasd/cv/series/e92f41b798d4c638b98cb5f85fef056c/series-image-medium/4AIFG0TFLD16CTHA6GCBV97HFO.jpg",
"mediumImageUrl": "https://oxomi.com/dasd/p/series/bc6dcf5b301b36734563223c67d5252b/4AIFG0TFLD16CTHA6GCBV97HFO/7N58C0OMOMTP5BM74AKJ34BEH8.jpg"
},
"shortText": "Halbeinbauwaschtisch weiß mit Tisch schwarz",
"type": "PRODUCT",
"variantGroup": "WT3690",
"variantPriority": 100,
"variantMaster": {
"filename": "WT3690.png",
"description": "",
"previewImageUrl": "https://oxomi.com/dasd/cv/attachments/709ca1f160f101961dd1f4707063439d/product-image-preview/JCBACKBR3GL10V95SFNSMC75U8.jpg",
"mediumImageUrl": "https://oxomi.com/dasd/cv/attachments/2fed30507966c3d484a6a345c1373f61/product-image-medium/JCBACKBR3GL10V95SFNSMC75U8.jpg",
"hdImageUrl": "https://oxomi.com/dasd/cv/attachments/b0dc3031cfbd17b829573a5c59a4a8d9/product-image-hd/JCBACKBR3GL10V95SFNSMC75U8.jpg",
"previewIsVariantImage": true
},
"classifications": [
{
"classificationSystem": "ETIM-9",
"classificationCode": "EC011550",
"groupCode": "EG017110",
"labels": {
"classificationCode": {
"de": "Waschbecken",
"en": "Washbasin"
},
"groupCode": {
"de": "Sanitärkeramiken",
"en": "(Wastewater) reception devices"
}
}
},
{
"classificationSystem": "CUSTOM",
"classificationCode": "-"
}
],
"features": [
{
"classificationSystem": "CUSTOM",
"code": "Made-To-Order",
"value": "false",
"value2": null,
"unit": null
},
{
"classificationSystem": "ETIM-9",
"code": "EF002169",
"value": "EV000572",
"value2": null,
"unit": null,
"effectiveUnit": null,
"labels": {
"code": {
"de": "Werkstoff",
"en": "Material"
},
"value": {
"de": "Keramik",
"en": "Ceramics"
}
}
},
{
"classificationSystem": "ETIM-9",
"code": "EF020348",
"value": "true",
"value2": null,
"unit": null,
"effectiveUnit": null,
"labels": {
"code": {
"de": "Mit Überlauf",
"en": "With overflow"
},
"value": {
"de": "Ja",
"en": "Yes"
}
}
},
{
"classificationSystem": "ETIM-9",
"code": "EF020710",
"value": "4",
"value2": null,
"unit": null,
"effectiveUnit": "EU570448",
"labels": {
"code": {
"de": "Durchmesser Ablaufloch",
"en": "Diameter of drain hole"
},
"effectiveUnit": {
"de": "mm",
"en": "mm"
}
}
}
],
"properties": [
{
"code": "COUNTRY_OF_ORIGIN",
"value": "de",
"value2": null
}
],
"texts": [
{
"type": "DESCRIPTION",
"lang": "de",
"textOriginal": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
}
],
"images": [
{
"type": "COLORED_IMAGE",
"filename": "item_thumbnail_large.jpg",
"priority": 1,
"previewImageUrl": "https://oxomi.com/dasd/cv/attachments/d36c132820dc57343fa350a9c2836cc3/product-image-preview/J4DGE7N3OQQIT64MGU542OE2CG.jpg",
"mediumImageUrl": "https://oxomi.com/dasd/cv/attachments/ff54d388b2af51ff9869be6dcd24f2f0/product-image-medium/J4DGE7N3OQQIT64MGU542OE2CG.jpg",
"hdImageUrl": "https://oxomi.com/dasd/cv/attachments/2d946a64f7d6fc6ba359e269a5c5c260/product-image-hd/J4DGE7N3OQQIT64MGU542OE2CG.jpg"
}
],
"attachments": [
{
"type": "BROCHURE",
"filename": "external_file.pdf",
"url": "https://example.com/external_file.pdf"
},
{
"type": "INSTALLATION_MANUAL",
"filename": "installation_manual.pdf",
"url": "https://oxomi.com/dasd/pd/attachments/12e1d4314c3afe29e750b72c8c3e9b63/M119BM49VBK9A2I2Q2FGC7MV34/FQ2KDGARVFKADDOE79RN04ADU0/katalog_as_arbeitsschutz_en.pdf"
}
],
"pricing": {
"discountGroup": "discount_group_code",
"bonusGroup": "bonus_group_code",
"prices": [
{
"type": "LIST_EXCL_VAT",
"amount": "15.00",
"currency": "EUR",
"priceLine": null,
"lowerBound": 1,
"validFrom": "2024-01-01",
"validUntil": null
},
{
"type": "RRP_INCL_VAT",
"amount": "39.99",
"currency": "EUR",
"priceLine": null,
"lowerBound": 1,
"validFrom": "2024-01-01",
"validUntil": null
}
]
}
}
],
"continuationToken": "-"
}
Download Schema
|
|
400
Missing parameter or malformed request
Content-Type:
application/json
|
{
"success": false,
"error": true,
"message": "The parameter {missingParameter} must be filled."
}
|
|
401
Authentication required but none provided
Content-Type:
application/json
|
|
|
403
Invalid authentication or missing permission
Content-Type:
application/json
|
|
|
404
Resource not found
Content-Type:
application/json
|
|
|
405
Incorrect request method, e.g. GET instead of POST
Content-Type:
application/json
|
|
|
500
Unexpected server-side error
Content-Type:
application/json
|
Synchronize Portal API-Token Date
Provides an API to synchronize the sync date of the provided API key to the given date.
GET
JSON
/portals/api/v1/core/update-sync-date
Parameters
| Name | Description | Example | |
|---|---|---|---|
|
accessToken
Required
|
Access token for non-public portals. When submitting a user or roles, the respective values need to be considered during the computation of the token. See Authentifizierung for details. | d0765f518ff0cab426dbbd6d467c9967 | |
|
apiToken
Required
|
The ID of the portal's API-Token to use for this request. The API-Token also needs to be considered during the computation of the access token. See Authentifizierung for details. | KJ9M1HEM2KEVRQS2KQFPO2TRS8 | |
|
date
Required
|
A date and time to which the sync date of the API key should be set to. | 2022-11-23 10:19:42 | |
|
portal
Required
|
Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page. | 9999999 | |
|
user
Required
|
User name | john.doe | |
| language | Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code. | de | |
| roles | Comma-separated list of roles assigned to the user. Can be omitted if roles are not in use, or if the portal is public. | Heating,Electronics,Top-Customer | |
Responses
| Description | Example |
|---|---|
|
200
Successful response
Content-Type:
application/json
|
{
"success": true,
"error": false
}
|
|
400
Missing parameter or malformed request
Content-Type:
application/json
|
{
"success": false,
"error": true,
"message": "The parameter {missingParameter} must be filled."
}
|
|
401
Authentication required but none provided
Content-Type:
application/json
|
|
|
403
Invalid authentication or missing permission
Content-Type:
application/json
|
|
|
404
Resource not found
Content-Type:
application/json
|
|
|
405
Incorrect request method, e.g. GET instead of POST
Content-Type:
application/json
|
|
|
500
Unexpected server-side error
Content-Type:
application/json
|