v1

latestOpenAPI 3.0.0Apache License Version 2.02026-07-24163274903.6 KB
Inventory Service

getPhysicalInventoryStandardsByPage

Retrieve by page, all physical inventory counts (quantity only) by date and location.

get/inventory/physicalinventorystandard/v1/getPhysicalInventoryStandardsByPage

Query parameters

inventoryDatestring required

Inventory date of a scheduled inventory or final for post inventory in format DD-MMM-YY.

locationCodestring required

The Code that identifies the Location in Crunchtime.

pageNumberinteger

Retrieve one or more records by pageNumber. Use to retrieve data in smaller chunks. If left blank, the default is 1.

productNumberstring

A unique alphanumeric code used to identify a product.

storageCodestring

Physical inventory item's storage code.

userIdForDetailsstring

Retrieve user id details when true.

pageSizeinteger

Number of items to display per page.

includeNullboolean

Specify 'true' to output null data elements.

Headers

authenticationtokenstring required

Secure token for API authentication.

passwordstring required

Password for the Crunchtime Application User.

sitenamestring required

Crunchtime site identifier. (test or production)

useridstring required

User ID for the Crunchtime Application User.

X-B3-TraceIdstring

Optional trace identifier for troubleshooting.

Response

Success

hasNextboolean
totalPagesinteger

Example response

{
  "physicalInventoryStandardDetails": [
    {
      "physicalInventoryStandardDetailDetails": [
        {
          "altQuantity1": 9.99,
          "altQuantity2": 9.99,
          "altQuantity3": 9.99,
          "inventoryDate": "09/10/2022",
          "quantity": 9.99,
          "userId": "john",
          "inventoryType": "User Defined Category (Corporate)",
          "detail": "CRITICAL COMPONENTS",
          "inventoryUnit": "LB",
          "totalQuantity": 6,
          "unitPrice": 3.6402,
          "physicalValue": 21.84,
          "byExceptionFlag": "N"
        }
      ]
    }
  ]
}