API Reference

List Inventory Units

post
https://ship.cars/api/inventory/v1/units

List inventory units with paging, sorting, and filtering

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean

Toggle show all columns

integer
≥ 1
Defaults to 1

Page number (1..N)

integer
≥ 1
Defaults to 50

The size of the page to be returned

sort
array of strings
Defaults to createdAt,desc

Sorting criteria in the format: property(,asc|desc). Multiple sort criteria are supported.

sort
Body Params
string

Advanced search to search by any term using 'TERM:VALUE'

pickupAddresses
array of objects
pickupAddresses
deliveryAddresses
array of objects
deliveryAddresses
customers
array of objects
customers
date-time
date-time
date-time
date-time
date
date
Responses

Updated 11 months ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago

Did this page help you?