1. Overview
B2ctelco Tmf Webservices Documentation
1.3. Tags
-
ChecklistAction : the checklistAction API
-
Customer Product Inventory : SubscriptionBase management API
-
Delivery Mode : the deliveryMode API
-
Geographic Address Management : Geographic address management API
-
Party Role Management : PartyRole Management API
-
Payment Methods : Payment Methods API
-
Process Type Management : ProcessType Management API
-
Product : the Product API
-
Product Catalog Management : Catalog Management API
-
Product Ordering : Product Ordering API
-
Recommendation : the recommendation API
-
Review : Review API
-
ShoppingCart : the ShoppingCart management API
-
Subscription : the Subscription API
-
UsageConsumptionReport : the UsageConsumptionReport API
2. Security
2.1. oauth2_password
Type : oauth2
Flow : password
Token URL : https://regression-utils.prod.tro.b2c.ydev.hybris.com:9002/authorizationserver/oauth/token
| Name |
|---|
basic |
2.2. oauth2_client_credentials
Type : oauth2
Flow : application
Token URL : https://regression-utils.prod.tro.b2c.ydev.hybris.com:9002/authorizationserver/oauth/token
| Name |
|---|
extended |
3. Resources
3.1. ChecklistAction
the checklistAction API
3.1.1. Retrieve the Checklist Actions for the given context
GET /checklistAction
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
baseSiteId |
Identifier of the BaseSite |
string |
Query |
fields |
Comma separated properties to display in response |
string |
Query |
processType.id |
Purchase Flow for which to retrieve the Checklist Actions |
string |
Query |
productOffering.id |
Product Offering IDs for which to retrieve the Checklist Actions |
< string > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
< ChecklistAction > array |
206 |
Partial Content |
< ChecklistAction > array |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
500 |
Internal Server Error |
3.2. Customer Product Inventory
SubscriptionBase management API
3.2.1. List or find 'SubscriptionBase' objects
GET /subscriptionBase
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body |
string |
Query |
subscriptionAccess.relatedParty.id |
Unique identifier of the Related Party |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
< SubscriptionBase > array |
204 |
No Content |
< SubscriptionBase > array |
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
No Content |
404 |
Not Found |
|
500 |
Internal Server Error |
3.3. Delivery Mode
the deliveryMode API
3.3.1. Retrieves a list of 'DeliveryMode'
GET /deliveryMode
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
baseSiteId |
Identifier of the BaseSite |
string |
Query |
description |
For filtering: Description of deliveryMode |
string |
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body |
string |
Query |
name |
For filtering: Name of deliveryMode |
string |
Query |
relatedParty.id |
Unique identifier of the Related Party |
string |
Query |
shoppingCart.id |
Unique identifier of the Shopping Cart |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
< DeliveryMode > array |
204 |
No Content |
< DeliveryMode > array |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
|
405 |
Method Not Allowed |
|
500 |
Internal Server Error |
3.4. Geographic Address Management
Geographic address management API
3.4.1. Creates a 'Geographic Address'
POST /geographicAddress
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
relatedParty.id |
The id of the related party. |
string |
Body |
geographicAddress |
The 'Geographic Address' Cart to be created |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
405 |
Method Not allowed |
|
409 |
Conflict |
|
500 |
Internal Server Error |
3.4.2. Retrieves a list of 'GeographicAddress'
GET /geographicAddress
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
baseSiteId |
Identifier of the BaseSite |
string |
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body |
string |
Query |
limit |
Requested number of resources to be provided in response requested by client |
string |
Query |
offset |
Requested index for start of resources to be provided in response requested by client |
string |
Query |
relatedParty.id |
Id of a specific party role for which the addresses should be provided |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
< GeographicAddress > array |
400 |
Bad Request List of supported error codes: - 20: Invalid URL parameter value - 21: Missing body - 22: Invalid body - 23: Missing body field - 24: Invalid body field - 25: Missing header - 26: Invalid header value - 27: Missing query-string parameter - 28: Invalid query-string parameter value |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found List of supported error codes: - 60: Resource not found |
|
405 |
Method Not Allowed List of supported error codes: - 61: Method not allowed |
|
422 |
Unprocessable entity Functional error |
|
500 |
Internal Server Error |
3.4.3. Retrieves a 'GeographicAddress' By ID
GET /geographicAddress/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Identifier of the Geographic Address |
string |
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body |
string |
Query |
relatedParty.id |
Id of a specific party role for which the addresses should be provided |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
< GeographicAddress > array |
400 |
Bad Request List of supported error codes: - 20: Invalid URL parameter value - 21: Missing body - 22: Invalid body - 23: Missing body field - 24: Invalid body field - 25: Missing header - 26: Invalid header value - 27: Missing query-string parameter - 28: Invalid query-string parameter value |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found List of supported error codes: - 60: Resource not found |
|
405 |
Method Not Allowed List of supported error codes: - 61: Method not allowed |
|
422 |
Unprocessable entity Functional error |
|
500 |
Internal Server Error |
3.4.4. Deletes a GeographicAddress
DELETE /geographicAddress/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Unique identifier of the geographic address |
string |
Query |
relatedParty.id |
Id of a specific party role for which the addresses should be provided |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
Success |
No Content |
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
405 |
Method Not allowed |
|
409 |
Conflict |
|
500 |
Internal Server Error |
3.4.5. Updates partially a 'GeographicAddress' by Id
PATCH /geographicAddress/{id}
Description
This operation updates an existing geographic address entity for the related party using its unique ID.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Identifier of the GeographicAddress |
string |
Query |
relatedParty.id |
The id of the related party. |
string |
Body |
geographicAddress |
The Geographic Address to be updated |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Updated |
|
204 |
No Content |
No Content |
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
405 |
Method Not allowed |
|
409 |
Conflict |
|
500 |
Internal Server Error |
3.5. Party Role Management
PartyRole Management API
3.5.1. Retrieves a 'PartyRole' by Id
GET /partyRole/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Identifier of the Party Role |
string |
Query |
fields |
Comma separated properties to display in response |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
< PartyRole > array |
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
405 |
Method Not allowed |
|
409 |
Conflict |
|
500 |
Internal Server Error |
3.6. Payment Methods
Payment Methods API
3.6.1. Retrieve a list of payment methods
GET /paymentMethod
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
bankAccount.BIC |
To retrieve the accounts of a specific bank |
string |
Query |
bankAccount.accountNumber |
To retrieve a specific account |
string |
Query |
bankAccount.bank |
To retrieve the accounts of a specific bank |
string |
Query |
bankCard.cardNumber |
To retrieve a specific bank card |
string |
Query |
bankCard.nameOnCard |
To retrieve cards with a specific name |
string |
Query |
bankCard.type |
To retrieve cards of a specific type |
string |
Query |
baseSiteId |
Identifier of the BaseSite |
string |
Query |
bucket |
To retrieve a specific bucket |
string |
Query |
check.bank |
To retrieve checks of a specific bank |
string |
Query |
check.checkId |
To retrieve a specific check |
string |
Query |
digitalWallet.id |
To retrieve a specific digital wallet |
string |
Query |
digitalWallet.service |
To retrieve digital wallets of a specific service |
string |
Query |
fields |
To apply a filter on every resource included in the response. It’s value is a list of comma separated values of the different fields that are requested. |
string |
Query |
limit |
To limit the maximum number of results to be included in the response. The name of query parameter is ‘limit’ and its value is an integer indicating the maximum number of elements to be included in the response. |
integer(int32) |
Query |
loyaltyAccount |
To retrieve a specific loyalty account |
string |
Query |
offset |
To apply an offset in the results to be included in the response. The name of query parameter is ‘offset’ and its value is an integer indicating the offset to be applied. |
integer(int32) |
Query |
relatedParty.id |
To retrieve methods from a specific related party |
string |
Query |
relatedParty.type |
To retrieve methods from a specific related party |
string |
Query |
type |
To retrieve methods of a specific type |
enum (cash, digitalWallet, tokenizedCard, bankAccountTransfer, bankAccountDebit, bankCard, account, bucket, voucher, check, loyaltyAccount, creditCard) |
Query |
voucher.code |
To retrieve voucher with a specific code |
string |
Query |
voucher.id |
To retrieve a specific voucher |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Payment methods retrieved successfully |
< PaymentMethodType > array |
204 |
No Content |
< PaymentMethodType > array |
400 |
Invalid Token |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
405 |
Method not Allowed |
No Content |
500 |
Internal Server Error |
No Content |
3.7. Process Type Management
ProcessType Management API
3.7.1. Returns the list of available process types
GET /processTypeManagement/processType
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
< ProcessType > array |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
|
500 |
Internal Server Error |
3.7.2. Returns the list of available process types for a given customer
GET /processTypeManagement/qualifiedProcessType
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body |
string |
Query |
relatedParty.Id |
The id of the customer for which we request the qualifiedProcessType |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
< QualifiedProcessType > array |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
|
500 |
Internal Server Error |
3.8. Product
the Product API
3.8.1. Retrieve product
GET /product/{productId}
Description
This operation retrieves a product entity. Attribute selection is enabled for all first level attributes. Filtering on sub-resources may be available depending on the compliance level supported by an implementation. Specific business errors for current operation will be encapsulated in HTTP Response 422 Unprocessable entity
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
productId |
Identifier of the Product |
string |
Query |
baseSiteId |
Identifier of the BaseSite |
string |
Query |
fields |
Response configuration. BASIC/FULL/DEFAULT |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
400 |
Bad Request List of supported error codes: - 20: Invalid URL parameter value - 21: Missing body - 22: Invalid body - 23: Missing body field - 24: Invalid body field - 25: Missing header - 26: Invalid header value - 27: Missing query-string parameter - 28: Invalid query-string parameter value |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found List of supported error codes: - 60: Resource not found |
|
405 |
Method Not Allowed List of supported error codes: - 61: Method not allowed |
|
409 |
Conflict The request could not be completed due to a conflict with the current state of the target resource. |
|
422 |
Unprocessable entity Functional error |
|
500 |
Internal Server Error List of supported error codes: - 1: Internal error |
3.9. Product Catalog Management
Catalog Management API
3.9.1. List or find 'Catalog' objects
GET /catalog
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
@baseType |
For filtering: Indicates<b> </b>the base (class) type of this REST resource |
string |
Query |
@schemaLocation |
For filtering: This field provides a link to the schema describing this REST resource |
string |
Query |
@type |
For filtering: Indicates the (class) type of catalog. For entity catalogs, this will be 'EntityCatalog'. |
string |
Query |
baseStore.id |
Identifier of the BaseStore |
string |
Query |
fields |
Comma separated properties to display in response |
string |
Query |
lastUpdate |
For filtering: Date and time of the last update |
string(date-time) |
Query |
lifecycleStatus |
For filtering: Used to indicate the current lifecycle status |
string |
Query |
name |
For filtering: Name of the catalog |
string |
Query |
validFor.endDateTime |
For filtering: An instant of time, ending at the TimePeriod. |
string(date-time) |
Query |
validFor.startDateTime |
For filtering: An instant of time, starting at the TimePeriod |
string(date-time) |
Query |
version |
For filtering: Catalog version |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
< Catalog > array |
204 |
No Content |
< Catalog > array |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
500 |
Internal Server Error |
3.9.2. Retrieves a 'Category' by Id
GET /category/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Identifier of the Category |
string |
Query |
baseSiteId |
Identifier of the BaseSite |
string |
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
< Category > array |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
|
500 |
Internal Server Error |
3.9.3. Retrieves a list of 'ProductOffering'
GET /productOffering
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
@baseType |
For filtering: Immediate base (class) type of the product offering |
string |
Query |
@schemaLocation |
For filtering: A link to the schema describing this product offering |
string |
Query |
@type |
For filtering: Class type of the product offering |
string |
Query |
agreement.@referredType |
For filtering: class type of the referred Agreement |
string |
Query |
agreement.name |
For filtering: Name of the agreement |
string |
Query |
attachment.@baseType |
For filtering: The immediate base class type of the attachment |
string |
Query |
attachment.@schemaLocation |
For filtering: A link to the schema describing this attachment entity |
string |
Query |
attachment.@type |
For filtering: the class type of the Attachment |
string |
Query |
attachment.mimeType |
For filtering: Attachment mime type such as extension file for video, picture and document |
string |
Query |
attachment.type |
For filtering: Attachment type such as video, picture |
string |
Query |
attachment.url |
For filtering: Uniform Resource Locator, is a web page address (a subset of URI) |
string |
Query |
baseSiteId |
Identifier of the BaseSite |
string |
Query |
bundledProductOffering.lifecycleStatus |
For filtering: Used to indicate the current lifecycle status |
string |
Query |
bundledProductOffering.name |
For filtering: Name of the BundledProductOffering |
string |
Query |
category.@referredType |
For filtering: the class type of the referred Category |
string |
Query |
category.name |
For filtering: Name of the category |
string |
Query |
category.version |
For filtering: Category version |
string |
Query |
channel.@referredType |
For filtering: (Class) type of the referred channel like DistributionChannel, SalesChannel and so on |
string |
Query |
channel.name |
For filtering: Name of the channel |
string |
Query |
facetSearchOption.id |
For filtering by facet options. The identifier of the facet search option. |
< string > array(multi) |
Query |
fields |
Comma separated properties to display in response |
string |
Query |
isBundle |
For filtering: isBundle determines whether a productOffering represents a single productOffering (false), or a bundle of productOfferings (true). |
boolean |
Query |
lastUpdate |
For filtering: Date and time of the last update |
string(date-time) |
Query |
lifecycleStatus |
For filtering: Used to indicate the current lifecycle status |
string |
Query |
limit |
Requested number of resources to be provided in response requested by client. |
integer(int32) |
Query |
marketSegment.@referredType |
For filtering: (Class) type of the referred market segment |
string |
Query |
marketSegment.name |
For filtering: Name of the market segment |
string |
Query |
name |
For filtering: Name of the productOffering |
string |
Query |
offeringGroup.id |
For filtering: Id of the productOfferingGroup |
string |
Query |
offset |
Requested index for start of resources to be provided in response requested by client. |
integer(int32) |
Query |
parentBundledProductOffering.id |
For filtering: Id of the parentBundledProductOffering |
string |
Query |
place.@referredType |
For filtering: class type of the referred Place object |
string |
Query |
place.address |
For filtering: A string characterizing an address (for instance a formatted address or an identifier taken from an address database or an address API). |
string |
Query |
place.name |
For filtering: A user-friendly name for the place, such as "Paris Store", "London Store", "Main Home" |
string |
Query |
place.role |
For filtering: Role of the place (for instance: 'home delivery', 'shop retrieval') |
string |
Query |
prodSpecCharValueUse.maxCardinality |
For filtering: The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality. |
integer(int32) |
Query |
prodSpecCharValueUse.minCardinality |
For filtering: The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality. |
integer(int32) |
Query |
prodSpecCharValueUse.name |
For filtering: Name of the associated productSpecCharacteristic |
string |
Query |
prodSpecCharValueUse.valueType |
For filtering: A kind of value that the characteristic can take on, such as numeric, text and so forth |
string |
Query |
productOfferingPrice.@baseType |
For filtering: the immediate base class of product offering price |
string |
Query |
productOfferingPrice.@schemaLocation |
For filtering: hyperlink reference to the product offering price schema |
string |
Query |
productOfferingPrice.@type |
For filtering: The class type of the product offering price |
string |
Query |
productOfferingPrice.isBundle |
For filtering: a flag indicating if this product offering price is bundle (composite) or not |
boolean |
Query |
productOfferingPrice.name |
For filtering: Name of the productOfferingPrice |
string |
Query |
productOfferingPrice.place.id |
For filtering: Identifier of the place for which product offering has prices available |
string |
Query |
productOfferingPrice.priceType |
For filtering: Indicates the price type: recurring, one time, usage |
string |
Query |
productOfferingPrice.recurringChargePeriod |
For filtering: Could be month, week… |
string |
Query |
productOfferingPrice.relatedParty.id |
For filtering: Identifier of the related party for which the price applies. |
string |
Query |
productOfferingPrice.unitOfMeasure |
For filtering: Could be minutes, GB… |
string |
Query |
productOfferingPrice.version |
For filtering: ProductOffering version |
string |
Query |
productOfferingTerm.@schemaLocation |
For filtering: A link to the schema describing this product offering term |
string |
Query |
productOfferingTerm.@type |
For filtering: The class type of ProductOfferingTerm |
string |
Query |
productOfferingTerm.name |
For filtering: Name of the productOfferingTerm |
string |
Query |
productSpecification.@referredType |
For filtering: class type of referred Product Specification |
string |
Query |
productSpecification.name |
For filtering: Name of the product specification |
string |
Query |
productSpecification.version |
For filtering: Version of the product specification |
string |
Query |
resourceCandidate.@referredType |
For filtering: The Class type of referred Resource Candidate |
string |
Query |
resourceCandidate.name |
For filtering: Name of the resource candidate |
string |
Query |
resourceCandidate.version |
For filtering: Version of the resource candidate |
string |
Query |
serviceCandidate.@referredType |
For filtering: The Class type of referred Service Candidate |
string |
Query |
serviceCandidate.name |
For filtering: Name of the service candidate |
string |
Query |
serviceCandidate.version |
For filtering: Version of the service candidate |
string |
Query |
serviceLevelAgreement.@referredType |
For filtering: class type of referred Service Level Agreement |
string |
Query |
serviceLevelAgreement.name |
For filtering: Name of the service level agreement |
string |
Query |
sort |
For sorting: The options the product offerings can be sorted by. |
< string > array(multi) |
Query |
validFor.endDateTime |
For filtering: An instant of time, ending at the TimePeriod. |
string(date-time) |
Query |
validFor.startDateTime |
For filtering: An instant of time, starting at the TimePeriod |
string(date-time) |
Query |
version |
For filtering: ProductOffering version |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
< ProductOffering > array |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
|
405 |
Method Not Allowed |
|
500 |
Internal Server Error |
3.9.4. Retrieves a 'ProductOffering' by Id
GET /productOffering/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Identifier of the Product Offering |
string |
Query |
baseSiteId |
Identifier of the BaseSite |
string |
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body |
string |
Query |
productOfferingPrice.place.id |
Identifier of the place for which product offering has prices available |
string |
Query |
productOfferingPrice.processType.id |
For filtering by the process type of the product offering price. |
< string > array(multi) |
Query |
productOfferingPrice.relatedParty.id |
For filtering: Identifier of the related party for which the price applies. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
< ProductOffering > array |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
|
500 |
Internal Server Error |
3.10. Product Ordering
Product Ordering API
3.10.1. Creates a 'ProductOrder' resource
POST /productOrdering/productOrder
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Success |
|
400 |
Bad Request List of supported error codes: - 20: Invalid URL parameter value - 21: Missing body - 22: Invalid body - 23: Missing body field - 24: Invalid body field - 25: Missing header - 26: Invalid header value - 27: Missing query-string parameter - 28: Invalid query-string parameter value |
|
401 |
Unauthorized List of supported error codes: - 40: Missing credentials - 41: Invalid credentials - 42: Expired credentials |
|
403 |
Forbidden List of supported error codes: - 50: Access denied - 51: Forbidden requester - 52: Forbidden user - 53: Too many requests |
|
404 |
Not Found List of supported error codes: - 60: Resource not found |
|
422 |
Unprocessable entity Functional error |
|
500 |
Internal Server Error List of supported error codes: - 1: Internal error |
|
503 |
Service Unavailable List of supported error codes: - 5: The service is temporarily unavailable |
3.11. Recommendation
the recommendation API
3.11.1. List or find 'Recommendation' objects
GET /recommendation
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
fields |
Comma separated properties to display in response |
string |
Query |
limit |
Requested number of resources to be provided in response |
integer(int32) |
Query |
offset |
Requested index for start of resources to be provided in response |
integer(int32) |
Query |
processType.id |
The identifier of the process type |
string |
Query |
productOfferingTerm.id |
The identifier of the product offering term |
string |
Query |
relatedParty.id |
The identifier of the related party |
string |
Query |
relatedProductOffering.id |
The identifier of the related product offering |
string |
Query |
subscriptionBase.id |
The identifier of the subscription base |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
< Recommendation > array |
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
405 |
Method Not allowed |
|
409 |
Conflict |
|
500 |
Internal Server Error |
3.12. Review
Review API
3.12.1. Creates a 'Review'
POST /review
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
productOffering.id |
Identifier of the Product Offering |
string |
Query |
relatedParty.id |
The id of the related party. |
string |
Body |
review |
The 'Review' resource to be created |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
405 |
Method Not allowed |
|
422 |
Unprocessable entity Functional error |
|
500 |
Internal Server Error |
3.12.2. List reviews
GET /review
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body |
string |
Query |
limit |
Requested number of resources to be provided in response requested by client. |
integer(int32) |
Query |
offset |
Requested index for start of resources to be provided in response requested by client. |
integer(int32) |
Query |
productOffering.id |
Identifier of the Product Offering |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
< Review > array |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
|
500 |
Internal Server Error |
3.13. ShoppingCart
the ShoppingCart management API
3.13.1. Creates a 'ShoppingCart'
POST /shoppingCart
Description
Creates a ShoppingCart. This API supports Location Based Pricing which means the prices will be applied based on the region of customer and stores other details of the customer like formerSuplier.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
baseSiteId |
The id of the base site. |
string |
Body |
shoppingCart |
The Shopping Cart to be created |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
405 |
Method Not allowed |
|
409 |
Conflict |
|
500 |
Internal Server Error |
3.13.2. List or find 'ShoppingCart' objects
GET /shoppingCart
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
baseSiteId |
Identifier of the BaseSite |
string |
Query |
fields |
Comma separated properties to display in response |
string |
Query |
limit |
Requested number of resources to be provided in response |
integer(int32) |
Query |
offset |
Requested index for start of resources to be provided in response |
integer(int32) |
Query |
relatedParty.Id |
Identifier of the Customer |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
< ShoppingCart > array |
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
405 |
Method Not allowed |
|
409 |
Conflict |
|
500 |
Internal Server Error |
3.13.3. Retrieves a 'ShoppingCart' by Id
GET /shoppingCart/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Identifier of the Shopping Cart |
string |
Query |
baseSiteId |
Identifier of the BaseSite |
string |
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body |
string |
Query |
relatedParty.Id |
Identifier of the Customer |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
< ShoppingCart > array |
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
405 |
Method Not allowed |
|
409 |
Conflict |
|
500 |
Internal Server Error |
3.13.4. Updates partially a 'ShoppingCart' by Id
PATCH /shoppingCart/{id}
Description
This operation updates the place, process type, cart status, and other details like former supplier of the customer.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Identifier of the Shopping Cart |
string |
Body |
shoppingCart |
The Shopping Cart to be updated |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Updated |
|
204 |
No Content |
No Content |
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
405 |
Method Not allowed |
|
409 |
Conflict |
|
500 |
Internal Server Error |
3.14. Subscription
the Subscription API
3.14.1. get Subscriptionbase for given Id
GET /subscriptionbase/{subscriptionBaseId}
Description
This operation get Subscriptionbase entity. Attribute selection is enabled for all first level attributes. Filtering may be available depending on the compliance level supported by an implementation. Specific business errors for current operation will be encapsulated in HTTP Response 422 Unprocessable entity
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
subscriptionBaseId |
Id for subscriptionBase selection |
string |
Query |
baseSiteId |
Identifier of the BaseSite |
string |
Query |
fields |
Attributes selection |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
400 |
Bad Request List of supported error codes: - 20: Invalid URL parameter value - 21: Missing body - 22: Invalid body - 23: Missing body field - 24: Invalid body field - 25: Missing header - 26: Invalid header value - 27: Missing query-string parameter - 28: Invalid query-string parameter value |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found List of supported error codes: - 60: Resource not found |
|
405 |
Method Not Allowed List of supported error codes: - 61: Method not allowed |
|
409 |
Conflict The request could not be completed due to a conflict with the current state of the target resource. |
|
422 |
Unprocessable entity Functional error |
|
500 |
Internal Server Error List of supported error codes: - 1: Internal error |
3.15. UsageConsumptionReport
the UsageConsumptionReport API
3.15.1. Query the calculation of an usage consumption report in synchronous mode
GET /usageConsumptionReport
Description
This operation is used to request the calculation of a new usage consumption report for a specific product identified by a msisdn number for example. Attribute selection is enabled for all first level attributes. Filtering may be available depending on the compliance level supported by an implementation. Specific business errors for current operation will be encapsulated in HTTP Response 422 Unprocessable entity
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
baseSiteId |
Identifier of the BaseSite |
string |
Query |
fields |
Attribute selection |
string |
Query |
product.id |
Susbcribed Product ID |
string |
Query |
subscriptionBase.id |
SubscriberIdentity contains Id of subcriptionbase |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
400 |
Bad Request List of supported error codes: - 20: Invalid URL parameter value - 21: Missing body - 22: Invalid body - 23: Missing body field - 24: Invalid body field - 25: Missing header - 26: Invalid header value - 27: Missing query-string parameter - 28: Invalid query-string parameter value |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found List of supported error codes: - 60: Resource not found |
|
405 |
Method Not Allowed List of supported error codes: - 61: Method not allowed |
|
422 |
Unprocessable entity Functional error |
|
500 |
Internal Server Error List of supported error codes: - 1: Internal error |
4. Definitions
4.1. AccountRefType
Reference to an external entity that can be tipically queried with another API such as a customer account, a ticket, etc.
| Name | Description | Schema |
|---|---|---|
@referredType |
Type of the referred account (s.g.: financialAccount) |
string |
description |
Description of the entity |
string |
href |
URI where to query or perform actions on the entity |
string |
id |
Unique identifier of the entity |
string |
name |
Screen name of the entity |
string |
4.2. AgreementRef
Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.
| Name | Description | Schema |
|---|---|---|
@referredType |
class type of the referred Agreement |
string |
href |
Reference of the agreement |
string |
id |
Identifier of the agreement |
string |
name |
Name of the agreement |
string |
4.3. AppointmentRef
If the product order item requires an appointment between the service provider and the customer.
| Name | Description | Schema |
|---|---|---|
@referredType |
Indicates the (class) type of resource. |
string |
href |
Hyperlink to access the appointment |
string |
id |
id of the appointment |
string |
4.4. Attachment
Media items configured for a product offering (images, videos).
| Name | Description | Schema |
|---|---|---|
@baseType |
The immediate base class type of the attachment |
string |
@schemaLocation |
A link to the schema describing this attachment entity |
string |
@type |
the class type of the Attachment |
string |
description |
A narrative text describing the content of the attachment |
string |
href |
Not Sent.Reference of the attachment. |
string |
id |
Unique identifier of the attachment |
string |
mimeType |
Attachment mime type such as extension file for video, picture and document |
string |
type |
Attachment type format. |
string |
url |
Uniform Resource Locator, is a web page address (a subset of URI) |
string |
validFor |
Not Sent. |
4.5. BaseStoreRef
Reference to the base store.
| Name | Description | Schema |
|---|---|---|
href |
Unique reference of the BaseStore |
string |
id |
Unique identifier of the BaseStore |
string |
name |
Name of the BaseStore |
string |
4.6. BillingAccountRef
A BillingAccount is a detailed description of a bill structure
| Name | Description | Schema |
|---|---|---|
@referredType |
Indicates the (class) type of the billing account |
string |
href |
Reference of the billing account |
string |
id |
Unique identier of the billing account |
string |
name |
Name of the billing account |
string |
4.7. BillingSystemRef
Billing system reference.
| Name | Description | Schema |
|---|---|---|
href |
Url used to reference the BillingSystem. |
string |
id |
The id of the billing system. |
string |
4.8. BundledPopRelationship
this object represents a bundle relationship from a bundle product offering (parent) to a simple product offering (child). A simple product offering may participate in more than one bundle relationships.
| Name | Description | Schema |
|---|---|---|
@type |
(Class) type of the associated product offering |
string |
href |
hyperlink reference of the associated product offering |
string |
id |
Unique identifier of the associated product offering |
string |
name |
Name of the associated product offering |
string |
4.9. BundledProductOffering
A type of ProductOffering that belongs to a grouping of ProductOfferings made available to the market. It inherits of all attributes of ProductOffering.
| Name | Description | Schema |
|---|---|---|
bundledProductOffering |
Not Sent |
< BundledProductOffering > array |
href |
Unique reference of the ProductOffering. |
string |
id |
Product Offering Id. |
string |
lifecycleStatus |
Used to indicate the current lifecycle status(approved/checked/unapproved). |
string |
name |
Name of the ProductOffering. |
string |
4.10. CartItem
An identified part of the shopping cart. A shopping cart is decomposed into one or more shopping cart item. Cart item represents a product offering or bundled product offering that user wish to purchase, as well as the pricing of the product offering, reference to product in case of configured characteristic or installation address. Cart items can be related to other cart item to related bundled offerings or reference cart Items to a shipping options
| Name | Description | Schema |
|---|---|---|
@baseType |
Generic attribute indicating the base class type of the extension class of the current object. Useful only when the class type of the current object is unknown to the implementation. |
string |
@schemaLocation |
Generic attribute containing the link to the schema that defines the structure of the class type of the current object. |
string |
@type |
Generic attribute containing the name of the resource class type |
string |
action |
The action to be carried out on the Product. Can be "add" / "update" / "keep" / "remove" |
enum (ADD, UPDATE, KEEP, REMOVE) |
appointment |
Appointment |
|
cartItem |
< CartItem > array |
|
cartItemRelationship |
< CartItemRelationship > array |
|
contractStartDate |
Date when the contract was created |
string(date-time) |
id |
Identifier of the cart item (generally it is a sequence number 01, 02, 03, …) in the shopping cart |
string |
itemPrice |
< CartPrice > array |
|
itemTerm |
< CartTerm > array |
|
itemTotalPrice |
< CartPrice > array |
|
note |
< Note > array |
|
processType |
CartItem process type |
|
product |
||
productOffering |
||
promotion |
< PromotionRef > array |
|
quantity |
Quantity of cart items |
integer(int32) |
status |
status of cart item. e.g "Active" , "SavedForLater". |
string |
validation |
< ValidationItem > array |
|
validationError |
Deprecated since 1911 |
< string > array |
4.11. CartItemRef
CartIIem reference. A CartItem is an identified part of the shopping cart.
| Name | Description | Schema |
|---|---|---|
@referredType |
Generic attribute indicating the name of the class type of the referred resource entity. |
string |
id |
Unique identifier of the cart item |
string |
4.12. CartItemRelationship
Relationship among cart items mainly other than hierarchical relationships such as "RelyOn", "DependentOn", "Shipping" etc.
| Name | Description | Schema |
|---|---|---|
cartItem |
< CartItemRef > array |
|
id |
Unique identifier of the referred cart item |
string |
type |
Type of the cart item relationship |
string |
4.13. CartPrice
An amount, usually of money, that represents the actual price paid by the customer for this item. May represent the total price of the shopping cart or the total of the cart item depending on the relation
| Name | Description | Schema |
|---|---|---|
@baseType |
Generic attribute indicating the base class type of the extension class of the current object. Useful only when the class type of the current object is unknown to the implementation. |
string |
@schemaLocation |
Generic attribute containing the link to the schema that defines the structure of the class type of the current object. |
string |
@type |
Generic attribute containing the name of the resource class type |
string |
cartPrice |
< CartPrice > array |
|
description |
A narrative that explains in detail the semantics of this order item price. |
string |
id |
The id of the price. |
string |
name |
A short descriptive name such as "Subscription price". |
string |
price |
||
priceAlteration |
< PriceAlteration > array |
|
priceType |
Type of price, such as: OneTime, Recurring, Usage. |
string |
recurringChargePeriod |
Could be month, week… |
string |
unitOfMeasure |
Could be minutes, GB… |
string |
usageChargeType |
The type of the usage charge |
string |
4.14. CartTerm
| Name | Description | Schema |
|---|---|---|
@baseType |
Generic attribute indicating the base class type of the extension class of the current object. Useful only when the class type of the current object is unknown to the implementation. |
string |
@schemaLocation |
Generic attribute containing the link to the schema that defines the structure of the class type of the current object. |
string |
@type |
Generic attribute containing the name of the resource class type |
string |
description |
string |
|
duration |
||
id |
string |
|
name |
string |
4.15. Catalog
The root entity for entity catalog management. An entity catalog can be defined as a collection of entity catalog items and arranging them in a particular manner based on the need. In comparison to Product, Service and Resource catalogs, the entity catalog is intended for the purpose of providing any SID entity to consumers via a catalog, with its specification and policy providing governance over its content. Even Entity catalog may have an overlap with Product, Service or Resource catalog, it doesn’t replace them. It is primarily intended to address those SID entities which may not be addressed by any of Product, Service or Resource catalog. An entity catalog comprises of a list of RootEntities made available through EntityCatalogItems. This API addresses only RootEntity extended items as EntitySpecification. An entity catalog typically includes name, description and time period that it is valid for.
| Name | Description | Schema |
|---|---|---|
@baseType |
Indicates<b> </b>the base (class) type of this REST resource |
string |
@schemaLocation |
This field provides a link to the schema describing this REST resource |
string |
@type |
Indicates the (class) type of catalog. For entity catalogs, this will be 'EntityCatalog'. |
string |
baseStore |
Reference to the baseStore |
|
description |
Description of this catalog |
string |
href |
Unique reference of the catalog |
string |
id |
Unique identifier of the Catalog |
string |
lastUpdate |
Date and time of the last update |
string(date-time) |
lifecycleStatus |
Used to indicate the current lifecycle status |
string |
name |
Name of the catalog |
string |
validFor |
The period for which the catalog is valid |
|
version |
Catalog version |
string |
4.16. Category
The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates.
| Name | Description | Schema |
|---|---|---|
@baseType |
the base class type of the category |
string |
@schemaLocation |
link to the schema describing this category |
string |
@type |
the class type of the Category |
string |
description |
Description of the category |
string |
href |
Reference of the catalog |
string |
id |
Unique identifier of the category |
string |
isRoot |
If true, this Boolean indicates that the category is a root of categories |
boolean |
lastUpdate |
Date and time of the last update |
string(date-time) |
lifecycleStatus |
Used to indicate the current lifecycle status |
string |
name |
Name of the category |
string |
parentId |
Unique identifier of the parent category |
string |
productOffering |
< ProductOfferingRef > array |
|
subCategory |
< CategoryRef > array |
|
superCategory |
< CategoryRef > array |
|
type |
Category type, can be Category,VariantCategory or VariantValueCategory. |
string |
validFor |
The period for which the category is valid |
|
version |
Category version |
string |
4.17. CategoryRef
Category reference. The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings.
| Name | Description | Schema |
|---|---|---|
@referredType |
The class type of the referred Category |
string |
href |
Not Sent.Unique reference of the category. |
string |
id |
Unique reference of the category |
string |
name |
Name of the category |
string |
type |
Category type, can be Category,VariantCategory or VariantValueCategory. |
string |
version |
Not Sent.Category version. |
string |
4.18. Channel
The channel defines the channel for selling product offerings where order has been submitted.
| Name | Description | Schema |
|---|---|---|
@type |
Indicates the (class) type of resource. |
string |
href |
Unique reference of the channel |
string |
id |
Unique identifier of the channel |
string |
name |
Name of the channel |
string |
role |
Role of the channel - could be 'initChannel', 'submitChannel' for example. |
string |
4.19. ChannelRef
Channel reference. The channel defines the channel for selling product offerings.
| Name | Description | Schema |
|---|---|---|
@referredType |
(Class) type of the referred channel |
string |
href |
Not Sent.Reference of the channel. |
string |
id |
Unique identifier of the channel |
string |
name |
Not Sent |
string |
4.20. ChecklistAction
Represents a Checklist Action resource.
| Name | Description | Schema |
|---|---|---|
@schemaLocation |
A link to the schema describing this Checklist Action entity. |
string |
@type |
Class type of the Checklist Action. |
string |
actionType |
Action type |
string |
description |
Description of the Checklist Action. |
string |
href |
Reference of the Checklist Action. |
string |
id |
Unique identifier of the Checklist Action. |
string |
name |
Name of the Checklist Action. |
string |
processType |
Represents the purchasing flows for which the checklist action is applicable. |
< ProcessType > array |
productOffering |
List of references to product offering fow which the checkout action is applicable. |
< ProductOfferingRef > array |
productSpecCharacteristic |
Product specification characteristic reference |
4.21. ClassificationSystem
Classification System subtype of the Catalog entity.
Polymorphism : Composition
| Name | Description | Schema |
|---|---|---|
@baseType |
Indicates<b> </b>the base (class) type of this REST resource |
string |
@schemaLocation |
This field provides a link to the schema describing this REST resource |
string |
@type |
Indicates the (class) type of catalog. For entity catalogs, this will be 'EntityCatalog'. |
string |
baseStore |
Reference to the baseStore |
|
description |
Description of this catalog |
string |
href |
Unique reference of the catalog |
string |
id |
Unique identifier of the Catalog |
string |
lastUpdate |
Date and time of the last update |
string(date-time) |
lifecycleStatus |
Used to indicate the current lifecycle status |
string |
name |
Name of the catalog |
string |
validFor |
The period for which the catalog is valid |
|
version |
Catalog version |
string |
4.22. ConstraintRef
Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec.
| Name | Description | Schema |
|---|---|---|
@referredType |
The (class) type of the referred constraint |
string |
href |
Hyperlink reference to the target constraint |
string |
id |
reference id to the target constraint |
string |
name |
Name given to the constraint |
string |
version |
constraint version |
string |
4.23. ContactMedium
Indicates the contact medium that could be used to contact the party.
| Name | Description | Schema |
|---|---|---|
@baseType |
Generic attribute indicating the base class type of the extension class of the current object. Useful only when the class type of the current object is unknown to the implementation. |
string |
@schemaLocation |
Generic attribute containing the link to the schema that defines the structure of the class type of the current object. |
string |
@type |
Generic attribute containing the name of the resource class type |
string |
characteristic |
||
preferred |
If true, indicates that is the preferred contact medium |
boolean |
type |
Type of the contact medium, such as: email address, telephone number, postal address |
string |
validFor |
The time period that the contact medium is valid for |
4.24. ContentCatalog
Content Catalog subtype of the Catalog entity.
Polymorphism : Composition
| Name | Description | Schema |
|---|---|---|
@baseType |
Indicates<b> </b>the base (class) type of this REST resource |
string |
@schemaLocation |
This field provides a link to the schema describing this REST resource |
string |
@type |
Indicates the (class) type of catalog. For entity catalogs, this will be 'EntityCatalog'. |
string |
baseStore |
Reference to the baseStore |
|
description |
Description of this catalog |
string |
href |
Unique reference of the catalog |
string |
id |
Unique identifier of the Catalog |
string |
lastUpdate |
Date and time of the last update |
string(date-time) |
lifecycleStatus |
Used to indicate the current lifecycle status |
string |
name |
Name of the catalog |
string |
validFor |
The period for which the catalog is valid |
|
version |
Catalog version |
string |
4.25. CreditCardType
Details of a credit card
| Name | Description | Schema |
|---|---|---|
brand |
Credit card brand. E.g.: Visa, MasterCard, AmericanExpress… |
string |
cardNumber |
Credit card number |
string |
cvv |
the CVV or CVV2 code of the card |
string |
expirationDate |
the card’s expiration date |
string(date-time) |
lastFourDigits |
Last four digits of the card |
string |
nameOnCard |
Name writen on the card |
string |
4.26. Cycle
Represents the billing cycle.
| Name | Description | Schema |
|---|---|---|
cycleEnd |
Ending cycle. |
integer(int32) |
cycleStart |
Starting cycle. |
integer(int32) |
4.27. DeliveryMode
| Name | Description | Schema |
|---|---|---|
@schemaLocation |
A link to the schema describing this delivery mode |
string |
@type |
Class type of the delivery mode |
string |
description |
Description of the delivery mode. |
string |
href |
Reference of the delivery mode. |
string |
id |
Unique identifier of the delivery mode. |
string |
name |
Name of the delivery mode. |
string |
price |
The price of the delivery mode. |
|
relatedParty |
Reference to the related party. |
|
shoppingCart |
Reference to the shopping cart. |
4.28. DeliveryModeRef
| Name | Description | Schema |
|---|---|---|
@referredType |
(Class) type of the referred delivery mode |
string |
@type |
Class type of the delivery mode |
string |
href |
Reference of the delivery mode. |
string |
id |
Unique identifier of the delivery mode. |
string |
4.29. Error
| Name | Description | Schema |
|---|---|---|
code |
An integer coding the error type. This is given to caller so he can translate them if required. |
integer(int32) |
description |
(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values. |
string |
infoURL |
(optional) A URL to online documentation that provides more information about the error. |
string |
message |
A short localized string that describes the error. |
string |
4.30. ErrorRepresentation
Error Representation
| Name | Schema |
|---|---|
@schemaLocation |
string |
@type |
string |
code |
integer(int32) |
message |
string |
reason |
string |
referenceError |
string |
status |
string |
4.31. GeographicAddress
A geographic address is a structured textual way of describing how to find a Property in an urban area (country properties are often defined differently)
| Name | Description | Schema |
|---|---|---|
@schemaLocation |
A Link to the schema describing this REST Resource. The resource described 'UrbanPropertyAddress' but a schema could be used for other property address description. |
string |
@type |
Indicates the type of the resource. Here can be 'UrbanPropertyAddress', ‘FormattedAddress’, ‘JapanesePropertyAddress’ , ‘AustralianPropertyAddress’, etc… |
string |
city |
City that the address is in |
string |
country |
Country that the address is in |
string |
geographicLocationRefOrValue |
||
geographicSubAddress |
< GeographicSubAddress > array |
|
href |
An URI used to access to the address resource |
string |
id |
Unique identifier of the address |
string |
isBillingAddress |
Flag that specifies if the geographic address is a billing address. |
boolean |
isContactAddress |
Flag that specifies if the geographic address is a contact address. |
boolean |
isInstallationAddress |
Flag that specifies if the geographic address is an installation address. |
boolean |
isShippingAddress |
Flag that specifies if the geographic address is a shipping address. |
boolean |
isUnloadingAddress |
Flag that specifies if the geographic address is an unloading address. |
boolean |
locality |
An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi-rural in nature |
string |
postcode |
Descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also known as zipcode) |
string |
relatedParty |
Party role references that the current address is associated with |
< RelatedPartyRef > array |
stateOfProvince |
The State or Province that the address is in |
string |
streetName |
Name of the street or other street type |
string |
streetNr |
Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses |
string |
streetNrLast |
Last number in a range of street numbers allocated to a property |
string |
streetNrLastSuffix |
Last street number suffix for a ranged address |
string |
streetNrSuffix |
The first street number suffix |
string |
streetSuffix |
A modifier denoting a relative direction |
string |
streetType |
Alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf |
string |
4.32. GeographicLocation
A GeographicLocation allows describing through coordinate(s) a point, a line or a space
| Name | Description | Schema |
|---|---|---|
@schemaLocation |
A link to the schema describing this REST Resource |
string |
@type |
Indicates the type of resource |
string |
accuracy |
string |
|
geometry |
< GeographicPoint > array |
|
geometryType |
Type allows describing Geolocation form: it could be a point, a line, a polygon, a cylinder, etc…. |
string |
href |
href of the GeoLocation |
string |
id |
Unique Identifier of a GeoLocation |
string |
name |
Name of a GeoLocation |
string |
spatialRef |
string |
4.33. GeographicPoint
A GeographicPoint defines a geographic point through coordinates.
| Name | Description | Schema |
|---|---|---|
x |
x coordinate (usually latitude) |
string |
y |
y coordinate (usually longitude) |
string |
z |
z coordinate (usually elevation) |
string |
4.34. GeographicSubAddress
It is used for addressing within a property in an urban area (country properties are often defined differently). It may refer to a building, a building cluster, or a floor of a multistory building.
| Name | Description | Schema |
|---|---|---|
@schemaLocation |
A link to the schema describing this REST Resource |
string |
@type |
Type of the resource for this subAdress |
string |
buildingName |
Allows for buildings that have well-known names |
string |
href |
Href of the subAddress |
string |
id |
Unique Identifier of the subAddress |
string |
levelNumber |
Used where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2 |
string |
levelType |
Describes level types within a building |
string |
name |
Name of the subAddress to identify it with a meaningful identification |
string |
privateStreetName |
Private streets internal to a property (e.g. a university) may have internal names that are not recorded by the land title office |
string |
privateStreetNumber |
Private streets numbers internal to a private street |
string |
subUnitNumber |
The discriminator used for the subunit often just a simple number e.g. FLAT 5, may also be a range |
string |
subUnitType |
The type of subunit e.g.BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF. |
string |
type |
Type of subAddress : it can be a subunit or a private street |
string |
4.35. IndexedProductOffering
IndexedProductOffering subtype of the ProductOffering entity.
Polymorphism : Composition
| Name | Description | Schema |
|---|---|---|
@baseType |
Immediate base (class) type of the product offering |
string |
@schemaLocation |
A link to the schema describing this product offering |
string |
@type |
Class type of the product offering |
string |
agreement |
Not Sent |
< AgreementRef > array |
attachment |
Media items configured for a product offering (images, videos). |
< Attachment > array |
baseProduct |
Base product of a variant. |
|
bundledProductOffering |
List of children product offering reference (sent only for bundled product offerings). |
< BundledProductOffering > array |
category |
< CategoryRef > array |
|
channel |
< ChannelRef > array |
|
classificationAttributeValueUse |
The list of classification attributes defined for the ProductOffering. |
< ProdSpecCharValueUse > array |
description |
Description of the ProductOffering. |
string |
facetSearchOption |
Represents the facet search value field name and value used for filtering. |
< FacetSearchOption > array |
href |
Reference of the ProductOffering. |
string |
id |
Unique identifier of the ProductOffering. |
string |
isBundle |
isBundle determines whether a productOffering represents a simple product Offering (false), or a bundled product offering(true).If false, then a productSpecification will be returned, but the bundledProductOfferings will be absent or empty and vice-versa if isBundle is true. |
boolean |
isInStock |
Flag to indicate if the product is in stock or not. |
boolean |
isSellable |
A flag indicating if this product offering can be sold as stand-alone or not. If this flag is false it indicates that the offer can only be sold within a bundled product offering. |
boolean |
lastUpdate |
Date and time of the last update. |
string(date-time) |
lifecycleStatus |
Used to indicate the current product offering approval status (approved/check/unapproved). |
string |
marketSegment |
Not Sent. |
< MarketSegmentRef > array |
name |
Name of the ProductOffering. |
string |
offeringGroup |
List of containing offering groups (sent only for BundleProductOfferings). |
< OfferingGroup > array |
parentBundleProductOffering |
A list of BundledProductOffering representing all parents of the offering. |
< BundledProductOffering > array |
place |
Not Sent |
< PlaceRef > array |
prodSpecCharValueUse |
The list of Product Specification Characteristic Values defined for the ProductOffering. |
< ProdSpecCharValueUse > array |
productOfferingPrice |
< ProductOfferingPrice > array |
|
productOfferingTerm |
Different commitment period for which the product offering is available. |
< ProductOfferingTerm > array |
productSpecification |
||
rating |
Rating of the product offering. |
string |
resourceCandidate |
Not Sent |
|
serviceCandidate |
Not Sent |
|
serviceLevelAgreement |
Not Sent |
|
validFor |
The period for which the productOffering is valid (online date - offline date). |
|
variantOption |
Variant options, in case of a variant product offering. |
< VariantOption > array |
variantProductOffering |
List of variants of the product offering. |
< ProductOfferingRef > array |
version |
Not Sent.Product offering version. |
string |
4.36. IndividualIdentification
Represents our registration of information used as proof of identity by an individual (passport, national identity card, driver’s license, social security number, birth certificate).
| Name | Description | Schema |
|---|---|---|
attachment |
An attachment ref or value (AttachmentRefOrValue). An attachment by value or by reference. |
< Attachment > array |
identificationId |
A string. Identifier. |
string |
identificationType |
A string. Identification type (passport, national identity card, driver’s license, social security number, birth certificate). |
string |
issuingAuthority |
A string. Authority which has issued the identifier, such as: social security, town hall. |
string |
issuingDate |
A date time (DateTime). Date at which the identifier was issued. |
string(date-time) |
validFor |
A time period. The period for which the identification information is valid. |
4.37. MarketSegmentRef
provides references to the corresponding market segment as target of product offerings. A market segment is grouping of Parties, GeographicAreas, SalesChannels, and so forth.
| Name | Description | Schema |
|---|---|---|
@referredType |
(Class) type of the referred market segment |
string |
href |
Reference of the market segment |
string |
id |
Unique identifier of the market segment |
string |
name |
Name of the market segment |
string |
4.38. MediumCharacteristic
Describes the contact medium characteristics that could be used to contact a party (an individual or an organization)
| Name | Description | Schema |
|---|---|---|
city |
The city |
string |
country |
The country |
string |
emailAddress |
Full email address in standard format |
string |
faxNumber |
The fax number of the contact |
string |
phoneNumber |
The primary phone number of the contact |
string |
postCode |
Postcode |
string |
stateOrProvince |
State or province |
string |
street1 |
Describes the street |
string |
street2 |
Complementary street description |
string |
type |
Type of medium (fax, mobile phone…) |
string |
4.39. Message
Indicates the messages that could appear on cart configuration
| Name | Description | Schema |
|---|---|---|
@baseType |
Generic attribute indicating the base class type of the extension class of the current object. Useful only when the class type of the current object is unknown to the implementation. |
string |
@schemaLocation |
Generic attribute containing the link to the schema that defines the structure of the class type of the current object. |
string |
@type |
Generic attribute containing the name of the resource class type |
string |
type |
Type of message, such as: error, warning |
enum (error, warning, success, wrong) |
value |
Content of message |
string |
4.40. Money
A base / value business entity used to represent money.
| Name | Description | Schema |
|---|---|---|
unit |
Currency (ISO4217 norm uses 3 letters to define the currency). |
string |
value |
A positive floating point number |
string |
4.41. Note
Extra information about a given entity
| Name | Description | Schema |
|---|---|---|
author |
Author of the note |
string |
date |
Date of the note |
string(date-time) |
text |
Text of the note |
string |
4.42. OfferingGroup
Represents a product offering group entity.
| Name | Description | Schema |
|---|---|---|
childProductOffering |
List of containing product offerings. |
< BundledProductOffering > array |
id |
Unique identifier of the offering group. |
string |
name |
Name of the offering group. |
string |
4.43. OneTimeChargeCartPrice
A cart price charge paid only once.
Polymorphism : Composition
| Name | Description | Schema |
|---|---|---|
@baseType |
Generic attribute indicating the base class type of the extension class of the current object. Useful only when the class type of the current object is unknown to the implementation. |
string |
@schemaLocation |
Generic attribute containing the link to the schema that defines the structure of the class type of the current object. |
string |
@type |
Generic attribute containing the name of the resource class type |
string |
cartPrice |
< CartPrice > array |
|
description |
A narrative that explains in detail the semantics of this order item price. |
string |
id |
The id of the price. |
string |
name |
A short descriptive name such as "Subscription price". |
string |
price |
||
priceAlteration |
< PriceAlteration > array |
|
priceType |
Type of price, such as: OneTime, Recurring, Usage. |
string |
recurringChargePeriod |
Could be month, week… |
string |
unitOfMeasure |
Could be minutes, GB… |
string |
usageChargeType |
The type of the usage charge |
string |
4.44. OneTimeChargeOrderPrice
An order price charge paid only once.
Polymorphism : Composition
| Name | Description | Schema |
|---|---|---|
@baseType |
Indicate the base type of orderPrice. |
string |
@schemaLocation |
A link to the schema describing this orderPrice extension. |
string |
@type |
Indicate the type of orderPrice. |
string |
billingAccount |
||
description |
A narrative that explains in detail the semantics of this order item price |
string |
id |
id |
string |
name |
A short descriptive name such as "Subscription price". |
string |
orderPrice |
< OrderPrice > array |
|
price |
||
priceAlteration |
< PriceAlteration > array |
|
priceType |
enum (recurring, oneTime, usage, PRODUCT_PRICE, DELIVERY_COST, PAYMENT_COST, DISCOUNT) |
|
recurringChargePeriod |
Could be month, week,… |
string |
unitOfMeasure |
Could be minutes, gigaBytes,… |
string |
usageChargeType |
The type of the usage charge. |
string |
4.45. OneTimePriceCharge
A price charge paid only once.
Polymorphism : Composition
| Name | Description | Schema |
|---|---|---|
@baseType |
The immediate base class type of this product offering |
string |
@schemaLocation |
hyperlink reference to the schema describing this resource |
string |
@type |
The class type of this Product offering |
string |
billingEvent |
Represents the billing event for one time prices. Could be : paynow, onfistbill, oncancellation. |
string |
bundledPop |
Represents the contained prices (charges), for a composed price. |
< ProductOfferingPrice > array |
bundledPopRelationship |
Not Sent. |
< BundledPopRelationship > array |
channel |
< ChannelRef > array |
|
constraint |
Not Sent. |
< ConstraintRef > array |
description |
Not Sent.Description of the productOfferingPrice |
string |
href |
Not Sent |
string |
id |
Price identifier. |
string |
isBundle |
A flag indicating if this POP is composite (bundle) or not |
boolean |
isPriceOverride |
A flag indicating if the price is defined directly for a simple product offering, or for a product offering bought as part of a bundled product offering. |
boolean |
lastUpdate |
Last modified time of price. |
string(date-time) |
lifecycleStatus |
Not Sent.The lifecycle status of this POP. |
string |
name |
Name of the productOfferingPrice. |
string |
percentage |
Percentage to apply for ProdOfferPriceAlteration (Discount). |
number(float) |
place |
Place references where the products are sold or delivered. |
< PlaceRef > array |
poRelationship |
Represents the product offering affected, or required by the price. This field is used for bundle product offerings. |
< PoRelationshipRef > array |
popRelationship |
Not Sent. |
< PopRelationship > array |
price |
The amount of money that characterizes the price. |
|
priceType |
A category that describes the price such as recurring, one time and usage. |
string |
pricingLogicAlgorithm |
Not Sent. |
< PricingLogicAlgorithm > array |
priority |
The priority of the price. |
integer(int32) |
processType |
Represents the purchasing flows for which the price is applicable. |
< ProcessType > array |
prodSpecCharValueUse |
< ProdSpecCharValueUse > array |
|
productOfferingTerm |
< ProductOfferingTerm > array |
|
recurringChargePeriodLength |
The period of the recurring charge: 1, 2, … .It sets to zero if it is not applicable |
integer(int32) |
recurringChargePeriodType |
The period to repeat the application of the price. Could be month,quarter,year.. |
string |
relatedParty |
||
tax |
Not Sent. |
< Tax > array |
unitOfMeasure |
A number and unit representing how many (for instance 1 dozen) of an ProductOffering is available at the offered price. Its meaning depends on the priceType. It could be a price, a rate, or a discount. |
|
validFor |
The period for which the productOfferingPrice is valid. |
|
version |
Not Sent.ProductOffering version. |
string |
4.46. OrderItem
An identified part of the order. A product order is decomposed into one or more order items.
| Name | Description | Schema |
|---|---|---|
@schemaLocation |
An URL to the schema describing this REST resource. |
string |
@type |
Indicates the type of resource. Here it can be a type of productOrderItem. |
string |
action |
The action to be carried out on the Product. Can be "add" / "update" / "keep" / "remove" |
enum (ADD, UPDATE, KEEP, REMOVE) |
appointment |
||
billingAccount |
||
contractStartDate |
Date when the contract was created |
string(date-time) |
id |
Identifier of the line item (generally it is a sequence number 01, 02, 03, …) |
string |
itemPrice |
< OrderPrice > array |
|
itemTerm |
< OrderTerm > array |
|
itemTotalPrice |
< OrderPrice > array |
|
orderItem |
< OrderItem > array |
|
orderItemRelationship |
< OrderItemRelationShip > array |
|
payment |
< PaymentRef > array |
|
processType |
Process type |
|
product |
||
productOffering |
||
promotion |
< PromotionRef > array |
|
qualification |
< QualificationRef > array |
|
quantity |
Quantity ordered |
integer(int64) |
state |
enum (CANCELLING, CHECKED_VALID, CREATED, CHECKED_INVALID, ON_VALIDATION, SUSPENDED, COMPLETED, PAYMENT_AUTHORIZED, CANCELLED, PAYMENT_NOT_AUTHORIZED, PAYMENT_AMOUNT_RESERVED, PAYMENT_AMOUNT_NOT_RESERVED, PAYMENT_CAPTURED, PAYMENT_NOT_CAPTURED, FRAUD_CHECKED, ORDER_SPLIT, PROCESSING_ERROR, WAIT_FRAUD_MANUAL_CHECK, PAYMENT_NOT_VOIDED, TAX_NOT_VOIDED, TAX_NOT_COMMITTED, TAX_NOT_REQUOTED) |
4.47. OrderItemRelationShip
Linked order items to the one instantiate.
| Name | Description | Schema |
|---|---|---|
id |
The identifier of the related ordered item. |
string |
type |
enum (reliesOn, brings, hasParent, hasChild) |
4.48. OrderPrice
An amount, usually of money, that represents the actual price paid by the Customer for this item or this order.
| Name | Description | Schema |
|---|---|---|
@baseType |
Indicate the base type of orderPrice. |
string |
@schemaLocation |
A link to the schema describing this orderPrice extension. |
string |
@type |
Indicate the type of orderPrice. |
string |
billingAccount |
||
description |
A narrative that explains in detail the semantics of this order item price |
string |
id |
id |
string |
name |
A short descriptive name such as "Subscription price". |
string |
orderPrice |
< OrderPrice > array |
|
price |
||
priceAlteration |
< PriceAlteration > array |
|
priceType |
enum (recurring, oneTime, usage, PRODUCT_PRICE, DELIVERY_COST, PAYMENT_COST, DISCOUNT) |
|
recurringChargePeriod |
Could be month, week,… |
string |
unitOfMeasure |
Could be minutes, gigaBytes,… |
string |
usageChargeType |
The type of the usage charge. |
string |
4.49. OrderTerm
Description of a productTerm linked to this orderItem. This represent a commitment with a duration. Duration or name must be provided.
| Name | Description | Schema |
|---|---|---|
@type |
Indicated the type of Term. |
string |
description |
Description of the productOrderTerm. |
string |
duration |
||
name |
Name of the productOrderTerm. |
string |
4.50. PartyRole
The part played by a party in a given context.
| Name | Description | Schema |
|---|---|---|
@baseType |
Generic attribute indicating the base class type of the extension class of the current object. Useful only when the class type of the current object is unknown to the implementation. |
string |
@schemaLocation |
Generic attribute containing the link to the schema that defines the structure of the class type of the current object. |
string |
@type |
Generic attribute containing the name of the resource class type |
string |
href |
Url used to reference the party role. |
string |
id |
Unique identifier for PartyRoles |
string |
individualIdentification |
< IndividualIdentification > array |
|
name |
A word, term, or phrase by which the PartyRole is known and distinguished from other PartyRoles. |
string |
subscriptionAccess |
< SubscriptionAccess > array |
4.51. PaymentMethodRef
PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).
| Name | Description | Schema |
|---|---|---|
@referredType |
Generic attribute indicating the name of the class type of the referred resource entity. |
string |
code |
Unique identifier of the voucher |
string |
href |
Reference of the payment method |
string |
id |
Unique identifier of the payment method |
string |
name |
Name of the payment method |
string |
type |
Payment method type. The content of the details field depends on the value of this one |
enum (VOUCHER, CREDITCARD) |
4.52. PaymentMethodType
Representation of a payment method
| Name | Description | Schema |
|---|---|---|
@type |
Payment method type. The content of the details field depends on the value of this one |
enum (cash, digitalWallet, tokenizedCard, bankAccountTransfer, bankAccountDebit, bankCard, account, bucket, voucher, check, loyaltyAccount, creditCard) |
account |
Account that owns or can use the payment method |
< AccountRefType > array |
authorizationCode |
Authorization code provided by a financial institution. Typically this would be populated for recurring payments using the method, as payments have an authorization code of their own. |
string |
description |
Description of the payment method |
string |
details |
Details of the payment method. This object’s type depends on the value of the type field above |
|
href |
URI where to perform actions on the payment method |
string |
id |
Unique id of the payment method in the server |
string |
name |
Screen name of the payment method |
string |
preferred |
Defines whether this particular method is the preferred one |
boolean |
relatedParty |
Account that owns the payment method |
< RelatedPartyRefType > array |
status |
Current status of the payment method |
string |
statusDate |
Last time the status changed |
string(date-time) |
validFor |
Validity period of the payment method |
4.53. PaymentRef
If an immediate payment has been done at the product order submission, the payment information are captured and stored (as a reference) in the order.
| Name | Description | Schema |
|---|---|---|
@referredType |
Indicates the type of resource. Here can be 'cash', 'BankCard', ‘Check’, etc… |
string |
code |
Unique identifier of the voucher |
string |
href |
Hyperlink to access to a payment. |
string |
id |
Identifier of a payment. |
string |
name |
Name of a payment. |
string |
type |
Payment method type. The content of the details field depends on the value of this one |
enum (VOUCHER, CREDITCARD) |
4.54. Place
Place defines the places where the products are sold, delivered. A place may be used for marking a geo location.
| Name | Description | Schema |
|---|---|---|
@referredType |
Indicate the type of Place class (example: 'geographicAddress') |
string |
@schemaLocation |
A link to the schema describing this REST resource |
string |
href |
Reference of the place |
string |
id |
Unique identifier of the place |
string |
name |
A user-friendly name for the place |
string |
role |
Role of the place (for instance: 'installation site', 'A-extremity site', 'Supervised Perimeter' etc…) |
string |
4.55. PlaceRef
Place reference. Place defines the places where the products are sold or delivered.
| Name | Description | Schema |
|---|---|---|
@referredType |
class type of the referred Place object |
string |
address |
A string characterizing an address (for instance a formatted address or an identifier taken from an address database or an address API). |
string |
geoLocationUrl |
A url providing a map for localizing the place |
string |
href |
Unique reference of the place |
string |
id |
Unique identifier of the place |
string |
name |
A user-friendly name for the place, such as "Paris Store", "London Store", "Main Home" |
string |
role |
Role of the place (for instance: 'home delivery', 'shop retrieval') |
string |
4.56. PoRelationshipRef
PoRelationshipRef reference. The PoRelationshipRef defines the affectedProductOffering and requiredProductOfferings of price for selling product offerings.
| Name | Description | Schema |
|---|---|---|
@referredType |
(Class) type of the referred productOffering |
string |
bpoId |
Id of the BPO where current POP is defined in case the current BPO is a price override |
string |
href |
Reference of the productOffering |
string |
id |
Unique identifier of the productOffering. |
string |
name |
Name of the productOffering. |
string |
poAttributeType |
PoAttributeType of the PoRelationshipRef |
enum (AFFECTED_PRODUCT, REQUIRED_PRODUCT) |
4.57. PopRelationship
product offering relationship
| Name | Description | Schema |
|---|---|---|
@type |
(Class) type of the associated product offering |
string |
href |
hyperlink reference of the associated product offering |
string |
id |
Unique identifier of the associated product offering |
string |
name |
Name of the associated product offering |
string |
relationshipType |
type of the relationship, for example override, discount, etc. |
string |
4.58. Price
Provides all amounts (tax included, duty free, tax rate), used currency and percentage applied for price and price alteration
| Name | Description | Schema |
|---|---|---|
@schemaLocation |
Link to the schema describing this REST resource. |
string |
@type |
Indicates the (class) type of the price |
string |
dutyFreeAmount |
||
percentage |
Percentage applied |
number(float) |
taxIncludedAmount |
||
taxRate |
Applied tax rate on amount |
number(float) |
4.59. PriceAlteration
Is an amount, usually of money, that modifies the price charged for an order item.
| Name | Description | Schema |
|---|---|---|
@baseType |
Generic attribute indicating the base class type of the extension class of the current object. Useful only when the class type of the current object is unknown to the implementation. |
string |
@schemaLocation |
Generic attribute containing the link to the schema that defines the structure of the class type of the current object. |
string |
@type |
Generic attribute containing the name of the resource class type |
string |
applicationDuration |
Duration during which the alteration applies on the order item price (for instance 2 months free of charge for the recurring charge) |
integer(int32) |
cycle |
||
description |
A narrative that explains in detail the semantics of this order item price alteration |
string |
name |
A short descriptive name such as "Monthly discount" |
string |
price |
||
priceType |
A category that describes the price such as recurring, one time and usage. |
string |
priority |
Priority level for applying this alteration among all the defined alterations on the order item price |
integer(int32) |
recurringChargePeriod |
Could be month, week… |
string |
unitOfMeasure |
Could be minutes, GB… |
string |
4.60. PricingLogicAlgorithm
The PricingLogicAlgorithm entity represents an instantiation of an interface specification to external rating function (without a modeled bahavior in SID). Some of the parameters of the interface definiition may be already set (such as price per unit) and some may be gathered during the rating process from the event (such as call duration) or from ProductCharacteristicValues (such as assigned bandwidth)
| Name | Description | Schema |
|---|---|---|
@type |
The class type of this PLA |
string |
description |
Description of the PLA |
string |
href |
hyperlink reference of this PLA |
string |
id |
unique id of the PLA |
string |
name |
Name given to the PLA |
string |
plaSpecId |
id of corresponding PLA specification |
string |
validFor |
The period for which the PLA is valid |
4.61. ProcessType
Process type. It could be ACQUISITION, RETENTION, CHANGE TARIFF
| Name | Description | Schema |
|---|---|---|
@schemaLocation |
A link to the schema describing the ProcessType |
string |
@type |
Indicated the type of the ProcessType |
string |
href |
Reference of the Process Type. |
string |
id |
Process Type id. |
string |
4.62. ProcessTypeRecommendation
Process Type Recommendation subtype of the Recommendation entity.
Polymorphism : Composition
| Name | Description | Schema |
|---|---|---|
@baseType |
The base type for use in polymorphic collections |
string |
@schemaLocation |
A link to the schema describing a resource (for type extension). |
string |
@type |
The class type of the actual resource (for type extension). |
string |
category |
The category for grouping recommendations |
|
channel |
||
description |
string |
|
href |
Hypertext Reference of the recommendation. |
string |
id |
Unique identifier of recommendation |
string |
item |
< RecommendationItem > array |
|
location |
The place which the recommendation is related with |
|
name |
Name of recommendation |
string |
order |
||
processType |
||
relatedParty |
||
shoppingCart |
The shopping cart which the recommendation is related with. |
|
subscriptionBase |
||
type |
Type of recommendation. The basic type is : ¡®AD¡¯: it means the recommendation is the advertisement for display ¡®OFFER¡¯: it means the recommended content is the offer entry page. By clicking it, the user can be forwarded to the details of the offering |
string |
validFor |
The period in which the recommendation is valid. |
4.63. ProcessTypeRef
A reference to the process type
| Name | Description | Schema |
|---|---|---|
@referredType |
(Class) type of the referred process type |
string |
@type |
(Class) type of the process type |
string |
href |
Url used to reference the process type |
string |
id |
The identifier of the process type |
string |
4.64. ProdOfferPriceAlteration
A price alteration of the ProductOfferingPrice
Polymorphism : Composition
| Name | Description | Schema |
|---|---|---|
@baseType |
The immediate base class type of this product offering |
string |
@schemaLocation |
hyperlink reference to the schema describing this resource |
string |
@type |
The class type of this Product offering |
string |
billingEvent |
Represents the billing event for one time prices. Could be : paynow, onfistbill, oncancellation. |
string |
bundledPop |
Represents the contained prices (charges), for a composed price. |
< ProductOfferingPrice > array |
bundledPopRelationship |
Not Sent. |
< BundledPopRelationship > array |
channel |
< ChannelRef > array |
|
constraint |
Not Sent. |
< ConstraintRef > array |
cycle |
Represents the start time, and end time of the recurring cycle (the first 3 months) . If empty, the cycle is the entire recurring period. |
|
description |
Not Sent.Description of the productOfferingPrice |
string |
href |
Not Sent |
string |
id |
Price identifier. |
string |
isBundle |
A flag indicating if this POP is composite (bundle) or not |
boolean |
isPriceOverride |
A flag indicating if the price is defined directly for a simple product offering, or for a product offering bought as part of a bundled product offering. |
boolean |
lastUpdate |
Last modified time of price. |
string(date-time) |
lifecycleStatus |
Not Sent.The lifecycle status of this POP. |
string |
name |
Name of the productOfferingPrice. |
string |
percentage |
Percentage to apply for ProdOfferPriceAlteration (Discount). |
number(float) |
place |
Place references where the products are sold or delivered. |
< PlaceRef > array |
poRelationship |
Represents the product offering affected, or required by the price. This field is used for bundle product offerings. |
< PoRelationshipRef > array |
popRelationship |
Not Sent. |
< PopRelationship > array |
price |
The amount of money that characterizes the price. |
|
priceType |
A category that describes the price such as recurring, one time and usage. |
string |
pricingLogicAlgorithm |
Not Sent. |
< PricingLogicAlgorithm > array |
priority |
The priority of the price. |
integer(int32) |
processType |
Represents the purchasing flows for which the price is applicable. |
< ProcessType > array |
prodSpecCharValueUse |
< ProdSpecCharValueUse > array |
|
productOfferingTerm |
< ProductOfferingTerm > array |
|
recurringChargePeriodLength |
The period of the recurring charge: 1, 2, … .It sets to zero if it is not applicable |
integer(int32) |
recurringChargePeriodType |
The period to repeat the application of the price. Could be month,quarter,year.. |
string |
relatedParty |
||
tax |
Not Sent. |
< Tax > array |
unitOfMeasure |
A number and unit representing how many (for instance 1 dozen) of an ProductOffering is available at the offered price. Its meaning depends on the priceType. It could be a price, a rate, or a discount. |
|
validFor |
The period for which the productOfferingPrice is valid. |
|
version |
Not Sent.ProductOffering version. |
string |
4.65. ProdSpecCharValueUse
A use of the ProdSpecCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of similar properties contained in ProdSpecCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecCharacteristic in a Product specification can be modified at the ProductOffering level. For example, a characteristic 'Color' might have values White, Blue, Green, and Red. But, the list of values can be restricted to e.g. White and Blue in an associated product offering. It should be noted that the list of values in 'ProdSpecCharValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics.
| Name | Description | Schema |
|---|---|---|
description |
A narrative that explains in detail what the productSpecCharacteristic is. |
string |
maxCardinality |
Not Sent |
integer(int32) |
minCardinality |
Not Sent |
integer(int32) |
name |
Not Sent |
string |
productSpecCharacteristicValue |
< ProductSpecCharacteristicValue > array |
|
productSpecification |
||
validFor |
Not Sent |
|
valueType |
Not Sent |
string |
4.66. Product
A Product represents the subscription of a ProductOffering by a Party playing a PartyRole, such as a Customer. For example, Jean has subscribed to company ABC’s internet ProductOffering. The association between ProductSpecification and Product allows ProductSpecification, to be instantiated as Product and related to customers or other involved parties.
| Name | Description | Schema |
|---|---|---|
@baseType |
Indicates the base type of the resource. Here can be 'Product' |
string |
@schemaLocation |
A link to the schema describing this REST resource. |
string |
@type |
Indicated the type of resource. |
string |
billingAccount |
< BillingAccountRef > array |
|
characteristic |
< ProductCharacteristic > array |
|
description |
The description of the product. It could be copied from the description of the Product Offering. |
string |
href |
Reference of the product |
string |
id |
Unique identifier of the product |
string |
isBundle |
If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering |
boolean |
isCustomerVisible |
If true, the product is visible by the customer |
boolean |
name |
The name of the product. It could be the same as the name of the Product Offering |
string |
place |
< Place > array |
|
productOffering |
||
productOrder |
< ProductOrderRef > array |
|
productPrice |
< ProductPrice > array |
|
productRelationship |
< ProductRelationship > array |
|
productSerialNumber |
Serial number for the product. This is typically applicable to tangible products e.g. Broadband Router. |
string |
productSpecification |
||
productTerm |
< ProductTerm > array |
|
realizingResource |
< RealizingResource > array |
|
realizingService |
< RealizingService > array |
|
relatedParty |
< RelatedParty > array |
|
startDate |
The date from which the product starts |
string(date-time) |
status |
enum (created, pendingActive, cancelled, active, pendingTerminate, terminated, suspended, aborted) |
|
terminationDate |
The date when the product was terminated. Not applicable to active products |
string(date-time) |
4.67. ProductCharacteristic
Characteristics of the product to instantiate or to modify.
| Name | Description | Schema |
|---|---|---|
@schemaLocation |
This field provided a link to the schema describing this REST resource. |
string |
@type |
Indicates the (class) type of resource |
string |
name |
Name of the characteristic |
string |
value |
Value of the characteristic |
string |
4.68. ProductOffering
Represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
| Name | Description | Schema |
|---|---|---|
@baseType |
Immediate base (class) type of the product offering |
string |
@schemaLocation |
A link to the schema describing this product offering |
string |
@type |
Class type of the product offering |
string |
agreement |
Not Sent |
< AgreementRef > array |
attachment |
Media items configured for a product offering (images, videos). |
< Attachment > array |
baseProduct |
Base product of a variant. |
|
bundledProductOffering |
List of children product offering reference (sent only for bundled product offerings). |
< BundledProductOffering > array |
category |
< CategoryRef > array |
|
channel |
< ChannelRef > array |
|
classificationAttributeValueUse |
The list of classification attributes defined for the ProductOffering. |
< ProdSpecCharValueUse > array |
description |
Description of the ProductOffering. |
string |
href |
Reference of the ProductOffering. |
string |
id |
Unique identifier of the ProductOffering. |
string |
isBundle |
isBundle determines whether a productOffering represents a simple product Offering (false), or a bundled product offering(true).If false, then a productSpecification will be returned, but the bundledProductOfferings will be absent or empty and vice-versa if isBundle is true. |
boolean |
isSellable |
A flag indicating if this product offering can be sold as stand-alone or not. If this flag is false it indicates that the offer can only be sold within a bundled product offering. |
boolean |
lastUpdate |
Date and time of the last update. |
string(date-time) |
lifecycleStatus |
Used to indicate the current product offering approval status (approved/check/unapproved). |
string |
marketSegment |
Not Sent. |
< MarketSegmentRef > array |
name |
Name of the ProductOffering. |
string |
offeringGroup |
List of containing offering groups (sent only for BundleProductOfferings). |
< OfferingGroup > array |
parentBundleProductOffering |
A list of BundledProductOffering representing all parents of the offering. |
< BundledProductOffering > array |
place |
Not Sent |
< PlaceRef > array |
prodSpecCharValueUse |
The list of Product Specification Characteristic Values defined for the ProductOffering. |
< ProdSpecCharValueUse > array |
productOfferingPrice |
< ProductOfferingPrice > array |
|
productOfferingTerm |
Different commitment period for which the product offering is available. |
< ProductOfferingTerm > array |
productSpecification |
||
rating |
Rating of the product offering. |
string |
resourceCandidate |
Not Sent |
|
serviceCandidate |
Not Sent |
|
serviceLevelAgreement |
Not Sent |
|
validFor |
The period for which the productOffering is valid (online date - offline date). |
|
variantOption |
Variant options, in case of a variant product offering. |
< VariantOption > array |
variantProductOffering |
List of variants of the product offering. |
< ProductOfferingRef > array |
version |
Not Sent.Product offering version. |
string |
4.69. ProductOfferingPrice
An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased. The price is valid for a defined period of time and may not represent the actual price paid by a customer.
| Name | Description | Schema |
|---|---|---|
@baseType |
The immediate base class type of this product offering |
string |
@schemaLocation |
hyperlink reference to the schema describing this resource |
string |
@type |
The class type of this Product offering |
string |
billingEvent |
Represents the billing event for one time prices. Could be : paynow, onfistbill, oncancellation. |
string |
bundledPop |
Represents the contained prices (charges), for a composed price. |
< ProductOfferingPrice > array |
bundledPopRelationship |
Not Sent. |
< BundledPopRelationship > array |
channel |
< ChannelRef > array |
|
constraint |
Not Sent. |
< ConstraintRef > array |
description |
Not Sent.Description of the productOfferingPrice |
string |
href |
Not Sent |
string |
id |
Price identifier. |
string |
isBundle |
A flag indicating if this POP is composite (bundle) or not |
boolean |
isPriceOverride |
A flag indicating if the price is defined directly for a simple product offering, or for a product offering bought as part of a bundled product offering. |
boolean |
lastUpdate |
Last modified time of price. |
string(date-time) |
lifecycleStatus |
Not Sent.The lifecycle status of this POP. |
string |
name |
Name of the productOfferingPrice. |
string |
percentage |
Percentage to apply for ProdOfferPriceAlteration (Discount). |
number(float) |
place |
Place references where the products are sold or delivered. |
< PlaceRef > array |
poRelationship |
Represents the product offering affected, or required by the price. This field is used for bundle product offerings. |
< PoRelationshipRef > array |
popRelationship |
Not Sent. |
< PopRelationship > array |
price |
The amount of money that characterizes the price. |
|
priceType |
A category that describes the price such as recurring, one time and usage. |
string |
pricingLogicAlgorithm |
Not Sent. |
< PricingLogicAlgorithm > array |
priority |
The priority of the price. |
integer(int32) |
processType |
Represents the purchasing flows for which the price is applicable. |
< ProcessType > array |
prodSpecCharValueUse |
< ProdSpecCharValueUse > array |
|
productOfferingTerm |
< ProductOfferingTerm > array |
|
recurringChargePeriodLength |
The period of the recurring charge: 1, 2, … .It sets to zero if it is not applicable |
integer(int32) |
recurringChargePeriodType |
The period to repeat the application of the price. Could be month,quarter,year.. |
string |
relatedParty |
||
tax |
Not Sent. |
< Tax > array |
unitOfMeasure |
A number and unit representing how many (for instance 1 dozen) of an ProductOffering is available at the offered price. Its meaning depends on the priceType. It could be a price, a rate, or a discount. |
|
validFor |
The period for which the productOfferingPrice is valid. |
|
version |
Not Sent.ProductOffering version. |
string |
4.70. ProductOfferingRecommendationRef
ProductOfferingRecommendationRef subtype of the ProductOfferingRef entity.
Polymorphism : Composition
| Name | Description | Schema |
|---|---|---|
@referredType |
Type (class) of the product offering |
string |
@type |
Type (class) of the product offering |
string |
href |
Reference of the product offering |
string |
id |
Unique identifier of the product offering |
string |
image |
Thumbnail image of the product offering |
|
name |
Name of the product offering |
string |
productOfferingTerm |
< ProductOfferingTermRef > array |
|
variantOption |
Variant options, in case of a variant product offering. |
< VariantOption > array |
4.71. ProductOfferingRef
ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
| Name | Description | Schema |
|---|---|---|
@referredType |
Type (class) of the product offering |
string |
@type |
Type (class) of the product offering |
string |
href |
Reference of the product offering |
string |
id |
Unique identifier of the product offering |
string |
image |
Thumbnail image of the product offering |
|
name |
Name of the product offering |
string |
variantOption |
Variant options, in case of a variant product offering. |
< VariantOption > array |
4.72. ProductOfferingTerm
A condition under which a ProductOffering is made available to Customers. For instance, a productOffering can be offered with multiple commitment periods.
| Name | Description | Schema |
|---|---|---|
@schemaLocation |
A link to the schema describing this product offering term |
string |
@type |
The class type of ProductOfferingTerm |
string |
description |
Not Sent.Description of the productOfferingTerm |
string |
duration |
Duration of the productOfferingTerm |
|
id |
Id of the productOfferingTerm |
string |
name |
Name of the productOfferingTerm |
string |
validFor |
Not Sent.The period for which the productOfferingterm is valid |
4.73. ProductOrder
Product order resource
| Name | Description | Schema |
|---|---|---|
@baseType |
Indicates the base type of the resource. Here can be 'ProductOrder'. |
string |
@schemaLocation |
A link to the schema describing this REST resource. |
string |
@type |
Indicates the type of resource. Here can be 'ProductOrder'. |
string |
billingAccount |
||
category |
Used to categorize the order from a business perspective that can be useful for the OM system (e.g. 'enterprise', 'residential', …). |
string |
channel |
< Channel > array |
|
completionDate |
Date when the order was completed. |
string(date-time) |
description |
Description of the product order |
string |
expectedCompletionDate |
Expected delivery date amended by the provider |
string(date-time) |
externalId |
ID given by the consumer and only understandable by him (to facilitate his searches afterwards). |
string |
href |
Hyperlink to access the order |
string |
id |
ID created on repository side (OM system) |
string |
note |
< Note > array |
|
notificationContact |
Contact attached to the order to send back information regarding this order |
string |
orderCost |
Represents the delivery and payment costs for the order |
< OrderPrice > array |
orderDate |
Date when the order was created |
string(date-time) |
orderItem |
< OrderItem > array |
|
orderTotalPrice |
< OrderPrice > array |
|
payment |
< PaymentRef > array |
|
priority |
enum (0, 1, 2, 3, 4) |
|
promotion |
< PromotionRef > array |
|
relatedParty |
< RelatedPartyRef > array |
|
requestedCompletionDate |
Requested delivery date from the requestor perspective |
string(date-time) |
requestedStartDate |
Order start date wished by the requestor |
string(date-time) |
shoppingCart |
Reference to the shopping cart resource collecting purchase entries used as input for place order |
|
state |
enum (CANCELLING, CHECKED_VALID, CREATED, CHECKED_INVALID, ON_VALIDATION, SUSPENDED, COMPLETED, PAYMENT_AUTHORIZED, CANCELLED, PAYMENT_NOT_AUTHORIZED, PAYMENT_AMOUNT_RESERVED, PAYMENT_AMOUNT_NOT_RESERVED, PAYMENT_CAPTURED, PAYMENT_NOT_CAPTURED, FRAUD_CHECKED, ORDER_SPLIT, PROCESSING_ERROR, WAIT_FRAUD_MANUAL_CHECK, PAYMENT_NOT_VOIDED, TAX_NOT_VOIDED, TAX_NOT_COMMITTED, TAX_NOT_REQUOTED) |
4.74. ProductOrderRef
The product order(s) related to this product inventory
| Name | Description | Schema |
|---|---|---|
@referredType |
Indicate the class (type) of productOrder |
string |
href |
Hypertext Reference of the product order |
string |
id |
Unique identifier of product order |
string |
orderItemAction |
Action of the order item for this product |
string |
orderItemId |
Identifier of the order item where the product was managed |
string |
4.75. ProductPrice
An amount, usually of money, that represents the actual price paid by a Customer for a purchase, a rent or a lease of a Product. The price is valid for a defined period of time.
| Name | Description | Schema |
|---|---|---|
@schemaLocation |
A link to the schema describing this REST resource |
string |
@type |
Indicates the type of ProductPrice class |
string |
billingAccount |
||
description |
A narrative that explains in detail the semantics of this product price |
string |
id |
Unique identifier of a productOfferingPrice |
string |
name |
A short descriptive name such as "Subscription price" |
string |
price |
||
priceType |
A category that describes the price, such as recurring, discount, allowance, penalty, and so forth |
string |
prodPriceAlteration |
||
recurringChargePeriod |
Could be month, week… |
string |
unitOfMeasure |
Could be minutes, GB… |
string |
4.76. ProductRef
A product reference to be used for relationship target
| Name | Description | Schema |
|---|---|---|
href |
Reference of the product |
string |
id |
Unique identifier of the product |
string |
4.77. ProductRelationship
Type of the product relationship. it can be 'bundled' if the product is a bundle and you want to describe the 'bundled' products inside this bundle, 'reliesOn' if the product needs another already owned product to rely on (e.g. an option on an already owned mobile access product) or 'targets' or 'isTargeted' (depending on the way of expressing the link) for any other kind of links that may be useful
| Name | Description | Schema |
|---|---|---|
product |
||
type |
Type of the product relationship |
string |
4.78. ProductSpecCharacteristicRef
Product Spec Characteristic reference.
| Name | Description | Schema |
|---|---|---|
@referredType |
Class type of the referred product spec characteristic |
string |
href |
Reference of the product spec characteristic |
string |
id |
Identifier of the product spec characteristic |
string |
name |
Name of the product spec characteristic |
string |
4.79. ProductSpecCharacteristicValue
A number or text that can be assigned to a ProductSpecCharacteristic.
| Name | Description | Schema |
|---|---|---|
@schemaLocation |
Hyperlink reference to schema describing this object |
string |
@type |
The class type of the characteristic value |
string |
isDefault |
Not Sent |
boolean |
rangeInterval |
Not Sent |
string |
regex |
Not Sent |
string |
unitOfMeasure |
Could be minutes, GB… |
string |
validFor |
Not Sent |
|
value |
The value of characteristic.The type of value is determined by ‘valueType’ characteristic. |
string |
valueFrom |
Not Sent |
string |
valueTo |
Not Sent |
string |
valueType |
A kind of value that the characteristic can take on, such as numeric, string, boolean. |
string |
4.80. ProductSpecification
A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
| Name | Description | Schema |
|---|---|---|
@referredType |
Indicate the productSpecification type class |
string |
describing |
||
href |
Reference of the product specification |
string |
id |
Unique identifier of the product specification |
string |
name |
Name of the product specification |
string |
version |
Version of the product specification |
string |
4.81. ProductSpecificationRef
Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
| Name | Description | Schema |
|---|---|---|
@referredType |
class type of referred Product Specification |
string |
href |
Reference of the product specification.(Not supported yet) |
string |
id |
Unique identifier of the product specification |
string |
name |
Name of the product specification |
string |
version |
Version of the product specification API (Not supported yet) |
string |
4.82. ProductTerm
This represent a commitment with a duration
| Name | Description | Schema |
|---|---|---|
@type |
Indicate the class (type) of the product term |
string |
description |
Description of the commitment term |
string |
duration |
||
name |
Name of the commitment term |
string |
validFor |
4.83. PromotionRef
Reference to promotion.
| Name | Description | Schema |
|---|---|---|
@referredType |
Class type of the referred promotion. |
string |
@type |
Generic attribute containing the name of the resource class type |
string |
href |
Url used to reference the promotion. |
string |
id |
Unique identifier for promotion. |
string |
message |
Promotion description |
string |
status |
The status of the promotion. |
enum (APPLIED, POTENTIAL) |
4.84. QualificationRef
It could be a serviceQualification or a productOfferingQualification that has been executed previously and captured in the productOrder to provide 'eligibility' information.
| Name | Description | Schema |
|---|---|---|
@referredType |
Indicates the type of resource. Here it can be a type of qualification. (could a service qualification or a product offering qualification). |
string |
href |
href of the qualification. |
string |
id |
Identifier of a pre-existing qualification. |
string |
qualificationItemId |
Id of an item of a qualification. |
string |
4.85. QualifiedProcessType
The list of process types that the related party is eligible for.
| Name | Description | Schema |
|---|---|---|
@schemaLocation |
A link to the schema describing the EligibleProcessType |
string |
@type |
Indicated the type of the EligibleProcessType |
string |
href |
Reference of the EligibleProcessType. |
string |
id |
Unique identifier of a qualified process type |
string |
processType |
The ProcessType that the related party is eligible for. |
|
relatedParty |
The relatedParty that the ProcessType belongs to. |
4.86. Quantity
Description of a quantity like for the Duration attribute
| Name | Description | Schema |
|---|---|---|
amount |
A value for the quantity |
number(float) |
units |
A unit associated with the quantity (for example months) |
string |
4.87. RealizingResource
RealizingResource reference. RealizingResource is a link to the resource that realizes the product.
| Name | Description | Schema |
|---|---|---|
@referredType |
Indicate the class (type) of the realizing resource |
string |
href |
Reference of the resource |
string |
id |
Unique identifier of the resource |
string |
name |
Name of the resource. |
string |
role |
Role of the resource |
string |
4.88. RealizingService
RealizingService reference. RealizingService is a link to the service that realizes the product.
| Name | Description | Schema |
|---|---|---|
@referredType |
Indicate the class (type) of the realizing service. |
string |
href |
Reference of the service |
string |
id |
Unique identifier of the service |
string |
name |
Name of the service |
string |
role |
Role of the realizing service |
string |
4.89. Recommendation
Recommendation API is used to recommend offering quickly based on the history and real-time context of customer. It is a real-time and personalized recommendation API. It is usually provided by e-commerce or BSS, CRM system in omni-channel.
| Name | Description | Schema |
|---|---|---|
@baseType |
The base type for use in polymorphic collections |
string |
@schemaLocation |
A link to the schema describing a resource (for type extension). |
string |
@type |
The class type of the actual resource (for type extension). |
string |
category |
The category for grouping recommendations |
|
channel |
||
description |
string |
|
href |
Hypertext Reference of the recommendation. |
string |
id |
Unique identifier of recommendation |
string |
item |
< RecommendationItem > array |
|
location |
The place which the recommendation is related with |
|
name |
Name of recommendation |
string |
order |
||
relatedParty |
||
shoppingCart |
The shopping cart which the recommendation is related with. |
|
type |
Type of recommendation. The basic type is : ¡®AD¡¯: it means the recommendation is the advertisement for display ¡®OFFER¡¯: it means the recommended content is the offer entry page. By clicking it, the user can be forwarded to the details of the offering |
string |
validFor |
The period in which the recommendation is valid. |
4.90. RecommendationItem
A list of recommendation items. Every item is a product offering and its rank.
| Name | Description | Schema |
|---|---|---|
@baseType |
The base type for use in polymorphic collections |
string |
@schemaLocation |
A link to the schema describing a resource (for type extension). |
string |
@type |
The class type of the actual resource (for type extension). |
string |
offering |
Recommended product offering |
|
price |
< ProductOfferingPrice > array |
|
priority |
The rank of the list of recommended offering. |
integer(int32) |
4.91. RecurringChargeCartPrice
A cart price charge paid recursively.
Polymorphism : Composition
| Name | Description | Schema |
|---|---|---|
@baseType |
Generic attribute indicating the base class type of the extension class of the current object. Useful only when the class type of the current object is unknown to the implementation. |
string |
@schemaLocation |
Generic attribute containing the link to the schema that defines the structure of the class type of the current object. |
string |
@type |
Generic attribute containing the name of the resource class type |
string |
cartPrice |
< CartPrice > array |
|
cycle |
Represents the start time, and end time of the recurring cycle (the first 3 months) . If empty, the cycle is the entire recurring period. |
|
description |
A narrative that explains in detail the semantics of this order item price. |
string |
id |
The id of the price. |
string |
name |
A short descriptive name such as "Subscription price". |
string |
price |
||
priceAlteration |
< PriceAlteration > array |
|
priceType |
Type of price, such as: OneTime, Recurring, Usage. |
string |
recurringChargePeriod |
Could be month, week… |
string |
unitOfMeasure |
Could be minutes, GB… |
string |
usageChargeType |
The type of the usage charge |
string |
4.92. RecurringChargeOrderPrice
An order price charge paid recursively.
Polymorphism : Composition
| Name | Description | Schema |
|---|---|---|
@baseType |
Indicate the base type of orderPrice. |
string |
@schemaLocation |
A link to the schema describing this orderPrice extension. |
string |
@type |
Indicate the type of orderPrice. |
string |
billingAccount |
||
cycle |
Represents the start time, and end time of the recurring cycle (the first 3 months) . If empty, the cycle is the entire recurring period. |
|
description |
A narrative that explains in detail the semantics of this order item price |
string |
id |
id |
string |
name |
A short descriptive name such as "Subscription price". |
string |
orderPrice |
< OrderPrice > array |
|
price |
||
priceAlteration |
< PriceAlteration > array |
|
priceType |
enum (recurring, oneTime, usage, PRODUCT_PRICE, DELIVERY_COST, PAYMENT_COST, DISCOUNT) |
|
recurringChargePeriod |
Could be month, week,… |
string |
unitOfMeasure |
Could be minutes, gigaBytes,… |
string |
usageChargeType |
The type of the usage charge. |
string |
4.93. RecurringPriceCharge
A price charge paid recursively.
Polymorphism : Composition
| Name | Description | Schema |
|---|---|---|
@baseType |
The immediate base class type of this product offering |
string |
@schemaLocation |
hyperlink reference to the schema describing this resource |
string |
@type |
The class type of this Product offering |
string |
billingEvent |
Represents the billing event for one time prices. Could be : paynow, onfistbill, oncancellation. |
string |
bundledPop |
Represents the contained prices (charges), for a composed price. |
< ProductOfferingPrice > array |
bundledPopRelationship |
Not Sent. |
< BundledPopRelationship > array |
channel |
< ChannelRef > array |
|
constraint |
Not Sent. |
< ConstraintRef > array |
cycle |
Represents the start time, and end time of the recurring cycle (the first 3 months) . If empty, the cycle is the entire recurring period. |
|
description |
Not Sent.Description of the productOfferingPrice |
string |
href |
Not Sent |
string |
id |
Price identifier. |
string |
isBundle |
A flag indicating if this POP is composite (bundle) or not |
boolean |
isPriceOverride |
A flag indicating if the price is defined directly for a simple product offering, or for a product offering bought as part of a bundled product offering. |
boolean |
lastUpdate |
Last modified time of price. |
string(date-time) |
lifecycleStatus |
Not Sent.The lifecycle status of this POP. |
string |
name |
Name of the productOfferingPrice. |
string |
percentage |
Percentage to apply for ProdOfferPriceAlteration (Discount). |
number(float) |
place |
Place references where the products are sold or delivered. |
< PlaceRef > array |
poRelationship |
Represents the product offering affected, or required by the price. This field is used for bundle product offerings. |
< PoRelationshipRef > array |
popRelationship |
Not Sent. |
< PopRelationship > array |
price |
The amount of money that characterizes the price. |
|
priceType |
A category that describes the price such as recurring, one time and usage. |
string |
pricingLogicAlgorithm |
Not Sent. |
< PricingLogicAlgorithm > array |
priority |
The priority of the price. |
integer(int32) |
processType |
Represents the purchasing flows for which the price is applicable. |
< ProcessType > array |
prodSpecCharValueUse |
< ProdSpecCharValueUse > array |
|
productOfferingTerm |
< ProductOfferingTerm > array |
|
recurringChargePeriodLength |
The period of the recurring charge: 1, 2, … .It sets to zero if it is not applicable |
integer(int32) |
recurringChargePeriodType |
The period to repeat the application of the price. Could be month,quarter,year.. |
string |
relatedParty |
||
tax |
Not Sent. |
< Tax > array |
unitOfMeasure |
A number and unit representing how many (for instance 1 dozen) of an ProductOffering is available at the offered price. Its meaning depends on the priceType. It could be a price, a rate, or a discount. |
|
validFor |
The period for which the productOfferingPrice is valid. |
|
version |
Not Sent.ProductOffering version. |
string |
4.94. RelatedParty
The party which the product is related with.
| Name | Description | Schema |
|---|---|---|
@referredType |
Indicates the (class) type of party |
string |
href |
Reference of the related party |
string |
id |
Unique identifier of the related party |
string |
name |
Name of the related party |
string |
role |
Role played by the related party |
string |
validFor |
4.95. RelatedPartyRef
RelatedParty reference. A related party defines party or party role linked to a specific entity.
| Name | Description | Schema |
|---|---|---|
@referredType |
The class type of referred party/party role reference |
string |
href |
Reference of the related party, could be a party reference or a party role reference |
string |
id |
Unique identifier of a related party |
string |
name |
Name of the related party |
string |
role |
Role of the related party. |
string |
validFor |
Validity period of the related party |
4.96. RelatedPartyRefType
Information about an associated entity and its role
| Name | Description | Schema |
|---|---|---|
@referredType |
Type of party (e.g.: account, customer, user…) |
string |
href |
Reference to the party |
string |
id |
Unique identifier of the related party |
string |
name |
Name of the party |
string |
role |
Role of the related entity |
string |
4.97. ResourceCandidateRef
ResourceCandidate reference: A resource candidate is an entity that makes a ResourceSpecification available to a catalog.
| Name | Description | Schema |
|---|---|---|
@referredType |
The Class type of referred Resource Candidate |
string |
href |
Reference of the resource candidate |
string |
id |
Unique identifier of the resource candidate |
string |
name |
Name of the resource candidate |
string |
version |
Version of the resource candidate |
string |
4.98. Review
The review resource contains the users opinion for a product
| Name | Description | Schema |
|---|---|---|
alias |
The name of the user, otherwise is Anonymous |
string |
comment |
Comment of the review |
string |
creationDate |
Date and time of the creation |
string(date-time) |
headline |
Headline of the review |
string |
id |
Unique identifier of the review |
string |
language |
Language of the review |
string |
productOffering |
Product offering reference. |
|
rating |
Rating of the review |
string |
relatedParty |
||
status |
enum (approved, pending, rejected) |
4.99. SLARef
ServiceLevelAgreement reference: A service level agreement (SLA) is a type of agreement that represents a formal negotiated agreement between two parties designed to create a common understanding about products, services, priorities, responsibilities, and so forth. The SLA is a set of appropriate procedures and targets formally or informally agreed between parties in order to achieve and maintain specified Quality of Service.
| Name | Description | Schema |
|---|---|---|
@referredType |
class type of referred Service Level Agreement |
string |
href |
Reference of the service level agreement |
string |
id |
Unique identifier of service level agreement |
string |
name |
Name of the service level agreement |
string |
4.100. ServiceCandidateRef
ServiceCandidate reference. ServiceCandidate is an entity that makes a ServiceSpecification available to a catalog.
| Name | Description | Schema |
|---|---|---|
@referredType |
The Class type of referred Service Candidate |
string |
href |
Unique reference of the service candidate |
string |
id |
Unique identifier of the service candidate |
string |
name |
Name of the service candidate |
string |
version |
Version of the service candidate |
string |
4.101. ShoppingCart
Shopping Cart resource is used for the temporarily selection and reservation of product offerings in e-commerce, call center and retail purchase. Shopping cart supports purchase of both physical and digital goods and service (e.g. handset, telecom network service). Shopping Cart contain list of cart items, a reference to customer (partyRole) or contact medium in case customer not exist, and the total items price including promotions
| Name | Description | Schema |
|---|---|---|
@baseType |
Generic attribute indicating the base class type of the extension class of the current object. Useful only when the class type of the current object is unknown to the implementation. |
string |
@schemaLocation |
Generic attribute containing the link to the schema that defines the structure of the class type of the current object. |
string |
@type |
Generic attribute containing the name of the resource class type |
string |
baseSiteId |
Identifier of the base site |
string |
cartCosts |
Represents the delivery and payment costs for the cart |
< CartPrice > array |
cartItem |
< CartItem > array |
|
cartTotalPrice |
Total amount of the shopping cart, usually of money, that represents the actual price paid by the Customer for cart (considering only "Active" cart items) |
< CartPrice > array |
contactMedium |
< ContactMedium > array |
|
deliveryMode |
Reference to the delivery mode |
|
href |
Hyperlink to access the shopping cart |
string |
id |
Unique identifier created on provider side (e.g. Order Capture system) |
string |
message |
Deprecated since 1911 |
< Message > array |
paymentMethod |
The payment methods of the cart. |
< PaymentMethodRef > array |
place |
< Place > array |
|
promotion |
< PromotionRef > array |
|
relatedParty |
< RelatedPartyRef > array |
|
status |
status of the shopping cart |
string |
validFor |
The period for which the shopping cart is valid (e.g. 90 if no activity or 7 days if cart is empty) |
|
validation |
< ValidationItem > array |
4.102. ShoppingCartRef
Reference to the shopping cart
| Name | Description | Schema |
|---|---|---|
href |
Reference of the shopping cart |
string |
id |
Unique identifier of the shopping cart |
string |
4.103. StackTraceElement
| Name | Schema |
|---|---|
classLoaderName |
string |
className |
string |
fileName |
string |
lineNumber |
integer(int32) |
methodName |
string |
moduleName |
string |
moduleVersion |
string |
nativeMethod |
boolean |
4.104. SubscriptionAccess
Customer’s role on a certain subscription base
| Name | Schema |
|---|---|
accessType |
enum (OWNER, ADMINISTRATOR, BENEFICIARY) |
relatedParty |
|
subscriptionBase |
4.105. SubscriptionBase
The subscription base.
| Name | Description | Schema |
|---|---|---|
@schemaLocation |
A link to the schema describing this subscription base. |
string |
@type |
Class type of the subscription base. |
string |
billingAccount |
Reference to the billing account. |
|
billingSystem |
Reference to the billing system. |
|
href |
Reference of the subscription base. |
string |
id |
Identifier of the subscription base. |
string |
subscriberIdentity |
The subscriber’s identity. |
string |
subscriptionAccess |
Customer’s role on a certain subscription base. |
< SubscriptionAccess > array |
4.106. SubscriptionBaseRef
SubscriptionBase reference.
| Name | Description | Schema |
|---|---|---|
href |
Url used to reference the SubscriptionBase |
string |
id |
Identifier of the subscription base |
string |
4.107. TargetResourceSchema
Target to the schema describing the product spec resource
| Name | Description | Schema |
|---|---|---|
@schemaLocation |
A link to the schema describing the product spec |
string |
@type |
Indicated the type of the productSpec described there - for example an E-Line Spec, a CPE spec |
string |
4.108. Tax
An amount of money levied on the price of a Product by a legislative body.
| Name | Description | Schema |
|---|---|---|
taxAmount |
tax amount |
|
taxCategory |
A categorization of the tax rate. |
|
taxRate |
Tax rate |
number(float) |
4.109. Throwable
| Name | Schema |
|---|---|
cause |
|
localizedMessage |
string |
message |
string |
stackTrace |
< StackTraceElement > array |
suppressed |
< Throwable > array |
4.110. TimePeriod
A time period described through 2 dates
| Name | Schema |
|---|---|
endDateTime |
string(date-time) |
startDateTime |
string(date-time) |
4.111. TimePeriodType
Representation of a time period
| Name | Description | Schema |
|---|---|---|
endDateTime |
End date of the period |
string(date-time) |
startDateTime |
Start date of the period |
string(date-time) |
4.112. TmaBalanceWsDto
The balance defines the remaining allowed product usage quantity in terms of volume, time, currency or events. It corresponds to the initial allowed usage quantity minus the usage consumed on the bucket.
| Name | Description | Schema |
|---|---|---|
remainingValue |
Numeric remaining value for the bucket given in the balance unit (for example 1.9). This numeric value could be used for calculation for example |
integer(int64) |
remainingValueLabel |
Remaining value in a formatted string for the bucket given in the balance unit (for example 1.9 Gb). This formatted string could be used for display needs for example |
string |
schemaLocation |
Link to the schema describing the REST resource |
string |
type |
Indicates the (class) type of the bucket balance |
string |
unit |
Code of the unit used to specify the given value of the balance. It could be different from the bucket unit |
string |
validFor |
4.113. TmaBillingAccountRefWsDto
A BillingAccount is a detailed description of a bill structure
| Name | Description | Schema |
|---|---|---|
href |
Reference of the billing account |
string |
id |
Unique identier of the billing account |
string |
name |
Name of the billing account |
string |
referredType |
Indicates the (class) type of the billing account |
string |
4.114. TmaBucketWsDto
A bucket represents a quantity of usage, as 2 hours national calls or 50 sms for example. It could be either a quantity or an amount in a currency (i.e. It could represent a fixed number of SMS, MMS, minutes of calls, quantity of data, number of events as well as a specific amount in a given currency). It requires one or more network products from which usages will debit the bucket.
| Name | Description | Schema |
|---|---|---|
bucketBalance |
< TmaBalanceWsDto > array |
|
bucketCounter |
< TmaConsumptionCounterWsDto > array |
|
id |
Unique identifier of the bucket |
string |
isShared |
True if the bucket is shared between several devices or users |
boolean |
name |
Bucket name |
string |
product |
||
schemaLocation |
Link to the schema describing the REST resource |
string |
type |
Indicates the (class) type of bucket |
string |
usageType |
Type of usage concerned by the bucket (voice, sms, data,…) |
string |
4.115. TmaConsumptionCounterWsDto
The consumption counters detail for example the different kind of consumption done on the bucket
| Name | Description | Schema |
|---|---|---|
counterType |
Type of the consumption counter. We can give for example a counter of the used value |
string |
level |
Counter level. The given counter can be given globally for the bucket or detailed by user or by product for example in case of shared bucket |
string |
product |
||
schemaLocation |
Link to the schema describing the REST resource |
string |
type |
Indicates the (class) type of consumption counter |
string |
unit |
Unit of the counter |
string |
user |
||
validFor |
||
value |
Numeric value of the bucket counter in the given unit |
integer(int64) |
valueLabel |
Value of the counter in a formatted string used for display needs for example |
string |
4.116. TmaErrorRepresentationWsDto
Standard TMF error representation
| Name | Description | Schema |
|---|---|---|
code |
Application related code (as defined in the API or from a common list) |
integer(int32) |
message |
Text that provides more details and corrective actions related to the error. This can be shown to a client user. |
string |
reason |
Text that explains the reason for error. This can be shown to a client user. |
string |
referenceError |
URL pointing to documentation describing the error |
string |
status |
http error code extension like 400-2 |
string |
4.117. TmaPlaceWsDto
Place defines the places where the products is installed or has a footprint (a place could be used for geo fencing
| Name | Description | Schema |
|---|---|---|
href |
Reference of the place |
string |
id |
Unique identifier of the place |
string |
name |
A user-friendly name for the place |
string |
referredType |
Indicate the type of Place class (example: 'geographicAddress') |
string |
role |
Role of the place (for instance: 'installation site', 'A-extremity site', 'Supervised Perimeter' etc…) |
string |
schemaLocation |
A link to the schema describing this REST resource |
string |
4.118. TmaPriceAlterationWsDto
Is an amount, usually of money, that modifies the price charged for a Product
| Name | Description | Schema |
|---|---|---|
description |
A narrative that explains in detail the semantics of this ProdPriceAlteration |
string |
id |
Link to the schema describing this REST resource. |
string |
name |
A short descriptive name such as "Monthly discount" |
string |
price |
||
priceType |
A category that describes the price such as recurring, one shot and so forth |
string |
priority |
Priority level for applying this alteration among all the defined alterations |
integer(int32) |
recurringChargePeriod |
Could be month, week… |
string |
schemaLocation |
A link to the schema describing the price alteration. |
string |
type |
Indicated the class (type) of the price alteration. |
string |
unitOfMeasure |
Could be minutes, GB… |
string |
validFor |
4.119. TmaPriceWsDto
Provides all amounts (tax included, duty free, tax rate), used currency and percentage applied for price and price alteration
| Name | Description | Schema |
|---|---|---|
@schemaLocation |
Link to the schema describing this REST resource. |
string |
@type |
Indicates the (class) type of the price |
string |
dutyFreeAmount |
||
percentage |
Percentage applied |
number(float) |
taxIncludedAmount |
||
taxRate |
Applied tax rate on amount |
number(float) |
4.120. TmaProductCharacteristicWsDto
Characteristics of the product to instantiate or to modify.
| Name | Description | Schema |
|---|---|---|
name |
Name of the characteristic |
string |
schemaLocation |
This field provided a link to the schema describing this REST resource. |
string |
type |
Indicates the (class) type of resource |
string |
value |
Value of the characteristic |
string |
4.121. TmaProductOfferingRefWsDto
ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.
| Name | Description | Schema |
|---|---|---|
href |
Reference of the product offering |
string |
id |
Unique identifier of the product offering |
string |
name |
Name of the product offering |
string |
referredType |
Type (class) of the product offering |
string |
4.122. TmaProductOrderRefWsDto
The product order(s) related to this product inventory
| Name | Description | Schema |
|---|---|---|
href |
Hypertext Reference of the product order |
string |
id |
Unique identifier of product order |
string |
orderItemAction |
Action of the order item for this product |
string |
orderItemId |
Identifier of the order item where the product was managed |
string |
referredType |
Indicate the class (type) of productOrder |
string |
4.123. TmaProductPriceWsDto
An amount, usually of money, that represents the actual price paid by a Customer for a purchase, a rent or a lease of a Product. The price is valid for a defined period of time.
| Name | Description | Schema |
|---|---|---|
billingAccount |
||
description |
A narrative that explains in detail the semantics of this product price |
string |
id |
Unique identifier of a productOfferingPrice |
string |
name |
A short descriptive name such as "Subscription price" |
string |
price |
||
priceType |
A category that describes the price, such as recurring, discount, allowance, penalty, and so forth |
string |
prodPriceAlteration |
||
recurringChargePeriod |
Could be month, week… |
string |
schemaLocation |
A link to the schema describing this REST resource |
string |
type |
Indicates the type of ProductPrice class |
string |
unitOfMeasure |
Could be minutes, GB… |
string |
4.124. TmaProductRefWsDto
Reference of a product
| Name | Description | Schema |
|---|---|---|
href |
Reference of the product |
string |
id |
Unique identifier of the product |
string |
name |
Subscribed Product name |
string |
publicIdentifier |
Public number associated to the product (msisdn number for mobile line for example) |
string |
user |
4.125. TmaProductRelationshipWsDto
Type of the product relationship. it can be 'bundled' if the product is a bundle and you want to describe the 'bundled' products inside this bundle, 'reliesOn' if the product needs another already owned product to rely on (e.g. an option on an already owned mobile access product) or 'targets' or 'isTargeted' (depending on the way of expressing the link) for any other kind of links that may be useful
| Name | Description | Schema |
|---|---|---|
product |
||
type |
Type of the product relationship |
string |
4.126. TmaProductSpecificationWsDto
A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
| Name | Description | Schema |
|---|---|---|
describing |
||
href |
Reference of the product specification |
string |
id |
Unique identifier of the product specification |
string |
name |
Name of the product specification |
string |
referredType |
Indicate the productSpecification type class |
string |
version |
Version of the product specification |
string |
4.127. TmaProductTermWsDto
This represent a commitment with a duration
| Name | Description | Schema |
|---|---|---|
@type |
Indicate the class (type) of the product term |
string |
description |
Description of the commitment term |
string |
duration |
||
name |
Name of the commitment term |
string |
validFor |
4.128. TmaProductWsDto
A Product represents the subscription of a ProductOffering by a Party playing a PartyRole, such as a Customer. For example, Jean has subscribed to company ABC’s internet ProductOffering. The association between ProductSpecification and Product allows ProductSpecification, to be instantiated as Product and related to customers or other involved parties.
| Name | Description | Schema |
|---|---|---|
baseType |
Indicates the base type of the resource. Here can be 'Product' |
string |
billingAccount |
< TmaBillingAccountRefWsDto > array |
|
characteristic |
< TmaProductCharacteristicWsDto > array |
|
description |
The description of the product. It could be copied from the description of the Product Offering. |
string |
href |
Reference of the product |
string |
id |
Unique identifier of the product |
string |
isBundle |
If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent which is an instantiation of a SimpleProductOffering |
boolean |
isCustomerVisible |
If true, the product is visible by the customer |
boolean |
name |
The name of the product. It could be the same as the name of the Product Offering |
string |
place |
< TmaPlaceWsDto > array |
|
productOffering |
||
productOrder |
< TmaProductOrderRefWsDto > array |
|
productPrice |
< TmaProductPriceWsDto > array |
|
productRelationship |
< TmaProductRelationshipWsDto > array |
|
productSerialNumber |
Serial number for the product. This is typically applicable to tangible products e.g. Broadband Router. |
string |
productSpecification |
||
productTerm |
< TmaProductTermWsDto > array |
|
publicIdentifier |
Public number associated to the product (msisdn number for mobile line for example) |
string |
realizingResource |
< TmaRealizingResourceWsDto > array |
|
realizingService |
< TmaRealizingServiceWsDto > array |
|
relatedParty |
< TmaRelatedPartyWsDto > array |
|
schemaLocation |
A link to the schema describing this REST resource. |
string |
startDate |
The date from which the product starts |
string |
status |
enum (created, pendingActive, cancelled, active, pendingTerminate, terminated, suspended, aborted) |
|
terminationDate |
The date when the product was terminated. Not applicable to active products |
string |
type |
Indicated the type of resource. |
string |
user |
4.129. TmaRealizingResourceWsDto
RealizingResource reference. RealizingResource is a link to the resource that realizes the product.
| Name | Description | Schema |
|---|---|---|
href |
Reference of the resource |
string |
id |
Unique identifier of the resource |
string |
name |
Name of the resource. |
string |
referredType |
Indicate the class (type) of the realizing resource |
string |
role |
Role of the resource |
string |
4.130. TmaRealizingServiceWsDto
RealizingService reference. RealizingService is a link to the service that realizes the product.
| Name | Description | Schema |
|---|---|---|
href |
Reference of the service |
string |
id |
Unique identifier of the service |
string |
name |
Name of the service |
string |
referredType |
Indicate the class (type) of the realizing service. |
string |
role |
Role of the realizing service |
string |
4.131. TmaRelatedPartyWsDto
The party which the product is related with.
| Name | Description | Schema |
|---|---|---|
href |
Reference of the related party |
string |
id |
Unique identifier of the related party |
string |
name |
Name of the related party |
string |
referredType |
Indicates the (class) type of party |
string |
role |
Role played by the related party |
string |
validFor |
4.132. TmaSubscriptionBaseDetailRefWsDto
A subscriptionBaseDetail is a detailed description of Subscription base.
| Name | Description | Schema |
|---|---|---|
accessType |
Reference of the Customer Access to the Subscription |
string |
id |
Unique identifier of the Subscription base |
string |
product |
< TmaProductRefWsDto > array |
|
relatedPartyRef |
< TmaRelatedPartyWsDto > array |
4.133. TmaSubscriptionBaseWsDto
A Subscription base represents the subscription base for subscription fo a Customer.
| Name | Description | Schema |
|---|---|---|
baseType |
Indicates the base type of the resource. Here can be 'Product' |
string |
description |
The description of the API |
string |
effectiveDate |
Current date |
string |
href |
Reference of the API |
string |
id |
Unique identifier of the response |
string |
name |
Name of the API |
string |
schemaLocation |
A link to the schema describing this REST resource. |
string |
subscriptionBase |
||
type |
Indicated the type of resource. |
string |
user |
4.134. TmaTargetResourceSchemaWsDto
Target to the schema describing the product spec resource
| Name | Description | Schema |
|---|---|---|
schemaLocation |
A link to the schema describing the product spec |
string |
type |
Indicated the type of the productSpec described there - for example an E-Line Spec, a CPE spec |
string |
4.135. TmaTimePeriodWsDto
A date time period between a start date and an end date
| Name | Description | Schema |
|---|---|---|
endDateTime |
End date time of the period |
string |
startDateTime |
Start date time of the period |
string |
4.136. TmaUsageConsumptionReportWsDto
An usage consumption report enables to know at a given point the balances and the consumption counters related to various buckets (SMS, Voice, Data for example). It could be calculated for a device identified by a public key (msisdn number for a mobile device for example or PSTN or VOIP number for a fix device), for a subscribed offer or option or for an user.
| Name | Description | Schema |
|---|---|---|
baseType |
Indicates the base (class) type of the usage consumption report |
string |
bucket |
< TmaBucketWsDto > array |
|
description |
Free short text describing the usage consumption report content |
string |
effectiveDate |
Date and time when the usage consumption report was calculated and generated |
string |
href |
Hyperlink to access the usage consumption report |
string |
id |
Unique identifier of the usage consumption report given by the server |
string |
name |
Usage consumption report name |
string |
relatedParty |
||
schemaLocation |
Link to the schema describing the REST resource |
string |
type |
Indicates the (class) type of the usage consumption report |
string |
4.137. UsageChargeCartPrice
A cart price per usage unit, either volume overage or tier price.
Polymorphism : Composition
| Name | Description | Schema |
|---|---|---|
@baseType |
Generic attribute indicating the base class type of the extension class of the current object. Useful only when the class type of the current object is unknown to the implementation. |
string |
@schemaLocation |
Generic attribute containing the link to the schema that defines the structure of the class type of the current object. |
string |
@type |
Generic attribute containing the name of the resource class type |
string |
cartPrice |
< CartPrice > array |
|
description |
A narrative that explains in detail the semantics of this order item price. |
string |
id |
The id of the price. |
string |
name |
A short descriptive name such as "Subscription price". |
string |
price |
||
priceAlteration |
< PriceAlteration > array |
|
priceType |
Type of price, such as: OneTime, Recurring, Usage. |
string |
recurringChargePeriod |
Could be month, week… |
string |
tierEnd |
The end limit of the usage tier |
string |
tierStart |
The start limit of the usage tier |
string |
unitOfMeasure |
Could be minutes, GB… |
string |
usageChargeType |
The type of the usage charge |
string |
4.138. UsageChargeOrderPrice
An order price per usage unit, either volume overage or tier price.
Polymorphism : Composition
| Name | Description | Schema |
|---|---|---|
@baseType |
Indicate the base type of orderPrice. |
string |
@schemaLocation |
A link to the schema describing this orderPrice extension. |
string |
@type |
Indicate the type of orderPrice. |
string |
billingAccount |
||
description |
A narrative that explains in detail the semantics of this order item price |
string |
id |
id |
string |
name |
A short descriptive name such as "Subscription price". |
string |
orderPrice |
< OrderPrice > array |
|
price |
||
priceAlteration |
< PriceAlteration > array |
|
priceType |
enum (recurring, oneTime, usage, PRODUCT_PRICE, DELIVERY_COST, PAYMENT_COST, DISCOUNT) |
|
recurringChargePeriod |
Could be month, week,… |
string |
tierEnd |
The end limit of the usage tier |
string |
tierStart |
The start limit of the usage tier |
string |
unitOfMeasure |
Could be minutes, gigaBytes,… |
string |
usageChargeType |
The type of the usage charge. |
string |
4.139. UsagePriceCharge
A price per usage unit, either volume overage or tier price.
Polymorphism : Composition
| Name | Description | Schema |
|---|---|---|
@baseType |
The immediate base class type of this product offering |
string |
@schemaLocation |
hyperlink reference to the schema describing this resource |
string |
@type |
The class type of this Product offering |
string |
billingEvent |
Represents the billing event for one time prices. Could be : paynow, onfistbill, oncancellation. |
string |
bundledPop |
Represents the contained prices (charges), for a composed price. |
< ProductOfferingPrice > array |
bundledPopRelationship |
Not Sent. |
< BundledPopRelationship > array |
channel |
< ChannelRef > array |
|
constraint |
Not Sent. |
< ConstraintRef > array |
description |
Not Sent.Description of the productOfferingPrice |
string |
href |
Not Sent |
string |
id |
Price identifier. |
string |
isBundle |
A flag indicating if this POP is composite (bundle) or not |
boolean |
isPriceOverride |
A flag indicating if the price is defined directly for a simple product offering, or for a product offering bought as part of a bundled product offering. |
boolean |
lastUpdate |
Last modified time of price. |
string(date-time) |
lifecycleStatus |
Not Sent.The lifecycle status of this POP. |
string |
name |
Name of the productOfferingPrice. |
string |
percentage |
Percentage to apply for ProdOfferPriceAlteration (Discount). |
number(float) |
place |
Place references where the products are sold or delivered. |
< PlaceRef > array |
poRelationship |
Represents the product offering affected, or required by the price. This field is used for bundle product offerings. |
< PoRelationshipRef > array |
popRelationship |
Not Sent. |
< PopRelationship > array |
price |
The amount of money that characterizes the price. |
|
priceType |
A category that describes the price such as recurring, one time and usage. |
string |
pricingLogicAlgorithm |
Not Sent. |
< PricingLogicAlgorithm > array |
priority |
The priority of the price. |
integer(int32) |
processType |
Represents the purchasing flows for which the price is applicable. |
< ProcessType > array |
prodSpecCharValueUse |
< ProdSpecCharValueUse > array |
|
productOfferingTerm |
< ProductOfferingTerm > array |
|
recurringChargePeriodLength |
The period of the recurring charge: 1, 2, … .It sets to zero if it is not applicable |
integer(int32) |
recurringChargePeriodType |
The period to repeat the application of the price. Could be month,quarter,year.. |
string |
relatedParty |
||
tax |
Not Sent. |
< Tax > array |
unitOfMeasure |
A number and unit representing how many (for instance 1 dozen) of an ProductOffering is available at the offered price. Its meaning depends on the priceType. It could be a price, a rate, or a discount. |
|
usageType |
Usage price type. Could be highest applicable tier or each respective tier. |
string |
usageUnit |
Usage unit applicable for the price. |
|
validFor |
The period for which the productOfferingPrice is valid. |
|
version |
Not Sent.ProductOffering version. |
string |
4.140. UsagePriceChargeEntry
UsageChargeEntry reference. The UsageChargeEntry defines the usage charge entries of usageCharge for selling product offerings.
Polymorphism : Composition
| Name | Description | Schema |
|---|---|---|
@baseType |
The immediate base class type of this product offering |
string |
@schemaLocation |
hyperlink reference to the schema describing this resource |
string |
@type |
The class type of this Product offering |
string |
billingEvent |
Represents the billing event for one time prices. Could be : paynow, onfistbill, oncancellation. |
string |
bundledPop |
Represents the contained prices (charges), for a composed price. |
< ProductOfferingPrice > array |
bundledPopRelationship |
Not Sent. |
< BundledPopRelationship > array |
channel |
< ChannelRef > array |
|
constraint |
Not Sent. |
< ConstraintRef > array |
description |
Not Sent.Description of the productOfferingPrice |
string |
href |
Not Sent |
string |
id |
Price identifier. |
string |
isBundle |
A flag indicating if this POP is composite (bundle) or not |
boolean |
isPriceOverride |
A flag indicating if the price is defined directly for a simple product offering, or for a product offering bought as part of a bundled product offering. |
boolean |
lastUpdate |
Last modified time of price. |
string(date-time) |
lifecycleStatus |
Not Sent.The lifecycle status of this POP. |
string |
name |
Name of the productOfferingPrice. |
string |
percentage |
Percentage to apply for ProdOfferPriceAlteration (Discount). |
number(float) |
place |
Place references where the products are sold or delivered. |
< PlaceRef > array |
poRelationship |
Represents the product offering affected, or required by the price. This field is used for bundle product offerings. |
< PoRelationshipRef > array |
popRelationship |
Not Sent. |
< PopRelationship > array |
price |
The amount of money that characterizes the price. |
|
priceType |
A category that describes the price such as recurring, one time and usage. |
string |
pricingLogicAlgorithm |
Not Sent. |
< PricingLogicAlgorithm > array |
priority |
The priority of the price. |
integer(int32) |
processType |
Represents the purchasing flows for which the price is applicable. |
< ProcessType > array |
prodSpecCharValueUse |
< ProdSpecCharValueUse > array |
|
productOfferingTerm |
< ProductOfferingTerm > array |
|
recurringChargePeriodLength |
The period of the recurring charge: 1, 2, … .It sets to zero if it is not applicable |
integer(int32) |
recurringChargePeriodType |
The period to repeat the application of the price. Could be month,quarter,year.. |
string |
relatedParty |
||
tax |
Not Sent. |
< Tax > array |
tierEnd |
Tier end of usageChargeEntry. |
integer(int32) |
tierStart |
Tier start of usageChargeEntry. |
integer(int32) |
unitOfMeasure |
A number and unit representing how many (for instance 1 dozen) of an ProductOffering is available at the offered price. Its meaning depends on the priceType. It could be a price, a rate, or a discount. |
|
usageType |
Usage price type. Could be highest applicable tier or each respective tier. |
string |
usageUnit |
Usage unit applicable for the price. |
|
validFor |
The period for which the productOfferingPrice is valid. |
|
version |
Not Sent.ProductOffering version. |
string |