Custom Data (Flows)
Use flows resource to extend an existing resource or to create a new resource.
important
Custom names and values prefixed with $ are not supported.
For more information, see the Custom data (Flows) section.
Core and Non-core Flows
The following table describes the differences between core and non-core flows:
| Core Flows | Non-core Flows |
|---|---|
| Extend an existing resource. | Create a new resource. |
| Entries managed automatically by Elastic Path Commerce Cloud. | Create and manage entries manually. |
Requests are sent to the fields endpoint. | Requests are sent to the entries endpoint. |
note
You cannot delete core flows after creating them on API or Commerce Manager.
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 |
|---|---|
accounts | Extend the account object. |
account-members | Extend the account-members object. |
account-memberships | Extend the account-membership object. |
addresses | Extend the address object. |
authentication-realms | Extend the authentication-realms object. |
brands | Extend the brand object. |
carts | Extend the carts object. |
cart_items | Extend the cart_item object. |
categories | Extend the category object. |
collections | Extend the collection object. |
customers | Extend the customer object. |
oidc-profiles | Extend the oidc-profiles object. |
order_items | Extend the order_item object. |
orders | Extend the order object. |
password-profiles | Extend the password-profiles object. |
products | Extend the product object. |
promotions | Extend the promotion. |
user-authentication-info | Extend the user-authentication-info object. |
user-authentication-oidc-profile-info | Extend the user-authentication-oidc-profile-info object. |
user-authentication-password-profile-info | Extend the user-authentication-password-profile-info 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, such as Product Rating, that is applied to an entity. All fields have a type , such as 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.