Add Types and Custom Fields to your Project
Use Composable Commerce Types to define the schema for the Custom Fields that commercetools InStore requires.
You must create these Types or extend existing Types with the required Custom Fields.
If you are new to commercetools and don't have existing Types defined, use the sample Terraform scripts provided by your commercetools representative to configure your Project with the required Types and Custom Field definitions.
Including Custom Fields in your Project
To correctly define Custom Fields in your Project, you need to be aware of the InStore requirements for these. InStore relies on the following Composable Commerce resources to function properly:
These resources can be extended using Custom Fields to add the attributes necessary for InStore features. You may need to add more Custom Fields than the defaults.
Ensure that your final Terraform scripts include the following Types and attributes:
| Type Key | InStore field |
|---|---|
| Cart/Order | ORDER_LOCATIONID_FIELD |
| Cart/Order | ORDER_ORDERTYPE_FIELD |
| Cart/Order | ORDER_SEQUENCE_NUMBER_FIELD |
| Cart/Order | ORDER_USERID_FIELD |
| Cart/Order | ORDER_WORKSTATIONID_FIELD |
| Customer | CUSTOMER_PAYMENTACCOUNTIDS_FIELD |
| LineItem | LINEITEM_FULFILLMENT_FIELD |
| LineItem | LINEITEM_ISGIFT_FIELD |
| LineItem | LINEITEM_MISTID_FIELD |
| LineItem | LINEITEM_PRICEOVERRIDEAPPROVER_FIELD |
| LineItem | LINEITEM_PRICEOVERRIDECODE_FIELD |
| LineItem | LINEITEM_PRICEOVERRIDETYPE_FIELD |
| LineItem | LINEITEM_PRICEOVERRIDEVALUE_FIELD |
| LineItem | LINEITEM_PURCHASELINEITEM_ID_FIELD |
| LineItem | LINEITEM_PURCHASEORDERID_FIELD |
| LineItem | LINEITEM_RETURNCOMMENT_FIELD |
| LineItem | LINEITEM_SALESPERSONID_FIELD |
| Payment | PAYMENT_ACCOUNTNAME_FIELD |
| Payment | PAYMENT_ACCOUNTNUMBER_FIELD |
| Payment | PAYMENT_BARCODE_FIELD |
| Payment | PAYMENT_CUSTOMERNUMBER_FIELD |
| Payment | PAYMENT_ISSUERID_FIELD |
| Payment | PAYMENT_MISTID_FIELD |
| Transaction | ORDER_EMAILTRIGGERED_FIELD |
| Transaction | PAYMENT_CASHROUNDING_FIELD |
| Transaction | PAYMENT_MISTID_FIELD |
| Transaction | TRANSACTION_MISTID_FIELD |
To learn more about these attributes, see the required attribute definitions.