Add a service to a proposal
- Proposal service
- Services
- 4 routes
How do I add a service to an existing proposal?
This scenario shows how to identify the available additional services, review the services already attached to a proposal, and update the selected proposal service list.
Overview
The sequence POST/v0/proposals/search/best -> GET/v0/additional_services -> GET/v0/proposals/{proposal_id}/services -> PUT/v0/proposals/{proposal_id}/services helps identify the additional services that can be sold, review the services already attached, and then replace the final service list kept on the proposal.
Prerequisites
- A usable proposal must be created or retrieved at the beginning of the journey.
- The
proposal_idreturned by the first step is required to read and update services. - The final update follows a
cancel & replacelogic: each call must carry the complete list of services that should remain on the proposal. - The documented calls use
accept-languageandx-api-key.
Process workflow
Legend:
Mandatory
Optional
1
Create or retrieve the proposal
Mandatory
POST/v1/proposals/search/best
S2
List available additional services
Mandatory
GET/v0/additional_services
S3
Review current proposal services
Mandatory
GET/v0/proposals/{proposal_id}/services
S4
Replace the proposal service list
Mandatory
PUT/v0/proposals/{proposal_id}/services
S