Custom Data (Flows)
Create and manage custom data through Flows. Flows allow you to extend an existing or create a new resource.
For more information and links to how-to guides, see Custom data (Flows).
Core vs. non-core Flow
The following table describes the main differences between core and non-core Flows.
| Core Flows | Non-core Flows |
|---|---|
| Extend an existing resource. | Create a new resource. |
| Entries managed automatically by Commerce Cloud. | Need to manually create and manage Entries. |
| Requests are sent to the Fields endpoint. | Requests are sent to the Entries endpoint. |
note
Core flows cannot be deleted after creation, no matter where they were created (API or Dashboard).
Extend a resource
Extending a resource applies only to core flows. When creating a new flow, make sure the slug matches that of a core resource listed in the following table.
Flow slug | Description |
|---|---|
addresses | Extend the address object. |
products | Extend the product object. |
brands | Extend the brand object. |
collections | Extend the collection object. |
categories | Extend the category object. |
customers | Extend the customer object. |
carts | Extend the carts object. |
cart_items | Extend the cart_item object. |
files | Extend the file object. |
orders | Extend the order object. |
order_items | Extend the order_item object. |
promotions | Extend the promotion object. |
Add a new resource
Adding a new resource is applicable only to non-core (custom) flows.
Resource structure
A Flow describes a collection of Fields. It is named after the internal entity type you want to associate it with. For example, a Flow with a slug of products applies to all product responses in your store.
A Field represents a single field of data (for example a Product Rating) to be applied to an entity. All Fields have a type (string, integer, boolean, date or relationship), a default value, and an optional set of validation rules.
An Entry is a specific instance of a Flow, and is associated with a specific instance of an entity (for example, a single product). Use Entries for custom flows (non-core) only. For core flows, these are managed for you.