/grid/tracking_view

get

https://api.etb.apkudo.com/grid/tracking_view

Provides tracking status details needed for display in the recovery platform.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

carrier

array of strings

Multiple values may be separated by commas.

carrier

created_after

date-time

created_before

date-time

customer

array of uuids

Multiple values may be separated by commas.

customer

format

string

enum

Allowed:

label_id

array of uuids

Multiple values may be separated by commas.

label_id

method

string

enum

API - API
RecoveryWizard - Recovery Wizard
CSVUpload - CSV Upload

Allowed:

out_of_compliance

boolean

page

integer

A page number within the paginated result set.

page_size

integer

Number of results to return per page.

program_name

array of strings

Multiple values may be separated by commas.

program_name

recovery_program

array of uuids

Multiple values may be separated by commas.

recovery_program

recovery_type

string

enum

RecoNotification - Reco Notification
ReturnLabel - Return Label
IndividualDeviceKit - Individual Device Kit
BulkDeviceKit - Bulk Device Kit
BulkTabletKit - Bulk Tablet Kit
BulkReturnLabel - Bulk Return Label
External - External
LaptopKit - Laptop Kit

request_id

array of uuids

Multiple values may be separated by commas.

request_id

string

sort

array of strings

Ordering

carrier - Carrier
-carrier - Carrier (descending)
method - Method
-method - Method (descending)
name - Name
-name - Name (descending)
out_of_compliance - Out of compliance
-out_of_compliance - Out of compliance (descending)
recovery_type - Recovery type
-recovery_type - Recovery type (descending)
request_date - Request date
-request_date - Request date (descending)
status - Status
-status - Status (descending)
tracking_number - Tracking number
-tracking_number - Tracking number (descending)
email - Email
-email - Email (descending)
delivery_date - Delivery date
-delivery_date - Delivery date (descending)
tracking_url - Tracking url
-tracking_url - Tracking url (descending)
label_image_url - Label image url
-label_image_url - Label image url (descending)
program_name - Program name
-program_name - Program name (descending)
estimated_delivery_date - Estimated delivery date
-estimated_delivery_date - Estimated delivery date (descending)

sort

status

array of strings

InTransitToCenter - In transit to center
DeliveredToCenter - Delivered to center
InTransitToEndUser - In transit to end user
DeliveredToEndUser - Delivered to end user
PreTransit - Pre Transit
Inactive - Inactive
Failure - Failure

status

Allowed:

tracking_number

array of strings

Multiple values may be separated by commas.

tracking_number

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/csv

200