Add file to product

Authentication
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Operations

Products
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Operations

List products

Request

Security

oauth2

Query

publicinteger

Get public products only

Example: public=1

curl -i -X GET \
  'https://docs.insert.nl/_mock/apis/document/products?public=1' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Paginated set of ProductResource

Bodyapplication/json

dataArray of objects(ProductResource)required

data[].idintegerrequired

data[].websiteURIstringrequired

data[].productCategorystringrequired

data[].subProductCategorystringrequired

data[].projectNumberstring or nullrequired

data[].tradeItemIdentificationobjectrequired

data[].tradeItemIdentification.suppliersTradeItemIdstring or nullrequired

data[].itemDetailsobjectrequired

data[].itemDetails.namestringrequired

data[].itemDetails.productDescriptionArray of items= 1 itemsrequired

data[].itemDetails.productDescription[].[0]object

data[].itemDetails.attachmentobjectrequired

data[].itemDetails.attachment.imageDatastringrequired

data[].itemDetails.attachment.attachedDatastringrequired

data[].physicalDimensionsobjectrequired

data[].physicalDimensions.heightstring or nullrequired

data[].physicalDimensions.widthstring or nullrequired

data[].physicalDimensions.depthstring or nullrequired

data[].physicalDimensions.uoMMeasurementany or string or nullrequired

Any of:

any

data[].quantityobjectrequired

data[].quantity.quantityValuestring or nullrequired

data[].quantity.quantityUoMstring or nullrequired

data[].priceInformationobjectrequired

data[].priceInformation.pricestring or nullrequired

data[].priceInformation.priceBaseobjectrequired

data[].priceInformation.priceBase.VATInformationboolean or nullrequired

data[].priceInformation.priceBase.numberOfUnitsInPriceBasisstring or nullrequired

data[].priceInformation.priceBase.priceOnRequestIndicatorboolean or nullrequired

data[].itemCharacteristicsobjectrequired

data[].itemCharacteristics.technicalQualitystring or nullrequired

data[].itemCharacteristics.aestheticQualitystring or nullrequired

data[].itemCharacteristics.rawMaterialstring or nullrequired

data[].itemCharacteristics.colorstring or nullrequired

data[].validityInformationobjectrequired

data[].validityInformation.statusCodestring or nullrequired

data[].validityInformation.validityStartDatestring or null(date-time)required

data[].validityInformation.validityEndDatestring or null(date-time)required

data[].personobjectrequired

data[].person.personNamestring or nullrequired

data[].person.contactInformationobjectrequired

data[].person.contactInformation.emailAddressstring or nullrequired

data[].addressobjectrequired

data[].address.streetstring or nullrequired

data[].address.postalCodestring or nullrequired

data[].address.citystring or nullrequired

data[].genericEnvironmentalInformationobjectrequired

data[].genericEnvironmentalInformation.co2Reductionstring or nullrequired

data[].genericEnvironmentalInformation.eciResultstring or nullrequired

data[].genericEnvironmentalInformation.mkiNMDidstring or nullrequired

data[].genericEnvironmentalInformation.noxResultstring or nullrequired

linksobjectrequired

links.firststring or nullrequired

links.laststring or nullrequired

links.prevstring or nullrequired

links.nextstring or nullrequired

metaobjectrequired

meta.current_pageintegerrequired

meta.frominteger or nullrequired

meta.last_pageintegerrequired

meta.linksArray of objectsrequired

Generated paginator links.

meta.links[].urlstring or nullrequired

meta.links[].labelstringrequired

meta.links[].activebooleanrequired

meta.pathstring or nullrequired

Base path for paginator generated URLs.

meta.per_pageintegerrequired

Number of items shown per page.

meta.tointeger or nullrequired

Number of the last item in the slice.

meta.totalintegerrequired

Total number of items being paginated.

Response

application/json

{
  "data": [
    { … }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  },
  "meta": {
    "current_page": 0,
    "from": 0,
    "last_page": 0,
    "links": [ … ],
    "path": "string",
    "per_page": 0,
    "to": 0,
    "total": 0
  }
}

Create product

Request

Security

oauth2

Bodyapplication/jsonrequired

