1. Resource Central
  2. arrow-right
  3. Carriers

Carriers

Carriers of trays on a Kardex machine.

Attributes

  • name integer

    The carrier number in a 3-digit format.

  • id string

    Unique identifier for the object.

  • blockReason string

    Reason for blocking the material in this location from warehouse operations.

  • isBlockedForPick boolean

    If the carrier is blocked from picking.

    Possible values:

    0 = False
    1 = True

  • isBlockedForPut boolean

    If the carrier is blocked from putting.

    Possible values:

    0 = False
    1 = True

  • maxWeight integer

    Permitted weight limit of the storage unit, if working with weight control. The preset unit of measurement is grams.

  • number integer

    The number of the carrier.

Endpoints

List Carriers /api/carriers
get

Get a list of carriers from the PPG database. View the guide on adding filters to List API calls.

Body Parameters

  • number string

    The number of the carrier.

  • countOnly boolean

    When "true", will only return a count of the amount of items in the query.

    Default value:

    false

  • limit integer

    A limit on the number of objects to be returned. Limit can range between 1 and 1000.

    Default value:

    250

  • page integer

    Page-numbering is based on the value of the "limit" argument. If limit=20, then page=0 will display the hits from 1 to 20. (Page numbers are zero-based.) Using page without a limit returns all items.

  • orderBy string, array

    Order the response by the selected field. Multiple values can be passed, separated by a comma.

Request with curl
curl "http://[subdomain.itempath.com or IP]/api/carriers" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]" -d '{ }'
Example Response
{ "carriers": [{ "name": " 010 ", "id": " string ", "blockReason": " string ", "isBlockedForPick": " boolean ", "isBlockedForPut": " boolean ", "maxWeight": " integer ", "number": " 10 ", }] }] }
Show Carrier /api/carriers/[id]
get

Get a single carrier from the PPG database and return a JSON response.

Request with curl
curl "http://[subdomain.itempath.com or IP]/api/carriers/[id]" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{ "carrier": { "name": 010 , "id": " string " , "blockReason": " string " , "isBlockedForPick": boolean , "isBlockedForPut": boolean , "maxWeight": integer , "number": 10 , } }