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

Lifecycle of an order session

flowchart LR A[<a href='/en/api-prise-commande/#creating-an-order-session'>Creation of an order session</a>] -->B(created) B -->C[<a href='/en/api-prise-commande/#confirming-the-order-session'>Confirmation of the order session</a>] C -->D(in_progress) D -->E{Were all order lines created ?} E -->|yes| F[completed] E -->G{Is at least one line created ?} G -->|yes| H[partial] G -->|no| I[rejected]

Lifecycle of an order line

flowchart LR A[<a href='/en/api-prise-commande/#creating-an-order-line'>Creating an order line</a>] -->B(created) B -->C[<a href='/en/api-prise-commande/#confirming-the-order-session'>Confirmation of the order line</a>] C -->D(in_progress) D -->E{Was the order created ?} E -->|yes| F[acknowledged\nheld_adv_validation\nin_progress] style F text-align:left E -->|no| G[rejected_creation]

Creating an Order Session

Once the order sesion has been created, one or many order lines can be added.

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

Example

{
  "external_id": "12345",
  "project_id": ""
}

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

Example

{
    "external_id": "12345",
    "project_id": "",
    "id": "0b10ba8a-3c31-44ba-a758-d178ec0bb166",
    "creation_date": "2025-04-10T12:11:57.548+02:00",
    "cancellation_date": null,
    "completion_date": null,
    "order_date": null,
    "state": "created"
}

List of order sessions

GET /api/v1/product_order/

Lists order sessions (carts) with optional filtering.

Available filters (query params):

Parameter	Type	Description
`state`	string	Filter by session state
`external_id`	string	Filter by external identifier
`project_id`	string	Filter by project identifier
`creation_date_gt`	datetime	Sessions created after this date (ISO 8601)
`creation_date_lt`	datetime	Sessions created before this date (ISO 8601)
`order_date_gt`	datetime	Sessions ordered after this date (ISO 8601)
`order_date_lt`	datetime	Sessions ordered before this date (ISO 8601)
`completion_date_gt`	datetime	Sessions completed after this date (ISO 8601)
`completion_date_lt`	datetime	Sessions completed before this date (ISO 8601)
`cancellation_date_gt`	datetime	Sessions cancelled after this date (ISO 8601)
`cancellation_date_lt`	datetime	Sessions cancelled before this date (ISO 8601)

Response: List of order sessions (same fields as the creation response).

Order session detail

GET /api/v1/product_order/{id}/

Retrieves the details of an order session, including all its order lines.

URL parameter:

Name	Type	Required	Description
`id`	UUID	✅	Order session identifier

Response:

Field	Type	Description
`id`	UUID	Unique session identifier
`external_id`	string	External identifier
`project_id`	string	Associated project identifier
`product_order_item`	array	List of associated order lines

Update an order session

PATCH /api/v1/product_order/{id}/

Updates the metadata of an existing order session.

URL parameter:

Name	Type	Required	Description
`id`	UUID	✅	Order session identifier

Request body:

Field	Type	Required	Description
`external_id`	string	❌	External identifier
`project_id`	string	❌	Associated project identifier

Response: Updated session detail (see GET /product_order/{id}/).

Delete an order session

DELETE /api/v1/product_order/{id}/

Deletes an order session and all its associated order lines.

URL parameter:

Name	Type	Required	Description
`id`	UUID	✅	Order session identifier

Creating an Order Line

During an order line creation, some non-required fields become required during the order session confirmation. It becomes necessary to fill them beforehand by updating the 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	Yes (during confirmation only*)
enni_2	string	Secondary ENNI identifier	No
vlan_reference	number	VLAN reference	No
customer_order_name	string	Customer order name	No
business_code	string	Business code	No
billing_site_ref	string	Billing site reference	No
related_contact_information	array	Related contact information	Yes (during confirmation only)
siret_known	boolean	Should the SIRET be filled ?	No
additional_vlan_reference	string	Additional VLAN reference	No
offer_family	string	Offer's family	No
offer_technology	string	Offer's technology	No
specific_request	string	Specific request	No
access_instructions	string	Access instructions given by the customer	No
scheduled_delivery_date	date	Scheduled delivery date	No
cpe_networking_number	string	CPE networking number	No
cpe_serial_number	string	CPE serial number	No

