Exporting Inventory Feeds
Onport allows you to generate a CSV file with all the variants from an inventory feed by making a specific API call.
The columns contained in the CSV document are:
- barcode
- compare_at_price
- handle
- name
- retail_price
- cost_price
- grams
- inventory_quantity
- product_type
- vendor_name
- vendor_sku
- description
- images
- tags
- option.name
- option.value
- metafields.name
- metafields.value
- inventory_feed.allocation_buffer
- variant.*
In order to request the CSV export generation, you can send a GET
request to https://api.jetti.io/api/inventory-feeds/:id/export.json
where :id is the id of the Inventory Feed.
curl --request GET \--url https://api.jetti.io/api/inventory-feeds/:id/export.json \--header 'Authorization: Bearer {{token}}' \--header 'Content-Type: application/json'
Onport will respond with the following JSON object:
{"displayName": "inventory_feed","read": false,"muteError": false,"id": <id>,"companyId": <companyId>,"userId": <userId>,"status": "pending","exportType": "inventory_feed","inventoryFeedId": <inventoryFeedId>,"updatedAt": "2021-07-12T16:03:02.372Z","createdAt": "2021-07-12T16:03:02.372Z","fileUri": null,"queuedAt": null,"startedAt": null,"completedAt": null,"inventoryExportId": null,"stockTakeId": null,"inventory_import_id": null,"intercomMessageId": null,"adminNotes": null,"dropshipProviderId": null,"templateId": null}
Bundles
If you are making use of bundles, you can also bundle details by passing in the ?includeBundles=true
query param into the GET
request above.
As the parent bundle (or bundle container) is unlikely to be attached to an inventory feed, it own line in the report. Instead, you'll be able to access the details on the parent bundle through the variant
headers. For example, bundle_variants.0.variant.sku
will contain a link to the parent SKU. It may be useful to take advantage of open source libraries for unfalttening the CSV content into a nested data structure (e.g. https://www.npmjs.com/package/flat)
An alternative to receiving exports as an email attachment is to poll Onport's API for Data Exports. More information is available via the article Polling the API for Data Exports
Exporting Connected Items
Onport also makes it possible to generate an export containing a mapping between variant SKUs set up in your channel(s) and the original/vendor SKUs from the inventory feeds.
The columns available in the document are:
- variant.sku
- vendor_sku
- original_sku
In order to request the generation of a Connected Items export, you can make the following API call:
curl --request GET \--url https://api.jetti.io/api/inventory-feeds/:id/export-connected-items.json \--header 'Authorization: Bearer {{token}}' \--header 'Content-Type: application/json'