Sign in

v1

latestOpenAPI 3.0.32026-07-24198357534.7 KB
Data Model

This endpoint provides a paginated list of DocumentTypes

Retrieves the collection of DocumentType resources.

get/document-types

Query parameters

pageinteger

The collection page number

limitinteger

The number of items per page

paginationboolean

Enable or disable pagination

idstring
id[]string[]
catalogs.idstring
catalogs.id[]string[]
objectType'media' | 'classification' | 'document' | 'link' | 'eav_value' | 'sku'
objectType[]string[]

Response

DocumentType collection

legacyIdinteger
objectTypestring
defaultboolean
hasVariantboolean
idstring

This is the unique identifier of the resource

Example response

[
  {
    "name": {
      "fr-FR": "fr-FR translation",
      "en-US": "en-US translation",
      "<*>": "..."
    },
    "description": {
      "fr-FR": "fr-FR translation",
      "en-US": "en-US translation",
      "<*>": "..."
    },
    "id": "identifier_example"
  }
]