CSV API Data Endpoint

It is possible to generate CSV reports programmatically using our CSV API endpoint.

This article assumes that you have already created an OAuth Client User with the "order-it.reporting" permission enabled.

This article assumes that you have already generated an OAuth access token with "scope=order-it.reporting".

Below is an example of a sample token request:

curl "https://oauth.custom-gateway.net/token" -d"client_id=***REDACTED***&client_secret=***REDACTED***&grant_type=client_credentials&scope=order-it.reporting" | jq .access_token -r 

The CSV reporting endpoint is located at:

1. https://oms.custom-gateway.net/v2/apis/misc/csv-reporting/:type/?period=:period
   

where :type and :period should be replaced depending on your requirements as per the following table.

Placeholder	Value	Description
:type	order-details
	order-summary
:period	last-day
	last-week
	last-month
	last-year
	this-month
	current-month
	previous-month

The endpoint should be called via a  GET request. It is necessary to include your OAuth access token using the Authorization header.

For example:

1. curl -H "Authorization: Bearer :accessToken" "https://oms.custom-gateway.net/v2/apis/misc/csv-reporting/order-details/?period=this-month"
   

Where :accessToken should be replaced with your OAuth access token.

• Related Articles

• CSV Order Import Breakdown

  The following article has been split out from the existing Generic FIlesystem article to show users how to use a CSV format to import textual orders into Order Manager found within the Sales module of the Kornit X Platform. For information on setting ...

• KornitX Platform Imports & Exports - ECommerce Data

  What Is eCommerce Data? Within the Kornit X Platform, your products can be set up with eCommerce data which can be downloaded within an export, updated with our import and generated in a feed to get products added to retailer sites and for many of ...

• Production Integration - Generic API

  Introduction The Generic API production integration pushes batch data and related order data, in JSON format, to an API endpoint.  The integration makes it easy for fulfillers with in-house developers, to ingest this data and produce jobs outside of ...

• Red Bubble API

  Red Bubble is an eCommerce artist portal that hosts millions of artwork designs by independent artists from all around the world. The artwork is available for purchase, on demand, printed on anything from clothing & apparel to home decor & ...

• Supplier Integration | Generic API

  Introduction The Order Push API from Kornit X is our generic Order Manager API allowing us to POST order data in JSON format (matching the structure of our standard orders in API) to an endpoint nominated by a supplier. This is a cheaper alternative ...