Order Status (action=status)

3. Order status – action=status

Description:
Returns order status for a single order or multiple orders.

3.1 Single order status

Parameters
  • key (required)
  • action (required) = status
  • order (required): API order ID returned by add (not the internal database id).
Example request
key=YOUR_API_KEY
action=status
order=23501
Example response
{
  "charge": "0.00",
  "start_count": "3572",
  "status": "Partial",
  "remains": "157",
  "currency": "USD"
}
Status values
  • Pending
  • In progress
  • Completed
  • Partial
  • Canceled

3.2 Multiple orders status

Parameters
  • key (required)
  • action (required) = status
  • orders (required): Comma-separated API order IDs (up to 100).
Example request
key=YOUR_API_KEY
action=status
orders=1,10,100
Example response
{
  "1": {
    "charge": "0.27819",
    "start_count": "3572",
    "status": "Partial",
    "remains": "157",
    "currency": "USD"
  },
  "10": {
    "error": "Incorrect order ID"
  },
  "100": {
    "charge": "1.44219",
    "start_count": "234",
    "status": "In progress",
    "remains": "10",
    "currency": "USD"
  }
}