/grid/request_history/group_children

post

https://api.etb.apkudo.com/grid/request_history/group_children

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

created_after

date-time

created_before

date-time

customer

array of uuids

Multiple values may be separated by commas.

customer

dropoff_code

array of strings

Multiple values may be separated by commas.

dropoff_code

exclude_recovery_program

array of uuids

Multiple values may be separated by commas.

exclude_recovery_program

format

string

enum

Allowed:

imei

array of strings

Multiple values may be separated by commas.

imei

method

string

enum

API - API
RecoveryWizard - Recovery Wizard
CSVUpload - CSV Upload

Allowed:

program_name

array of strings

Multiple values may be separated by commas.

program_name

program_state

string

enum

Program state

open - Open
closed - Closed
archived - Archived
pending - Pending

Allowed:

reco_action

array of strings

RetailReturn - Retail Return
EmployeePurchase - Employee Purchase
EmployeePurchasePlus - Employee Purchase Plus
ReturnLabel - Return Label
IndividualDeviceKit - Individual Device Kit
LaptopKit - Laptop Kit
DeviceCollection - Device Collection

reco_action

Allowed:

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
RetailReturn - Retail Return
BulkRetailReturn - Bulk Retail Return

request_id

array of uuids

Multiple values may be separated by commas.

request_id

string

serial_number

array of strings

Multiple values may be separated by commas.

serial_number

sort

array of strings

Ordering

request_date - Request date
-request_date - Request date (descending)
recipient_name - Recipient name
-recipient_name - Recipient name (descending)
recipient_email - Recipient email
-recipient_email - Recipient email (descending)
sender_name - Sender name
-sender_name - Sender name (descending)
sender_email - Sender email
-sender_email - Sender email (descending)
address1 - Address1
-address1 - Address1 (descending)
address2 - Address2
-address2 - Address2 (descending)
city - City
-city - City (descending)
state - State
-state - State (descending)
postal_code - Postal code
-postal_code - Postal code (descending)
country_code - Country code
-country_code - Country code (descending)
method - Method
-method - Method (descending)
status - Status
-status - Status (descending)
recovery_type - Recovery type
-recovery_type - Recovery type (descending)
imei - Imei
-imei - Imei (descending)
serial_number - Serial number
-serial_number - Serial number (descending)
program_name - Program name
-program_name - Program name (descending)

sort

status

array of strings

AwaitingMethod - Awaiting method
ReturnRequested - Return requested
Failure - Failure
Complete - Complete
Cancelled - Cancelled
PreTransit - Pre Transit
InTransitToEndUser - In transit to end user
DeliveredToEndUser - Delivered to end user
InTransitToCenter - In transit to center
DeliveredToCenter - Delivered to center
DevicePending - Device Pending
DeviceProcessed - Device Processed
ReturnedToCustomer - Returned To Customer

status

Body Params

group_ids

array of uuids

required

length ≤ 250

group_ids*

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

200