request_inventory_export[source]

request_inventory_export(user:UserWithUserTokenBasedAuthentication)

Request an csv export for the given inventory.

User Authentication needed.

Parameters:

user: user object (required)

# Example for usage of request_inventory_export
request_inventory_export(user=example_user)

<Response [200]>

get_recent_inventory_exports[source]

get_recent_inventory_exports(user:UserWithUserTokenBasedAuthentication, page:Optional[int]=None, per_page:Optional[int]=None)

Get a list of all recent exports for the given inventory.

User Authentication needed.

Parameters:

user: user object (required)

page: number (optional) -> The page you want to request.

per_page: number (optional) -> The number of items per page.

# Example for usage of get_recent_inventory_exports
get_recent_inventory_exports(user=example_user, 
                             page=1, 
                             per_page=3)

<Response [200]>

get_inventory_export_details[source]

get_inventory_export_details(user:UserWithUserTokenBasedAuthentication, export_id:int)

Get details about the status of the given inventory export.

User Authentication needed.

Parameters:

user: user object (required)

export_id: number (required) -> Id of the export.

# Example for usage of get_inventory_export_details
get_inventory_export_details(user=example_user, 
                             export_id=838414)

<Response [200]>

download_inventory_export[source]

download_inventory_export(user:UserWithUserTokenBasedAuthentication, export_id:int)

Download an existing inventory export. The response will be a zipped csv file.

User Authentication needed.

Parameters:

user: user object (required)

export_id: number (required) -> Id of the export.

# Example for usage of download_inventory_export
download_inventory_export(user=example_user, export_id=838414)

<Response [200]>