j
Custom Objects
1.1.0
API Overview
The Custom Objects API lets you manage custom objects in Commerce Cloud.
Overview
Custom objects are instances of custom object types that can hold any business-specific data. Each custom object belongs to an object type and is identified by a unique key attribute.
Custom objects can be scoped globally (organization-level) or to a specific site.
Key Features
- CRUD Operations: Create, read, update, and delete custom objects by object type and key
- Search: Search custom objects using flexible query expressions with pagination and sorting
- Site-Specific Scope: Operate on global or site-specific custom objects via separate endpoints
Searchable Attributes
The following attributes can be used in search queries:
keyValueString- The string key value of the custom object (String)keyValueInteger- The integer key value of the custom object (Integer)creationDate- The creation date of the custom object (Date)lastModified- The last modification date of the custom object (Date)siteId- The site identifier (String)- Any custom attribute
Sortable Attributes
Only searchable attributes can be used in sorting.
Authentication
This API requires OAuth 2.0 authentication with the appropriate scopes:
sfcc.custom-objects- Read access to custom object resourcessfcc.custom-objects.rw- Read and write access to custom object resources
https://{shortCode}.api.commercecloud.salesforce.com/custom-object/custom-objects/v1
DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!
Let us know so we can improve!