Special case of the enni field for the DIA offer

The enni field should not be filled in for the DIA offer: if it is filled in, it will be replaced by the value calculated by our system.

Example

{
  "end_customer_name": "Covage",
  "external_id": "6789",
  "option_ids": [...],
  "note": "",
  "technical_note": "",
  "product_offering_id": "2173",
  "product_offering_qualification_item_id":"{eligibility_id}",
  "project_id": "",
  "quote_item_id": "{quote_id}",
  "delivery_mode": "",
  "enni": "AZ001234",
  "enni2": "",
  "vlan_reference": "1257",
  "customer_order_name": "john Doe",
  "business_code": "AB123",
  "billing_site_ref": "AUX99",
  "related_contact_information": [...],
  "siret_known": true,
  "additional_vlan_reference": "1258",
  "offer_family": "BPE",
  "offer_technology": "FIBDE",
  "specific_request": "Demande de raccordement spécifique",
  "access_instructions": "Prendre la grande porte",
  "scheduled_delivery_date": "2025-09-21",
  "cpe_network_number": "NET-123456",
  "cpe_serial_number": "SR-123456"
}

Name	Type	Description	Required
end_customer_name	string	End customer name	Yes (during confirmation only)
siret	string	SIRET number	No
contact1_email_address	string	On-site contact email address	Yes (during confirmation only)
contact1_firstname	string	On-site contact firstname	Yes (during confirmation only)
contact1_lastname	string	On-site contact name	Yes (during confirmation only)
contact1_phone_number	string	On-site contact phone number	Yes (during confirmation only)
contact2_email_address	string	Secondary contact email address	No
contact2_firstname	string	Secondary contact firstname	No
contact2_lastname	string	Secondary contact name	No
contact2_phone_number	string	Secondary contact phone number	No
city	string	City	Yes (during confirmation only)
postcode	string	Postal code	Yes (during confirmation only)
street_name	string	Street name	Yes (during confirmation only)
street_number	string	Street number	Yes (during confirmation only)
street_number_extension	string	Street number extension	No
insee_code	string	INSEE code	Yes (during confirmation only)
building_name	string	Building name	No
level_number	string	Level number	No
latitude	number	Address latitude	No
longitude	number	Address longitude	No

Example

"related_contact_information": [
    {
      "end_customer_name": "Covage corp",
      "siret": "00000000000000",
      "contact1_email_address": "John.Doe@unknown.com",
      "contact1_firstname": "John",
      "contact1_lastname": "Doe",
      "contact1_phone_number": "0123456789",
      "contact2_email_address": "Jane.Doe@unknown.com",
      "contact2_firstname": "Jane",
      "contact2_lastname": "Doe",
      "contact2_phone_number": "0987654321",
      "city": "Mont-Saint-Aignan",
      "postcode": "76130",
      "street_name": "Rue Andrei Sakharov",
      "street_number": "4",
      "street_number_extension": "B",
      "insee_code": "76451",
      "building_name": "",
      "level_number": "0",
      "latitude": 49.4744077,
      "longitude": 1.091455
    }]

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
enni_2	string	Secondary ENNI identifier	No
vlan_reference	number	VLAN reference	No
business_code	string	Business code	No
customer_order_name	string	Customer order name	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
temporary_reference	string	Order temporary reference (Depreciated, refer to the order_reference field)	No
building_ref	string	Building reference	No
offer_family	string	Offer family	No
offer_technology	string	Offer technology	No
cpe_networking_number	string	CPE networking number	No
cpe_serial_number	string	CPE serial number	No

Exemple

