opportunity.schema.md

XDM Business Opportunity Schema

https://ns.adobe.com/xdm/context/opportunity

XDM Business Opportunity is a standard Experience Data Model (XDM) class that captures the minimum required properties of a business opportunity. This XDM class can only be included in the profile for customers with the B2B or B2P Edition.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	Yes	Stable	No	Forbidden	Permitted	classes/b2b/opportunity.schema.json

Schema Hierarchy

• XDM Business Opportunity https://ns.adobe.com/xdm/context/opportunity
  • Extensibility base schema https://ns.adobe.com/xdm/common/extensible
  • Record Schema https://ns.adobe.com/xdm/data/record
  • B2B Source https://ns.adobe.com/xdm/datatypes/b2b-source
  • External Source System Audit Details https://ns.adobe.com/xdm/common/external-source-system-audit-details
  • Record Status https://ns.adobe.com/xdm/mixins/record-status

XDM Business Opportunity Example

{
  "xdm:opportunityID": "12345",
  "xdm:opportunityName": "Best Buy AEP",
  "xdm:opportunityDescription": "This opportunity is for Best buy customer to buy AEP product",
  "xdm:opportunityType": "business",
  "xdm:stage": "initial"
}

XDM Business Opportunity Properties

Property	Type	Required	Defined by
@id	string	Optional	Record Schema
xdm:accountID	string	Optional	XDM Business Opportunity (this schema)
xdm:accountKey	B2B Source	Optional	XDM Business Opportunity (this schema)
xdm:extSourceSystemAudit	External Source System Audit Attributes	Optional	External Source System Audit Details
xdm:isDeleted	boolean	Optional	Record Status
xdm:opportunityDescription	string	Optional	XDM Business Opportunity (this schema)
xdm:opportunityID	string	Optional	XDM Business Opportunity (this schema)
xdm:opportunityKey	B2B Source	Optional	XDM Business Opportunity (this schema)
xdm:opportunityName	string	Optional	XDM Business Opportunity (this schema)
xdm:opportunityStage	string	Optional	XDM Business Opportunity (this schema)
xdm:opportunityType	string	Optional	XDM Business Opportunity (this schema)
*	any	Additional	this schema allows additional properties

@id

Identifier

A unique identifier for the record.

@id

• is optional
• type: string
• defined in Record Schema

@id Type

string

• format: uri-reference – URI Reference (according to RFC3986)

xdm:accountID

Account ID

Unique ID of the account this opportunity is associated with.

xdm:accountID

• is optional
• type: string
• defined in this schema

xdm:accountID Type

string

xdm:accountKey

Account Key

Unique composite identifier of the account this opportunity is associated with.

xdm:accountKey

• is optional
• type: B2B Source
• defined in this schema

xdm:accountKey Type

• B2B Source – https://ns.adobe.com/xdm/datatypes/b2b-source

xdm:extSourceSystemAudit

External Source System Audit Properties

Audit attributes for external sources.

xdm:extSourceSystemAudit

• is optional
• type: External Source System Audit Attributes
• defined in External Source System Audit Details

xdm:extSourceSystemAudit Type

• External Source System Audit Attributes – https://ns.adobe.com/xdm/common/external-source-system-audit

xdm:isDeleted

Soft Delete Flag

Soft delete flag to indicate if the record is marked for deletion.

xdm:isDeleted

• is optional
• type: boolean
• defined in Record Status

xdm:isDeleted Type

boolean

xdm:opportunityDescription

Opportunity Description

Description of the opportunity.

xdm:opportunityDescription

• is optional
• type: string
• defined in this schema

xdm:opportunityDescription Type

string

xdm:opportunityID

Opportunity ID

Unique ID of the opportunity.

xdm:opportunityID

• is optional
• type: string
• defined in this schema

xdm:opportunityID Type

string

xdm:opportunityKey

Opportunity Key

Unique composite identifier for the Opportunity.

xdm:opportunityKey

• is optional
• type: B2B Source
• defined in this schema

xdm:opportunityKey Type

• B2B Source – https://ns.adobe.com/xdm/datatypes/b2b-source

xdm:opportunityName

Opportunity Name

Name of the opportunity.

xdm:opportunityName

• is optional
• type: string
• defined in this schema

xdm:opportunityName Type

string

xdm:opportunityStage

Opportunity Stage

Sales stage of the opportunity.

xdm:opportunityStage

• is optional
• type: string
• defined in this schema

xdm:opportunityStage Type

string

xdm:opportunityType

Opportunity Type

Type of the opportunity.

xdm:opportunityType

• is optional
• type: string
• defined in this schema

xdm:opportunityType Type

string