Order List

Retrieve a paginated list of Deployment orders for your company.

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

Description

Returns Deployment orders with optional status and date filters.

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 order status (e.g. IN TRANSIT, COMPLETED). Case-insensitive match against order_status.
start_datestringNoOn or after this date (YYYY-MM-DD; shipping labels also accept MM/DD/YYYY).
end_datestringNoOn or before this date (YYYY-MM-DD; shipping labels also accept MM/DD/YYYY).

Response

FieldTypeDescription
total_ordersnumberTotal matching orders.
total_pagesnumberTotal pages.
current_pagenumberCurrent page.
orders[]arrayOrder objects with shipping, billing, items, documents, and tracking where applicable.
orders[].order_numberstringUnique order number.
orders[].order_statusstringHuman-readable status (field name varies by order type on list).
orders[].items[]arrayLine items (fields vary by order type; Procurement list omits items).
orders[].trackingarrayShipment tracking entries when available.

Notes

  • Default page size is 10.
  • status filter is matched case-insensitively against order_status.
  • Deployment orders use Device Hub / marketplace line items (item_number, product_name, sku_code, sub_total, discount, qty).
  • List uses last_update_date for the latest status timestamp; detail may include a tag object with cost center and department metadata.

Related Endpoints

Did this page help you?