cycle_count

List Cycle Counts

Get a list of cycle counts based on search parameters.

get/cycle-counts

Request

  • Base URL: https://app.zenventory.com/rest
  • URL: https://app.zenventory.com/rest/cycle-counts
  • Auth: none declared

Query parameters

type'' | 'normal' | 'adjustment'

Type of cycle count to filter for. Normal cycle counts count all item inventory at each location while an adjustment is for a single item.

inProgressboolean

True to filter for cycle counts whose locations have not yet all been counted.

completedboolean

True to filter for cycle counts whose locations have all been counted, but not yet approved.

approvedboolean

True to filter for cycle counts whose locations have all been counted and approved.

warehouseIdinteger

Id of the warehouse the cycle counts are being performed in.

warehouseNamestring

Name of the warehouse the cycle counts are being performed in. Ignored if warehouseId is provided.

createdFromstring date-time

Get cycle counts created at or after this time.

createdTostring date-time

Get cycle counts created at or before this time.

orderBy'' | 'id' | 'createdDate'

Field to order results by.

orderDir'asc' | 'desc'

Direction to order the results by. Only used if orderBy is not an empty string.

pageinteger

Page number of the results to get.

perPageinteger

Page number of the results to get.

Response

Success

Example response

{
  "cycleCounts": [
    {
      "id": 118,
      "progress": 100,
      "accuracy": 100,
      "warehouse": {
        "id": 1,
        "name": "Main Warehouse"
      },
      "createdDate": "2021-02-01T10:50:30-07:00",
      "createdBy": {
        "id": 1,
        "name": "Mr Sparks"
      },
      "claimedBy": {
        "id": 1,
        "name": "Mr Sparks"
      },
      "completed": true,
      "completedDate": "2021-02-01T12:50:30-07:00",
      "completedBy": {
        "id": 1,
        "name": "Mr Sparks"
      },
      "approved": true,
      "approvedDate": "2021-02-02T10:50:30-07:00",
      "approvedBy": {
        "id": 1,
        "name": "Mr Sparks"
      },
      "locations": [
        {
          "id": 150,
          "location": {
            "id": 1800,
            "name": "Isle A"
          },
          "accuracy": 100,
          "completed": true,
          "completedDate": "2021-02-01T12:50:30-07:00",
          "completedBy": {
            "id": 1,
            "name": "Mr Sparks"
          },
          "approved": true,
          "approvedDate": "2021-02-02T10:50:30-07:00",
          "approvedBy": {
            "id": 1,
            "name": "Mr Sparks"
          }
        }
      ]
    }
  ],
  "meta": {
    "count": 70,
    "page": 1,
    "perPage": 20,
    "totalPages": 4
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.