FileStorage
This service provides functionality to manage assets and generate pdf. You can upload the assets, get the cdn link for the assets, proxy the assets and many more things.
Browse files by fetching all files in a directory based on the provided namespace, query, and request body parameters. It determines the directory path, retrieves paginated files accordingly, and serializes the response for further processing. This method optimizes directory browsing functionality within the system.
Operations
GET
# Application browse files.
POST
# Browse Files
Parameters
namespace
string
Required
Segregation of different types of files(products, orders, logistics etc), Required for validating the data of the file being uploaded, decides where exactly the file will be stored inside the storage bucket.
company_id
integer
Required
Unique numeric identifier for the company.
application_id
string
Required
Unique identifier for the application.
page
integer
page no
limit
integer
Limit
search
string
Search
Response
200
400
Success
Properties
items
array of object
Array of Properties
_id
string
file_name
string
file_path
string
success
boolean
namespace
string
content_type
string
size
number
operation
string
tags
array of string
cdn
object
Properties
url
string
upload
object
Properties
url
string
expiry
number
created_by
object
Properties
username
string
user_id
string
company_id
number
bucket_key
string
created_at
string
updated_at
string
__v
number
page
object
Properties
item_total
integer
| int32
next_id
string
has_previous
boolean
has_next
boolean
current
integer
| int32
type
string
size
integer
| int32
Examples
Parameters
namespace:
"test"
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
page:
1
limit:
1
search:
"test"
Was this section helpful?
GET
Response
Parameters
namespace
string
Required
Segregation of different types of files(products, orders, logistics etc), Required for validating the data of the file being uploaded, decides where exactly the file will be stored inside the storage bucket.
company_id
integer
Required
Unique numeric identifier for the company.
application_id
string
Required
Unique identifier for the application.
page
integer
page no
limit
integer
Limit
search
string
Search
Request body
extension_slug
string
A unique slug identifier for the extension.
Response
200
400
Success
Properties
items
array of object
Array of Properties
_id
string
file_name
string
file_path
string
success
boolean
namespace
string
content_type
string
size
number
operation
string
tags
array of string
cdn
object
Properties
url
string
upload
object
Properties
url
string
expiry
number
created_by
object
Properties
username
string
user_id
string
company_id
number
bucket_key
string
created_at
string
updated_at
string
__v
number
page
object
Properties
item_total
integer
| int32
next_id
string
has_previous
boolean
has_next
boolean
current
integer
| int32
type
string
size
integer
| int32
Examples
Parameters
namespace:
"test"
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
page:
1
limit:
1
search:
"test"
body:
body
Was this section helpful?
POST
Response
Enable seamless file management within application and across external sources. It copy files, ensuring data replication and backup for various purposes. Additionally, browse, navigate, and utilize proxy functionality for interacting with files and performing operations on them within the platform
Operations
POST
# Application copy files.
Parameters
sync
boolean
sync
company_id
integer
Required
Unique numeric identifier for the company.
application_id
string
Required
Unique identifier for the application.
Request body
urls
array of string
List of URLs of files to be copied.
destination
object (DestinationNamespace)
Required
DestinationNamespace
namespace
string
The target namespace for copied files.
Response
200
400
Success
Properties
tracking_url
string
The URL to track the status of the copy-files task.
task
object
Details about the task being performed.
Properties
id
string
A string representing the unique identifier of the task.
name
string
A string representing the name of the task.
data
object
An object that includes urls, destination.
Properties
urls
array of string
An array of strings, each representing a URL of a file.
destination
object
The destination details for the copied files.
Properties
namespace
string
This is defining namespace.
basepath
string
The base path in the destination where files will be stored.
opts
object
Options for task execution.
Properties
attempts
number
The number of attempts to try the task.
backoff
object
The backoff strategy for retrying the task.
Properties
type
string
The type of backoff strategy.
delay
number
The delay between retries in milliseconds.
delay
number
The delay before starting the task, in milliseconds.
timestamp
number
The timestamp when the task was created.
progress
number
The current progress of the task, as a percentage.
delay
number
The delay before starting the task, in milliseconds.
timestamp
number
The timestamp when the task was created.
attemptsMade
number
The number of attempts that have been made to complete the task.
returnvalue
string
Nullable
The return value of the task upon completion.
finishedOn
string
Nullable
The timestamp when the task was finished.
processedOn
string
Nullable
The timestamp when the task started processing.
stacktrace
array of object
This is defining the The stack trace.
Examples
Parameters
company_id:
2
body:
body
Was this section helpful?
POST
Response
File upload is a feature that enables users to upload files from their device to a designated storage location in the system. The process of uploading begins by validating user parameters and organizing files into different groups based on their type using something called a "namespace". This helps in storing the files into Public and Private buckets Private - The files stored in private bucket is accessible via getSignedUrl method for a temporary duration. Public - The files stored in public bucket is accessible via cdn url Customer initiate the upload process by selecting from pre-existing images, choosing from your device, uploading via URL, or entering an image URL. 1. Start Upload - Once seller calls start upload will receive a signed URL to initiate the upload process. 2. Utilize a Google Cloud Platform (GCP) method to upload the file through the obtained signed URL. 3. Complete File upload - Important file details such as name, size, content type, and namespace are collected and linked to maintain data integrity within the system's database. Once you upload a file, you receive a message with all the details about where your file is stored, including a secure URL for uploading files to the designated storage and a CDN (Content Delivery Network) URL for future accessibility. Furthermore, the system sets an expiration time for access links(signed Url) enhancing security measures.
Operations
POST
# Application start upload.
POST
# Application complete upload.
Start uploading a file from an application and returns a storage link in response.
Parameters
namespace
string
Required
Segregation of different types of files(products, orders, logistics etc), Required for validating the data of the file being uploaded, decides where exactly the file will be stored inside the storage bucket.
company_id
integer
Required
Unique numeric identifier for the company.
application_id
string
Required
Unique identifier for the application.
Request body
file_name
string
Required
The name of the file to be uploaded.
content_type
string
Required
The MIME type of the file.
size
integer
Required
The file size in bytes.
tags
array of string
Tags associated with the file.
params
object
Additional parameters for file upload.
Response
200
400
Success. Returns a response containing relaving and absolute_url of storage service
FileUpload
file_name
string
The name of the uploaded file.
file_path
string
The storage path of the uploaded file.
content_type
string
The MIME type of the file.
method
string
The HTTP method used for uploading the file.
namespace
string
The namespace under which the file is stored.
operation
string
The operation type related to the file upload.
size
integer
The size of the file in bytes.
upload
object (Upload)
Upload
expiry
integer
The time in milliseconds before the signed URL expires.
url
string
The signed URL for uploading a file.
tags
array of string
A list of tags associated with the file.
Examples
Parameters
namespace:
"test"
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
Response
Parameters
namespace
string
Required
Segregation of different types of files(products, orders, logistics etc), Required for validating the data of the file being uploaded, decides where exactly the file will be stored inside the storage bucket.
company_id
integer
Required
Unique numeric identifier for the company.
application_id
string
Required
Unique identifier for the application.
Request body
file_name
string
Required
The name of the uploaded file.
file_path
string
Required
The storage path of the uploaded file.
content_type
string
Required
The MIME type of the file.
method
string
The HTTP method used for uploading the file.
namespace
string
Required
The namespace under which the file is stored.
operation
string
Required
The operation type related to the file upload.
size
integer
Required
The size of the file in bytes.
upload
object (Upload)
Required
Upload
expiry
integer
Required
The time in milliseconds before the signed URL expires.
url
string
Required
The signed URL for uploading a file.
tags
array of string
A list of tags associated with the file.
Response
200
400
Success
FileUploadComplete
_id
string
The unique identifier of the uploaded file.
file_name
string
The name of the uploaded file.
file_path
string
The storage path of the file.
content_type
string
The MIME type of the file.
namespace
string
The namespace where the file is stored.
operation
string
The operation performed on the file.
company_id
number
The ID of the company associated with the file.
size
integer
The file size in bytes.
upload
object (Upload)
Upload
expiry
integer
The time in milliseconds before the signed URL expires.
url
string
The signed URL for uploading a file.
cdn
object (CDN)
CDN
url
string
The full URL to access the file via the CDN.
absolute_url
string
The absolute URL of the file stored in the CDN.
relative_url
string
The relative path to the file within the CDN.
success
boolean
Indicates if the file upload was successful.
tags
array of string
Tags associated with the file.
created_on
string
| date-time
The timestamp when the file was created.
modified_on
string
| date-time
The timestamp when the file was last modified.
created_by
object (CreatedBy)
CreatedBy
username
string
The username of the creator.
user_id
string
The unique identifier of the user.
Examples
Parameters
namespace:
"test"
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
Response
Manage and customize PDF and HTML templates. Access various PDF types, retrieve default PDF data, obtain default HTML templates, save custom HTML templates, preview templates, and access the default PDF template.
Operations
GET
# Get all the supported invoice pdf types
GET
# Get the pdf types of by id
GET
# Get default PDF data.
GET
# Get default PDF data.
GET
# Update html template for invoice or label
PUT
# Update HTML Template
DEL
# Delete a PDF generator configuration
GET
# Get html template for sales channel
POST
# Save HTML template.
GET
# Get default PDF template.
POST
# Generate payment receipt.
GET
# get default html template for invoice or label
Get all the supported invoice pdf types such as Invoice, Label, Delivery challan
Parameters
company_id
integer
Required
Unique numeric identifier for the company.
application_id
string
Required
Unique identifier for the application.
country_code
string
Country code used to filter data displayed on the UI.
store_os
boolean
Required
Identifies whether the store OS determines the PDF generator flow displayed on the UI.
Response
200
Get all the invoice types and its format
InvoiceTypes
data
array of object (InvoiceTypesData)
A list of invoice types.
Array of InvoiceTypesData
status
boolean
Indicates the status of the invoice type.
_id
string
The unique identifier of the invoice type.
pdf_type_id
integer
| int32
The ID associated with the PDF type.
name
string
The name of the invoice type.
format
array of string
The supported document formats (e.g., A4, A6, POS).
__v
integer
Version number of the document.
visibility
boolean
Indicates if the invoice type is visible.
store_os
boolean
Specifies whether the invoice type is store-OS enabled.
country_code
string
The ISO country code associated with the invoice type.
success
boolean
Indicates if the request was successful.
Examples
Parameters
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
country_code:
"IN"
Was this section helpful?
GET
Response
Parameters
company_id
integer
Required
Unique numeric identifier for the company.
application_id
string
Required
Unique identifier for the application.
id
string
Required
Unique identifier for the PDF type.
Response
200
Get Pdf types successfully for given id.
PdfTypeByIdDetails
store_os
boolean
A flag indicating if the PDF type is linked to the store operating system.
country_code
string
The ISO code representing the country.
pdf_type_id
integer
The unique identifier for the PDF type.
__v
integer
The version number of the document.
_id
string
The unique document identifier.
format
array of string
A list of formats applicable for this PDF type.
name
string
The name of the PDF type.
visibility
boolean
Indicates whether the PDF type is visible.
Examples
Parameters
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
id:
"65ca228e6b701f6e108ba690"
Was this section helpful?
GET
Response
Parameters
company_id
integer
Required
Unique numeric identifier for the company.
application_id
string
Required
Unique identifier for the application.
pdf_type_id
integer
Required
Unique identifier for the invoice type.
country_code
string
Country code used to filter data displayed on the UI.
Response
200
Get dummy json data for invoice
PdfDataItemsDetails
data
array of object (DummyTemplateData)
List of PDF payload data.
Array of DummyTemplateData
_id
string
Unique identifier for the PDF payload.
pdf_type_id
number
Unique identifier for the invoice.
payload
object (PdfPayloadDetails)
PdfPayloadDetails
is_export
boolean
Indicates if the shipment is an export.
is_export_shipment
boolean
Indicates if the shipment is specifically meant for export.
app_domain_name
string
The domain name associated with the app processing the invoice.
txn_id
string
The unique transaction ID related to the order.
utr
string
The Unique Transaction Reference (UTR) for payment processing.
po_number
string
The purchase order number for the transaction.
credit_note_id
string
Nullable
The credit note ID associated with the order, if applicable.
current_date
string
| date-time
The current date when the invoice is generated.
total_value_of_goods
number
The total value of goods in the order.
b2b_buyer_details
object
Contains details about the business-to-business (B2B) buyer.
is_qwik
object
Metadata related to quick (Qwik) shipments.
order_type
string
The type of order, e.g., B2B, B2C.
conversion_rate
object (ConversionRate)
ConversionRate
base
string
The base currency code.
rates
object
A key-value map of currency rates.
timestamp
number
The timestamp when the rates were fetched.
currency_code
string
The currency code used for the transaction.
shipment_id
string
The unique identifier of the shipment.
delivery_partner_detail
object (DeliveryPartnerDetail)
DeliveryPartnerDetail
name
string
The name of the delivery partner.
awb_number_barcode
string
The barcode for the AWB (Airway Bill) number.
awb_number
string
The AWB number for tracking.
origin
string
The origin location of the shipment.
destination
string
The destination location of the shipment.
eway_bill_number
string
Nullable
The e-way bill number, if applicable.
image
object (Image)
Image
sales_channel_logo
string
URL of the sales channel logo.
payments
array of object (PaymentData)
A list of payment details associated with the transaction.
Array of PaymentData
payment_type
string
Type of payment method used.
amount
number
Amount of the transaction.
date
string
Date of the transaction.
transaction_id
string
Unique identifier for the transaction.
time
string
Time of the transaction.
mode
string
Mode of payment (e.g., credit card, UPI, net banking).
name
string
Name associated with the payment method.
meta
object
Additional metadata related to the payment.
invoice_detail
object (InvoiceDetail)
InvoiceDetail
invoice_id
string
Unique identifier for the invoice.
invoice_date
string
| date-time
Date when the invoice was generated.
irn
string
Invoice Reference Number (if applicable).
external_order_id
string
External order ID associated with the invoice.
shipment_id
string
Identifier for the shipment linked to this invoice.
signed_qrcode
string
Signed QR code for the invoice.
upi_qrcode
string
UPI QR code for payment processing.
device_id
string
Identifier for the device used to generate the invoice.
marketplace_invoice_id
string
Invoice ID assigned by the marketplace.
marketplace_shipment_id
string
Shipment ID assigned by the marketplace.
channel_order_id
string
Order ID assigned by the sales channel.
company_detail
object (CompanyDetail)
CompanyDetail
name
string
The official name of the company.
address
string
The physical street address of the company.
city
string
The city where the company is located.
state
string
The state or province where the company is located.
country
string
The country where the company is based.
zip_code
number
The postal code for the company's location.
state_code
string
A code representing the state, often used in official documents and forms.
country_code
string
The country code.
gstin
string
Nullable
The Goods and Services Tax Identification Number, unique to each business in India.
pan
string
Nullable
The Permanent Account Number, unique to each taxpayer in India.
phone_no
string
Nullable
The primary contact phone number for the company.
cin
string
The Corporate Identification Number, unique to each company registered in India.
website_url
string
The URL to the company's official website.
email
string
The company's official email address.
display_address
string
The display address of the company.
sector
string
The sector in which the company operates.
phone
object
The provided phone number associated with the company.
trn
string
The Tax Registration Number (TRN) of the company.
vat
string
The Value Added Tax (VAT) number of the company.
business_country_timezone
string
The business country’s timezone.
business_country_currency
object
Represents the business country currency details.
meta
object
Additional metadata related to the company.
store_detail
object (StoreDetail)
StoreDetail
store_name
string
Name of the store
address
string
Full address of the store
city
string
City where the store is located
state
string
State where the store is located
country
string
Country where the store is located
country_code
string
Country code of the store's location
zip_code
string
ZIP or postal code of the store's location
state_code
string
State code where the store is located
gstin
string
Nullable
GSTIN number for the store
display_address
string
Formatted display address of the store
sector
string
Sector or industry category of the store
store_id
string
Unique identifier for the store
customer_billing_detail
object (CustomerBillingDetail)
CustomerBillingDetail
name
string
Name of the customer
phone_no
string
Phone number of the customer
address
string
Billing address of the customer
city
string
City of the customer's billing address
state
string
State of the customer's billing address
country
string
Country of the customer's billing address
country_code
string
Country code of the billing address
zip_code
string
ZIP or postal code of the billing address
state_code
string
State code of the billing address
gstin
string
Nullable
GSTIN number of the customer
display_address
string
Formatted display address of the customer
sector
string
Sector or industry related to the customer
email
string
Email address of the customer
customer_shipping_detail
object (CustomerShippingDetail)
CustomerShippingDetail
name
string
Name of the recipient
phone_no
string
Phone number of the recipient
address
string
Shipping address of the customer
city
string
City of the shipping address
state
string
State of the shipping address
country
string
Country of the shipping address
country_code
string
Country code of the shipping address
zip_code
string
ZIP or postal code of the shipping address
state_code
string
State code of the shipping address
gstin
string
Nullable
GSTIN number related to the shipping details
display_address
string
Formatted display address of the recipient
sector
string
Sector or industry related to the shipping details
return_detail
object (ReturnDetail)
ReturnDetail
address
string
Return address
city
string
City of the return address
state
string
State of the return address
country
string
Country of the return address
country_code
string
Nullable
Country code of the return address
zip_code
string
ZIP or postal code of the return address
state_code
string
State code of the return address
gstin
string
Nullable
GSTIN number related to the return details
display_address
string
Formatted display address of the return location
sector
string
Sector or industry related to the return details
product_table
object (ProductTable)
ProductTable
total_items
number
The total number of different products in the order.
products
array of object (ItemsProductTable)
A list of products included in the order.
Array of ItemsProductTable
name
string
The name of the product.
seller_identifier
string
A unique identifier assigned to the seller for this product.
total
number
The total price of the product including all applicable charges.
brand
object (Brand)
Brand
logo
string
URL of the brand logo
name
string
Name of the brand
hsn_code
string
The Harmonized System Nomenclature (HSN) code used for tax classification.
item_code
string
The unique item code assigned to the product.
total_units
number
The total number of units purchased for this product.
size
string
The size variant of the product.
mrp
number
The Maximum Retail Price (MRP) of the product.
discount
number
The discount applied to the product.
taxable_amount
number
The amount on which tax is calculated.
total_taxable_amount
number
The total taxable amount including all units of the product.
tax
object (Tax)
Tax
cgst
object (Cgst)
Cgst
value
number
CGST value
percent
number
CGST percentage
sgst
object (Sgst)
Sgst
value
number
SGST value
percent
number
SGST percentage
igst
object (Igst)
Igst
value
number
IGST value
percent
number
IGST percentage
meta
object
Additional metadata related to the product.
country_of_origin
string
The country where the product was manufactured.
grand_total
number
The final amount to be paid including all charges and discounts.
delivery_charges
number
The charges applicable for delivery of the order.
delivery_charge_text
string
A descriptive text about the delivery charges.
cod_charges
number
The additional charges for Cash on Delivery (COD) payments.
fynd_discounts
number
Discounts applied by Fynd.
total_in_words
string
The grand total amount represented in words.
gift_price
number
The price of any gift items included in the order.
total_quantity
number
The total quantity of all products in the order.
sub_total
number
The subtotal amount before additional charges.
discount
number
The total discount applied to the order.
promotion
number
The promotional discount applied to the order.
coupon
number
The coupon discount applied to the order.
reward
number
The reward-based discount applied to the order.
round_off
number
The rounding off value added or subtracted to finalize the total amount.
total_value_of_goods
number
The total value of all products before applying taxes and discounts.
tax_table
object (TaxTable)
TaxTable
taxes
array of object (Taxes)
A list of tax details applied to different items.
Array of Taxes
hsn_code
string
The HSN code associated with the product for tax purposes.
tax
object (Tax)
Tax
cgst
object (Cgst)
Cgst
value
number
CGST value
percent
number
CGST percentage
sgst
object (Sgst)
Sgst
value
number
SGST value
percent
number
SGST percentage
igst
object (Igst)
Igst
value
number
IGST value
percent
number
IGST percentage
total_tax_value
number
The total tax value calculated for the item.
total_tax
number
The total tax amount for the entire order.
tax_in_words
string
The total tax amount represented in words.
declaration_texts
array of string
A list of declaration statements associated with the invoice.
registered_company_detail
object (RegisteredCompanyDetail)
RegisteredCompanyDetail
address
string
The complete address of the company.
city
string
The city where the company is located.
state
string
The state where the company is registered.
country
string
The country where the company operates.
country_code
string
The country code of the registered company.
zip_code
number
The postal/zip code of the company’s location.
state_code
string
The state code for taxation purposes.
display_address
string
The formatted display address of the company.
sector
string
The industry sector the company belongs to.
disclaimer
string
A disclaimer statement included in the invoice.
meta
object (Meta)
Meta
generator
object (MetaProperty)
MetaProperty
shipment_id_barcode_generator
object (ShipmentIdBarcodeGenerator)
ShipmentIdBarcodeGenerator
method
string
The method used to generate the barcode.
kwargs
object (Kwargs)
Kwargs
value
string
The value associated with the keyword argument.
signed_qrcode_generator
object (SignedQrcodeGenerator)
SignedQrcodeGenerator
method
string
The method used to generate the QR code.
kwargs
object (Kwargs)
Kwargs
value
string
The value associated with the keyword argument.
upi_qrcode_generator
object (UpiQrcodeGenerator)
UpiQrcodeGenerator
method
string
The method used to generate the UPI QR code.
kwargs
object (KwargsUpiQrcode)
KwargsUpiQrcode
qr_data
string
The data encoded in the QR code.
qr_url
string
The URL associated with the QR code.
digitalsignature_generator
object (DigitalsignatureGenerator)
DigitalsignatureGenerator
method
string
The method used to generate the digital signature.
kwargs
object (Kwargs)
Kwargs
value
string
The value associated with the keyword argument.
awb_number_label_barcode_generator
object (AwbNumberLabelBarcodeGenerator)
AwbNumberLabelBarcodeGenerator
method
string
The method used to generate the AWB number label barcode.
kwargs
object (KwargsAwbNumber)
KwargsAwbNumber
value
array of object
A list of objects containing AWB number details.
awb_number_barcode_generator
object (AwbNumberBarcodeGenerator)
AwbNumberBarcodeGenerator
method
string
The method used to generate the AWB number barcode.
kwargs
object (Kwargs)
Kwargs
value
string
The value associated with the keyword argument.
is_self_ship
boolean
Indicates whether the shipment is self-shipped by the seller.
mode
string
The mode of shipping, e.g., air, ground, sea.
is_self_pickup
boolean
Indicates whether the order is picked up by the customer.
platform_name
string
The platform name where the order was placed.
amount_to_be_collected
number
The total amount to be collected from the customer.
amount_paid
number
The total amount paid by the customer.
waybills
array of object
A list of waybills associated with the shipment.
total_items
number
The total number of items in the order.
brand_logo
string
The URL of the brand logo associated with the invoice.
shipment_id_barcode
string
The barcode associated with the shipment ID.
signed_qrcode
string
The signed QR code used for authentication or verification.
upi_qrcode
string
The UPI QR code for payment processing.
digitalsignature
string
The digital signature associated with the document.
awb_number_barcode
string
The barcode generated for the AWB number.
uid
string
The unique identifier associated with the invoice or shipment.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
country_code
string
Country code associated with the payload.
__v
integer
Version number of the document.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
success
boolean
Indicates whether the operation was successful.
Examples
Parameters
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
pdf_type_id:
1
country_code:
"IN"
Was this section helpful?
GET
Response
Parameters
company_id
integer
Required
Unique numeric identifier for the company.
application_id
string
Required
Unique identifier for the application.
id
string
Required
Unique identifier associated with the PDF payload, used for retrieving or processing PDF-related data.
Response
200
Get dummy json data for invoice
MapperDetails
_id
string
Unique identifier for the mapping entry.
pdf_type_id
number
Identifier for the type of PDF.
payload
object (PdfPayloadDetails)
PdfPayloadDetails
is_export
boolean
Indicates if the shipment is an export.
is_export_shipment
boolean
Indicates if the shipment is specifically meant for export.
app_domain_name
string
The domain name associated with the app processing the invoice.
txn_id
string
The unique transaction ID related to the order.
utr
string
The Unique Transaction Reference (UTR) for payment processing.
po_number
string
The purchase order number for the transaction.
credit_note_id
string
Nullable
The credit note ID associated with the order, if applicable.
current_date
string
| date-time
The current date when the invoice is generated.
total_value_of_goods
number
The total value of goods in the order.
b2b_buyer_details
object
Contains details about the business-to-business (B2B) buyer.
is_qwik
object
Metadata related to quick (Qwik) shipments.
order_type
string
The type of order, e.g., B2B, B2C.
conversion_rate
object (ConversionRate)
ConversionRate
base
string
The base currency code.
rates
object
A key-value map of currency rates.
timestamp
number
The timestamp when the rates were fetched.
currency_code
string
The currency code used for the transaction.
shipment_id
string
The unique identifier of the shipment.
delivery_partner_detail
object (DeliveryPartnerDetail)
DeliveryPartnerDetail
name
string
The name of the delivery partner.
awb_number_barcode
string
The barcode for the AWB (Airway Bill) number.
awb_number
string
The AWB number for tracking.
origin
string
The origin location of the shipment.
destination
string
The destination location of the shipment.
eway_bill_number
string
Nullable
The e-way bill number, if applicable.
image
object (Image)
Image
sales_channel_logo
string
URL of the sales channel logo.
payments
array of object (PaymentData)
A list of payment details associated with the transaction.
Array of PaymentData
payment_type
string
Type of payment method used.
amount
number
Amount of the transaction.
date
string
Date of the transaction.
transaction_id
string
Unique identifier for the transaction.
time
string
Time of the transaction.
mode
string
Mode of payment (e.g., credit card, UPI, net banking).
name
string
Name associated with the payment method.
meta
object
Additional metadata related to the payment.
invoice_detail
object (InvoiceDetail)
InvoiceDetail
invoice_id
string
Unique identifier for the invoice.
invoice_date
string
| date-time
Date when the invoice was generated.
irn
string
Invoice Reference Number (if applicable).
external_order_id
string
External order ID associated with the invoice.
shipment_id
string
Identifier for the shipment linked to this invoice.
signed_qrcode
string
Signed QR code for the invoice.
upi_qrcode
string
UPI QR code for payment processing.
device_id
string
Identifier for the device used to generate the invoice.
marketplace_invoice_id
string
Invoice ID assigned by the marketplace.
marketplace_shipment_id
string
Shipment ID assigned by the marketplace.
channel_order_id
string
Order ID assigned by the sales channel.
company_detail
object (CompanyDetail)
CompanyDetail
name
string
The official name of the company.
address
string
The physical street address of the company.
city
string
The city where the company is located.
state
string
The state or province where the company is located.
country
string
The country where the company is based.
zip_code
number
The postal code for the company's location.
state_code
string
A code representing the state, often used in official documents and forms.
country_code
string
The country code.
gstin
string
Nullable
The Goods and Services Tax Identification Number, unique to each business in India.
pan
string
Nullable
The Permanent Account Number, unique to each taxpayer in India.
phone_no
string
Nullable
The primary contact phone number for the company.
cin
string
The Corporate Identification Number, unique to each company registered in India.
website_url
string
The URL to the company's official website.
email
string
The company's official email address.
display_address
string
The display address of the company.
sector
string
The sector in which the company operates.
phone
object
The provided phone number associated with the company.
trn
string
The Tax Registration Number (TRN) of the company.
vat
string
The Value Added Tax (VAT) number of the company.
business_country_timezone
string
The business country’s timezone.
business_country_currency
object
Represents the business country currency details.
meta
object
Additional metadata related to the company.
store_detail
object (StoreDetail)
StoreDetail
store_name
string
Name of the store
address
string
Full address of the store
city
string
City where the store is located
state
string
State where the store is located
country
string
Country where the store is located
country_code
string
Country code of the store's location
zip_code
string
ZIP or postal code of the store's location
state_code
string
State code where the store is located
gstin
string
Nullable
GSTIN number for the store
display_address
string
Formatted display address of the store
sector
string
Sector or industry category of the store
store_id
string
Unique identifier for the store
customer_billing_detail
object (CustomerBillingDetail)
CustomerBillingDetail
name
string
Name of the customer
phone_no
string
Phone number of the customer
address
string
Billing address of the customer
city
string
City of the customer's billing address
state
string
State of the customer's billing address
country
string
Country of the customer's billing address
country_code
string
Country code of the billing address
zip_code
string
ZIP or postal code of the billing address
state_code
string
State code of the billing address
gstin
string
Nullable
GSTIN number of the customer
display_address
string
Formatted display address of the customer
sector
string
Sector or industry related to the customer
email
string
Email address of the customer
customer_shipping_detail
object (CustomerShippingDetail)
CustomerShippingDetail
name
string
Name of the recipient
phone_no
string
Phone number of the recipient
address
string
Shipping address of the customer
city
string
City of the shipping address
state
string
State of the shipping address
country
string
Country of the shipping address
country_code
string
Country code of the shipping address
zip_code
string
ZIP or postal code of the shipping address
state_code
string
State code of the shipping address
gstin
string
Nullable
GSTIN number related to the shipping details
display_address
string
Formatted display address of the recipient
sector
string
Sector or industry related to the shipping details
return_detail
object (ReturnDetail)
ReturnDetail
address
string
Return address
city
string
City of the return address
state
string
State of the return address
country
string
Country of the return address
country_code
string
Nullable
Country code of the return address
zip_code
string
ZIP or postal code of the return address
state_code
string
State code of the return address
gstin
string
Nullable
GSTIN number related to the return details
display_address
string
Formatted display address of the return location
sector
string
Sector or industry related to the return details
product_table
object (ProductTable)
ProductTable
total_items
number
The total number of different products in the order.
products
array of object (ItemsProductTable)
A list of products included in the order.
Array of ItemsProductTable
name
string
The name of the product.
seller_identifier
string
A unique identifier assigned to the seller for this product.
total
number
The total price of the product including all applicable charges.
brand
object (Brand)
Brand
logo
string
URL of the brand logo
name
string
Name of the brand
hsn_code
string
The Harmonized System Nomenclature (HSN) code used for tax classification.
item_code
string
The unique item code assigned to the product.
total_units
number
The total number of units purchased for this product.
size
string
The size variant of the product.
mrp
number
The Maximum Retail Price (MRP) of the product.
discount
number
The discount applied to the product.
taxable_amount
number
The amount on which tax is calculated.
total_taxable_amount
number
The total taxable amount including all units of the product.
tax
object (Tax)
Tax
cgst
object (Cgst)
Cgst
value
number
CGST value
percent
number
CGST percentage
sgst
object (Sgst)
Sgst
value
number
SGST value
percent
number
SGST percentage
igst
object (Igst)
Igst
value
number
IGST value
percent
number
IGST percentage
meta
object
Additional metadata related to the product.
country_of_origin
string
The country where the product was manufactured.
grand_total
number
The final amount to be paid including all charges and discounts.
delivery_charges
number
The charges applicable for delivery of the order.
delivery_charge_text
string
A descriptive text about the delivery charges.
cod_charges
number
The additional charges for Cash on Delivery (COD) payments.
fynd_discounts
number
Discounts applied by Fynd.
total_in_words
string
The grand total amount represented in words.
gift_price
number
The price of any gift items included in the order.
total_quantity
number
The total quantity of all products in the order.
sub_total
number
The subtotal amount before additional charges.
discount
number
The total discount applied to the order.
promotion
number
The promotional discount applied to the order.
coupon
number
The coupon discount applied to the order.
reward
number
The reward-based discount applied to the order.
round_off
number
The rounding off value added or subtracted to finalize the total amount.
total_value_of_goods
number
The total value of all products before applying taxes and discounts.
tax_table
object (TaxTable)
TaxTable
taxes
array of object (Taxes)
A list of tax details applied to different items.
Array of Taxes
hsn_code
string
The HSN code associated with the product for tax purposes.
tax
object (Tax)
Tax
cgst
object (Cgst)
Cgst
value
number
CGST value
percent
number
CGST percentage
sgst
object (Sgst)
Sgst
value
number
SGST value
percent
number
SGST percentage
igst
object (Igst)
Igst
value
number
IGST value
percent
number
IGST percentage
total_tax_value
number
The total tax value calculated for the item.
total_tax
number
The total tax amount for the entire order.
tax_in_words
string
The total tax amount represented in words.
declaration_texts
array of string
A list of declaration statements associated with the invoice.
registered_company_detail
object (RegisteredCompanyDetail)
RegisteredCompanyDetail
address
string
The complete address of the company.
city
string
The city where the company is located.
state
string
The state where the company is registered.
country
string
The country where the company operates.
country_code
string
The country code of the registered company.
zip_code
number
The postal/zip code of the company’s location.
state_code
string
The state code for taxation purposes.
display_address
string
The formatted display address of the company.
sector
string
The industry sector the company belongs to.
disclaimer
string
A disclaimer statement included in the invoice.
meta
object (Meta)
Meta
generator
object (MetaProperty)
MetaProperty
shipment_id_barcode_generator
object (ShipmentIdBarcodeGenerator)
ShipmentIdBarcodeGenerator
method
string
The method used to generate the barcode.
kwargs
object (Kwargs)
Kwargs
value
string
The value associated with the keyword argument.
signed_qrcode_generator
object (SignedQrcodeGenerator)
SignedQrcodeGenerator
method
string
The method used to generate the QR code.
kwargs
object (Kwargs)
Kwargs
value
string
The value associated with the keyword argument.
upi_qrcode_generator
object (UpiQrcodeGenerator)
UpiQrcodeGenerator
method
string
The method used to generate the UPI QR code.
kwargs
object (KwargsUpiQrcode)
KwargsUpiQrcode
qr_data
string
The data encoded in the QR code.
qr_url
string
The URL associated with the QR code.
digitalsignature_generator
object (DigitalsignatureGenerator)
DigitalsignatureGenerator
method
string
The method used to generate the digital signature.
kwargs
object (Kwargs)
Kwargs
value
string
The value associated with the keyword argument.
awb_number_label_barcode_generator
object (AwbNumberLabelBarcodeGenerator)
AwbNumberLabelBarcodeGenerator
method
string
The method used to generate the AWB number label barcode.
kwargs
object (KwargsAwbNumber)
KwargsAwbNumber
value
array of object
A list of objects containing AWB number details.
awb_number_barcode_generator
object (AwbNumberBarcodeGenerator)
AwbNumberBarcodeGenerator
method
string
The method used to generate the AWB number barcode.
kwargs
object (Kwargs)
Kwargs
value
string
The value associated with the keyword argument.
is_self_ship
boolean
Indicates whether the shipment is self-shipped by the seller.
mode
string
The mode of shipping, e.g., air, ground, sea.
is_self_pickup
boolean
Indicates whether the order is picked up by the customer.
platform_name
string
The platform name where the order was placed.
amount_to_be_collected
number
The total amount to be collected from the customer.
amount_paid
number
The total amount paid by the customer.
waybills
array of object
A list of waybills associated with the shipment.
total_items
number
The total number of items in the order.
brand_logo
string
The URL of the brand logo associated with the invoice.
shipment_id_barcode
string
The barcode associated with the shipment ID.
signed_qrcode
string
The signed QR code used for authentication or verification.
upi_qrcode
string
The UPI QR code for payment processing.
digitalsignature
string
The digital signature associated with the document.
awb_number_barcode
string
The barcode generated for the AWB number.
uid
string
The unique identifier associated with the invoice or shipment.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
country_code
string
Country code associated with the mapping entry.
__v
integer
Version number of the mapping entry.
Examples
Parameters
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
id:
"65e07e1c26e7477701e961ea"
Was this section helpful?
GET
Response
Update html template for invoice such as Invoice, Label, Deliver challan
Parameters
company_id
integer
Required
Unique numeric identifier for the company.
application_id
string
Required
Unique identifier for the application.
id
string
Required
Unique identifier for fetching PDF configuration details.
Response
200
Update html template for invoice
Properties
_id
string
application_id
string
company_id
integer
format
string
pdf_type_id
integer
__v
integer
created_at
string
| date-time
template
string
updated_at
string
| date-time
Examples
Parameters
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
id:
"65ccd7250ffb27e1f347e22a"
Was this section helpful?
GET
Response
Parameters
company_id
integer
Required
Unique numeric identifier for the company.
application_id
string
Required
Unique identifier for the application.
id
string
Required
Unique identifier used for operations.
Request body
format
string
Invoice document format (A4, A6, POS).
Enum
template
string
HTML template string for the document.
pdf_type_id
integer
Identifier for the type of PDF.
country_code
string
Country code associated with the configuration.
default_template
boolean
Indicates whether the fetched template is the default template.
Response
200
Update html template for invoice
PdfConfigSaveSuccess
data
object (PdfConfigSaveSuccessData)
PdfConfigSaveSuccessData
_id
string
Unique identifier for the saved configuration.
company_id
integer
Identifier for the associated company.
application_id
string
Identifier for the associated application.
pdf_type_id
integer
Identifier for the type of PDF.
format
string
Format of the PDF document.
Enum
template
string
HTML template used in the saved configuration.
__v
integer
Version number of the saved configuration.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
success
boolean
Indicates whether the operation was successful.
Examples
Parameters
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
id:
"65ccd7250ffb27e1f347e22c"
body:
body
Was this section helpful?
PUT
Response
Deletes a specific PDF generator configuration based on the provided id.
Parameters
company_id
integer
Required
Unique numeric identifier for the company.
application_id
string
Required
Unique identifier for the application.
id
string
Required
Unique identifier used for operations.
Response
200
Successful deletion of the PDF generator configuration.
Properties
success
boolean
Indicates if the deletion was successful.
Examples
Parameters
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
id:
"65ccd7250ffb27e1f347e22c"
Was this section helpful?
DEL
Response
Parameters
company_id
integer
Required
Unique numeric identifier for the company.
application_id
string
Required
Unique identifier for the application.
pdf_type_id
integer
Required
Unique identifier for the invoice type.
format
string
Required
Specifies the invoice document format (e.g., A4, A6, POS, A3).
Enum
country_code
string
Country code used to filter data displayed on the UI.
Response
200
Get last saved html template for invoice
PdfConfigSuccess
data
array of object (PdfConfigSuccessData)
List of successful PDF configurations.
Array of PdfConfigSuccessData
_id
string
Unique identifier for the PDF configuration.
company_id
integer
Identifier for the company associated with the configuration.
application_id
string
Identifier for the application using this configuration.
pdf_type_id
integer
Identifier for the type of PDF.
format
string
Format of the invoice document.
Enum
template
string
HTML template for the document.
__v
integer
Version number of the configuration document.
country_code
string
Country code associated with the configuration.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
success
boolean
Indicates whether the operation was successful.
Examples
Parameters
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
pdf_type_id:
1
format:
"A4"
country_code:
"IN"
Was this section helpful?
GET
Response
Parameters
company_id
integer
Required
Unique numeric identifier for the company.
application_id
string
Required
Unique identifier for the application.
Request body
format
string
Invoice document format (A4, A6, POS).
Enum
template
string
HTML template string for the document.
pdf_type_id
integer
Identifier for the type of PDF.
country_code
string
Country code associated with the configuration.
default_template
boolean
Indicates whether the fetched template is the default template.
Response
201
Saved html template for invoice
PdfConfigSaveSuccess
data
object (PdfConfigSaveSuccessData)
PdfConfigSaveSuccessData
_id
string
Unique identifier for the saved configuration.
company_id
integer
Identifier for the associated company.
application_id
string
Identifier for the associated application.
pdf_type_id
integer
Identifier for the type of PDF.
format
string
Format of the PDF document.
Enum
template
string
HTML template used in the saved configuration.
__v
integer
Version number of the saved configuration.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
success
boolean
Indicates whether the operation was successful.
Examples
Parameters
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
Response
Parameters
company_id
integer
Required
Unique numeric identifier for the company.
application_id
string
Required
Unique identifier for the application.
pdf_type_id
integer
Required
Unique identifier for the invoice type.
format
string
Required
Specifies the invoice document format (e.g., A4, A6, POS, A3).
Enum
country_code
string
Country code used to filter data displayed on the UI.
Response
200
Get rendered html with dummy json payload
PdfDefaultTemplateSuccess
data
array of object (Document)
A list of default PDF templates.
Array of Document
_id
string
Unique identifier for the document.
pdf_type_id
integer
Identifier for the type of PDF.
format
string
Format of the document.
template
string
HTML template content.
country_code
string
Country code associated with the document.
__v
integer
Version number of the document.
success
boolean
Indicates if the request was successful.
Examples
Parameters
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
pdf_type_id:
1
format:
"A4"
country_code:
"IN"
Was this section helpful?
GET
Response
Parameters
company_id
integer
Required
Unique numeric identifier for the company.
application_id
string
Required
Unique identifier for the application.
Request body
payload
object (PaymentReceiptPayload)
PaymentReceiptPayload
uid
string
A unique identifier for the payment receipt.
order_detail
object (PaymentReceiptOrderDetails)
PaymentReceiptOrderDetails
jiomart_order_id
string
Unique order identifier.
total_items
number
Total number of items in the order.
final_amount
number
Final amount for the order.
final_amount_in_words
string
Final amount represented in words.
order_created_date
string
Order creation date.
order_created_time
string
Order creation time.
prm_id
string
Unique PRM identifier.
receipt_no
string
Receipt number for the transaction.
taxes
object (PaymentReceiptTaxes)
PaymentReceiptTaxes
gstin
string
The GST Identification Number (GSTIN) associated with the company.
pancard
string
The Permanent Account Number (PAN) of the company or individual.
customer_detail
object (PaymentReceiptCustomerDetails)
PaymentReceiptCustomerDetails
id
string
Unique identifier for the customer.
email_id
string
Customer's email address.
last_name
string
Customer's last name.
first_name
string
Customer's first name.
mobile_number
string
Customer's mobile number.
payments
array of object (PaymentReceiptPayments)
A list of payment transactions included in the receipt.
Array of PaymentReceiptPayments
payment_desc
string
A description of the payment transaction.
txn_date
string
| date-time
The date and time when the transaction was made.
meta
object (PaymentReceiptMeta)
PaymentReceiptMeta
job_type
string
Specifies the type of job processing the payment receipt.
action
string
The action performed in relation to the payment receipt.
event
object
Additional event details associated with the receipt processing.
organizaton_id
string
The unique identifier of the organization issuing the receipt.
company_id
number
The numeric identifier of the company handling the payment.
application_id
array of string
A list of application identifiers linked to the transaction.
format
object (PaymentReceiptFormat)
PaymentReceiptFormat
payment_receipt
array of string
A list of formats available for generating the payment receipt.
trace_id
array of string
A list of trace identifiers for tracking the transaction.
created_timestamp
number
The timestamp (in epoch format) when the receipt was created.
service
object (PaymentReceiptService)
PaymentReceiptService
name
string
The name of the service handling the payment receipt.
event_trace_info
object
Additional trace information related to the event.
trace
string
A unique trace identifier for debugging or tracking purposes.
Response
200
400
Kafka response published to generate payment receipt
Properties
success
boolean
Examples
Parameters
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
body:
body
Was this section helpful?
POST
Response
get default html template for invoice such as Invoice, Label, Deliver challan
Parameters
company_id
integer
Required
Unique numeric identifier for the company.
application_id
string
Required
Unique identifier for the application.
id
string
Required
Unique identifier for the default PDF template.
Response
200
Update html template for invoice
PdfDefaultTemplateById
_id
string
The ID of the PDF default template
country_code
string
The country code associated with the template
format
string
The format of the template (e.g., "A4")
pdf_type_id
integer
The ID of the PDF type
__v
integer
Version number
template
string
The HTML template content
Examples
Parameters
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
id:
"65ccd7250ffb27e1f347e1d8"
Was this section helpful?
GET
Response