cisco-cvp-ux
Get Pending ProductOrders - TMF622 GET
This operation retrieves the pending product orders associated with an account from SF.
Request
URL
http://[host]:[port]/cisco-cvp-ux/v1/{businessId}/productOrder
URI Parameter
Name | Type | M/O | Description |
---|---|---|---|
businessId | string | M | Business unit identifier. Can be one of: "JM", "PA", "PR", "CL", "CR" |
Headers
name | value | description | required |
---|---|---|---|
X-Correlation-ID | string | This is a unique identifier for the current call chain that can be used to tie together log entries on multiple layers. Example: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b | M |
channelId | string | Channel to identify the business group. Eg:ivrB2C | O |
Security Headers
Name | Type | M/O | Description |
---|---|---|---|
client_id | string | M | Client Id value for Client Id Enforcement policy. Environment Specific Value. Eg: 6f0ed16a7b494d76b2d60e05bc3b3332 |
client_secret | string | M | Client secret value for Client Id Enforcement policy. Environment Specific Value, eg: e4CD4D43449846aA9D8Cb9c43fAd324a |
Query Parameters
Name | Type | M/O | Description |
---|---|---|---|
id | string | M | billingAccountId of the customer(BAN-CAN) |
Response
Possible success response
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 ]
[
{
"requestedStartDate": "2023-06-22T17:29:43.204Z",
"id": "80163000002X2WqAAK",
"productOrderItem": [
{
"product": {
"id": "PR_B2C_Prepaid_4GB_Mobile_Line",
"name": "Prepaid 4GB Mobile Line",
"productCharacteristic": [
{
"name": "Device Details",
"valueType": "object",
"value": {
"type": "Mobile Phone",
"model": "iPhone 13",
"state": "New",
"manufacturer": "Apple",
"capacity": "128GB",
"color": "Blue",
"installmentType": "test",
"lineUserName": "Pool Id Customer2210171"
}
},
{
"name": "Insurance Details",
"valueType": "object",
"value": {
"policyType": "testExample",
"socCode": "test1234",
"claimType": "test"
}
},
{
"name": "SIM Details",
"valueType": "object",
"value": {
"simCardType": "Dynamic eSim"
}
}
],
"realizingResource": [
{
"name": "imei",
"id": "17872210172178722",
"@type": "PhysicalResource"
},
{
"name": "msisdn",
"id": "17872210172",
"@type": "LogicalResource"
},
{
"name": "imsi",
"id": "313790887000969",
"@type": "LogicalResource"
},
{
"name": "iccid",
"id": "8901790001870000969",
"@type": "PhysicalResource"
}
]
}
}
],
"state": "In Progress",
"@type": "ProductOrder"
}
]
Definitions
name | type | description | required |
---|---|---|---|
id | String | ID created on repository side | Y |
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 | Y |
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. | N |
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). | N |
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 | N |
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.value.type | String | Name of the characteristic | N |
productOrderItem.product.productCharacteristic.value.model | String | Data type of the value of the characteristic | N |
productOrderItem.product.productCharacteristic.value.state | String | State of the device | N |
productOrderItem.product.productCharacteristic.value.manufacturer | String | Manufacturer of the device | N |
productOrderItem.product.productCharacteristic.value.capacity | String | Capacity of the device | N |
productOrderItem.product.productCharacteristic.value.color | String | Color of the device | N |
productOrderItem.product.productCharacteristic.value.installmentType | String | Installment Type of the device | N |
productOrderItem.product.productCharacteristic.value.lineUserName | String | Line user name of the device | N |
productOrderItem.product.productCharacteristic.value.policyType | String | Policy type of the insurance | N |
productOrderItem.product.productCharacteristic.value.socCode | String | socCode of the insurance | N |
productOrderItem.product.productCharacteristic.value.claimType | String | claim type of the insurance | N |
productOrderItem.product.productCharacteristic.value.simCardType | String | Type of the sim card | 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. | N |
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 | N |
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. | N |
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. | N |
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. | N |
state | string | enum: - acknowledged - rejected - pending - held - inProgress - cancelled - completed - failed - partial - assessingCancellation - pendingCancellation | Y |
@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 errors
[ 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": "APIKIT:BAD_REQUEST",
"description": "Invalid value 'M' for uri parameter businessId. M is not a valid enum value"
}
]
}
[ 401 ]
Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.
{
"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"
}]
}
[ 403 ]
Forbidden - Indicates that the server understood the request but refuses to fulfill it. If authentication credentials were provided in the request, the server considers them insufficient to grant access. The client SHOULD NOT automatically repeat the request with the same credentials. The client MAY repeat the request with new or different credentials.
[ 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.
{
"errors": [
{
"code": 404,
"message": "APIKIT:NOT_FOUND",
"description": "/PR/productOrder1"
}
]
}
[ 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.
{
"errors": [
{
"code": 405,
"message": "APIKIT:METHOD_NOT_ALLOWED",
"description": "HTTP Method post not allowed for : /{businessId}/productOrder"
}
]
}
[ 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.
{
"errors" : [{
"code" : 500,
"message" : "The request failed due to an internal error.",
"description": "error description"
}]
}
[ 501 ]
Check for the other BU Flows, if not implemented then throw a standard error message as below.
{
"errors": [
{
"code": 501,
"message": "NOT IMPLEMENTED",
"description": "Operation GET /{businessId}/productOrder for Business Id: PA not implemented."
}
]
}
[ 503 ]
Service Unavailable
{
"errors": [
{
"code": 503,
"message": "HTTP:SERVICE_UNAVAILABLE",
"description": "HTTP GET on resource 'http://0.0.0.0:9091/tmf-api/product-ordering-biz/v1/{businessId}/productOrder' failed: service unavailable (503)."
}
]
}