{
    "end_customer_name": "Covage",
    "external_id": "",
    "option_ids": [],
    "note": "",
    "technical_note": "",
    "product_offering_id": "2173",
    "product_offering_qualification_item_id": "d5a4a9aa-ba2c-4f53-95c7-0c1ce6f6e7fa",
    "project_id": "",
    "quote_item_id": "",
    "delivery_mode": "",
    "enni": "",
    "enni2": "",
    "vlan_reference": 1257,
    "customer_order_name": "john Doe",
    "business_code": "",
    "billing_site_ref": "AUX00",
    "related_contact_information": [
        {
            "end_customer_name": "Covage corp",
            "siret": "00000000000000",
            "contact1_email_address": "John.Doe@unknown.com",
            "contact1_firstname": "John",
            "contact1_lastname": "Doe",
            "contact1_phone_number": "0123456789",
            "contact2_email_address": "Jane.Doe@unknown.com",
            "contact2_firstname": "Jane",
            "contact2_lastname": "Doe",
            "contact2_phone_number": "0987654321",
            "city": "Mont-Saint-Aignan",
            "postcode": "76130",
            "street_name": "Rue Andrei Sakharov",
            "street_number": "4",
            "street_number_extension": "B",
            "insee_code": "76451",
            "building_name": "",
            "level_number": "0",
            "latitude": 49.4744077,
            "longitude": 1.091455
        }
    ],
    "id": "259a1c5b-8462-4c5e-90d0-90d135763378",
    "product_order_id": "908d2cc0-4bdc-4f62-b812-f8c1f48c96cd",
    "cancellation_date": null,
    "cancellation_reason": "",
    "completion_date": null,
    "order_date": null,
    "state": "created",
    "state_change": [
        {
            "change_reason": "",
            "change_date": "2025-04-23T10:13:08.733+02:00",
            "state": "created"
        }
    ],
    "termination_error": [],
    "order_reference": "PO_DC173_20250423_003363",
    "temporary_reference": "PO_DC173_20250423_003363",
    "building_ref": "",
    "offer_family": "BPE",
    "offer_technology": "FIBDE",
    "cpe_network_number": "NET-123456",
    "cpe_serial_number": "SR-123456"
}

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_firstname	string	On-site contact firstname	No
contact1_lastname	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_firstname	string	Secondary contact firstname	No
contact2_lastname	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

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

Exemple

"termination_error": [
    {
    "code":"string",
    "property_path":"string",
    "value":"string"
    }
]

Updating Order Line Information

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	Yes (during confirmation only*)
enni_2	string	Secondary ENNI identifier	No
vlan_reference	number	VLAN reference	No
customer_order_name	string	Customer order name	No
business_code	string	Business code	No
billing_site_ref	string	Billing site reference	No
related_contact_information	array	Related contact information	Yes (during confirmation only)
siret_known	boolean	Should the SIRET be filled ?	No
additional_vlan_reference	string	Additional VLAN reference	No
specific_request	string	Specific request	No
access_instructions	string	Access instructions given by the customer	No
scheduled_delivery_date	date	Scheduled delivery date	No
cpe_networking_number	string	CPE networking number	No
cpe_serial_number	string	CPE serial number	No

Exemple

{
  "product_offering_id": "b99fce70-d195-41ed-b029-9b75c62ecd7c",
  "product_offering_qualification_item_id": "1b83a456-89a2-456e-9b78-a578c39b0474",
  "end_customer_name": "Covage corp edited",
  "external_id": "99999",
  "option_ids": [],
  "note": "you can add any information here",
  "technical_note": "you can add any technical information here",
  "project_id": "56789",
  "quote_item_id": "c0b5c9ab-c206-4858-8957-3befa6cbe58a",
  "delivery_mode": "string",
  "enni": "string",
  "enni2": "string",
  "vlan_reference": "1234",
  "customer_order_name": "John Doe",
  "business_code": "FLASH",
  "related_contact_information": [...],
  "siret_known": true,
  "specific_request": "Demande de raccordement spécifique",
  "cpe_network_number": "NET-123456",
  "cpe_serial_number": "SR-123456"
}

