Freshly Inventory API
The Freshly API lets your other systems, such as an ERP, WMS, or order management tool, read and update Freshly inventory batches and assign batches to order line items.
API access is in beta. To request access, email hello@getfreshly.io with your Shopify store URL and we'll turn it on for your store. API access is limited to paid plans.
API documentation
Full endpoint reference: https://developer.getfreshly.io/docs
Base URL: https://developer.getfreshly.io/api/shopify
Available endpoints:
| Resource | Endpoints |
|---|---|
| Shop | GET /shop |
| Inventory batches | GET /inventory_batches , GET /inventory_batches/:id , POST /inventory_batches , PUT /inventory_batches/:id , DELETE /inventory_batches/:id |
| Batch assignments on orders | GET /inventory_batch_order_items , POST /inventory_batch_order_items , DELETE /inventory_batch_order_items/:id |
Create an API key
- In Freshly, go to Preferences.
- In the API Key section, click Create API key.
- On the API keys page, click Create API key.
- Enter an API key name (for example, "My ERP integration") and click Create.
- Click Copy API key and store the key somewhere safe. Freshly only shows it once.
To revoke a key, go to the API keys page and click Delete next to it.
If you don't see the API Key section in Preferences, API access hasn't been turned on for your store yet. Email us to request it.
Authenticate requests
Send your API key in the Authorization header of every request:
curl https://developer.getfreshly.io/api/shopify/shop \ -H "Authorization: Bearer YOUR_API_KEY"
Requests without a valid key return 401 Unauthorized .
Questions and feedback
Email us at hello@getfreshly.io. We usually reply within 24 hours.