productCategorystringrequired

subProductCategorystring or null

projectNumberinteger or null

itemDetailsobject

tradeItemIdentificationobject

physicalDimensionsobject

quantityobject

priceInformationobject

itemCharacteristicsobject

validityInformationobject

personobject

addressobject

genericEnvironmentalInformationobject

curl -i -X POST \
  https://docs.insert.nl/_mock/apis/document/products \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "productCategory": "string",
    "subProductCategory": "string",
    "projectNumber": 0,
    "itemDetails": {
      "name": "string",
      "productDescription": {
        "description": "string",
        "languageCode": "string"
      },
      "attachment": {
        "imageData": "string",
        "attachedData": "string"
      }
    },
    "tradeItemIdentification": {
      "suppliersTradeItemId": "string"
    },
    "physicalDimensions": {
      "height": 0,
      "width": 0,
      "depth": 0,
      "uoMMeasurement": "string"
    },
    "quantity": {
      "quantityValue": 0,
      "quantityUoM": "string"
    },
    "priceInformation": {
      "price": 0,
      "priceBase": {
        "VATInformation": true,
        "numberOfUnitsInPriceBasis": "string",
        "priceOnRequestIndicator": true
      }
    },
    "itemCharacteristics": {
      "technicalQuality": "string",
      "aestheticQuality": "string",
      "rawMaterial": "string",
      "color": "string"
    },
    "validityInformation": {
      "statusCode": "Beschikbaar",
      "validityStartDate": "2019-08-24T14:15:22Z",
      "validityEndDate": "2019-08-24T14:15:22Z"
    },
    "person": {
      "personName": "string",
      "contactInformation": {
        "emailAddress": "user@example.com"
      }
    },
    "address": {
      "street": "string",
      "postalCode": "string",
      "city": "string"
    },
    "genericEnvironmentalInformation": {
      "co2Reduction": 0,
      "eciResult": 0,
      "mkiNMDid": "string",
      "noxResult": 0
    }
  }'

Responses

Bodyapplication/json

idstringrequired

Response

application/json

{
  "id": "string"
}

Update product

Request

Security

oauth2

Path

productintegerrequired

The product ID

Bodyapplication/jsonrequired

productCategorystringrequired

subProductCategorystring or null

itemDetailsobject

tradeItemIdentificationobject

physicalDimensionsobject

quantityobject

priceInformationobject

itemCharacteristicsobject

validityInformationobject

personobject

addressobject

genericEnvironmentalInformationobject

curl -i -X PUT \
  'https://docs.insert.nl/_mock/apis/document/products/{product}/update' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "productCategory": "string",
    "subProductCategory": "string",
    "itemDetails": {
      "name": "string",
      "productDescription": {
        "description": "string",
        "languageCode": "string"
      },
      "attachment": {
        "imageData": "string",
        "attachedData": "string"
      }
    },
    "tradeItemIdentification": {
      "suppliersTradeItemId": "string"
    },
    "physicalDimensions": {
      "height": 0,
      "width": 0,
      "depth": 0,
      "uoMMeasurement": "string"
    },
    "quantity": {
      "quantityValue": 0,
      "quantityUoM": "string"
    },
    "priceInformation": {
      "price": 0,
      "priceBase": {
        "VATInformation": true,
        "numberOfUnitsInPriceBasis": "string",
        "priceOnRequestIndicator": true
      }
    },
    "itemCharacteristics": {
      "technicalQuality": "string",
      "aestheticQuality": "string",
      "rawMaterial": "string",
      "color": "string"
    },
    "validityInformation": {
      "statusCode": "Beschikbaar",
      "validityStartDate": "2019-08-24T14:15:22Z",
      "validityEndDate": "2019-08-24T14:15:22Z"
    },
    "person": {
      "personName": "string",
      "contactInformation": {
        "emailAddress": "user@example.com"
      }
    },
    "address": {
      "street": "string",
      "postalCode": "string",
      "city": "string"
    },
    "genericEnvironmentalInformation": {
      "co2Reduction": 0,
      "eciResult": 0,
      "mkiNMDid": "string",
      "noxResult": 0
    }
  }'