Name	Type	Description	Required
end_customer_name	string	End customer name	Yes (during confirmation only)
siret	string	SIRET number	No
contact1_email_address	string	On-site contact email address	Yes (during confirmation only)
contact1_firstname	string	On-site contact firstname	Yes (during confirmation only)
contact1_lastname	string	On-site contact name	Yes (during confirmation only)
contact1_phone_number	string	On-site contact phone number	Yes (during confirmation only)
contact2_email_address	string	Secondary contact email address	No
contact2_firstname	string	Secondary contact firstname	No
contact2_lastname	string	Secondary contact name	No
contact2_phone_number	string	Secondary contact phone number	No
city	string	City	Yes (during confirmation only)
postcode	string	Postal code	Yes (during confirmation only)
street_name	string	Street name	Yes (during confirmation only)
street_number	string	Street number	Yes (during confirmation only)
street_number_extension	string	Street number extension	No
insee_code	string	INSEE code	Yes (during confirmation only)
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
enni_2	string	Seconday 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
temporary_reference	string	Order line temporary reference (Depreciated, refer to the order_reference field)	No
building_ref	string	Building reference	No
cpe_networking_number	string	CPE networking number	No
cpe_serial_number	string	CPE serial number	No

Exemple

{
    "end_customer_name": "Covage",
    "external_id": "",
    "option_ids": [],
    "note": "",
    "technical_note": "",
    "product_offering_id": "2173",
    "product_offering_qualification_item_id": "1b83a456-89a2-456e-9b78-a578c39b0474",
    "project_id": "",
    "quote_item_id": "",
    "delivery_mode": "",
    "enni": "",
    "enni2": "",
    "vlan_reference": 1257,
    "customer_order_name": "john Doe",
    "business_code": "",
    "billing_site_ref": "",
    "related_contact_information": [...],
    "id": "764a778c-4b16-4502-8377-e817b93d5b08",
    "product_order_id": "2144c9f2-6ac1-49fd-8a7d-905def231857",
    "cancellation_date": null,
    "cancellation_reason": "",
    "completion_date": null,
    "order_date": null,
    "state": "created",
    "state_change": [...],
    "termination_error": [],
    "order_reference": "PO_DG541_20250404_000001",
    "temporary_reference": "PO_DG541_20250404_000001",
    "building_ref": "",
    "cpe_network_number": "NET-123456",
    "cpe_serial_number": "SR-123456"
}

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_firstname	string	On-site contact firstname	No
contact1_lastname	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_firstname	string	Secondary contact firstname	No
contact2_lastname	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

Exemple

    {
        "end_customer_name": "Covage corp",
        "siret": "00000000000000",
        "contact1_email_address": "John.Doe@unknown.com",
        "contact1_firstname": "John",
        "contact1_lastname": "Doe",
        "contact1_phone_number": "0123456789",
        "contact2_email_address": "Jane.Doe@unknown.com",
        "contact2_firstname": "Jane",
        "contact2_lastname": "Doe",
        "contact2_phone_number": "0987654321",
        "city": "Mont-Saint-Aignan",
        "postcode": "76130",
        "street_name": "Rue Andrei Sakharov",
        "street_number": "4",
        "street_number_extension": "B",
        "insee_code": "76451",
        "building_name": "",
        "level_number": "0",
        "latitude": 49.4744077,
        "longitude": 1.091455
    }

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

Exemple

    {
        "change_reason": "",
        "change_date": "2025-04-04T11:30:47.475+02:00",
        "state": "created"
    }

Termination Error Details

Name	Type	Description	Required
code	string	Error code	Yes
property_path	string	Concerned property path	Yes
value	string	Associated value	Yes

Deleting order line

This endpoint allows you to delete an order line from an order session.

DELETE /api/v1/product_order/{product_order_id}/product_order_item/{item_id}/

Request Field Parameters

Name	Type	Description	Required
product_order_id	string	Order Session Identifier	Yes
item_id	string	Offer Qualification Item Identifier	Yes

Response

Name	Type	Description	Required
external_id	string	Request's external identifier	No
project_id	string	Related project's identifier	No
id	string	Order identifier	Yes
product_order_item	array	List of order items	Yes

Example

{
    "external_id": "444555666777",
    "project_id": "",
    "id": "f12c54b3-881b-48e0-9c96-fea9b2597967",
    "product_order_item": []
}

List of order lines

GET /api/v1/product_order_item/

Lists order lines (across all order sessions) with advanced filtering.

Available filters (query params):

