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

See also:

This function by default fetches a list of current valid cart instances in your account. Unless you are working with sub-accounts using a master account, it takes no arguments.

JSON example request:

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

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

JSON example response:

{
   "results" : {
      "more_rows" : 0,
      "data" : [
         {
            "billcomp" : "barritel",
            "cartID" : 1838764,
            "TTL" : 247
         },
         {
            "billcomp" : "barritel",
            "cartID" : 1838768,
            "TTL" : 512
         },
         {
            "TTL" : 677,
            "cartID" : 1838770,
            "billcomp" : "barritel"
         }
      ]
   },
   "success" : 1
}

Arguments for suppliers using a master account

argrequired?syntaxinfo
supplier_custIDNposintthe custID of your supplier account; supply this to view all current carts of all of your customer sub-accounts
custIDNposintthe custID who owns the cart; defaults to the account of your own API logins (unless supplier_custID is specified)

Further argument information

supplier_custID

If you supply this argument then it should be your own account's custID (see whoami). This function will then list carts owned by all of your customers' sub-accounts.

custID

If you want to use your master account to view the carts in a specific sub-account, specify the custID of that sub-account here.