--- updatedAt: 2025-09-10T20:59:03.000Z agentTools: projectIndex: https://shipcars.readme.io/llms.txt --- # List Inventory Units List inventory units with paging, sorting, and filtering # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "User Management", "description": "Ship.Cars User Management", "contact": { "url": "https://ship.cars", "email": "support@ship.cars" }, "version": "1.0.0" }, "components": { "securitySchemes": { "bearerAuth": { "type": "oauth2", "flows": { "password": { "tokenUrl": "https://auth.ship.cars/auth/realms/master/protocol/openid-connect/token", "scopes": {} } } } } }, "servers": [ { "url": "https://ship.cars/api" } ], "paths": { "/inventory/v1/units": { "post": { "tags": [ "Inventory Units API" ], "summary": "List Inventory Units", "description": "List inventory units with paging, sorting, and filtering", "operationId": "listInventory", "parameters": [ { "name": "showAllColumns", "in": "query", "description": "Toggle show all columns", "required": false, "schema": { "type": "boolean" }, "example": false }, { "name": "page", "in": "query", "description": "Page number (1..N)", "schema": { "minimum": 1, "type": "integer", "default": 1 } }, { "name": "size", "in": "query", "description": "The size of the page to be returned", "schema": { "minimum": 1, "type": "integer", "default": 50 } }, { "name": "sort", "in": "query", "description": "Sorting criteria in the format: property(,asc|desc). Multiple sort criteria are supported.", "schema": { "type": "array", "items": { "type": "string" }, "default": [ "createdAt,desc" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "advanceSearch": { "type": "string", "description": "Advanced search to search by any term using 'TERM:VALUE'", "example": "year:1999" }, "pickupAddresses": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "YK41K" }, "address": { "type": "string", "description": "Street", "example": "161 W Cherry St" }, "city": { "type": "string", "example": "Albion" }, "state": { "type": "string", "example": "IL" }, "zip": { "type": "string", "example": "62806" } } } }, "deliveryAddresses": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "YK41K" }, "address": { "type": "string", "description": "Street", "example": "161 W Cherry St" }, "city": { "type": "string", "example": "Albion" }, "state": { "type": "string", "example": "IL" }, "zip": { "type": "string", "example": "62806" } } } }, "customers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "YK41K" }, "contact": { "type": "string", "example": "YK41K" }, "name": { "type": "string", "example": "Martin" }, "companyName": { "type": "string", "example": "MartinTLC" }, "phone": { "type": "string", "example": "1234567890" } } } }, "createdAfter": { "type": "string", "format": "date-time", "example": "2022-05-13T13:46:44.627Z" }, "createdBefore": { "type": "string", "format": "date-time", "example": "2022-05-13T13:46:44.627Z" }, "modifiedAfter": { "type": "string", "format": "date-time", "example": "2022-05-13T13:46:44.627Z" }, "modifiedBefore": { "type": "string", "format": "date-time", "example": "2022-05-13T13:46:44.627Z" }, "shippingDateAfter": { "type": "string", "format": "date" }, "shippingDateBefore": { "type": "string", "format": "date" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "totalPages": { "type": "integer", "format": "int32" }, "totalElements": { "type": "integer", "format": "int64" }, "page": { "type": "integer", "format": "int32" }, "size": { "type": "integer", "format": "int32" }, "content": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "YK41K" }, "loadId": { "type": "string", "example": "CS12345" }, "status": { "type": "string", "enum": [ "UNIT_NEW", "UNIT_ON_HOLD", "UNIT_ADDED_TO_LOAD" ] }, "externalId": { "type": "string", "example": "CS12345" }, "shippingDate": { "type": "string", "description": "Shipping date in yyyy-MM-dd format", "format": "date", "example": "2022-03-20" }, "vin": { "type": "string", "example": "1D4GP24R85B225747" }, "year": { "type": "integer", "format": "int32", "example": 2022 }, "make": { "type": "string", "example": "BMW" }, "model": { "type": "string", "example": "218i" }, "vehicleType": { "type": "string", "example": "Car" }, "buyerNumber": { "type": "string", "example": "123CXS23" }, "lotNumber": { "type": "string", "example": "123CXS23" }, "stockNumber": { "type": "string", "example": "123CXS23" }, "operableType": { "type": "string", "example": "OPERABLE", "enum": [ "OPERABLE", "INOPERABLE" ] }, "trailerType": { "type": "string", "example": "OPEN", "enum": [ "OPEN", "ENCLOSED" ] }, "cpay": { "type": "number", "description": "Carrier pay", "format": "float", "example": 132.1 }, "rate": { "type": "number", "description": "Vehicle rate", "format": "float", "example": 132.55 }, "pickupContact": { "type": "string", "description": "Name from the Contact Book for pickup contact", "example": "Dealer Office" }, "pickupName": { "type": "string", "example": "Martin" }, "pickupCompanyName": { "type": "string", "example": "MartinTLC" }, "pickupPhone": { "type": "string", "example": "5551047890" }, "pickupAddress": { "type": "string", "description": "Street", "example": "161 W Cherry St" }, "pickupCity": { "type": "string", "example": "Albion" }, "pickupState": { "type": "string", "example": "IL" }, "pickupZip": { "type": "string", "example": "62806" }, "deliveryContact": { "type": "string", "description": "Name from the Contact Book for delivery contact", "example": "Dealer Office" }, "deliveryName": { "type": "string", "example": "Martin" }, "deliveryCompanyName": { "type": "string", "example": "MartinTLC" }, "deliveryPhone": { "type": "string", "example": "5553047890" }, "deliveryAddress": { "type": "string", "description": "Street", "example": "161 W Cherry St" }, "deliveryCity": { "type": "string", "example": "Albion" }, "deliveryState": { "type": "string", "example": "IL" }, "deliveryZip": { "type": "string", "example": "62806" }, "customerContact": { "type": "string", "description": "Name from the Contact Book for customer contact", "example": "Dealer Office" }, "customerName": { "type": "string", "example": "Martin" }, "customerCompanyName": { "type": "string", "example": "MartinTLC" }, "customerPhone": { "type": "string", "example": "5551047890" }, "dispatchInstructions": { "type": "string", "example": "Please pick up the car gently." }, "gatePassUri": { "maxLength": 2048, "type": "string", "example": "https://url.com/gatepass.pdf" }, "gatePassDownloadStatus": { "type": "string", "enum": [ "DOWNLOAD_PENDING", "DOWNLOAD_EMPTY_TARGET_URL", "DOWNLOAD_INVALID_TARGET_URL", "DOWNLOAD_IN_PROGRESS", "DOWNLOAD_COMPLETED", "DOWNLOAD_FAILED" ] }, "modifiedAt": { "type": "string", "description": "Date of last modification", "format": "date-time", "example": "2022-05-13T13:46:44.627Z" }, "createdAt": { "type": "string", "description": "Date of creation", "format": "date-time", "example": "2022-05-13T13:46:44.627Z" } } } }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "hasPrevious": { "type": "boolean" }, "hasNext": { "type": "boolean" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time" }, "httpStatus": { "type": "integer", "format": "int32" }, "errorCode": { "type": "integer", "format": "int32" }, "errorMessage": { "type": "string" }, "errorDetails": { "type": "array", "items": { "type": "string" } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time" }, "httpStatus": { "type": "integer", "format": "int32" }, "errorCode": { "type": "integer", "format": "int32" }, "errorMessage": { "type": "string" }, "errorDetails": { "type": "array", "items": { "type": "string" } } } } } } } }, "security": [ { "bearerAuth": [] } ] } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ```