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"
items	WarehouseRequestItem	List of items in the warehouse request
location	Location	Location related to the warehouse request
job	Job	Job related to the warehouse request
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 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
requisition	Requisition	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

Queries

warehouseRequest

Read a single Warehouse Request by ID or identifier.

Parameters

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

Response

A single Warehouse Request.

Example Query

query {
  warehouseRequest(id: "ckmnpybisiy5x08abky4g2d1f") {
    id
    identifier
    state
    job {
      id
      name
    }
    items {
      id
      requisition {
        id
        state
        identifier
      }
      state
      description
      quantity
      uom
      notes
      upc
      mpn
    }
    createdAt
    createdById
    updatedAt
  }
}

Example Response

{
  "id": "ckmnpybisiy5x08abky4g2d1f",
  "identifier": "WHREQ-12345",
  "state": "SENT",
  "job": {
    "id": "cltoj9jh101assxdoutgzkf28",
    "name": "Oceanwide Center"
  },
  "items": [
    {
      "id": "ckmnpybisiy5x08aasdf13242",
      "requisition": {
        "id": "clxattx5g001iu2qpcbdk035r",
        "state": "PARTIALLY_FULFILLED",
        "identifier": "REQ-A12783"
      },
      "state": "PICKED",
      "description": "Chain, 10ft",
      "quantity": 7,
      "uom": "EA",
      "notes": "",
      "upc": "00123456789012",
      "mpn": "HSC0424PP"
    },
    {
      "id": "ckva1id7hgm0a0845jqaypur8",
      "requisition": {
        "id": "clxattx5g001iu2qp23dnj22",
        "state": "PARTIALLY_FULFILLED",
        "identifier": "REQ-A12784"
      },
      "state": "REQUESTED",
      "description": "1/4 SHANK MANDREL",
      "quantity": 7,
      "uom": "EA",
      "notes": "",
      "upc": "00123456784561",
      "mpn": "DMC0423LK"
    }
  ],
  "createdAt": "2021-03-24 17:26:46.983Z",
  "createdById": "chjkpybisiy5x08abky4g2d1f",
  "updatedAt": "2021-03-24 17:26:46.983Z"
}

warehouseRequests

Read all warehouse requests, with pagination.

Parameters

Accepts all standard pagination parameters.

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

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

Max page limit of 100.

Response

A list of Warehouse Request objects.

Example Query

query {
  warehouseRequests(
    orderBy: identifier
    direction: ASC
    filter: { createdAt_lt: "2024-01-01T15:10:10" }
  ) {
    id
    identifier
    createdAt
  }
}

Example Response

[
  {
    "id": "ckmnpybisiy5x08aasdf13242",
    "identifier": "WHREQ_0001",
    "createdAt": "2023-01-26T16:18:35.931Z"
  },
  {
    "id": "ckmnpybisiy5x08abky4g2d1f",
    "identifier": "WHREQ_0002",
    "createdAt": "2023-01-26T16:49:04.773Z"
  }
]

warehouseRequestItems

Read all items for a warehouse request, with pagination.

Parameters

Name	Description	Example
id	The ID of the warehouse request of which to fetch its items	"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.

Max page limit of 100.

Response

A list of Warehouse Request Items objects.

Example Query

query {
  warehouseRequestItems(warehouseRequestId: "ckmnpybisiy5x08aasdf13242") {
    id
    requisition {
      id
      state
      identifier
    }
    state
    description
    quantity
    uom
    notes
    upc
    mpn
  }
}

Example Response

[
  {
    "id": "ckva1id7hgm0a0845jqaypur8",
    "requisition": {
      "id": "clxattx5g001iu2qp23dnj22",
      "state": "PARTIALLY_FULFILLED",
      "identifier": "REQ-A12784"
    },
    "state": "REQUESTED",
    "description": "1/4 SHANK MANDREL",
    "quantity": 7,
    "uom": "EA",
    "notes": "",
    "upc": "00123456784561",
    "mpn": "DMC0423LK"
  }
]