Artemis Product Ordering API V3

To deliver an excellent customer service it is essential we empower our Partners and Customers to have fast, easy access to information and the ability to self-serve and manage their orders and services

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 and in-flight order

Delete - Cease an existing product

Cancel - Request cancellation of an in-flight product order

All order flow journeys can be summarised in one workflow diagram:

Step1: SecurityAPI	Obtain Security Token
Step2: UPRN	Partners should have the UPRN, then jump to step4. If they need ALK, for Openreach products, go to Step3.
Step3: Address Matching	Use Address Matching API to obtain Openreach Alk.
Step4: Search Product Availability by Address	Do product availability check for the UPRN using Product Availability API. In the response, check if there is a desired product available: No End of journey. Yes then check "ProvisioningCommand" in "ProvisioningType" to select required journey to move forward. The following Provisioning Commands are available to choose from. All journeys follow almost same set of API calls, the only difference would be in the product characteristic and scenario how they flow, please click on each option for difference, variations, uses case etc. ProvideNew Switch SwitchToNew SwitchToStop Takeover Restart Replace ReplaceToNew ReplaceToStop Check "ProvisioningDetails" section: If "name": "available" has "value": "N" then end of Journey. If "name": "available" has "value": "Y" this means definitely the journey is possible, then check      if "name": "appointmentRequired" has "value": "Y" then go to Step6.      if "name": "appointmentRequired" has "value": "R" then go to Step6. This indicated that an appointment is recommended. You will only see this for SOGEA products.      if "name": "appointmentRequired" has "value": "N" go to Step8. If "name": "available" has "value": "P" this means it's possible, so we need to do additional checks to determine which line the product availability is possible, so go to Step5.
Step5: Search Product availability by line	Search product availability check by line using the line details from Step4 response payload. When targeting an Openreach FTTP ONT Journey you must pass the ontReference and portNumber as these are mandatory input parameters. The reason the portnumber needs to be passed is because, an ONTReference number can have up-to four ethernet ports, so we need to know which port number needs switching. Best example would be say it is an apartment, which has one fibre cable and has 4 ethernet ports connecting to four different apartments, then we need to know which portnumber is connected to that house (or to the retailer). When targeting an Openreach Access Line for a SOGEA Journey, you must pass the targeted accessLineId the end customer wishes to move. If the end customer has a live ONT and Access Line ID you can pass both in the Search By Line availability checker by setting the line type to AccessLineId-ONTRef this will return the available options for both technologies.
Step6: Search Available appointments	Select the desired appointment date and time and go to Step7 to book and appointment.
Step7: Book Engineering Appointment	Pass the selected date and time and book and appointment. You will get an appointment id as your response payload. You need to pass that in your Place order payload if an appointment.
Step8: Place Order	Using PlaceOrder End point you can place an order for any of the journeys mentioned in Step4. Note: ProvisioningCommand, Product Characteristics and appointment details will vary based on the selected journey.

---

Page Version History