Parameter	Type	Description
`state`	string	Filter by line state
`order_reference`	string	Filter by order reference (X3)
`temporary_reference`	string	Filter by temporary reference
`customer_order_name`	string	Filter by customer order name
`end_customer_name`	string	Filter by end customer name
`creation_date_gt`	datetime	Lines created after this date (ISO 8601)
`creation_date_lt`	datetime	Lines created before this date (ISO 8601)
`order_date_gt`	datetime	Lines ordered after this date (ISO 8601)
`order_date_lt`	datetime	Lines ordered before this date (ISO 8601)
`expiration_date_gt`	datetime	Lines expiring after this date (ISO 8601)
`expiration_date_lt`	datetime	Lines expiring before this date (ISO 8601)
`search`	string	Free-text search
`sort`	string	Sort field

Response: Paginated list of order lines.

Field	Type	Description
`id`	UUID	Line identifier
`product_order_id`	UUID	Parent session identifier
`end_customer_name`	string	End customer name
`external_id`	string	External identifier
`product_offering_id`	string	Selected offer identifier
`product_offering_qualification_item_id`	UUID	Associated eligibility item identifier
`state`	string	Current line state
`order_reference`	string	Order reference (set after confirmation)
`temporary_reference`	string	Temporary reference (before confirmation)
`customer_order_name`	string	Customer order name
`creation_date`	datetime	Creation date (ISO 8601)
`order_date`	datetime	Order date (ISO 8601)
`expiration_date`	string	Draft expiration date (D+90 from creation)
`scheduled_delivery_date`	date	Requested delivery date

Order line detail

GET /api/v1/product_order_item/{item_id}/

Retrieves the full detail of an order line.

URL parameter:

Name	Type	Required	Description
`item_id`	UUID	✅	Order line identifier

Response: Full ProductOrderItemSchema object (all creation fields + read-only fields: id, state, order_reference, temporary_reference, cancellation_date, cancellation_reason, completion_date, order_date, state_change, termination_error).

Confirming the Order Session

Confirming the order session starts the creation of the orders from the order lines stored within the order session.

The cpe_networking_number and cpe_serial_number fields are required if option 7021 is present in option_ids, otherwise they must be empty.

It's then possible to follow the state of those newly created order (except the ones with status rejected_creation) with the Order Tracking API.

PATCH /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

Exemple

{
    "external_id": "777888999",
    "project_id": "",
    "id": "908d2cc0-4bdc-4f62-b812-f8c1f48c96cd",
    "product_order_item": [
        {
            "end_customer_name": "Covage",
            "external_id": "",
            "option_ids": [
                "2210",
                "2220",
                "1615"
            ],
            "cpe_network_number": "NET-123456",
            "cpe_serial_number": "SR-123456",
            "note": "",
            "technical_note": "",
            "product_offering_id": "2173",
            "product_offering_qualification_item_id": "d5a4a9aa-ba2c-4f53-95c7-0c1ce6f6e7fa",
            "project_id": "",
            "quote_item_id": "",
            "delivery_mode": "",
            "enni": "",
            "enni2": "",
            "vlan_reference": 1257,
            "customer_order_name": "john Doe",
            "business_code": "",
            "billing_site_ref": "AUX00",
            "related_contact_information": [
                {
                    "end_customer_name": "Covage corp",
                    "siret": "00000000000000",
                    "contact1_email_address": "John.Doe@unknown.com",
                    "contact1_firstname": "John",
                    "contact1_lastname": "Doe",
                    "contact1_phone_number": "0123456789",
                    "contact2_email_address": "Jane.Doe@unknown.com",
                    "contact2_firstname": "Jane",
                    "contact2_lastname": "Doe",
                    "contact2_phone_number": "0987654321",
                    "city": "Mont-Saint-Aignan",
                    "postcode": "76130",
                    "street_name": "Rue Andrei Sakharov",
                    "street_number": "4",
                    "street_number_extension": "B",
                    "insee_code": "76451",
                    "building_name": "",
                    "level_number": "0",
                    "latitude": 49.4744077,
                    "longitude": 1.091455
                }
            ],
            "id": "259a1c5b-8462-4c5e-90d0-90d135763378",
            "product_order_id": "908d2cc0-4bdc-4f62-b812-f8c1f48c96cd",
            "cancellation_date": null,
            "cancellation_reason": "",
            "completion_date": null,
            "order_date": null,
            "state": "in_progress",
            "state_change": [
                {
                    "change_reason": "",
                    "change_date": "2025-04-23T10:13:08.733+02:00",
                    "state": "created"
                },
                {
                    "change_reason": "",
                    "change_date": "2025-04-23T10:24:57.225+02:00",
                    "state": "in_progress"
                }
            ],
            "termination_error": [],
            "order_reference": "PO_DC173_20250423_003363",
            "temporary_reference": "PO_DC173_20250423_003363",
            "building_ref": ""
        }
    ]
}

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
enni_2	string	Seconday 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
temporary_reference	string	Order's temporary reference (Depreciated, refer to the order_reference field)	No
building_ref	string	Building reference	No
cpe_networking_number	string	CPE networking number	No
cpe_serial_number	string	CPE serial number	No

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_firstname	string	On-site contact firstname	Yes
contact1_lastname	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_firstname	string	Secondary contact firstname	No
contact2_lastname	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