Responses

ProductResource

Bodyapplication/json

dataobject(ProductResource)required

data.idintegerrequired

data.websiteURIstringrequired

data.productCategorystringrequired

data.subProductCategorystringrequired

data.projectNumberstring or nullrequired

data.tradeItemIdentificationobjectrequired

data.tradeItemIdentification.suppliersTradeItemIdstring or nullrequired

data.itemDetailsobjectrequired

data.itemDetails.namestringrequired

data.itemDetails.productDescriptionArray of items= 1 itemsrequired

data.itemDetails.productDescription[].[0]object

data.itemDetails.attachmentobjectrequired

data.itemDetails.attachment.imageDatastringrequired

data.itemDetails.attachment.attachedDatastringrequired

data.physicalDimensionsobjectrequired

data.physicalDimensions.heightstring or nullrequired

data.physicalDimensions.widthstring or nullrequired

data.physicalDimensions.depthstring or nullrequired

data.physicalDimensions.uoMMeasurementany or string or nullrequired

Any of:

any

data.quantityobjectrequired

data.quantity.quantityValuestring or nullrequired

data.quantity.quantityUoMstring or nullrequired

data.priceInformationobjectrequired

data.priceInformation.pricestring or nullrequired

data.priceInformation.priceBaseobjectrequired

data.priceInformation.priceBase.VATInformationboolean or nullrequired

data.priceInformation.priceBase.numberOfUnitsInPriceBasisstring or nullrequired

data.priceInformation.priceBase.priceOnRequestIndicatorboolean or nullrequired

data.itemCharacteristicsobjectrequired

data.itemCharacteristics.technicalQualitystring or nullrequired

data.itemCharacteristics.aestheticQualitystring or nullrequired

data.itemCharacteristics.rawMaterialstring or nullrequired

data.itemCharacteristics.colorstring or nullrequired

data.validityInformationobjectrequired

data.validityInformation.statusCodestring or nullrequired

data.validityInformation.validityStartDatestring or null(date-time)required

data.validityInformation.validityEndDatestring or null(date-time)required

data.personobjectrequired

data.person.personNamestring or nullrequired

data.person.contactInformationobjectrequired

data.person.contactInformation.emailAddressstring or nullrequired

data.addressobjectrequired

data.address.streetstring or nullrequired

data.address.postalCodestring or nullrequired

data.address.citystring or nullrequired

data.genericEnvironmentalInformationobjectrequired

data.genericEnvironmentalInformation.co2Reductionstring or nullrequired

data.genericEnvironmentalInformation.eciResultstring or nullrequired

data.genericEnvironmentalInformation.mkiNMDidstring or nullrequired

data.genericEnvironmentalInformation.noxResultstring or nullrequired

Response

application/json

{
  "data": {
    "id": 0,
    "websiteURI": "string",
    "productCategory": "string",
    "subProductCategory": "string",
    "projectNumber": "string",
    "tradeItemIdentification": { … },
    "itemDetails": { … },
    "physicalDimensions": { … },
    "quantity": { … },
    "priceInformation": { … },
    "itemCharacteristics": { … },
    "validityInformation": { … },
    "person": { … },
    "address": { … },
    "genericEnvironmentalInformation": { … }
  }
}

Archive product

Request

Security

oauth2

Path

productintegerrequired

The product ID

curl -i -X POST \
  'https://docs.insert.nl/_mock/apis/document/products/{product}/archive' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/jsonArray [

string

]

Response

application/json

[]

Add image to product

Request

Security

oauth2

Path

productintegerrequired

The product ID

Bodyapplication/jsonrequired

namestringrequired

srcstringrequired

curl -i -X POST \
  'https://docs.insert.nl/_mock/apis/document/products/{product}/images' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "src": "string"
  }'

Responses

Bodyapplication/jsonArray [

object

]

Response

application/json

[
  null
]

Delete product image

Request

Security

oauth2

Path

productintegerrequired

The product ID

imageIdintegerrequired

curl -i -X DELETE \
  'https://docs.insert.nl/_mock/apis/document/products/{product}/images/{imageId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/jsonArray [

object

]

Response

application/json

[
  null
]