Artemis Product Ordering API V3

Defination

Provision of a new circuit where either no connectivity currently exists or an additional circuit is required. Provide new journey happens when there is no infrastructure in their home. A customer or the retailer has decided to install new line at the property If they need Additional Line Access supplier is installing infrastructure at the property. This journey can be used in conjunction with "Customer Switch" (OTS) where customer is new to PXC network (or to the retailer).

Work flow diagram

Security API	Get the token consuming security API
Address Matching API	Select the desired property by passing only postcode and then selecting the property, or pass postcode and building name/building number, or pass UPRN. You can obtain GALK using Address Matching API, GALK is needed only for Openreach products. For other products you need UPRN. If you already have the GLAK/ UPRN you can go to next step. The minimum fields you can pass in your request payload are UPRN or Postcode and house number/name.
Product Availability (Search by Address)	Check if there are suppliers available by calling Product Availability check API's. If there is a "Y" for Supplier availability, then check what provisioning commands are available, each provisioning command will have three outcomes. Y, N or P. If provisioning command New Provide is "N" then end of Journey. If provisioning command New Provide is "Y" then new provide is possible. Check if there are any other alternative options available, you can do this by checking for P for other provisioning command. if P you see a P for any other provisioning command then that route is possible. Follow that path accordingly. But because this is Provide New Journey only, we will assume we have got only Y for Provide new and all other provisioning commands have got a N.
Search List of Available Appointments	Once desired product is selected, check if appointment field is required. If appointment field is "Y" then call Appointment API, If it is "N" then Skip Earchlist of Available Appointment and Reserve Appointments API calls. And Jump to Place Order; section
Reserve Appointment	Select a slot and reserve an appointment. Note. The appointment will be confirmed and booked only if a valid order is placed.
Product Order: Provide New	Place an order calling the ProductOrder endpoint.
Order Management	To check the status of the Order, cancel, amend, modify, cease.

Use Case 1: Provide New as a New service

Use Case 2: Provide New as an Additional line

Use Case 3: Provide New as a Change service: Description