Order Taking
Operation
sequenceDiagram
participant Client
participant Covage API
participant Covage Backend
Client ->> Covage API: Create an order session
Covage API -->> Client: Retrieve the order session ID
Client ->> Covage API: Create an order line
Covage API -->> Client: Retrieve the order line ID
Client ->> Covage API: Update the order line information
Covage API -->> Client: Confirm the order line update
Client ->> Covage API: Confirm the order session
Covage API -->> Client: Confirm the order receipt
Covage API ->> Covage Backend: Create the order
Covage Backend -->> Covage API: Confirm the order
Creating an Order Session
POST /api/v1/product_order
Request Field Parameters
| Name |
Type |
Description |
Required |
| external_id |
string |
External identifier for the request |
No |
| project_id |
string |
Associated project identifier |
No |
Response
| Name |
Type |
Description |
Required |
| external_id |
string |
External identifier for the request |
No |
| project_id |
string |
Associated project identifier |
No |
| id |
string |
Order identifier |
Yes |
| creation_date |
string |
Order creation date |
Yes |
| cancellation_date |
string |
Order cancellation date |
No |
| completion_date |
string |
Order completion date |
No |
| order_date |
string |
Order date |
Yes |
| state |
string |
Current state of the order |
Yes |
Creating an Order Line
POST /api/v1/product_order/{id}/product_order_item
Request Field Parameters
| Name |
Type |
Description |
Required |
| end_customer_name |
string |
End customer name |
No |
| external_id |
string |
External identifier for the request |
No |
| option_ids |
array |
List of option identifiers |
No |
| note |
string |
Note associated with the order |
No |
| technical_note |
string |
Technical note associated with the order |
No |
| product_offering_id |
string |
Product offering identifier |
Yes |
| product_offering_qualification_item_id |
string |
Product offering qualification item identifier |
Yes |
| project_id |
string |
Associated project identifier |
No |
| quote_item_id |
string |
Quote item identifier |
No |
| delivery_mode |
string |
Delivery mode |
No |
| enni |
string |
ENNI identifier |
No |
| vlan_reference |
number |
VLAN reference |
No |
| customer_order_name |
string |
Customer order name |
No |
| business_code |
string |
Business code |
No |
| related_contact_information |
array |
Related contact information |
No |
Related Contact Information Details
| Name |
Type |
Description |
Required |
| end_customer_name |
string |
End customer name |
Yes |
| siret |
string |
SIRET number |
Yes |
| contact1_email_address |
string |
On-site contact email address |
Yes |
| contact1_name |
string |
On-site contact name |
Yes |
| contact1_phone_number |
string |
On-site contact phone number |
Yes |
| contact2_email_address |
string |
Secondary contact email address |
No |
| contact2_name |
string |
Secondary contact name |
No |
| contact2_phone_number |
string |
Secondary contact phone number |
No |
| city |
string |
City |
Yes |
| postcode |
string |
Postal code |
Yes |
| street_name |
string |
Street name |
Yes |
| street_number |
string |
Street number |
Yes |
| street_number_extension |
string |
Street number extension |
No |
| insee_code |
string |
INSEE code |
Yes |
| building_name |
string |
Building name |
No |
| level_number |
string |
Level number |
No |
| latitude |
number |
Address latitude |
Yes |
| longitude |
number |
Address longitude |
Yes |
Response
| Name |
Type |
Description |
Required |
| end_customer_name |
string |
End customer name |
No |
| external_id |
string |
External identifier for the request |
No |
| option_ids |
array |
List of option identifiers |
No |
| note |
string |
Note associated with the order |
No |
| technical_note |
string |
Technical note associated with the order |
No |
| product_offering_id |
string |
Product offering identifier |
Yes |
| product_offering_qualification_item_id |
string |
Product offering qualification item identifier |
Yes |
| project_id |
string |
Associated project identifier |
No |
| quote_item_id |
string |
Quote item identifier |
No |
| delivery_mode |
string |
Delivery mode |
No |
| enni |
string |
ENNI identifier |
No |
| vlan_reference |
number |
VLAN reference |
No |
| customer_order_name |
string |
Customer order name |
No |
| business_code |
string |
Business code |
No |
| related_contact_information |
array |
Related contact information |
No |
| id |
string |
Order identifier |
Yes |
| cancellation_date |
string |
Order cancellation date |
No |
| cancellation_reason |
string |
Cancellation reason |
No |
| completion_date |
string |
Order completion date |
No |
| order_date |
string |
Order date |
No |
| state |
string |
Current state of the order |
Yes |
| state_change |
array |
State change history |
No |
| termination_error |
array |
Associated termination errors |
No |
| order_reference |
string |
Order reference |
No |
| reference_id |
string |
Reference identifier |
No |
Related Contact Information Details
| Name |
Type |
Description |
Required |
| end_customer_name |
string |
End customer name |
Yes |
| siret |
string |
SIRET number |
Yes |
| contact1_email_address |
string |
On-site contact email address |
Yes |
| contact1_name |
string |
On-site contact name |
Yes |
| contact1_phone_number |
string |
On-site contact phone number |
Yes |
| contact2_email_address |
string |
Secondary contact email address |
No |
| contact2_name |
string |
Secondary contact name |
No |
| contact2_phone_number |
string |
Secondary contact phone number |
No |
| city |
string |
City |
Yes |
| postcode |
string |
Postal code |
Yes |
| street_name |
string |
Street name |
Yes |
| street_number |
string |
Street number |
Yes |
| street_number_extension |
string |
Street number extension |
No |
| insee_code |
string |
INSEE code |
Yes |
| building_name |
string |
Building name |
No |
| level_number |
string |
Level number |
No |
| latitude |
number |
Address latitude |
Yes |
| longitude |
number |
Address longitude |
Yes |
Associated Fees Details
| Name |
Type |
Description |
Required |
| description |
string |
Fee description |
Yes |
| access_fee |
number |
Access fee |
Yes |
| recurring_price |
number |
Recurring price |
Yes |
State Change Details
| Name |
Type |
Description |
Required |
| change_reason |
string |
State change reason |
Yes |
| change_date |
string |
State change date |
Yes |
| state |
string |
New state |
Yes |
Termination Error Details
| Name |
Type |
Description |
Required |
| code |
string |
Error code |
Yes |
| property_path |
string |
Concerned property path |
Yes |
| value |
string |
Associated value |
Yes |
PATCH /api/v1/product_order/{id}/product_order_item/{item_id}
Request Field Parameters
| Name |
Type |
Description |
Required |
| end_customer_name |
string |
End customer name |
No |
| external_id |
string |
External identifier for the request |
No |
| option_ids |
array |
List of option identifiers |
No |
| note |
string |
Note associated with the order |
No |
| technical_note |
string |
Technical note associated with the order |
No |
| product_offering_id |
string |
Product offering identifier |
No |
| product_offering_qualification_item_id |
string |
Product offering qualification item identifier |
No |
| project_id |
string |
Associated project identifier |
No |
| quote_item_id |
string |
Quote item identifier |
No |
| delivery_mode |
string |
Delivery mode |
No |
| enni |
string |
ENNI identifier |
No |
| vlan_reference |
number |
VLAN reference |
No |
| customer_order_name |
string |
Customer order name |
No |
| business_code |
string |
Business code |
No |
| related_contact_information |
array |
Related contact information |
No |
Related Contact Information Details
| Name |
Type |
Description |
Required |
| end_customer_name |
string |
End customer name |
No |
| siret |
string |
SIRET number |
No |
| contact1_email_address |
string |
On-site contact email address |
No |
| contact1_name |
string |
On-site contact name |
No |
| contact1_phone_number |
string |
On-site contact phone number |
No |
| contact2_email_address |
string |
Secondary contact email address |
No |
| contact2_name |
string |
Secondary contact name |
No |
| contact2_phone_number |
string |
Secondary contact phone number |
No |
| city |
string |
City |
No |
| postcode |
string |
Postal code |
No |
| street_name |
string |
Street name |
No |
| street_number |
string |
Street number |
No |
| street_number_extension |
string |
Street number extension |
No |
| insee_code |
string |
INSEE code |
No |
| building_name |
string |
Building name |
No |
| level_number |
string |
Level number |
No |
| latitude |
number |
Address latitude |
No |
| longitude |
number |
Address longitude |
No |
Response
| Name |
Type |
Description |
Required |
| end_customer_name |
string |
End customer name |
No |
| external_id |
string |
External identifier for the request |
No |
| option_ids |
array |
List of option identifiers |
No |
| note |
string |
Note associated with the order |
No |
| technical_note |
string |
Technical note associated with the order |
No |
| product_offering_id |
string |
Product offering identifier |
Yes |
| product_offering_qualification_item_id |
string |
Product offering qualification item identifier |
Yes |
| project_id |
string |
Associated project identifier |
No |
| quote_item_id |
string |
Quote item identifier |
No |
| delivery_mode |
string |
Delivery mode |
No |
| enni |
string |
ENNI identifier |
No |
| vlan_reference |
number |
VLAN reference |
No |
| customer_order_name |
string |
Customer order name |
No |
| business_code |
string |
Business code |
No |
| related_contact_information |
array |
Related contact information |
No |
| id |
string |
Order identifier |
Yes |
| cancellation_date |
string |
Order cancellation date |
No |
| cancellation_reason |
string |
Cancellation reason |
No |
| completion_date |
string |
Order completion date |
No |
| order_date |
string |
Order date |
No |
| state |
string |
Current state of the order |
Yes |
| state_change |
array |
State change history |
No |
| termination_error |
array |
Associated termination errors |
No |
| order_reference |
string |
Order reference |
No |
| reference_id |
string |
Reference identifier |
No |
Related Contact Information Details
| Name |
Type |
Description |
Required |
| end_customer_name |
string |
End customer name |
Yes |
| siret |
string |
SIRET number |
Yes |
| contact1_email_address |
string |
On-site contact email address |
Yes |
| contact1_name |
string |
On-site contact name |
Yes |
| contact1_phone_number |
string |
On-site contact phone number |
Yes |
| contact2_email_address |
string |
Secondary contact email address |
No |
| contact2_name |
string |
Secondary contact name |
No |
| contact2_phone_number |
string |
Secondary contact phone number |
No |
| city |
string |
City |
Yes |
| postcode |
string |
Postal code |
Yes |
| street_name |
string |
Street name |
Yes |
| street_number |
string |
Street number |
Yes |
| street_number_extension |
string |
Street number extension |
No |
| insee_code |
string |
INSEE code |
Yes |
| building_name |
string |
Building name |
No |
| level_number |
string |
Level number |
No |
| latitude |
number |
Address latitude |
Yes |
| longitude |
number |
Address longitude |
Yes |
State Change Details
| Name |
Type |
Description |
Required |
| change_reason |
string |
State change reason |
Yes |
| change_date |
string |
State change date |
Yes |
| state |
string |
New state |
Yes |
Termination Error Details
| Name |
Type |
Description |
Required |
| code |
string |
Error code |
Yes |
| property_path |
string |
Concerned property path |
Yes |
| value |
string |
Associated value |
Yes |
Confirming the Order Session
/api/v1/product_order/{id}/confirm/
Response
| Name |
Type |
Description |
Required |
| external_id |
string |
External identifier for the request |
No |
| project_id |
string |
Associated project identifier |
No |
| id |
string |
Order identifier |
Yes |
| product_order_item |
array |
List of order items |
Yes |
Order Item Details
| Name |
Type |
Description |
Required |
| end_customer_name |
string |
End customer name |
No |
| external_id |
string |
External identifier for the request |
No |
| option_ids |
array |
List of option identifiers |
No |
| note |
string |
Note associated with the order |
No |
| technical_note |
string |
Technical note associated with the order |
No |
| product_offering_id |
string |
Product offering identifier |
Yes |
| product_offering_qualification_item_id |
string |
Product offering qualification item identifier |
Yes |
| project_id |
string |
Associated project identifier |
No |
| quote_item_id |
string |
Quote item identifier |
No |
| delivery_mode |
string |
Delivery mode |
No |
| enni |
string |
ENNI identifier |
No |
| vlan_reference |
number |
VLAN reference |
No |
| customer_order_name |
string |
Customer order name |
No |
| business_code |
string |
Business code |
No |
| related_contact_information |
array |
Related contact information |
No |
| id |
string |
Order identifier |
Yes |
| cancellation_date |
string |
Order cancellation date |
No |
| cancellation_reason |
string |
Cancellation reason |
No |
| completion_date |
string |
Order completion date |
No |
| order_date |
string |
Order date |
No |
| state |
string |
Current state of the order |
Yes |
| state_change |
array |
State change history |
No |
| termination_error |
array |
Associated termination errors |
No |
| order_reference |
string |
Order reference |
No |
| reference_id |
string |
Reference identifier |
No |
Related Contact Information Details
| Name |
Type |
Description |
Required |
| end_customer_name |
string |
End customer name |
Yes |
| siret |
string |
SIRET number |
Yes |
| contact1_email_address |
string |
On-site contact email address |
Yes |
| contact1_name |
string |
On-site contact name |
Yes |
| contact1_phone_number |
string |
On-site contact phone number |
Yes |
| contact2_email_address |
string |
Secondary contact email address |
No |
| contact2_name |
string |
Secondary contact name |
No |
| contact2_phone_number |
string |
Secondary contact phone number |
No |
| city |
string |
City |
Yes |
| postcode |
string |
Postal code |
Yes |
| street_name |
string |
Street name |
Yes |
| street_number |
string |
Street number |
Yes |
| street_number_extension |
string |
Street number extension |
No |
| insee_code |
string |
INSEE code |
Yes |
| building_name |
string |
Building name |
No |
| level_number |
string |
Level number |
No |
| latitude |
number |
Address latitude |
Yes |
| longitude |
number |
Address longitude |
Yes |
State Change Details
| Name |
Type |
Description |
Required |
| change_reason |
string |
State change reason |
Yes |
| change_date |
string |
State change date |
Yes |
| state |
string |
New state |
Yes |
Termination Error Details
| Name |
Type |
Description |
Required |
| code |
string |
Error code |
Yes |
| property_path |
string |
Concerned property path |
Yes |
| value |
string |
Associated value |
Yes |