Warehouse Requests

Warehouse Requests specify the need for inventory from a warehouse.

Schema

Warehouse Request

Name	Type	Description	Example
id	ID	Unique identifier for the warehouse request	cltoj9o1i0lkfsxdonp069jxk
identifier	string	Identifier of the warehouse request	"WHREQ-A0005"
state	WarehouseRequestState	Current status of the warehouse request	"DRAFT"
needByDateDay	DateTime	Date by which the items are needed	"2021-03-24 17:26:46.983Z"
locationId	Id	Unique identifier for the location	cltoj9nzw0lh2sxdoblehy78s
jobId	Id	Unique identifier for the job	cltoj9nzw0lh3sxdoj03mp76n
createdById	ID	Unique identifier of the user who created the warehouse request	ckmnpybisiy5x08abky4g2d1f
createdAt	DateTime	Date when the warehouse request was created	"2021-03-24 17:26:46.983Z"
updatedAt	DateTime	Date when the warehouse request was last updated	"2021-03-24 17:26:46.983Z"

Warehouse Request Item

Name	Type	Description	Example
id	ID	Unique identifier for the warehouse request item	cltoj9o2q0lmusxdoh8symyyf
warehouseRequestId	ID	Unique identifier for the parent warehouse request	cltoj9o1i0lkfsxdonp069jxk
lineNumber	int	Line number	2
state	WarehouseRequestItemState	Current state of the warehouse request item	"SHIPPED"
description	string	Item description	"SOLID-CORE, 0-5VDC, SENSOR"
quantity	float?	Quantity requested	9
pickedQuantity	float?	Quantity picked	7
uom	string	Unit Of Measure	"EA"
notes	string?	Any manually added notes
upc	string?	Universal Product Code
sku	string?	Stock Keeping Unit
mpn	string?	Manufaturer Part Number
requisitionId	ID	Unique identifier of the linked requisition
createdById	ID	Unique identifier of the user who created the warehouse request item	ckmnpybisiy5x08abky4g2d1f
createdAt	DateTime	Date when the warehouse request item was created	"2021-03-24 17:26:46.983Z"
updatedAt	DateTime	Date when the warehouse request item was last updated	"2021-03-24 17:26:46.983Z"

Enums

WarehouseRequestState

Name	Description
ACKNOWLEDGED
DRAFT
SENT

WarehouseRequestItemState

Name	Description
CANCELLED
DRAFT
PARTIAL_PICK
PICKED
REQUESTED
SHIPPED
UNAVAILABLE

REST Endpoints

GET /warehouseRequests/:id

Read a single Warehouse Request by ID.

Parameters

Name	Description	Example
id	The ID of the warehouse request to fetch	"ckmnpybisiy5x08abky4g2d1f"

Response

A single Warehouse Request.

Example Request

GET https://api.kojo.tech/warehouse-requests/ckmnpybisiy5x08abky4g2d1f

Example Response

{
  "id": "ckmnpybisiy5x08abky4g2d1f",
  "identifier": "WHREQ-12345",
  "jobId": "cltoj9jhz01basxdo7ixqdzba",
  "locationId": "cltoj9jh101assxdoutgzkf28",
  "state": "DRAFT",
  "createdAt": "2021-03-24 17:26:46.983Z",
  "createdById": "cltoj9nzx0lhbsxdopxjinxuh",
  "updatedAt": "2021-03-24 17:26:46.983Z"
}

GET /warehouseRequests/:warehouseRequestId/items

Read a Warehouse Request's items, with pagination.

Parameters

Name	Description	Example
warehouseRequestId	The ID of the warehouse request to fetch	"ckmnpybisiy5x08abky4g2d1f"

Accepts all standard pagination parameters.

Allowed orderBy fields: createdAt, createdById, id, state, updatedAt, lineNumber, sku, upc, mpn, quantity, pickedQuantity.

Allowed filter fields: createdAt, createdById, id, state, updatedAt, lineNumber, sku, upc, mpn, quantity, pickedQuantity.

Limit has a max of 100.

Response

A list of Warehouse Request Items belonging to the specified Warehouse Request.

Example Request

GET https://api.kojo.tech/warehouse-requests/ckmnpybisiy5x08abky4g2d1f/items

Example Response

[
  {
    "id": "cltoj9o2q0lmusxdoh8symyyf",
    "warehouseRequestId": "cltoj9o1i0lkfsxdonp069jxk",
    "description": "SOLID-CORE, 0-5VDC, SENSOR",
    "notes": "This is a note",
    "quantity": "EA",
    "pickedQuantity": "5",
    "uom": "Units",
    "upc": "123456789012",
    "sku": "SKU12345",
    "mpn": "MPN12345",
    "lineNumber": "10",
    "state": "SHIPPED",
    "createdAt": "2022-01-01T00:00:00Z",
    "createdById": "user123",
    "updatedAt": "2022-01-02T00:00:00Z"
  }
]

GET /warehouse-requests

Read all warehouse requests, with pagination.

Parameters

Accepts all standard pagination parameters.

Supported orderBy fields: createdAt,needByDateDay, id, state, identifier, updatedAt, createdById.

Allowed filter fields: createdAt, id, jobId, locationId, identifier, state, updatedAt, createdById, needByDateDay.

Limit has a max of 100.

Response

A list of WarehouseRequest objects.

Example Request

GET https://api.kojo.tech/warehouse-requests

Example Response

[
  {
    "id": "cldccucy400kxlgkxq2v5u8ha",
    "identifier": "WHREQ-REQ-0001",
    "jobId": "cldccucy400kwlgkxnd1cfo0y",
    "locationId": "cltoj9nzw0lh3sxdoj03mp76n",
    "needByDateDay": "2024-03-12T15:34:45.690Z",
    "state": "DRAFT",
    "createdAt": "2023-12-13T16:43:14.376Z",
    "createdById": "cltoj9nzx0lhbsxdopxjinxuh",
    "updatedAt": "2024-01-05T22:01:25.180Z"
  }
]

Example Request With Filtering and Sorting

GET https://api.kojo.tech/warehouse-requests?filter.identifier_starts_with=WHREQ-REQ-01&orderBy=createdAt&direction=DESC

Example Response

[
  {
    "id": "whreq1",
    "identifier": "WHREQ-REQ-0101",
    "jobId": "cldccucy400kwlgkxnd1cfo0y",
    "locationId": "cltoj9nzw0lh3sxdoj03mp76n",
    "needByDateDay": "2024-03-12T15:34:45.690Z",
    "state": "DRAFT",
    "createdAt": "2023-12-13T16:43:14.376Z",
    "createdById": "User1",
    "updatedAt": "2024-01-05T22:01:25.180Z"
  }
]