Quotation (Quote)

The quotation process allows you to obtain quotes for fibre offers before converting them into firm orders.

Quotation lifecycle

stateDiagram-v2 [*] --> created created --> confirmed confirmed --> [*]

State	Description
`created`	Quote cart created, pending completion
`confirmed`	Quote confirmed

Creating a quote cart

POST /api/v1/quote/

Creates a new quote cart.

Request body:

Field	Type	Required	Description
`external_id`	string	❌	External identifier
`project_id`	string	❌	Associated project ID

Response:

Field	Type	Description
`id`	UUID	Quote cart identifier
`external_id`	string	External identifier
`project_id`	string	Associated project identifier
`state`	string	Current state (`created`, `confirmed`)
`quote_date`	datetime	Quotation date (ISO 8601)
`creation_date`	datetime	Creation date (ISO 8601)

List of quote carts

GET /api/v1/quote/

Lists or filters quote carts.

Available filters (query params):

Parameter	Type	Description
`state`	string	Filter by state
`external_id`	string	Filter by external identifier
`project_id`	string	Filter by project identifier
`creation_date_gt`	datetime	Carts created after this date (ISO 8601)
`creation_date_lt`	datetime	Carts created before this date (ISO 8601)
`quote_date_gt`	datetime	Carts quoted after this date (ISO 8601)
`quote_date_lt`	datetime	Carts quoted before this date (ISO 8601)

Response: List of carts (same fields as creation response).

Quote cart detail

GET /api/v1/quote/{id}/

Retrieves the details of a quote cart, including all its quote lines.

URL parameter:

Name	Type	Required	Description
`id`	UUID	✅	Quote cart identifier

Response:

Field	Type	Description
`id`	UUID	Unique identifier
`external_id`	string	External identifier
`project_id`	string	Associated project identifier
`state`	string	Current state
`quote_item`	array	List of quote lines

Update a quote cart

PATCH /api/v1/quote/{id}/

Updates the metadata of a quote cart.

URL parameter:

Name	Type	Required	Description
`id`	UUID	✅	Quote cart identifier

Request body:

Field	Type	Required	Description
`external_id`	string	❌	External identifier
`project_id`	string	❌	Associated project identifier

Response: Updated cart detail.

Confirm a quote cart

PATCH /api/v1/quote/{id}/confirm/

Confirms a quote cart. No request body required.

URL parameter:

Name	Type	Required	Description
`id`	UUID	✅	Quote cart identifier

Response: 204 No Content

Add a quote line

POST /api/v1/quote/{quote_id}/quote_item/

Adds a quote line to a cart.

URL parameter:

Name	Type	Required	Description
`quote_id`	UUID	✅	Quote cart identifier

Request body:

