Home > misc-functions > func.telecoms.cart.delete
function telecoms.cart.delete

See also:

This function deletes a cart instance. Any phone numbers that were in the cart will have their reservations removed and will immediately go back into the available pool for others to buy.

Arguments:

argrequired?syntaxinfo
cartIDYposintthe cartID of the cart instance; see telecoms.cart.list to get a list of all cartIDs

JSON example request:

POST https://live.apicontrol.co.uk/1/json
{
    "auth" : {
        "username" : "YOURUSERNAME",
        "password" : "YOURPASSWORD",
    },
   "func" : "telecoms.cart.delete",
   "args" : {
      "cartID" : 1838776
   }
}

The response indicates three curently valid carts. Their cartID as well as TTL (in seconds) are returned.

JSON example response:

{                                                                                                   
   "success" : 1,                                                                                   
   "results" : {}                                                                                   
}

Arguments for suppliers using a master account

argrequired?syntaxinfo
custIDNposintthe custID who owns the cart if it is not a cart within your own account

Further argument information

custID

If using a master account, uset his argument to specify the custID of the account that owns the cart instaince being deleted.