Order & Installation
All operations require authentication.
Move an xDSL pack to another addressProduction
Move an xDSL pack to another address. Starts the move to the new address with the chosen offer, modem, installation details and services to keep or delete. Returns an asynchronous task.
Path parameters
The internal name of your pack
Request body (required)
You explicitly accept the terms of the contract corresponding to your new offer
Building identifier, "null" if no identifier is available
Building reference for FTTH and FTTE offers
Customer contact phone number
Door identifier, "null" if no identifier is available
Eligibility reference
Number of months of re-engagement
Floor identifier, "null" if no identifier is available
Installation type, only on FTTH technology
activateactivate_undefinedcreatemultiOtpWhether or not the current number should be kept
Data to book a meeting slot
Modem option chosen for the new offer
norecycledyesMondial relay ID if a shipping is needed
The date when the customer is no longer at the current address. Must be between now and +30 days. The default date will be the one in 30 days from now.
nicShipping if a shipping is needed
Reference of the new offer
Allows you to personalize a delivery address for the ONT. If empty, the address will be that of the installation
Options wanted in the new offer
Whether an Optical Termination Point (OTP) is already installed at the address
Reference of the Optical Termination Point
Product code, an unique identifier for the product from addressMove/offer
Residence identifier, "null" if no identifier is available
Stair identifier, "null" if no identifier is available
List of domains of services to delete if needed
List of domains of services to keep if needed
Response
Error
Status of the call
errorokpendingExample uses packName = string
$ curl https:/{ "error": "string", "result": 0, "status": "error"}
Search the address move offers of an xDSL packProduction
Search the address move offers of an xDSL pack. Returns, as an asynchronous task, the offers available at the new address for the given eligibility reference.
Path parameters
The internal name of your pack
Request body (required)
Eligibility reference
Response
Error
List of available Move address offer
Status of the call
errorokpendingExample uses packName = string
$ curl https:/{ "error": "string", "result": { "offers": [ { "contracts": [ { "content": "string", "name": "string", "url": "string" } ], "customOntAddress": true, "description": "string", "engageMonths": 0, "engaged": true, "modemOptions": [ { "name": "string", "price": { "currencyCode": null, "text": null, "value": null } } ], "modemReferenceToReturn": "string", "needModem": true, "needNewModem": true, "offerName": "string", "operator": "string", "options": [ { "duration": 0, "included": 0, "name": "string", "optional": 0, "optionalPrice": { "currencyCode": null, "text": null, "value": null } } ], "prices": { "creationLineFees": { "description": "string", "price": { "currencyCode": null, "text": null, "value": null } }, "currentOfferPrice": { "description": "string", "price": { "currencyCode": null, "text": null, "value": null } }, "due": { "description": "string", "price": { "currencyCode": null, "text": null, "value": null } }, "firstYearPromo": { "description": "string", "price": { "currencyCode": null, "text": null, "value": null } }, "gtrComfortFees": { "description": "string", "price": { "currencyCode": null, "text": null, "value": null } }, "installFees": { "description": "string", "price": { "currencyCode": null, "text": null, "value": null } }, "modemRental": { "description": "string", "price": { "currencyCode": null, "text": null, "value": null } }, "price": { "description": "string", "price": { "currencyCode": null, "text": null, "value": null } }, "promotion": { "endDate": "2024-01-01T12:00:00Z", "id": "string", "installFee": { "discount": null, "duration": null }, "startDate": "2024-01-01T12:00:00Z", "subscription": { "discount": null, "duration": null } }, "providerAI": { "description": "string", "price": { "currencyCode": null, "text": null, "value": null } }, "providerOrange": { "description": "string", "price": { "currencyCode": null, "text": null, "value": null } } }, "productCodes": [ "string" ], "subServicesToDelete": [ { "numberToDelete": 0, "services": [ null ], "type": "domain" } ], "url": "string" } ] }, "status": "error"}
List the services to delete to move an xDSL packProduction
List the services to delete to move an xDSL pack. Returns, by service type, the number of services to delete and their unpack terms for the offer at the new address.
Path parameters
The internal name of your pack
Request body (required)
Eligibility reference
Reference of the new offer
Options wanted in the new offer
Response
Number of services to be deleted
List of domains of sub services with unpack terms
Type of service to be deleted
domainemailProexchangeAccountexchangeIndividualexchangeOrganizationgrt10hogrt20m10hogrt20m4hogrt4hogrt5m10hogrt5m4hogrtAltgrtDspgrtFtgrtKoscgrtOvhhostedEmailmodemoverTheBoxHardwareoverTheBoxServicevoipAliasvoipBillingAccountvoipEcoFaxvoipLinevoipTrunkxdslAccessExample uses packName = string
$ curl https:/[ { "numberToDelete": 0, "services": [ { "isAllowed": true, "price": { "currencyCode": "AUD", "text": "string", "value": 0 }, "renewPeriod": 0, "renewPrice": { "currencyCode": "AUD", "text": "string", "value": 0 }, "service": "string" } ], "type": "domain" }]
Migrate an xDSL pack to another offerProduction
Migrate an xDSL pack to another offer. Starts the migration to the selected offer with its options, modem, installation details and services to keep or delete. Returns the task that performs it.
Path parameters
The internal name of your pack
Request body (required)
You explicitly accept the terms of the contract corresponding to your new offer
Building reference for FTTH and FTTE offers
Customer contact phone number
Number of months of re-engagement
Floor identifier, "NA" if no identifier is available
Installation type, only on FTTH technology
activateactivate_undefinedcreatemultiOtpData to book a meeting slot
Modem option chosen for the new offer
norecycledyesMondial relay ID if a shipping is needed
nicShipping if a shipping is needed
Reference of the new offer
Allows you to personalize a delivery address for the ONT. If empty, the address will be that of the installation
Options wanted in the new offer
Whether an Optical Termination Point (OTP) is already installed at the address
Reference of the Optical Termination Point
Product code, an unique identifier to designate the chosen offer
Stair identifier, "NA" if no identifier is available
List of domains of services to delete if needed
List of domains of services to keep if needed
Response
Status of a task.
cancelleddoingdoneerrorproblemtodoExample uses packName = string
$ curl https:/{ "function": "string", "id": 0, "status": "cancelled", "updateDate": "2024-01-01T12:00:00Z"}
Search the migration offers of an xDSL packProduction
Search the migration offers of an xDSL pack. Returns, as an asynchronous task, the offers the pack can migrate to and, for fiber, the buildings to choose from.
Path parameters
The internal name of your pack
Request body (required)
Building reference for FTTH and FTTE offers
Response
Error
List of available Migration offer
Status of the call
errorokpendingExample uses packName = string
$ curl https:/{ "error": "string", "result": { "buildings": [ { "name": "string", "nro": "string", "reference": "string", "stairs": [ { "floors": [ null ], "stair": "string" } ], "type": "BUILDING" } ], "offers": [ { "contractList": [ "string" ], "contracts": [ { "content": "string", "name": "string", "url": "string" } ], "currentOfferPrice": { "currencyCode": "AUD", "text": "string", "value": 0 }, "customOntAddress": true, "description": "string", "due": { "currencyCode": "AUD", "text": "string", "value": 0 }, "engageMonths": 0, "engaged": true, "engagementMonths": [ 0 ], "firstYearPromo": { "currencyCode": "AUD", "text": "string", "value": 0 }, "gtrComfortFees": { "currencyCode": "AUD", "text": "string", "value": 0 }, "installFees": { "currencyCode": "AUD", "text": "string", "value": 0 }, "modemMacToReturn": "string", "modemOptions": [ { "name": "string", "price": { "currencyCode": null, "text": null, "value": null } } ], "modemRental": { "currencyCode": "AUD", "text": "string", "value": 0 }, "multiOtp": true, "needModem": true, "needNewModem": true, "offerName": "string", "operator": "string", "options": [ { "duration": 0, "included": 0, "name": "string", "optional": 0, "optionalPrice": { "currencyCode": null, "text": null, "value": null } } ], "price": { "currencyCode": "AUD", "text": "string", "value": 0 }, "promotion": { "endDate": "2024-01-01T12:00:00Z", "id": "string", "installFee": { "discount": { "currencyCode": null, "text": null, "value": null }, "duration": "string" }, "startDate": "2024-01-01T12:00:00Z", "subscription": { "discount": { "currencyCode": null, "text": null, "value": null }, "duration": "string" } }, "providerAI": { "currencyCode": "AUD", "text": "string", "value": 0 }, "providerOrange": { "currencyCode": "AUD", "text": "string", "value": 0 }, "subServicesToDelete": [ { "numberToDelete": 0, "services": [ null ], "type": "domain" } ], "url": "string" } ] }, "status": "error"}
List the services to delete to migrate an xDSL packProduction
List the services to delete to migrate an xDSL pack. Returns, by service type, the number of services to delete and their unpack terms for the target offer.
Path parameters
The internal name of your pack
Request body (required)
Reference of the new offer
Options wanted in the new offer
Response
Number of services to be deleted
List of domains of sub services with unpack terms
Type of service to be deleted
domainemailProexchangeAccountexchangeIndividualexchangeOrganizationgrt10hogrt20m10hogrt20m4hogrt4hogrt5m10hogrt5m4hogrtAltgrtDspgrtFtgrtKoscgrtOvhhostedEmailmodemoverTheBoxHardwareoverTheBoxServicevoipAliasvoipBillingAccountvoipEcoFaxvoipLinevoipTrunkxdslAccessExample uses packName = string
$ curl https:/[ { "numberToDelete": 0, "services": [ { "isAllowed": true, "price": { "currencyCode": "AUD", "text": "string", "value": 0 }, "renewPeriod": 0, "renewPrice": { "currencyCode": "AUD", "text": "string", "value": 0 }, "service": "string" } ], "type": "domain" }]
Get the order follow-up of an xDSL packProduction
Get the order follow-up of an xDSL pack. Returns the steps of the pack order with their status, expected duration, completion date and comments.
Path parameters
The internal name of your pack
Response
Additional information about the step
Date when the step has been done
Unit used for the expected duration step
Expected duration step
Order follow up step name
Status of the step
Example uses packName = string
$ curl https:/[ { "comments": [ "string" ], "doneDate": "2024-01-01T12:00:00Z", "durationUnit": "string", "expectedDuration": 0, "name": "string", "status": "string" }]