Order Handoff Summary

The idea is to offer Distributors an API endpoint for final order submission. Successful results must be obtained from Credit checks to submit any related order.

In this stage, the Solution provider (SP) submits the order. This action confirms and completes the order created during the order enrichment stage.  

All relevant details, including the main order, sub-orders, and installation specifics, are reviewed and solidified. Once the SP submits the order, they receive an acknowledgment, affirming that the order has been successfully submitted

Order handoff flow

Security

This RESTful service uses a client id enforcement policy as the authentication mechanism. Please work with the Client On-Boarding Team if you do not have the necessary credentials.

Endpoints and Headers

POST API Endpoints

If you are a Connector—meaning you develop on behalf of multiple Solution Provider accounts to retrieve information for them, you will use the same URL, and ensure that you pass the unique client header per Solution Provider.

API Headers

The following are the fields in the Request headers of the Order Handoff API.

Field Name

Field Description

Mandatory/Optional

content-type

Application/json

M

accept

Specifies the format of the response message body.

Structured text message payloads are required to support application/json. No other format is permitted. As they are the only supported format, the accept header is not relevant for those requests.

O

x-trace-id

This field is used for passing a trace ID between API hops for end-to-end traceability.

 

M

x-transaction-id

This field is used for passing a traceable ID to uniquely identify the transactions.

O

client_id

This field represents client id.

M

client_secret

This field represents client secret.

M

source

This field should identify the calling system/application.

O