API docs by Redocly

Asset Part Transfer API (1.0.0)

Download OpenAPI specification:Download

URL: https://repzo.com

API for managing asset part transfers between locations

Asset Part Transfer

Operations related to asset part transfer management

Get all asset part transfers

Retrieve a list of all asset part transfers 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 transfer

Create a new asset part transfer with the provided data

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

Unique transfer number

required
object
required
object
requestedBy
required
string

User who requested the transfer

approvedBy
string

User who approved the transfer

transferredBy
string

User who executed the transfer

requestDate
string <date-time>

Date when transfer was requested

approvalDate
string <date-time>

Date when transfer was approved

transferDate
string <date-time>

Date when transfer was executed

scheduledDate
string <date-time>

Scheduled transfer date

status
string
Default: "requested"
Enum: "requested" "approved" "in-progress" "completed" "cancelled"

Status of the transfer

priority
string
Default: "medium"
Enum: "low" "medium" "high" "urgent"

Priority of the transfer

reason
string

Reason for the transfer

required
Array of objects
totalItems
integer >= 0

Total number of items being transferred

transportMethod
string
Default: "manual"
Enum: "manual" "vehicle" "courier" "automated"

Method of transport

carrier
string

Carrier/transporter name

trackingNumber
string

Tracking number if applicable

estimatedArrival
string <date-time>

Estimated arrival time

actualArrival
string <date-time>

Actual arrival time

cost
number <double> >= 0

Transfer cost

currency
string

Currency code

Array of objects
notes
string

General notes

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "transferNumber": "TRF-2023-001",
  • "fromLocation": {
    },
  • "toLocation": {
    },
  • "requestedBy": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "approvedBy": "60f7b1b3e4b0e8b3f8b3f8b5",
  • "transferredBy": "60f7b1b3e4b0e8b3f8b3f8b6",
  • "requestDate": "2023-01-15T08:00:00Z",
  • "approvalDate": "2023-01-15T09:00:00Z",
  • "transferDate": "2023-01-15T10:00:00Z",
  • "scheduledDate": "2023-01-15T10:00:00Z",
  • "status": "requested",
  • "priority": "low",
  • "reason": "string",
  • "items": [
    ],
  • "totalItems": 0,
  • "transportMethod": "manual",
  • "carrier": "string",
  • "trackingNumber": "string",
  • "estimatedArrival": "2019-08-24T14:15:22Z",
  • "actualArrival": "2019-08-24T14:15:22Z",
  • "cost": 0,
  • "currency": "USD",
  • "documents": [],
  • "notes": "string",
  • "metadata": { }
}

Response samples

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

Get asset part transfer by ID

Retrieve a specific asset part transfer by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part transfer ID

Responses

Response samples

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

Update asset part transfer

Update an existing asset part transfer with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part transfer ID

Request Body schema: application/json
transferNumber
required
string

Unique transfer number

required
object
required
object
requestedBy
required
string

User who requested the transfer

approvedBy
string

User who approved the transfer

transferredBy
string

User who executed the transfer

requestDate
string <date-time>

Date when transfer was requested

approvalDate
string <date-time>

Date when transfer was approved

transferDate
string <date-time>

Date when transfer was executed

scheduledDate
string <date-time>

Scheduled transfer date

status
string
Default: "requested"
Enum: "requested" "approved" "in-progress" "completed" "cancelled"

Status of the transfer

priority
string
Default: "medium"
Enum: "low" "medium" "high" "urgent"

Priority of the transfer

reason
string

Reason for the transfer

required
Array of objects
totalItems
integer >= 0

Total number of items being transferred

transportMethod
string
Default: "manual"
Enum: "manual" "vehicle" "courier" "automated"

Method of transport

carrier
string

Carrier/transporter name

trackingNumber
string

Tracking number if applicable

estimatedArrival
string <date-time>

Estimated arrival time

actualArrival
string <date-time>

Actual arrival time

cost
number <double> >= 0

Transfer cost

currency
string

Currency code

Array of objects
notes
string

General notes

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "transferNumber": "TRF-2023-001",
  • "fromLocation": {
    },
  • "toLocation": {
    },
  • "requestedBy": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "approvedBy": "60f7b1b3e4b0e8b3f8b3f8b5",
  • "transferredBy": "60f7b1b3e4b0e8b3f8b3f8b6",
  • "requestDate": "2023-01-15T08:00:00Z",
  • "approvalDate": "2023-01-15T09:00:00Z",
  • "transferDate": "2023-01-15T10:00:00Z",
  • "scheduledDate": "2023-01-15T10:00:00Z",
  • "status": "requested",
  • "priority": "low",
  • "reason": "string",
  • "items": [
    ],
  • "totalItems": 0,
  • "transportMethod": "manual",
  • "carrier": "string",
  • "trackingNumber": "string",
  • "estimatedArrival": "2019-08-24T14:15:22Z",
  • "actualArrival": "2019-08-24T14:15:22Z",
  • "cost": 0,
  • "currency": "USD",
  • "documents": [],
  • "notes": "string",
  • "metadata": { }
}

Response samples

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

Delete asset part transfer

Delete an existing asset part transfer

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part transfer ID

Responses

Response samples

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

Complete asset part transfer

Mark an asset part transfer as completed

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part transfer ID

Responses

Response samples

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