Overview
RyderShip API customers can access Inventory Snapshot CSVs via the /documents API endpoint.
The Inventory Snapshot is a daily summary of your inventory totals by location role or stock type (pickable, backstock, etc) for each warehouse where you have stock. It returns a URL, and you can download the CSV from there.
General requests & endpoint
Endpoint:
https://www.getwhiplash.com/api/v2/documents
This is available on v2.1 as well.
Example steps:
1. GET to https://www.getwhiplash.com/api/v2/documents?tagged_with=InventorySnapshot will return all your inventory snapshots that exist in RyderShip.
2. Grab the ID of the Inventory Snapshot you want and GET to request a specific snapshot, like: https://www.getwhiplash.com/api/v2/documents/{{document_id}}
To get the latest inventory snapshots, you can use: https://www.getwhiplash.com/api/v2/documents?tagged_with=InventorySnapshot&sort=created_at
desc
3. Grab the URL from the signed_url attribute to download the Inventory Snapshot CSV file.
"customer_name" : "ABC Apparel",
"partner_name" : "XYZ Logistics",
"user_name" : null,
"signed_url" : "https://example-inventory-snapshot-signed-url.com"
Note that the pre-signed URL is valid for one hour.
Related articles: