v1

latestOpenAPI 3.0.0Apache License Version 2.02026-07-24163274903.6 KB
Storage Location Service

getStorageLocationsByPage

getStorageLocationsByPage Implementation Notes

get/storagelocation/v1/getStorageLocationsByPage

Query parameters

centralStorageFlagboolean

The 'Central Storage' flag for the storage location. Use true or false.

closingIntermediarystring

The “Intermediary” Primary Closing Method for the storage location. must be ‘B’, ‘E’, ‘L’ or ‘Z’.

closingNonInventorystring

The “Non-Stock” Primary Closing Method for the storage location. must be ‘B’, ‘E’, ‘L’ or ‘Z’.

closingSalesstring

The “Sales” Primary Closing Method for the storage location. must be ‘B’, ‘E’, ‘L’ or ‘Z’.

closingStockstring

The “Stock” Primary Closing Method for the storage location. must be ‘B’, ‘E’, ‘L’ or ‘Z’.

includeNullboolean

Specify 'true' to output null data elements.

locationCodestring

The Code for the location to be associated with the storage location. Must match an existing active location in Enterprise Manager.

minutesSinceUpdateinteger

The number of minutes since a Storage Location record was last updated. Use to set how far back to search.

pageNumberinteger

pageNumber

pageSizeinteger

pageSize

prepStationCodestring

The prep station Code for the storage location.

secondaryClosingIntermediarystring

The “Intermediary” Secondary Closing Method for the storage location. must be ‘B’, ‘E’, ‘L’ or ‘Z’.

secondaryClosingNonInventorystring

The “Non-Stock” Secondary Closing Method for the storage location. must be ‘B’, ‘E’, ‘L’ or ‘Z’.

secondaryClosingSalesstring

The “Sales” Secondary Closing Method for the storage location. must be ‘B’, ‘E’, ‘L’ or ‘Z’.

secondaryClosingStockstring

The “Stock” Secondary Closing Method for the storage location. must be ‘B’, ‘E’, ‘L’ or ‘Z’.

storageCodestring

The Code for the storage location.

storageNamestring

The Storage Name for the storage location. Use 2 or more characters.

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

{
  "storageLocationDetails": [
    {
      "storageLocationDetailDetails": [
        {
          "centralStorageFlag": "Y",
          "closingIntermediary": "B",
          "closingNonInventory": "B",
          "closingSales": "B",
          "closingStock": "B",
          "locationCode": "000125",
          "secondaryClosingIntermediary": "B",
          "secondaryClosingNonInventory": "B",
          "secondaryClosingSales": "B",
          "secondaryClosingStock": "B",
          "storageCode": "UNASGN",
          "storageName": "Unassigned"
        }
      ]
    }
  ]
}