Provision
Name | Type | Description | Restrictions |
---|---|---|---|
stock | object array | An array of stock corresponding to the SIMs you wish to update | At least one |
provisioningOrderNumber | number | The id of the Provisioning Order to use | Required |
tariffNumber | number | The id of the Tariff to use | Required |
boltOns | number array | The id of the Boltons to use | |
createNewProvisioningOrder | bool | Should a new Provisioning Order be created? | |
newProvisioningOrderName | string | Name of new Provisioning Order | Required if createNewProvisioningOrder = true |
provisioningOrderNumber | number | Id of the Provisioning Order to use | Required if createNewProvisioningOrder = false |
publicIpGroupId | number | Id of the Public IP Group to use | Required if a Public Ip Group BoltOn is specified |
staticIpGroupId | number | Id of the Static IP Group to use | Required if a Static Ip Group BoltOn is specified |
purchaseOrderNumber | string | Comma separated values for Order 1, Order 2, etc | Maximum 5 values and 100 characters total |
Stock
Name | Type | Description | Restrictions |
---|---|---|---|
serialNumber | string | The serial number of the sim | Required |
msisdn | string | The msisdn to assign | Only provide this when the sim does not already have an MSISDN |
Request (New Provisioning Order)
curl --location 'https://api.cellhire.com/api/simSubmission/Provision' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjRBMDlENTFBMDhEOEUxMTU0OTkyODFDN...' \
--data '{
"stock": [
{
"serialNumber": "89441000303198729483",
"msisdn": "07000000000"
}
],
"purchaseOrderNumber": "string",
"tariffNumber": 100001,
"boltOns": [
500032,
500051
],
"createNewProvisioningOrder": true,
"newProvisioningOrderName": "Test Order",
}
Request (Existing Provisioning Order)
curl --location 'https://api.cellhire.com/api/simSubmission/Provision' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjRBMDlENTFBMDhEOEUxMTU0OTkyODFDN...' \
--data '{
"stock": [
{
"serialNumber": "89441000303198729483",
"msisdn": "07000000000"
}
],
"purchaseOrderNumber": "string",
"tariffNumber": 100001,
"boltOns": [
500032,
500051
],
"provisioningOrderNumber": 12345,
}
Additional commands needed for provisioning can be found on on the Provision Extras page.