Order List

Retrieve a paginated list of ITAD orders for your company.

GET
/api/v1/itad/orders?page=1&limit=10

Description

Returns ITAD orders with optional status and created-at date filters. Pass filters as query parameters. Campaign/recovery buyback orders are excluded.

Request

Headers

HeaderValueRequired
AuthorizationBearer <access_token>Yes
Content-Typeapplication/jsonYes

Query Parameters

ParameterTypeRequiredDescription
pagenumberNoPage number (1-based). Default is 1.
limitnumberNoRecords per page. Default is 10. Max 100 on tickets, wallet, and shipping labels.
statusstringNoFilter by status label (case-insensitive). One of: ORDER RECEIVED, BOX SHIPPED, PICKUP REQUESTED, DEVICE RECEIVED, TECHNICAL ASSESSMENT, ORDER PAYOUT, COMPLETED, CANCELLED.
start_datestringNoInclude orders created on or after this date. Format: YYYY-MM-DD. Query parameter only.
end_datestringNoInclude orders created on or before this date (inclusive through end of day). Format: YYYY-MM-DD. Query parameter only.

Response

FieldTypeDescription
total_ordersnumberTotal matching orders.
total_pagesnumberTotal pages.
current_pagenumberCurrent page.
ordersarrayITAD order objects.
orders[].order_idstringITAD order ID, externally encoded as {7-digit-prefix}-{numericId}. Prefer order_number for Cancel and Detail lookup.
orders[].order_numberstringUnique ITAD order number. Use this for Order Detail and Cancel.
orders[].contactobjectPerson attributed on the order (company default platform user).
orders[].contact.first_namestringContact first name.
orders[].contact.last_namestringContact last name.
orders[].contact.emailstringContact email.
orders[].contact.phonestringContact phone.
orders[].shippingobjectShip-from / recovery address.
orders[].shipping.emailstringShipping email.
orders[].shipping.namestringShipping name.
orders[].shipping.phonestringShipping phone.
orders[].shipping.aptstringApartment / suite.
orders[].shipping.countrystringShipping country code.
orders[].shipping.statestringShipping state / province.
orders[].shipping.citystringShipping city.
orders[].shipping.zipstringShipping postal code.
orders[].shipping.addressstringShipping street address.
orders[].billingobjectBilling address from the company record.
orders[].billing.namestringBilling name.
orders[].billing.phonestringBilling phone.
orders[].billing.aptstringBilling apartment / suite.
orders[].billing.addressstringBilling street address.
orders[].billing.citystringBilling city.
orders[].billing.statestringBilling state / province.
orders[].billing.zipstringBilling postal code.
orders[].billing.countrystringBilling country code.
orders[].currency_codestringOrder currency (e.g. USD).
orders[].tax_amountstring | numberTax amount.
orders[].total_amountstring | numberFinal order total.
orders[].payout_statusstringPayout state: Paid or Unpaid (matches Manage Orders Payout column).
orders[].order_statusstringCurrent status label in UPPERCASE. One of: ORDER RECEIVED, BOX SHIPPED, PICKUP REQUESTED, DEVICE RECEIVED, TECHNICAL ASSESSMENT, ORDER PAYOUT, COMPLETED, CANCELLED. Manage Orders shows the same labels in Title Case.
orders[].order_status_datestringFormatted date of the current order_status (not the same as created_at).
orders[].created_atstringFormatted order creation date.
orders[].devicesarrayDevices on the order.
orders[].devices[].device_typenumberDevice category code: 1=Mobile, 2=Tablet, 3=iPod, 4=Laptop, 5=Server, 6=Printers, 7=Desktop, 8=Network Gear, 9=Other.
orders[].devices[].brandstringDevice brand.
orders[].devices[].devicestringDevice category label (e.g. Laptop).
orders[].devices[].typestringModel / type name (e.g. MacBook Pro).
orders[].devices[].qtynumberQuantity.
orders[].devices[].sub_totalstringLine subtotal.
orders[].devices[].year_manufacturedstring | nullManufacture year when applicable (e.g. laptops).
orders[].documentsobjectAttached documents keyed by document type. Each value is an array of { filename } download URLs. Empty object {} when none.
orders[].shipmentsarrayCarrier shipment tracking entries (empty when none).
orders[].shipments[].carrier_namestringCarrier (e.g. ups, eshipz).
orders[].shipments[].forwardobjectOutbound / forward leg tracking.
orders[].shipments[].forward.tracking_numberstring | nullForward tracking number.
orders[].shipments[].forward.tracking_linkstring | nullForward tracking URL.
orders[].shipments[].returnobjectReturn leg tracking.
orders[].shipments[].return.tracking_numberstring | nullReturn tracking number.
orders[].shipments[].return.tracking_linkstring | nullReturn tracking URL.

Notes

  • Default page size is 10.
  • status accepts the human-readable label (case-insensitive). total_orders / total_pages reflect the filtered set.
  • start_date / end_date filter on created_at (YYYY-MM-DD query params; end_date is inclusive through end of day).
  • Response matches a single orders[] object from Order List, retrieved by order_number.
  • Use order_number from Place Order or Order List for Detail and Cancel.
  • devices[] lists devices on the order. device_type is a numeric category code (1–9).
  • contact is the attributed platform user; shipping is the ship-from / recovery address.
  • documents is always an object keyed by document type → array of { filename } URLs ({} when none).
  • shipments[] holds carrier tracking with forward and return legs. For print-a-label recoveries, tracking often appears under return.
  • order_status is always an UPPERCASE string. Valid values: ORDER RECEIVED, BOX SHIPPED, PICKUP REQUESTED, DEVICE RECEIVED, TECHNICAL ASSESSMENT, ORDER PAYOUT, COMPLETED, CANCELLED.
  • payout_status is Paid or Unpaid (Manage Orders Payout column).

Related Endpoints

Did this page help you?