API docs by Redocly

Repzo API - Transfer (1.0.0)

Download OpenAPI specification:Download

OpenAPI specification for Repzo Transfer endpoints.

Find transfers

query Parameters
object

Query parameters for filtering transfers

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0
}

Create a transfer

Request Body schema: application/json
fromWarehouse
required
string

Source warehouse ID

toWarehouse
required
string

Destination warehouse ID

rep
string

Representative ID who initiated the transfer

expectedDate
string <date-time>

Expected delivery date

required
Array of objects

List of items being transferred

reason
string

Reason for the transfer

notes
string

Additional notes

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "fromWarehouse": "string",
  • "toWarehouse": "string",
  • "rep": "string",
  • "expectedDate": "2019-08-24T14:15:22Z",
  • "items": [
    ],
  • "reason": "string",
  • "notes": "string",
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "transferNumber": "string",
  • "fromWarehouse": "string",
  • "toWarehouse": "string",
  • "rep": "string",
  • "transferDate": "2019-08-24T14:15:22Z",
  • "expectedDate": "2019-08-24T14:15:22Z",
  • "completedDate": "2019-08-24T14:15:22Z",
  • "status": "pending",
  • "items": [
    ],
  • "totalValue": 0,
  • "reason": "string",
  • "notes": "string",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get a transfer by ID

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "transferNumber": "string",
  • "fromWarehouse": "string",
  • "toWarehouse": "string",
  • "rep": "string",
  • "transferDate": "2019-08-24T14:15:22Z",
  • "expectedDate": "2019-08-24T14:15:22Z",
  • "completedDate": "2019-08-24T14:15:22Z",
  • "status": "pending",
  • "items": [
    ],
  • "totalValue": 0,
  • "reason": "string",
  • "notes": "string",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Update a transfer

path Parameters
id
required
string
Request Body schema: application/json
expectedDate
string <date-time>

Expected delivery date

status
string
Enum: "pending" "in_transit" "completed" "cancelled"

Status of the transfer

Array of objects

List of items being transferred

notes
string

Additional notes

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "expectedDate": "2019-08-24T14:15:22Z",
  • "status": "pending",
  • "items": [
    ],
  • "notes": "string",
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "transferNumber": "string",
  • "fromWarehouse": "string",
  • "toWarehouse": "string",
  • "rep": "string",
  • "transferDate": "2019-08-24T14:15:22Z",
  • "expectedDate": "2019-08-24T14:15:22Z",
  • "completedDate": "2019-08-24T14:15:22Z",
  • "status": "pending",
  • "items": [
    ],
  • "totalValue": 0,
  • "reason": "string",
  • "notes": "string",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}