Product Change Process
API users can initiate service changes through the API by following a streamlined process. To successfully execute this action, clients must adhere to specific requirements. To begin, clients should possess a comprehensive understanding of the products offered. Additionally, they must confirm the availability of the specific service they intend to modify. By fulfilling these prerequisites, API users can seamlessly perform service changes using the provided API.
Instructions:
1. Prerequisites:
- Clients must have knowledge about the products offered.
- Clients must confirm the availability of the specific service they intend to modify.
2. API Request:
To initiate a service change, clients can use the following curl command as an example:
curl --request POST \
--url {URL} \
--header 'Authorization: Insert Token' \
--header 'Content-Type: application/json' \
--data '{
"service_change": {
"service_id": "ServiceId",
"product_id": "ProductId",
"effective_date": "When will this change happen",
"direction": null
},
"modified_by": "Who made the change"
}'
3. JSON Request Format:
Clients can post the following JSON object:
{
"service_change": {
"service_id": "ServiceId",
"product_id": "ProductId",
"effective_date": "When will this change happen",
"direction": null
},
"modified_by": "Who made the change"
}
4. API Response:
Upon successful execution, clients will receive the following JSON object:
{
"customer": {
"id": "CustomerId or PersonId"
},
"premise": {
"id": "PremisesId"
},
"service": {
"id": "The new ServiceId"
},
"payment_attribute": {
"id": null
}
}
This response provides details about the customer, premise, and the new service ID resulting from the service change. Clients can use this information for further reference or verification.