API docs by Redocly

Return Asset Part Unit API (1.0.0)

Download OpenAPI specification:Download

URL: https://repzo.com

API for managing returns of asset part units

Return Asset Part Unit

Operations related to returning asset part units

Get all asset part unit returns

Retrieve a list of all asset part unit returns with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
limit
integer [ 1 .. 100 ]
Default: 50

Maximum number of records to return

offset
integer >= 0
Default: 0

Number of records to skip for pagination

sort
string

Field to sort by

order
string
Default: "desc"
Enum: "asc" "desc"

Sort order (asc or desc)

filter
string

Filter conditions in JSON format

search
string

Search term for text fields

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "total": 0
}

Create a new asset part unit return

Create a new asset part unit return with the provided data

Authorizations:
ApiKeyAuth
Request Body schema: application/json
returnNumber
required
string

Unique return number

assetPartUnit
required
string

Asset part unit ID being returned

serialNumber
string

Serial number of the part unit

returnType
required
string
Enum: "warranty" "defective" "excess" "end-of-lease" "maintenance"

Type of return

returnReason
required
string

Reason for return

returnedBy
required
string

User who initiated the return

authorizedBy
string

User who authorized the return

returnDate
string <date-time>

Date when the return was processed

requestDate
string <date-time>

Date when the return was requested

originalInstallDate
string <date-time>

Original installation date

originalWorkOrder
string

Original work order ID

originalAsset
string

Original asset ID where it was installed

status
string
Default: "requested"
Enum: "requested" "approved" "in-transit" "received" "processed" "completed" "rejected"

Status of the return

condition
string
Enum: "new" "good" "fair" "poor" "damaged" "defective"

Condition of the returned part

object
supplier
string

Supplier ID if returning to supplier

creditAmount
number <double> >= 0

Credit amount for the return

currency
string

Currency code

replacementRequired
boolean
Default: false

Whether a replacement is required

replacementPartUnit
string

Replacement part unit ID if applicable

warrantyStatus
string
Enum: "in-warranty" "out-of-warranty" "extended-warranty"

Warranty status at time of return

object
Array of objects
notes
string

Additional notes

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "returnNumber": "RET-2023-001",
  • "assetPartUnit": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "serialNumber": "SN-EP001-2023-001",
  • "returnType": "defective",
  • "returnReason": "Part failed after 30 days of use",
  • "returnedBy": "60f7b1b3e4b0e8b3f8b3f8b5",
  • "authorizedBy": "60f7b1b3e4b0e8b3f8b3f8b6",
  • "returnDate": "2023-01-15T10:00:00Z",
  • "requestDate": "2023-01-14T10:00:00Z",
  • "originalInstallDate": "2023-01-01T10:00:00Z",
  • "originalWorkOrder": "60f7b1b3e4b0e8b3f8b3f8b7",
  • "originalAsset": "60f7b1b3e4b0e8b3f8b3f8b8",
  • "status": "requested",
  • "condition": "defective",
  • "returnLocation": {
    },
  • "supplier": "string",
  • "creditAmount": 0,
  • "currency": "USD",
  • "replacementRequired": false,
  • "replacementPartUnit": "string",
  • "warrantyStatus": "in-warranty",
  • "qualityInspection": {
    },
  • "documents": [],
  • "notes": "string",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get asset part unit return by ID

Retrieve a specific asset part unit return by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part unit return ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update asset part unit return

Update an existing asset part unit return with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part unit return ID

Request Body schema: application/json
returnNumber
required
string

Unique return number

assetPartUnit
required
string

Asset part unit ID being returned

serialNumber
string

Serial number of the part unit

returnType
required
string
Enum: "warranty" "defective" "excess" "end-of-lease" "maintenance"

Type of return

returnReason
required
string

Reason for return

returnedBy
required
string

User who initiated the return

authorizedBy
string

User who authorized the return

returnDate
string <date-time>

Date when the return was processed

requestDate
string <date-time>

Date when the return was requested

originalInstallDate
string <date-time>

Original installation date

originalWorkOrder
string

Original work order ID

originalAsset
string

Original asset ID where it was installed

status
string
Default: "requested"
Enum: "requested" "approved" "in-transit" "received" "processed" "completed" "rejected"

Status of the return

condition
string
Enum: "new" "good" "fair" "poor" "damaged" "defective"

Condition of the returned part

object
supplier
string

Supplier ID if returning to supplier

creditAmount
number <double> >= 0

Credit amount for the return

currency
string

Currency code

replacementRequired
boolean
Default: false

Whether a replacement is required

replacementPartUnit
string

Replacement part unit ID if applicable

warrantyStatus
string
Enum: "in-warranty" "out-of-warranty" "extended-warranty"

Warranty status at time of return

object
Array of objects
notes
string

Additional notes

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "returnNumber": "RET-2023-001",
  • "assetPartUnit": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "serialNumber": "SN-EP001-2023-001",
  • "returnType": "defective",
  • "returnReason": "Part failed after 30 days of use",
  • "returnedBy": "60f7b1b3e4b0e8b3f8b3f8b5",
  • "authorizedBy": "60f7b1b3e4b0e8b3f8b3f8b6",
  • "returnDate": "2023-01-15T10:00:00Z",
  • "requestDate": "2023-01-14T10:00:00Z",
  • "originalInstallDate": "2023-01-01T10:00:00Z",
  • "originalWorkOrder": "60f7b1b3e4b0e8b3f8b3f8b7",
  • "originalAsset": "60f7b1b3e4b0e8b3f8b3f8b8",
  • "status": "requested",
  • "condition": "defective",
  • "returnLocation": {
    },
  • "supplier": "string",
  • "creditAmount": 0,
  • "currency": "USD",
  • "replacementRequired": false,
  • "replacementPartUnit": "string",
  • "warrantyStatus": "in-warranty",
  • "qualityInspection": {
    },
  • "documents": [],
  • "notes": "string",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete asset part unit return

Delete an existing asset part unit return

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part unit return ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Asset part unit return deleted successfully"
}