Artemis Product Ordering API V2
home
Artemis Product Ordering API V3 API V3 now available
PXC Partners must uplift to Artemis Product Ordering API V3 for Single Line Voice (VoIP) and other future developments.
Use this API to:
Create a product order with the following TMF622 actions:
Add - Provide a new product order
Modify - Make a change an existing product
Delete - Cease an existing product
Patch - Amend an in-flight product order
Cancel - Request cancellation of an in-flight product order
Note: A "Product" is an instance of a product offering sometimes referred to as an asset or service.
product.id is a unique identifier associated to each product, which is used throughout its lifecycle and a billing identifier:
A Product order includes place, product, notes and productCharacteristic information to progress your order:
• billingAccount (Used to provision the product to the targeted account)
• Notes (Used to send specific information to suppliers, engineers and PXC)
• productLineItem (Includes specific product information which forms the product order)
-action (TMF action of the Product order being placed)
-appointment.id (Appointment ID reserved via the Partner Appointing Experience API)
-product.name (Name of the product being ordered which is supplied via the Partner Availability Experience API)
-product.place (Array containing the address identifier (GALK or UPRN) and Emergency Database valid address information
-product.characteristics (Array of name value pairs, which define the product speed, care level, IP allocation and specific order information)
Page Version History
Version | Date last updated | Author | Owner | Description of change |
---|---|---|---|---|
1.0 | 05/09/2024 | Andy Kirk-Kelly | Customer Platforms | Updated key features of Product Ordering Experience API |