Product Ordering Biz Api
GetLoanHistory
/productOrder [GET]
This operation list a ProductOrder entity. Attribute selection is enabled for all first level attributes.
Request
This section defines all the possible data structures sent by the client when consuming the method.
URL
https://[localhost]:[port]/tmf-api/productOrdering/v4/{businessId}/productOrder
URL PARAMS
name | type | description | required |
---|---|---|---|
businessId | string | 2 letter ISO 3166 country code | Y |
Header
name | value | description | required |
---|---|---|---|
client_id | string | The client_id identifying the channel. Minimum characters: 5 | Y |
client_secret | string | Password associated with the client_id. Minimum characters: 5 | Y |
X-Correlation-ID | string | An identifier for the current call chain that can be used to tie together log entries on multiple layers (e.g. client, server, mainframe). This identifier must be designed to be unique across all applications. Pattern: \^[a-zA-Z0-9-+/=_]{16,64}$ Minimum characters: 16 Maximum characters: 64 | Y |
Query Param
name | type | description | required |
---|---|---|---|
billingAccount.id | string | Unique identifer of the account | Y |
orderDate.gte | date | Date to be compared to OrderDate parameter | N |
orderDate.lte | date | Date to be compared to OrderDate parameter | N |
relatedParty.id | string | A related party defines party or party role linked to a specific entity. Unique identifier of a related entity. | N |
channel.name | string | Name of the channel (Ex: ESB) | N |
realizingResource.name | string | Name of the resource. | N |
realizingResource.id | string | Unique identifier of a related entity. | N |
Response
In this section all the possible data structures received by the client at the moment of responding the method are defined.
Possible response success
This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.
[ 200 ]
OK - listProductOrder request processed successfully, response body contains an entity corresponding to the requested resource. ProductOrder: A Product Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa,
{
"id":"30001",
"href":"https://host:port/productOrderingManagement/v1/productOrder/30001",
"category":"B2C product order",
"completionDate":"2019-05-02T08:13:59.506Z",
"description":"Product Order illustration sample",
"expectedCompletionDate":"2019-05-02T08:13:59.506Z",
"externalId":"PO-456",
"orderDate":"2019-04-30T08:13:59.506Z",
"priority":"1",
"requestedCompletionDate":"2019-05-02T08:13:59.506Z",
"requestedStartDate":"2019-05-03T08:13:59.506Z",
"channel":[
{
"id":"1",
"role":"Used channel for order capture",
"name":"Online chanel"
}
],
"note":[
{
"id":"1",
"author":"Jean Pontus",
"date":"2019-04-30T08:13:59.509Z",
"text":"This is a TMF product order illustration"
}
],
"productOrderItem":[
{
"id":"100",
"quantity":1,
"action":"add",
"productOffering":{
"id":"14277",
"href":"https://host:port/productCatalogManagement/v1/productOffering/14277",
"name":"TMF25"
},
"productOrderItemRelationship":[
{
"id":"110",
"relationshipType":"bundles"
},
{
"id":"120",
"relationshipType":"bundles"
},
{
"id":"130",
"relationshipType":"bundles"
}
],
"state":"completed",
"@type":"ProductOrderItem"
},
{
"id":"110",
"quantity":1,
"action":"add",
"itemPrice":[
{
"description":"Access Fee",
"name":"Access Fee",
"priceType":"nonRecurring",
"price":{
"taxRate":0,
"dutyFreeAmount":{
"unit":"EUR",
"value":0.99
},
"taxIncludedAmount":{
"unit":"EUT",
"value":0.99
}
}
}
],
"payment":[
{
"id":"2365",
"href":"https://host:port/paymentManagement/v1/cashPayment/2365",
"name":"Cash payment for access fee",
"@type":"CashPayment",
"@referredType":"Payment"
}
],
"product":{
"isBundle":false,
"@type":"Product",
"productCharacteristic":[
{
"name":"TEL_MSISDN",
"valueType":"string",
"value":"415 279 7439"
}
],
"productSpecification":{
"id":"14307",
"href":"https://host:port/productCatalogManagement/v1/productSpecification/14307",
"name":"Mobile Telephony",
"version":"1",
"@type":"ProductSpecificationRef"
}
},
"productOffering":{
"id":"14305",
"href":"https://host:port/productCatalogManagement/v1/productOffering/14305",
"name":"TMF Mobile Telephony"
},
"state":"completed",
"@type":"ProductOrderItem"
},
{
"id":"120",
"quantity":1,
"action":"add",
"billingAccount":{
"id":"1513",
"href":"https://host:port/billingAccountManagement/v1/billingAccount/1513",
"@type":"BillingAccount"
},
"itemPrice":[
{
"description":"Tariff plan monthly fee",
"name":"MonthlyFee",
"priceType":"recurring",
"recurringChargePeriod":"month",
"price":{
"taxRate":0,
"dutyFreeAmount":{
"unit":"EUR",
"value":20
},
"taxIncludedAmount":{
"unit":"EUR",
"value":20
}
},
"priceAlteration":[
{
"applicationDuration":3,
"description":"20% for first 3 months",
"name":"WelcomeDiscount",
"priceType":"recurring",
"priority":1,
"recurringChargePeriod":"month",
"price":{
"percentage":20,
"taxRate":0,
"@type":"price"
}
}
]
}
],
"itemTerm":[
{
"description":"Tariff plan 12 Months commitment",
"name":"12Months",
"duration":{
"amount":12,
"units":"month"
}
}
],
"product":{
"isBundle":false,
"@type":"Product",
"productSpecification":{
"id":"14395",
"href":"https://host:port/productCatalogManagement/v1/productSpecification/14395",
"name":"TMF Tariff plan",
"version":"1",
"@type":"ProductSpecificationRef"
}
},
"productOffering":{
"id":"14344",
"href":"https://host:port/productCatalogManagement/v1/productOffering/14344",
"name":"TMF Tariff Plan"
},
"productOrderItemRelationship":[
{
"id":"110",
"relationshipType":"reliesOn"
}
],
"state":"completed",
"@type":"ProductOrderItem"
},
{
"id":"130",
"quantity":1,
"action":"add",
"product":{
"isBundle":false,
"@type":"Product",
"productCharacteristic":[
{
"name":"CoverageOptions",
"valueType":"string",
"value":"National"
}
],
"productSpecification":{
"id":"14353",
"href":"https://host:port/productCatalogManagement/v1/productSpecification/14353",
"name":"Coverage",
"version":"1",
"@type":"ProductSpecificationRef"
}
},
"productOffering":{
"id":"14354",
"href":"https://host:port/productCatalogManagement/v1/productOffering/14354",
"name":"Coverage Options"
},
"productOrderItemRelationship":[
{
"id":"110",
"relationshipType":"reliesOn"
}
],
"state":"completed",
"@type":"ProductOrderItem"
}
],
"relatedParty":[
{
"id":"456-dd-df45",
"href":"https://host:port/partyManagement/v1/individual/456-dd-df45",
"name":"Joe Doe",
"role":"Seller",
"@type":"RelatedParty",
"@referredType":"Individual"
},
{
"id":"ff55-hjy4",
"href":"https://host:port/partyRoleManagement/v1/customer/ff55-hjy4",
"name":"Jean Pontus",
"@type":"RelatedParty",
"@referredType":"Customer"
}
],
"state":"completed"
}
Definitions
Each of the response parameters is detailed.
name | type | description | required |
---|---|---|---|
id | String | ID created on repository side | N |
href | String | Hyperlink to access the order. | N |
cancellationDate | datetime | Date when the order is cancelled. This is used when order is cancelled | N |
cancellationReason | datetime | Reason why the order is cancelled. This is used when order is cancelled. | N |
category | String | Used to categorize the order from a business perspective that can be useful for the OM system (e.g. "enterprise", "residential", ...). | N |
completionDate | DateTime | Date when the order was completed. | N |
description | String | description | N |
expectedCompletionDate | DateTime | Expected delivery date amended by the provider. | N |
externalId | String | ID given by the consumer and only understandable by him (to facilitate his searches afterwards). | N |
orderCharacteristics | array | Custom order Attribute. | N |
orderCharacteristics.cisEmpId | String | cisEmpId | N |
orderCharacteristics.depttCode | String | depttCode | N |
orderCharacteristics.siteCode | String | siteCode | N |
orderCharacteristics.sourceOfApplication | String | sourceOfApplication | N |
orderCharacteristics.salesRepId | String | salesRepId | N |
orderCharacteristics.carrierUniqueServId | String | carrierUniqueServId | N |
orderCharacteristics.lastLineNumber | String | lastLineNumber | N |
orderCharacteristics.exchangeId | String | exchangeId | N |
orderCharacteristics.numberAreaCode | String | numberAreaCode | N |
orderCharacteristics.exchangeId_TP | String | exchangeId_TP | N |
orderCharacteristics.numberAreaCode_TP | String | numberAreaCode_TP | N |
orderCharacteristics.exchangeId_DS | String | exchangeId_DS | N |
orderCharacteristics.numberAreaCode_DS | String | numberAreaCode_DS | N |
orderCharacteristics.exchangeId_TI | String | exchangeId_TI | N |
orderCharacteristics.numberAreaCode_TI | String | numberAreaCode_TI | N |
orderCharacteristics.exchangeId_MO | String | exchangeId_MO | N |
orderCharacteristics.numberAreaCode_MO | String | numberAreaCode_MO | N |
serviceAddress | object array | Custom order Attribute. | N |
serviceAddress.addrNo | String | Service Address Number | N |
serviceAddress.addrType | String | Address type | N |
serviceAddress.addrLine1 | String | service Address line 1 | N |
serviceAddress.addrLine2 | String | service Address line 2 | N |
serviceAddress.addrLine3 | String | service Address line 3 | N |
serviceAddress.addrLine4 | String | service Address line 4 | N |
serviceAddress.addrLine5 | String | service Address line 5 | N |
serviceAddress.addrPostCode | String | service Address post code | N |
notificationContact | string | Contact attached to the order to send back information regarding this order | N |
orderDate | DateTime | Date when the order was created. | N |
priority | String | A way that can be used by consumers to prioritize orders in OM system (from 0 to 4 : 0 is the highest priority, and 4 the lowest). | N |
requestedCompletionDate | DateTime | Requested delivery date from the requestor perspective. | N |
requestedStartDate | DateTime | Order fulfillment start date wished by the requestor. This is used when, for any reason, requestor cannot allow seller to begin to operationally begin the fulfillment before a date | N |
agreement | array | A reference to an agreement defined in the context of the product order | N |
agreement.id | String | Unique identifier Id of the EntityRef | N |
agreement.href | String | Unique reference of the EntityRef. | N |
agreement.name | String | Name of the account. | N |
agreement.@baseType | String | When sub-classing, this defines the super-class. | N |
agreement.@schemaLocation | String | A URI to a JSON-Schema file that defines additional attributes and relationships. | No |
agreement.@type | String | When sub-classing, this defines the sub-class entity name | N |
agreement.@referredType | String | The actual type of the target instance when needed for disambiguation. | N |
billingAccount | array | ||
billingAccount.id | String | Unique identifier Id of the EntityRef | N |
billingAccount.href | String | Unique reference of the EntityRef. | N |
billingAccount.name | String | Name of the account. | N |
billingAccount.@baseType | String | When sub-classing, this defines the super-class. | N |
billingAccount.@schemaLocation | String | A URI to a JSON-Schema file that defines additional attributes and relationships. | N |
billingAccount.@type | String | When sub-classing, this defines the sub-class entity name | N |
billingAccount.@referredType | String | The actual type of the target instance when needed for disambiguation. | N |
channel | object array | Related channel to another entity. May be online web, mobile app, social ,etc. | N |
channel.id | String | Unique identifier Id of the related entity. | N |
channel.href | String | Unique reference of the related entity. | N |
channel.name | String | Name of the related entity.. | N |
channel.role | String | Role playing by the channel. | N |
channel.@baseType | String | When sub-classing, this defines the super-class. | N |
channel.@schemaLocation | String | A URI to a JSON-Schema file that defines additional attributes and relationships. | N |
channel.@type | String | When sub-classing, this defines the sub-class entity name | N |
channel.@referredType | String | The actual type of the target instance when needed for disambiguation. | N |
note | array | Extra information about a given entity | N |
note.author | String | Author of the note. | N |
note.date | datetime | string | N |
note.id | String | Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation). | N |
note.text | String | Text of the note. | N |
note.@baseType | String | When sub-classing, this defines the super-class. | N |
note.@schemaLocation | String | A URI to a JSON-Schema file that defines additional attributes and relationships. | N |
note.@type | String | When sub-classing, this defines the sub-class entity name | N |
note.@referredType | String | The actual type of the target instance when needed for disambiguation. | N |
orderTotalPrice | array | An amount, usually of money, that represents the actual price paid by the Customer for this item or this order | N |
orderTotalPrice.billingAccount | billingAccount | A reference to a billing account used for paid the order price charge. | N |
orderTotalPrice.description | string | A narrative that explains in detail the semantics of this order item price. | N |
orderTotalPrice.name | string | A short descriptive name such as "Subscription price" | N |
orderTotalPrice.price | array | A structure used to define price amount. | N |
orderTotalPrice.price.dutyFreeAmount | array | All taxes excluded amount (expressed in the given currency). | |
orderTotalPrice.price.dutyFreeAmount.unit | string | Currency (ISO4217 norm uses 3 letters to define the currency) | N |
orderTotalPrice.price.dutyFreeAmount.amount | number | A positive floating point number | N |
orderTotalPrice.price.percentage | Float | Percentage to apply for ProdOfferPriceAlteration | N |
orderTotalPrice.price.taxIncludedAmount | array | All taxes included amount (expressed in the given currency). | N |
orderTotalPrice.price.taxIncludedAmount.unit | string | Currency (ISO4217 norm uses 3 letters to define the currency) | N |
orderTotalPrice.price.taxIncludedAmount.amount | number | A positive floating point number | N |
orderTotalPrice.price.taxRate | Float | Tax rate. | N |
orderTotalPrice.price.@baseType | String | When sub-classing, this defines the super-class. | N |
orderTotalPrice.price.@schemaLocation | String | A URI to a JSON-Schema file that defines additional attributes and relationships. | N |
orderTotalPrice.price.@type | String | When sub-classing, this defines the sub-class entity name | N |
orderTotalPrice.priceAlteration | orderTotalPrice.price | A structure used to describe a price alteration. | N |
orderTotalPrice.priceType | string | A category that describes the price, such as recurring, discount, allowance, penalty, and so forth | N |
orderTotalPrice.productOfferingPrice | object | 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. | N |
orderTotalPrice.productOfferingPrice.id | String | Unique identifier Id of the EntityRef | N |
orderTotalPrice.productOfferingPrice.href | String | Unique reference of the EntityRef. | N |
orderTotalPrice.productOfferingPrice.description | String | Detailed description of the EntityRef. | N |
orderTotalPrice.productOfferingPrice.name | String | Name of the account. | N |
orderTotalPrice.productOfferingPrice.@baseType | String | When sub-classing, this defines the super-class. | N |
orderTotalPrice.productOfferingPrice.@schemaLocation | String | A URI to a JSON-Schema file that defines additional attributes and relationships. | N |
orderTotalPrice.productOfferingPrice.@type | String | When sub-classing, this defines the sub-class entity name | N |
orderTotalPrice.productOfferingPrice.@referredType | String | The actual type of the target instance when needed for disambiguation. | N |
orderTotalPrice.recurringChargePeriod | string | Could be month, week... | N |
orderTotalPrice.unitOfMeasure | string | Could be minutes, GB... | N |
orderTotalPrice.@baseType | string | When sub-classing, this defines the super-class | N |
orderTotalPrice.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
orderTotalPrice.@type | string | When sub-classing, this defines the sub-class entity name | N |
payment | array | ||
payment.id | String | Unique identifier Id of the EntityRef | N |
payment.href | String | Unique reference of the EntityRef. | N |
payment.description | String | Detailed description of the EntityRef. | N |
payment.name | String | Name of the account. | N |
payment.@baseType | String | When sub-classing, this defines the super-class. | N |
payment.@schemaLocation | String | A URI to a JSON-Schema file that defines additional attributes and relationships. | N |
payment.@type | String | When sub-classing, this defines the sub-class entity name | N |
payment.@referredType | String | The actual type of the target instance when needed for disambiguation. | N |
productOfferingQualification | array | ||
productOfferingQualification.id | String | Unique identifier Id of the EntityRef | N |
productOfferingQualification.href | String | Unique reference of the EntityRef. | N |
productOfferingQualification.description | String | Detailed description of the EntityRef. | N |
productOfferingQualification.name | String | Name of the account. | N |
productOfferingQualification.@baseType | String | When sub-classing, this defines the super-class. | N |
productOfferingQualification.@schemaLocation | String | A URI to a JSON-Schema file that defines additional attributes and relationships. | N |
productOfferingQualification.@type | String | When sub-classing, this defines the sub-class entity name | N |
productOfferingQualification.@referredType | String | The actual type of the target instance when needed for disambiguation. | N |
productOrderItem | Object Array | An identified part of the order. A product order is decomposed into one or more order items. | N |
productOrderItem.action | String | The action to be carried out on the Product. Can be: add, modify, delete, noChange. | N |
productOrderItem.appointment | Array | Refers an appointment, such as a Customer presentation or internal meeting or site visit.. | N |
productOrderItem.appointment.id | String | The identifier of the referred appointment | N |
productOrderItem.appointment.href | String | The reference of the appointment | N |
productOrderItem.appointment.description | String | An explanatory text regarding the appointment made with a party. | N |
productOrderItem.appointment.@baseType | String | When sub-classing, this defines the super-class. | N |
productOrderItem.appointment.@schemaLocation | String | A URI to a JSON-Schema file that defines additional attributes and relationships. | N |
productOrderItem.appointment.@type | String | When sub-classing, this defines the sub-class entity name | N |
productOrderItem.appointment.@referredType | String | The actual type of the target instance when needed for disambiguation. | N |
productOrderItem.billingAccount | billingAccount | A BillingAccount is a detailed description of a bill structure. | N |
productOrderItem.id | String | Identifier of the line item (generally it is a sequence number 01, 02, 03...) | N |
productOrderItem.itemPrice | orderTotalPrice | An amount, usually of money, that represents the actual price paid by the Customer for this item or this order. | N |
productOrderItem.itemTerm | Array | Description of a productTerm linked to this orderItem. This represent a commitment with a duration. | N |
productOrderItem.itemTerm.description | string | Description of the productOrderTerm | N |
productOrderItem.itemTerm.duration | array | Duration of the productOrderTerm. | N |
productOrderItem.itemTerm.duration.unit | string | Unit | N |
productOrderItem.itemTerm.duration.amount | number | Numeric value in a given unit | N |
productOrderItem.itemTerm.name | string | Name of the productOrderTerm. | N |
productOrderItem.itemTerm.@baseType | String | When sub-classing, this defines the super-class. | N |
productOrderItem.itemTerm.@schemaLocation | String | A URI to a JSON-Schema file that defines additional attributes and relationships. | N |
productOrderItem.itemTerm.@type | String | When sub-classing, this defines the sub-class entity name | N |
productOrderItem.itemTotalPrice | orderTotalPrice | An amount, usually of money, that represents the actual price paid by the Customer for this item or this order. | N |
productOrderItem.payment | payment | 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. | N |
productOrderItem.product | Object Array | A product to be created defined by value or existing defined by reference. | N |
productOrderItem.product.href | String | Reference of the product. | N |
productOrderItem.product.id | String | Unique identifier of the product. | N |
productOrderItem.product.name | String | Name of the product. It could be the same as the name of the product offering. | N |
productOrderItem.product.description | String | Is the description of the product. It could be copied from the description of the Product Offering. | N |
productOrderItem.product.isBundle | Boolean | 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 | N |
productOrderItem.product.isCustomerVisible | Boolean | If true, the product is visible by the customer. | N |
productOrderItem.product.orderDate | DateTime | Is the date when the product was ordered. | N |
productOrderItem.product.productSerialNumber | String | Is the serial number for the product. This is typically applicable to tangible products e.g. Broadband Router | N |
productOrderItem.product.startDate | DateTime | Is the date from which the product starts. | N |
productOrderItem.product.terminationDate | DateTime | Is the date when the product was terminated | N |
productOrderItem.product.agreement | agreement | 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. | N |
productOrderItem.product.billingAccount | billingAccount | A BillingAccount is a detailed description of a bill structure. | N |
productOrderItem.product.place | relatedParty | Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. | N |
productOrderItem.product.product | productOrderItem.product | A product to be created defined by value or existing defined by reference. | N |
productOrderItem.product.productCharacteristic | Object Array | Describes a given characteristic of an object or entity through a name/value pair. | N |
productOrderItem.product.productCharacteristic.name | String | Name of the characteristic | Y |
productOrderItem.product.productCharacteristic.valueType | String | Data type of the value of the characteristic | N |
productOrderItem.product.productCharacteristic.value | any | The value of the characteristic | N |
productOrderItem.product.productCharacteristic.@baseType | String | When sub-classing, this defines the super-class. | N |
productOrderItem.product.productCharacteristic.@schemaLocation | String | A URI to a JSON-Schema file that defines additional attributes and relationships. | N |
productOrderItem.product.productCharacteristic.@type | String | When sub-classing, this defines the sub-class entity name | N |
productOrderItem.product.productCharacteristic.@referredType | String | The actual type of the target instance when needed for disambiguation | N |
productOrderItem.product.productOffering | array | A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information. | N |
productOrderItem.product.productOffering.id | String | Unique identifier Id of the EntityRef | N |
productOrderItem.product.productOffering.href | String | Unique reference of the EntityRef. | N |
productOrderItem.product.productOffering.description | String | Detailed description of the EntityRef. | N |
productOrderItem.product.productOffering.name | String | Name of the account. | N |
productOrderItem.product.productOffering.@baseType | String | When sub-classing, this defines the super-class. | N |
productOrderItem.product.productOffering.@schemaLocation | String | A URI to a JSON-Schema file that defines additional attributes and relationships. | N |
productOrderItem.product.productOffering.@type | String | When sub-classing, this defines the sub-class entity name | N |
productOrderItem.product.productOffering.@referredType | String | The actual type of the target instance when needed for disambiguation. | N |
productOrderItem.product.productOrderItem | object Array | An identified part of the order. A product order is decomposed into one or more order items. | N |
productOrderItem.product.productOrderItem.orderItemAction | String | Action of the order item for this product | N |
productOrderItem.product.productOrderItem.orderItemId | String | Identifier of the order item where the product was managed | N |
productOrderItem.product.productOrderItem.productOrderHref | String | Reference of the related entity. | N |
productOrderItem.product.productOrderItem.productOrderId | String | Unique identifier of a related entity. | N |
productOrderItem.product.productOrderItem.role | String | role of the product order item for this product | N |
productOrderItem.product.productOrderItem.@baseType | String | When sub-classing, this defines the super-class | N |
productOrderItem.product.productOrderItem.@schemaLocation | String | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
productOrderItem.product.productOrderItem.@type | String | When sub-classing, this defines the sub-class entity name | N |
productOrderItem.product.productOrderItem.@referredType | String | The actual type of the target instance when needed for disambiguation. | N |
productOrderItem.product.productPrice | orderTotalPrice | 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. | N |
productOrderItem.product.productRelationship | Object Array | A list of product relationships. | N |
productOrderItem.product.productRelationship.product | productOrderItem.product | A product to be created defined by value or existing defined by reference. | |
productOrderItem.product.productRelationship.@baseType | String | When sub-classing, this defines the super-class | N |
productOrderItem.product.productRelationship.@schemaLocation | String | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
productOrderItem.product.productRelationship.@type | String | When sub-classing, this defines the sub-class entity name | N |
productOrderItem.product.productRelationship.relationshipType | string | Type of the product relationship, such as [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) [targets] or [isTargeted] (depending on the way of expressing the link) for any other kind of links that may be useful | |
productOrderItem.product.productSpecification | Object Array | 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. | N |
productOrderItem.product.productSpecification.href | string | Reference of the related entity. | N |
productOrderItem.product.productSpecification.id | string | Unique identifier of a related entity. | N |
productOrderItem.product.productSpecification.name | string | Name of the related entity. | N |
productOrderItem.product.productSpecification.targetProductSchema | string | A target product schema reference. The reference object to the schema and type of target product which is described by product specification. Reference to Sub Object TargetProductSchema | N |
productOrderItem.product.productSpecification.targetProductSchema.@schemaLocation | string | The actual type of the target instance when needed for disambiguation. | N |
productOrderItem.product.productSpecification.targetProductSchema.@type | string | Class type of the target product. | N |
productOrderItem.product.productSpecification.targetProductSchema.@baseType | string | When sub-classing, this defines the super-class | N |
productOrderItem.product.productSpecification.version | string | Version of the product specification. | N |
productOrderItem.product.productSpecification.@baseType | String | When sub-classing, this defines the super-class | N |
productOrderItem.product.productSpecification.@schemaLocation | String | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
productOrderItem.product.productSpecification.@type | String | When sub-classing, this defines the sub-class entity name | N |
productOrderItem.product.productSpecification.@referredType | string | The actual type of the target instance when needed for disambiguation. | N |
productOrderItem.product.productTerm | productOrderItem.itemTerm | Description of a productTerm linked to this product. This represent a commitment with a duration. | N |
productOrderItem.product.realizingResource | Object array | A list of resource references. | N |
productOrderItem.product.realizingResource.id | String | Unique identifier Id of the related entity. | Y |
productOrderItem.product.realizingResource.href | String | Unique reference of the related entity. | N |
productOrderItem.product.realizingResource.name | String | Name of the related entity.. | N |
productOrderItem.product.realizingResource.@baseType | String | When sub-classing, this defines the super-class. | N |
productOrderItem.product.realizingResource.@schemaLocation | String | A URI to a JSON-Schema file that defines additional attributes and relationships. | N |
productOrderItem.product.realizingResource.@type | String | When sub-classing, this defines the sub-class entity name | N |
productOrderItem.product.realizingResource.@referredType | String | The actual type of the target instance when needed for disambiguation. | N |
productOrderItem.product.realizingService | array | A list of service references. Reference to Sub Object ServiceRef | N |
productOrderItem.product.realizingService.id | String | Unique identifier Id of the EntityRef | N |
productOrderItem.product.realizingService.href | String | Unique reference of the EntityRef. | N |
productOrderItem.product.realizingService.description | String | Detailed description of the EntityRef. | N |
productOrderItem.product.realizingService.name | String | Name of the account. | N |
productOrderItem.product.realizingService.@baseType | String | When sub-classing, this defines the super-class. | N |
productOrderItem.product.realizingService.@schemaLocation | String | A URI to a JSON-Schema file that defines additional attributes and relationships. | N |
productOrderItem.product.realizingService.@type | String | When sub-classing, this defines the sub-class entity name | N |
productOrderItem.product.realizingService.@referredType | String | The actual type of the target instance when needed for disambiguation. | N |
productOrderItem.product.relatedParty | relatedParty | Related Entity reference. A related party defines party or party role linked to a specific entity. | N |
productOrderItem.product.status | String | Is the lifecycle status of the product. | |
productOrderItem.product.@baseType | String | When sub-classing, this defines the super-class. | N |
productOrderItem.product.@schemaLocation | String | A URI to a JSON-Schema file that defines additional attributes and relationships. | N |
productOrderItem.product.@type | String | When sub-classing, this defines the sub-class entity name | N |
productOrderItem.product.@referredType | String | The actual type of the target instance when needed for disambiguation | N |
productOrderItem.productOffering | Object Array | A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information. | N |
productOrderItem.productOffering.id | String | Unique identifier Id of the EntityRef | N |
productOrderItem.productOffering.href | String | Unique reference of the EntityRef. | N |
productOrderItem.productOffering.description | String | Detailed description of the EntityRef. | N |
productOrderItem.productOffering.name | String | Name of the account. | N |
productOrderItem.productOffering.@baseType | String | When sub-classing, this defines the super-class. | N |
productOrderItem.productOffering.@schemaLocation | String | A URI to a JSON-Schema file that defines additional attributes and relationships. | N |
productOrderItem.productOffering.@type | String | When sub-classing, this defines the sub-class entity name | N |
productOrderItem.productOffering.@referredType | String | The actual type of the target instance when needed for disambiguation. | N |
productOrderItem.productOfferingQualificationItem | productOrderItem | It's a productOfferingQualification item that has been executed previously. | N |
productOrderItem.productOrderItem | productOrderItem | An identified part of the order. A product order is decomposed into one or more order items. | N |
productOrderItem.productOrderItemRelationship | Object Array | A list of order item relationships. | N |
productOrderItem.productOrderItemRelationship.id | string | N | |
productOrderItem.productOrderItemRelationship.relationshipType | string | The type of order item relationship | N |
productOrderItem.productOrderItemRelationship.@baseType | String | When sub-classing, this defines the super-class. | N |
productOrderItem.productOrderItemRelationship.@schemaLocation | String | A URI to a JSON-Schema file that defines additional attributes and relationships. | N |
productOrderItem.productOrderItemRelationship.@type | String | When sub-classing, this defines the sub-class entity name | N |
productOrderItem.qualification | Array | A list of product offering qualification references. | N |
productOrderItem.qualification.id | String | Unique identifier Id of the EntityRef | N |
productOrderItem.qualification.href | String | Unique reference of the EntityRef. | N |
productOrderItem.qualification.description | String | Detailed description of the EntityRef. | N |
productOrderItem.qualification.name | String | Name of the account. | N |
productOrderItem.qualification.@baseType | String | When sub-classing, this defines the super-class. | N |
productOrderItem.qualification.@schemaLocation | String | A URI to a JSON-Schema file that defines additional attributes and relationships. | N |
productOrderItem.qualification.@type | String | When sub-classing, this defines the sub-class entity name | N |
productOrderItem.qualification.@referredType | String | The actual type of the target instance when needed for disambiguation. | N |
productOrderItem.quantity | Int32 | Quantity ordered. | N |
productOrderItem.quoteItem | array | It's a Quote item that has been executed previously. | N |
productOrderItem.quoteItem.id | string | Unique identifier of a related entity. | N |
productOrderItem.quoteItem.href | string | Reference of the related entity. | N |
productOrderItem.quoteItem.name | string | Name of the related entity. | N |
productOrderItem.quoteItem.quoteHref | string | Reference of the related entity. | N |
productOrderItem.quoteItem.quoteId | string | Unique identifier of a related entity. | N |
productOrderItem.quoteItem.quoteName | string | Name of the related entity | N |
productOrderItem.quoteItem.@baseType | string | When sub-classing, this defines the super-class | N |
productOrderItem.quoteItem.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
productOrderItem.quoteItem.@type | string | When sub-classing, this defines the sub-class entity name | N |
productOrderItem.quoteItem.@referredType | string | The actual type of the target instance when needed for disambiguation. | N |
productOrderItem.state | String | State of the order item, enum: - acknowledged - rejected - pending - held - inProgress - cancelled - completed - failed - partial - assessingCancellation - pendingCancellation | N |
quote | array | ||
quote.id | String | Unique identifier Id of the EntityRef | N |
quote.href | String | Unique reference of the EntityRef. | N |
quote.description | String | Detailed description of the EntityRef. | N |
quote.name | String | Name of the account. | N |
quote.@baseType | String | When sub-classing, this defines the super-class. | N |
quote.@schemaLocation | String | A URI to a JSON-Schema file that defines additional attributes and relationships. | N |
quote.@type | String | When sub-classing, this defines the sub-class entity name | N |
quote.@referredType | String | The actual type of the target instance when needed for disambiguation. | N |
relatedParty | array | Related Entity reference. A related party defines party or party role linked to a specific entity. | N |
relatedParty.id | String | Unique identifier Id of the related entity. | N |
relatedParty.href | String | Unique reference of the related entity. | N |
relatedParty.name | String | Name of the related entity.. | N |
relatedParty.role | String | Role played by the related party | N |
relatedParty.@baseType | String | When sub-classing, this defines the super-class. | N |
relatedParty.@schemaLocation | String | A URI to a JSON-Schema file that defines additional attributes and relationships. | N |
relatedParty.@type | String | When sub-classing, this defines the sub-class entity name | N |
relatedParty@referredType | String | The actual type of the target instance when needed for disambiguation. | Y |
state | string | enum: - acknowledged - rejected - pending - held - inProgress - cancelled - completed - failed - partial - assessingCancellation - pendingCancellation | N |
@baseType | String | When sub-classing, this defines the super-class | N |
@schemaLocation | String | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
@type | String | When sub-classing, this defines the sub-class entity name | N |
Possible response error
In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.
[ 400 ]
Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.
{
"errors" : [{
"code" : 400 ,
"message" : "The request is invalid or not properly formed.",
"description" : "The client sent too many requests and server is not able to serve them all at the moment"
}
]
}
[ 401 ]
Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.json
{
"errors" : [{
"code" : 401 ,
"message" : "The user could not be authenticated for this request.",
"description" : "The request has not been applied because it lacks valid authentication credentials for the target resource"
}
]
}
[ 404 ]
Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.
```json
{
"errors" : [{
"code" : 404,
"message" : "The request is invalid or not properly formed.",
"description" : "The requested operation failed because a resource associated with the request could not be found."
}
]
}
```
[ 405 ]
Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.json
{
"errors": [{
"code": 405,
"message": "APIKIT:METHOD_NOT_ALLOWED",
"description": "HTTP Method post not allowed for : /{businessId}/productOrder"
}]
}
[ 429 ]
Too Many Requests - client has sent too many requests in a space of time (rate limiting). When a server is under attack or just receiving a very large number of requests from a single party, responding to each with a 429 status code will consume resources. Therefore, servers may drop connections or take other steps instead of responding with the 429 status code, when limiting resource usage.
```json
{
"errors" : [{
"code" : 429,
"message" : "The request is invalid or not properly formed.",
"description" : "The requested operation failed because a resource associated with the request could not be found."
}
]
}
#### [ 500 ]
Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.
```json
{
"errors" : [{
"code" : 500,
"message" : "The request failed due to an internal error.",
"description": ""
}
]
}
[ 501]
{
"errors":[
{
"code":501,
"message":"Not implemented",
"description":"Operation GET /productOrder for Business Id: XXXX not implemented"
}
]
}
[ 503 ]
Service Unavailable - temporary maintenance of service, try again later. The implication is that this is a temporary condition which will be alleviated after some delay. If known, the length of the delay will be indicated in a Retry-After header. If no Retry-After is given, the client SHOULD handle the response as it would for a 500 response. Note: The existence of the 503 status code does not imply that a server will use it when becoming overloaded. Servers may simply refuse the connection.http
Retry-After: 120
Administration and data management
In this section you define all the transformations, temporary and final repositories of the data within the method flow.
Transformation Request
In this section the matrix of all the data transformations that is carried out within the service is defined.
Original Payload | Mulesoft | transformation |
---|---|---|
payload | payload |
Query Parameters to be mapped from request
Original Payload | Mulesoft | transformation |
---|---|---|
attributes.queryParameters.billingAccount.id | attributes.queryParameters.billingAccount.id |
Additional Query Parameters to be passed for Comverse
Original Payload | Mulesoft | transformation |
---|---|---|
Completed,In Progress | attributes.queryParameters.state | |
attributes.queryParameters.orderDate.lte | attributes.queryParameters.orderDate.lte | |
attributes.queryParameters.orderDate.gte | attributes.queryParameters.orderDate.gte |
nontmf-evolving-sys
Original Payload | Mulesoft | transformation |
---|---|---|
queryParam.'channel.name' | queryParam.'channel.name' | |
queryParam.'relatedParty.id' | queryParam.'relatedParty.id' |
sfdc-sys
Original Payload | Mulesoft | transformation |
---|---|---|
queryParam.'realizingResource.name' | queryParam.'realizingResource.name' | |
queryParam.'realizingResource.id' | queryParam.'realizingResource.id' | |
queryParam.'channel.name' | queryParam.'channel.name' |
Transformation Response
In this section the matrix of all the data transformations that is carried out within the service is defined.
Original Payload | Mulesoft | transformation |
---|---|---|
payload | payload |
nontmf-evolving-sys
note: Same SYS response without transformation
Original Payload | Mulesoft | transformation |
---|---|---|
payload | payload |
Services dependencies
This section defines all the connections to the web services and the methods that are used within the method.
liberate-product-ordering-sys
Method | Type |
---|---|
/productOrder | GET |
csg-product-ordering-sys
Method | Type |
---|---|
/productOrder | GET |
cerillion-product-ordering-sys
Method | Type |
---|---|
/productOrder | GET |
comverse1-product-ordering-sys
Method | Type |
---|---|
/productOrder | GET |
nontmf-evolving-sys
Method | Type |
---|---|
\loanProductOrdering | GET |
sfdc-sys
Method | Type | URL | Example |
---|---|---|---|
\productOrder | GET |