Create ITAD requests

Error

A valid request URL is required to generate request examples

[
  {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "status": "PENDING_DATA_DESTRUCTION",
    "submittedVia": "ITAD_CENTER",
    "createdByActor": "CUSTOMER",
    "createdAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z",
    "cancelledAt": "2023-11-07T05:31:56Z",
    "totalEstimatedResaleValue": 2500,
    "totalResaleValue": 2300,
    "warehouseId": "ecb7e933-de1e-9830-b180-b25d1d0d296e",
    "warehouseName": "US East Warehouse",
    "organizationId": "ecb7e933-de1e-9830-b180-b25d1d0d296e",
    "organizationName": "Acme Corp",
    "createdById": "ecb7e933-de1e-9830-b180-b25d1d0d296e",
    "createdByName": "John Doe",
    "lotCodDocumentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "lotCodUploadedAt": "2023-11-07T05:31:56Z",
    "settlementReportDocumentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "settlementReportGeneratedAt": "2023-11-07T05:31:56Z",
    "parentItadRequestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "items": [
      {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "inventoryId": "ecb7e933-de1e-9830-b180-b25d1d0d296e",
        "serialNumber": "C02X1234ABCD",
        "skuTitle": "MacBook Pro 14\" M2",
        "categoryCode": "COMPUTER",
        "estimatedResaleValue": 450,
        "resaleValue": 420,
        "estimatedMaxCreditValueAtRequest": 500,
        "rmsStatus": "NOT_ENROLLED",
        "status": "PENDING",
        "settledAmount": 400,
        "grossSaleAmount": 410,
        "currencyCode": "USD",
        "cancelledAt": "2023-11-07T05:31:56Z"
      }
    ]
  }
]

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

POST

api

itad

requests

Error

A valid request URL is required to generate request examples

[
  {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "status": "PENDING_DATA_DESTRUCTION",
    "submittedVia": "ITAD_CENTER",
    "createdByActor": "CUSTOMER",
    "createdAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z",
    "cancelledAt": "2023-11-07T05:31:56Z",
    "totalEstimatedResaleValue": 2500,
    "totalResaleValue": 2300,
    "warehouseId": "ecb7e933-de1e-9830-b180-b25d1d0d296e",
    "warehouseName": "US East Warehouse",
    "organizationId": "ecb7e933-de1e-9830-b180-b25d1d0d296e",
    "organizationName": "Acme Corp",
    "createdById": "ecb7e933-de1e-9830-b180-b25d1d0d296e",
    "createdByName": "John Doe",
    "lotCodDocumentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "lotCodUploadedAt": "2023-11-07T05:31:56Z",
    "settlementReportDocumentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "settlementReportGeneratedAt": "2023-11-07T05:31:56Z",
    "parentItadRequestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "items": [
      {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "inventoryId": "ecb7e933-de1e-9830-b180-b25d1d0d296e",
        "serialNumber": "C02X1234ABCD",
        "skuTitle": "MacBook Pro 14\" M2",
        "categoryCode": "COMPUTER",
        "estimatedResaleValue": 450,
        "resaleValue": 420,
        "estimatedMaxCreditValueAtRequest": 500,
        "rmsStatus": "NOT_ENROLLED",
        "status": "PENDING",
        "settledAmount": 400,
        "grossSaleAmount": 410,
        "currencyCode": "USD",
        "cancelledAt": "2023-11-07T05:31:56Z"
      }
    ]
  }
]

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

{
  "errors": [
    {
      "detail": "Invalid request",
      "source": "request"
    }
  ]
}

Authorizations

Authorization

string

header

required

Prefix the value with "ApiKey" to indicate the custom authorization type

Body

application/json

Request body to create ITAD requests

inventoryIds

string<uuid>[]

required

List of inventory IDs to include in the ITAD request(s). Items will be grouped by warehouse.

Minimum array length: 1

createdById

string<uuid>

required

ID of the person creating the request (must belong to the organization)

Example:

"ecb7e933-de1e-9830-b180-b25d1d0d296e"

Response

ITAD requests created successfully

string<uuid>

required

Unique request ID

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

status

enum<string>

required

Current request status

Available options:

PENDING_DATA_DESTRUCTION,

REQUIRES_ACTION,

AWAITING_RECHECK,

PENDING_SETTLEMENT,

COMPLETED,

CANCELLED

Example:

"PENDING_DATA_DESTRUCTION"

submittedVia

enum<string>

required

How the request was submitted

Available options:

ASSETS_PAGE,

ITAD_CENTER,

RETURN

Example:

"ITAD_CENTER"

createdByActor

enum<string>

required

Actor who created the request

Available options:

CUSTOMER,

OPS

Example:

"CUSTOMER"

createdAt

string<date-time>

Timestamp when the request was created

completedAt

string<date-time>

Timestamp when the request was completed

cancelledAt

string<date-time>

Timestamp when the request was cancelled

totalEstimatedResaleValue

number

Total estimated resale value of all items

Example:

2500

totalResaleValue

number

Total actual resale value of all items

Example:

2300

warehouseId

string<uuid>

ID of the warehouse

Example:

"ecb7e933-de1e-9830-b180-b25d1d0d296e"

warehouseName

string

Name of the warehouse

Example:

"US East Warehouse"

organizationId

string<uuid>

ID of the organization

Example:

"ecb7e933-de1e-9830-b180-b25d1d0d296e"

organizationName

string

Name of the organization

Example:

"Acme Corp"

createdById

string<uuid>

ID of the person who created the request

Example:

"ecb7e933-de1e-9830-b180-b25d1d0d296e"

createdByName

string

Name of the person who created the request

Example:

"John Doe"

lotCodDocumentId

string<uuid>

Lot Certificate of Destruction document ID

lotCodUploadedAt

string<date-time>

Timestamp when the lot CoD was uploaded

settlementReportDocumentId

string<uuid>

Settlement report document ID

settlementReportGeneratedAt

string<date-time>

Timestamp when the settlement report was generated

parentItadRequestId

string<uuid>

Parent ITAD request ID for multi-warehouse bulk submissions

items

object[]

Items in this request (included in detail responses only)

Show child attributes

List ITAD requests Get a single ITAD request by ID

⌘I

People

Shipment Notices V1

Returns

Replacements

People — Lifecycle

Packages

Orders

New Joiners

ITAD

Inventory

Inventory Orders

Inventory Levels

Assets

Return Orders

Offices

Warehouses V1

Shipment

Regions V1

Categories

Catalog

Brands

Authorizations

Body

Response