SIM Management
API Reference
Provision

Provision

NameTypeDescriptionRestrictions
stockobject arrayAn array of stock corresponding to the SIMs you wish to updateAt least one
provisioningOrderNumbernumberThe id of the Provisioning Order to useRequired
tariffNumbernumberThe id of the Tariff to useRequired
boltOnsnumber arrayThe id of the Boltons to use
createNewProvisioningOrderboolShould a new Provisioning Order be created?
newProvisioningOrderNamestringName of new Provisioning OrderRequired if createNewProvisioningOrder = true
provisioningOrderNumbernumberId of the Provisioning Order to useRequired if createNewProvisioningOrder = false
publicIpGroupIdnumberId of the Public IP Group to useRequired if a Public Ip Group BoltOn is specified
staticIpGroupIdnumberId of the Static IP Group to useRequired if a Static Ip Group BoltOn is specified
purchaseOrderNumberstringComma separated values for Order 1, Order 2, etcMaximum 5 values and 100 characters total

Stock

NameTypeDescriptionRestrictions
serialNumberstringThe serial number of the simRequired
msisdnstringThe msisdn to assignOnly 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.