API - Packing Lists - Retrieve Details or Update

Base URL: https://rental.software/api6

Required query parameters: apiKey

GET /packinglists

Request Body Parameters

  • lead_id integer (optional)
  • rental_id integer (optional)

If the optional parameters are not supplied, a JSON encoded array of all available packing list statuses is returned.

If the optional parameters are supplied, a single status is returned.

Response Schema

  • plstatus_id
    • Packing list status ID.
    • Example: 1234
  • plstatus_name
    • Packing list status name.
    • Example: prepare
  • plstatus_requirescan
    • Packing list status requires items to be physically scanned.
    • Example: 0,1
  • plstatus_order
    • Packing list status order.
    • Example 0,1,2…n
  • plstatus_username
    • Packing list status username
    • Example: demo
  • plstatus_lastmodified
    • Packing list status last modified date (unix timestamp.)
    • Example: 1744226804
  • plstatus_delivered
    • Packing list status is delivered.
    • Example: 0, 1
  • plstatus_intransit
    • Packing list status is in transit.
    • Example: 0,1
  • plstatus_possession
    • Packing list status is in company possession.
    • Example: 0.1
  • request_time integer
    • The current request time as a unix timestamp in seconds

POST /packinglists

Request Body Parameters

  • lead_id integer required
  • rental_id integer required
  • plstatus_id integer required
  • loaded_qty integer required
  • notes string
    • Notes about the specific item.
  • skip integer (0 or 1)
    • Skip loading the item on the specified packing list status. If the loaded quantity does not match what is specified on the lead, this needs to be set for the status to be considered complete.
  • remove integer (0 or 1)
    • Removes the item from all packing list statuses for the specified lead.

Response Schema

Red indicates properties that are only sent when the message fails

  • message string
    • A message describing the error
  • request_time integer
    • The current request time as a unix timestamp in seconds

Example Request

POST https://rental.software/api6/packinglists?apiKey=XXXX&rental_id=XXXX&lead_id=XXXX&plstatus_id=XXXX&loaded_qty=XXXX

Example Responses

Successful response example

200 OK

Content-Type: application/json

{

"request_time": 1694712498

}

Error response examples

403 Forbidden

Content-Type: application/json

{

"status": 403,

"message": "Permission access restricted. Packing List Statuses Access Required."

}

404 Not found

Content-Type: application/json

{

"status": 404,

"message": “… not found”

}

422 Unprocessable Content

Content-Type: application/json

{

"status": 422,

"message": "The lead id, item id, plstatus id, and loaded quantity are required."

}

<style>p { line-height: 115%; margin-bottom: 0.1in; background: transparent }a:link { color: #000080; text-decoration: underline }</style>
Is this article helpful?
0 0 0