Object Definitions

GET Get system object types

GET /organizations/{organizationId}/system/object-types

Operation ID: getSystemObjectTypes. Security: AmOAuth2 (sfcc.object-definitions, sfcc.object-definitions.rw).

Retrieves a paginated list of all system object type definitions.

Use the select parameter to specify which properties to include in the response. Use offset and limit for pagination.

Parameters

organizationId (path, OrganizationId, required) An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character realm identifier and a 3-character instance type identifier.
Example
```
f_ecom_zzxy_prd
```
select (query, Select)
Example: select
```
(**)
```
limit (query, integer (int32)) Number of records to retrieve per request. Must be between 1 (minimum) and 200 (maximum). Defaults to 25.
Default: 25. Minimum: 1. Maximum: 200.
offset (query, integer (int32)) Used to retrieve the results based on a particular resource offset.
Default: 0. Minimum: 0.

Responses

200 Successfully returned system object types

Media type: application/json. Schema: ObjectTypeDefinitionResult.

Example: SystemObjectTypeResultExample List of system object types

{
  "limit": 3,
  "offset": 0,
  "total": 85,
  "data": [
    {
      "objectType": "Product",
      "displayName": {
        "default": "Product"
      },
      "description": {
        "default": "Object type representing products."
      },
      "readOnly": false,
      "queryable": false,
      "contentObject": true,
      "attributeDefinitionCount": 166,
      "attributeGroupCount": 8
    },
    {
      "objectType": "Order",
      "displayName": {
        "default": "Order"
      },
      "description": {
        "default": "Object type representing orders."
      },
      "readOnly": false,
      "queryable": true,
      "contentObject": false,
      "attributeDefinitionCount": 120,
      "attributeGroupCount": 5
    },
    {
      "objectType": "Customer",
      "displayName": {
        "default": "Customer"
      },
      "description": {
        "default": "Object type representing customers."
      },
      "readOnly": false,
      "queryable": true,
      "contentObject": false,
      "attributeDefinitionCount": 45,
      "attributeGroupCount": 3
    }
  ]
}

401 Your access token is invalid or expired and can’t be used to identify a user.
Media type: application/problem+json. Schema: ErrorResponse.

Example: UnauthorizedExample
```
{
  "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/unauthorized",
  "title": "Unauthorized",
  "detail": "Unauthorized request"
}
```
403 Forbidden. Your access token is valid, but you don’t have the required permissions to access the resource.
Media type: application/problem+json. Schema: ErrorResponse.

Example: ForbiddenExample
```
{
  "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/forbidden",
  "title": "Forbidden",
  "detail": "Access to requested resource forbidden"
}
```

404 Object Type Not Found

Media type: application/problem+json. Schema: ErrorResponse.

Example: ObjectTypeNotFoundExample

{
  "title": "Object Type Not Found",
  "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/object-type-not-found",
  "detail": "No object type with ID 'InvalidObjectType' could be found.",
  "objectType": "InvalidObjectType"
}