custom-objecttype-definitions-HW
Fichero de metadatos SFCC (metadata xmlns) que define los tipos de objetos personalizados (Custom Object Types) del proyecto. Los Custom Objects permiten almacenar datos estructurados fuera de los modelos estándar de SFCC.
Glosario de propiedades
| Propiedad | Valores posibles | Descripción |
|---|---|---|
storage-scope | site / organization | site: datos aislados por site. organization: compartidos entre todos los sites. |
staging-mode | no-staging / source-to-target | no-staging: no se replica entre entornos. source-to-target: se replica de staging a producción. |
retention-days | número | Días que SFCC conserva los registros antes de eliminarlos automáticamente. |
key-definition | — | Atributo que actúa como clave primaria del tipo. |
Resumen de tipos definidos
type-id | Ámbito | Staging | Retención | Clave |
|---|---|---|---|---|
PayPalNewTransactions | site | no-staging | 365 días | orderNo |
StripeWebhookNotifications | organization | no-staging | 3 días | stripeEventId |
productOptions_hk_lens_color | organization | source-to-target | — | optionValueId |
productOptions_hk_lens_treatment | organization | source-to-target | — | optionValueId |
productOptions_hk_lens_type | organization | source-to-target | — | optionValueId |
if_returns_rma | organization | no-staging | — | returnId |
knowledgeArticle | organization | source-to-target | — | id |
Tipos de pago
- PayPalNewTransactions
- StripeWebhookNotifications
PayPal new transaction — registra transacciones creadas a través de la funcionalidad "New Transaction" de PayPal. Alcance por site, retención de 365 días, sin replicación entre entornos.
| Atributo | Tipo | Descripción |
|---|---|---|
orderNo (clave) | string | Número de pedido. |
currencyCode | string | Código de moneda. |
email | string | Email del comprador. |
firstName | string | Nombre del comprador. |
lastName | string | Apellido del comprador. |
orderDate | string | Fecha del pedido. |
orderTotal | string | Total del pedido. |
paymentStatus | string | Estado del pago. |
transactionId | string | ID de la transacción PayPal. |
transactionsHistory | set-of-string | Historial de transacciones asociadas. |
Stripe Webhook Notifications — almacena temporalmente las notificaciones de webhook de Stripe para su procesamiento asíncrono. Retención de solo 3 días — diseñado como almacén transitorio, no como histórico. Alcance de organización.
| Atributo | Tipo | Descripción |
|---|---|---|
stripeEventId (clave) | string | ID del evento Stripe recibido por webhook. |
amount | string | Importe del cargo. |
currency | string | Moneda del cargo. |
dateCreated | string | createdDate del webhook. |
livemode | boolean | true si es producción, false si es test. |
orderId | string | ID del pedido en SFCC. |
siteId | string | ID del site SFCC. |
processingStatus | enum-of-string | Estado de procesamiento del objeto. |
stripeObjectId | string | ID del objeto Stripe (charge o source). |
stripeObjectType | string | Tipo de objeto: "Charge" o "Source". |
stripeSourceId | string | ID del source usado para generar el cargo. |
stripeType | string | Campo type del evento Stripe. |
stripePaymentIntentID | string | ID del Payment Intent de Stripe. |
stripeWebhookData | text | Payload JSON completo del webhook (para troubleshooting). |
Estados de processingStatus:
| Valor | Significado |
|---|---|
PENDING_CHARGE | Pendiente de cobro. |
PROCESS | En proceso. |
PROCESSED | Procesado correctamente. |
FAIL_OR_CANCEL | Fallido o cancelado. |
UNKNOWN | Estado desconocido. |
Tipos de opciones de producto (lentes)
Los tres tipos siguientes extienden las opciones de producto estándar de SFCC para las configuraciones de lentes graduadas. Todos comparten: alcance organization, staging source-to-target, clave optionValueId.
- Lens Color
- Lens Treatment
- Lens Type
productOptions_hk_lens_color — extiende los valores de la opción de producto "Lens Color".
| Atributo | Tipo | Localizable | Descripción |
|---|---|---|---|
optionValueId (clave) | string | — | ID del valor de la opción. |
option_lensId | string | No | ID de la lente. |
option_lensName | string | No | Nombre de la lente. |
option_lensColor | string | Sí | Color de la lente (localizado). |
option_description | text | Sí | Descripción de la opción (localizada). |
option_hideValue | boolean | — | Si true, el valor no se muestra en el carrito ni en el popup de opciones. |
productOptions_hk_lens_treatment — extiende los valores de la opción de producto "Lens Treatment".
| Atributo | Tipo | Localizable | Descripción |
|---|---|---|---|
optionValueId (clave) | string | — | ID del valor de la opción. |
option_lensId | string | No | ID de la lente. |
option_lensName | string | No | Nombre de la lente. |
option_reductionId | string | No | ID de reducción asociado al tratamiento. |
option_description | text | Sí | Descripción de la opción (localizada). |
option_hideValue | boolean | — | Si true, el valor no se muestra en el carrito ni en el popup de opciones. |
productOptions_hk_lens_type — extiende los valores de la opción de producto "Lens Type".
| Atributo | Tipo | Localizable | Descripción |
|---|---|---|---|
optionValueId (clave) | string | — | ID del valor de la opción. |
option_lensId | string | No | ID de la lente. |
option_lensName | string | No | Nombre de la lente. |
option_prescriptionType | string | No | Tipo de prescripción asociada al tipo de lente. |
option_description | text | Sí | Descripción de la opción (localizada). |
option_hideValue | boolean | — | Si true, el valor no se muestra en el carrito ni en el popup de opciones. |
Tipos de operaciones
- if_returns_rma
- knowledgeArticle
iF returns RMA object — almacena las solicitudes de devolución (RMA) gestionadas a través de la integración con iF Returns. Alcance organization, sin staging.
| Atributo | Tipo | Descripción |
|---|---|---|
returnId (clave) | string | ID del return request en formato GUID. |
returnName | string | Nombre en formato RX-ABC (X = número de devolución, ABC = pedido). |
status | enum-of-string | Estado de la solicitud de devolución. |
ecommerceCustomerId | string | ID del cliente en SFCC. |
ecommerceCustomerEmail | string | Email del cliente asociado al pedido. |
ecommerceOrderName | string | Nombre del pedido del que se devuelven artículos. |
dataJson | string | Solicitud de devolución completa en formato JSON. |
Estados de status:
| Valor | Descripción |
|---|---|
PENDING | Solicitud creada, pendiente de procesamiento. |
RECEPTION_IN_PROGRESS | Recepción en curso. |
RECEPTION_COMPLETED | Recepción completada. |
RECEIVED | Artículos recibidos en almacén. |
CHECKED | Artículos verificados. |
CLOSED | Devolución cerrada. |
DISCARDED | Devolución descartada. |
EXPIRED | Solicitud caducada. |
NEEDS_VALIDATION | Requiere validación manual. |
Articulo de conocimiento (Service Cloud) — almacena artículos de la base de conocimiento sincronizados desde Salesforce Service Cloud para su uso en el FAQ o help center. Staging source-to-target, alcance organization.
| Atributo | Tipo | Localizable | Descripción |
|---|---|---|---|
id (clave) | string | — | ID del artículo. |
title | string | Sí | Título del artículo. |
summary | html | Sí | Resumen en HTML. |
question | text | No | Pregunta asociada al artículo. |
details | text | No | Detalle completo del artículo. |
category | enum-of-string | No | Categoría temática. |
index | double | No | Orden de presentación. |
Valores de category:
| Valor | Etiqueta |
|---|---|
orders | Pedidos |
returns_warranty | Devoluciones y garantía |
delivery | Envíos |
payments | Pagos |
promotions | Promociones |
products | Productos |
stores | Tiendas |