Update status of items in pending queue

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

SecurityBasicAuth

Request

query Parameters

order_item_id required	string 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. Examples: Multiple IDs. order_item_id=order_item_id-1=12345&order_item_id-2=12346&order_item_id-3=12347 Multiple IDs alternative. order_item_id=order_item_id=12345&order_item_id=12346&order_item_id=12347 A single ID. order_item_id=12345
provider required	string The cPanel Market provider's name. Example: provider=cPStore
status required	string The new status of the item in the cPanel Market pending queue. `confirmed` — The system confirmed payment for the item with the provider. Value: "confirmed" Example: status=confirmed

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/Market/set_status_of_pending_queue_items

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  Market \
  set_status_of_pending_queue_items \
  provider='cPStore' \
  order_item_id='12345' \
  status='confirmed'

Response samples

application/json

{"apiversion": 3,
"func": "set_status_of_pending_queue_items",
"module": "Market",
"result": {"data": {"error_type": "EntryDoesNotExist",
"order_item_ids": [8675309
]
},
"errors": ["The order item ID “8675309” does not match any entries in the pending queue."
],
"messages": null,
"metadata": { },
"status": 0,
"warnings": null
}
}