Field	Type	Required	Description
`product_offering_qualification_item_id`	UUID	✅	Associated eligibility item identifier
`product_offerings`	array	❌	Desired offers (max 4 per line)
`end_customer_name`	string	❌	End customer name
`external_id`	string	❌	External identifier
`site_connection_type`	string	❌	Site connection type
`business_sector`	string	❌	Business sector
`expected_response_date`	date	❌	Desired response date
`option_ids`	array	❌	List of options to add
`note`	string	❌	Free-text note
`technical_note`	string	❌	Technical note
`project_id`	string	❌	Associated project identifier
`customer_order_name`	string	❌	Customer order name
`business_code`	string	❌	Business code
`related_contact_information`	array	❌	Associated contacts (max 2)

Response:

Field	Type	Description
`id`	UUID	Quote line identifier
`state`	string	Quote line state
`reference`	string	Quote line reference
`quote_date`	datetime	Quotation date (ISO 8601)

Update a quote line

PATCH /api/v1/quote/{quote_id}/quote_item/{quote_item_id}/

Updates an existing quote line.

URL parameters:

Name	Type	Required	Description
`quote_id`	UUID	✅	Quote cart identifier
`quote_item_id`	UUID	✅	Quote line identifier

Request body: Same fields as creation (all optional).

Response: Updated cart detail.

Delete a quote line

DELETE /api/v1/quote/{quote_id}/quote_item/{quote_item_id}/

Deletes a quote line from a cart.

URL parameters:

Name	Type	Required	Description
`quote_id`	UUID	✅	Quote cart identifier
`quote_item_id`	UUID	✅	Quote line identifier

Response: Updated cart detail.

List of quote lines

GET /api/v1/quote_item/

Lists or filters quote lines (across all carts).

Available filters (query params):

Parameter	Type	Description
`reference`	string	Filter by line reference
`customer_order_name`	string	Filter by customer order name
`end_customer_name`	string	Filter by end customer name
`business_sector`	string	Filter by business sector
`project_id`	string	Filter by project identifier
`state`	string	Filter by state
`offer_family`	string	Filter by offer family
`technology_family`	string	Filter by technology family
`creation_date_gt`	datetime	Lines created after this date (ISO 8601)
`creation_date_lt`	datetime	Lines created before this date (ISO 8601)
`search`	string	Free-text search
`sort`	string	Sort field

Response: Paginated list of quote lines (QuoteItemListSchema).

Field	Type	Description
`id`	UUID	Line identifier
`end_customer_name`	string	End customer name
`external_id`	string	External identifier
`reference`	string	Line reference
`state`	string	Current state
`site_connection_type`	string	Site connection type
`business_sector`	string	Business sector
`product_offerings`	array	Requested offers
`product_offering_qualification_item_id`	UUID	Associated eligibility item identifier
`address`	object	Site address
`latitude`	float	Site latitude
`longitude`	float	Site longitude
`creation_date`	datetime	Creation date (ISO 8601)
`order_date`	datetime	Quotation date (ISO 8601)
`expected_response_date`	date	Requested response date

Quote line detail

GET /api/v1/quote_item/{id}/

Retrieves the full detail of a quote line.

URL parameter:

Name	Type	Required	Description
`id`	UUID	✅	Quote line identifier

Response: Full QuoteItemSchema object (all list fields + note, technical_note, option_ids, business_code).

Order Taking

Operation

Lifecycle of an order session

Lifecycle of an order line

Creating an Order Session

Request Field Parameters

Example

Response

Example

List of order sessions

Order session detail

Update an order session

Delete an order session

Creating an Order Line

Request Field Parameters

Special case of the enni field for the DIA offer

Example

Related Contact Information Details

Example

Response

Exemple

Related Contact Information Details

State Change Details

Termination Error Details

Exemple

Updating Order Line Information

Request Field Parameters

Exemple

Related Contact Information Details

Response

Exemple

Related Contact Information Details

Exemple

State Change Details

Exemple

Termination Error Details

Deleting order line

Request Field Parameters

Response

Example

List of order lines

Order line detail

Confirming the Order Session

Response

Exemple

Order Item Details

Related Contact Information Details

State Change Details

Termination Error Details

Quotation (Quote)

Quotation lifecycle

Creating a quote cart

List of quote carts

Quote cart detail

Update a quote cart

Confirm a quote cart

Add a quote line

Update a quote line

Delete a quote line

List of quote lines

Quote line detail