Retrieve a list of all Orders

Follow

URL Query Parameters

  • customer_id - The Customers unique ID
  • page - The current page (default: 1)
  • payment_status_id - The payment status, by ID
  • order_status_id - The order status by ID
  • limit - Amount of results per page (default: 20)

Optional Search URL Query Parameters

  • action - Set this to "search" to trigger an order search
  • keyword - This should be the Order ID
  • lastname - Optional lastname parameter
  • postcode - Optional postcode parameter

Possible Order Status IDs

  • 1 - Pending
  • 2 - Security Checks
  • 3 - Payment processing
  • 4 - Order processing
  • 5 - Awaiting Stock
  • 6 - Part Shipped
  • 7 - Despatched
  • 8 - Cancelled
  • 9 - Check Payment
  • 10 - Stock Check
  • 11 - Queued for Payment
  • 12 - Paid / Complete

Possible Payment Status IDs

  • 1 - Pending
  • 2 - Complete
  • 3 - Declined
  • 4 - Address Mis-match
  • 5 - Security Code Incorrect
  • 6 - No Data Matches
  • 7 - Credit Account
  • 8 - Payment Check
  • 9 - Payment Processor Error

Call

GET /rest/orders.json?page=2

Usage Examples

GET /rest/orders.json?page=2
GET /rest/orders.json?page=2&limit=10&payment_status=1&order_status_id=2
Have more questions? Submit a request

Comments

Powered by Zendesk