UAPI Functions - Market::set_status_of_pending_queue_items

Description

This function sets the status of an item or items in the cPanel Market pending queue.

Examples


 cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Market/set_status_of_pending_queue_items?provider=cPStore&order_item_id=8675309&status=confirmed

 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
  
// Set the status of 8675309 item in the queue to confirmed status.
$davidbowielives $cpanel->uapi(
    'Market''set_status_of_pending_queue_items',
    array(
        'provider'        => 'cPStore',
        'order_item_id'   => '8675309',
        'status'          => 'confirmed'
    )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Set the status of 8675309 item in the queue to confirmed status
my $davidbowielives $cpliveapi->uapi(
    'Market''set_status_of_pending_queue_items',
    {
        'provider'         => 'cPStore',
        'order_item_id'    => '8675309',
        'status'           => 'confirmed'
    }
);

 cPanel Template Toolkit

<!--  Set the status of 8675309 item in the queue to confirmed status -->
[% execute('Market', 'set_status_of_pending_queue_items', { provider => 'cPStore','order_item_id'=>'8675309','status' => 'confirmed' } ) %]

 Command Line

uapi --user=username Market set_status_of_pending_queue_items provider=cPStore order_item_id=8675309 status=confirmed

 

Notes:

  • You must URI-encode values.
  • username represents your account-level username.

 Output (JSON)

Success:

 

1
2
3
4
5
6
7
{   
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{ 
   }
}

Failure:

 

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
   "data":{ 
      "error_type":"EntryDoesNotExist",
      "order_item_ids":[ 
         8675309,
         5551212
      ]
   },
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{ 
 
   }
}

 

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

  

Parameters

Parameter

Type

Description

Possible values

Example

provider

 string 

Required

The cPanel Market provider's name.

A valid string.

cPStore

 order_item_id 

string

Required

The ID of the ordered item.

Note:

To set the status for multiple items, duplicate or increment the parameter name. For example, to change the status for three certificates, use the order_item_id parameter multiple times or use the order_item_id-1, order_item_id-2, and order_item_id-3 parameters.

A valid string.

8675309

status

string

Required

The new status of the item in the cPanel Market pending queue.

  • confirmed — The system confirmed payment for the item with the provider.

 confirmed 

 

Returns

Note:

The function only returns these values if the user or users do not have the order_item_id item in the cPanel Market pending queue.

Return

 Type 

Description

Possible values

 Example 

error_type

string

The type of error that the function encountered.

Note:

We introduced this return in cPanel & WHM version 56.1.

  • EntryDoesNotExist — The returnedorder_item_ids do not exist in the cPanel Market pending queue for the user. 

cPStore

 order_item_ids 

array

 An array that lists order item IDs which do not exist in the cPanel Market pending queue for the user. 

Note:

We introduced this return in cPanel & WHM version 56.1.

A list of order item IDs.

8675309

 

  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....