Invoice v2
All endpoints related to Invoices v2
Supported Endpoints
getAllInvoices(): Returns a list of all the listings created.getInvoice(id): Retrieves a listing by the entered ID.getOrderDeliverables(id): Creates a listing and returns the created listing.createInvoice(fields): Updates a listing by the entered ID.issueReplacement(id, fields): Deletes a listing by the entered ID.createPayment(id): Generates a payment session for the given order.
Invoices v2
getAllInvoices()
getAllInvoices()limit
integer
❌
Limit the number of invoices returned
page
integer
❌
The page number you are attempting to access.
getInvoice()
getInvoice()id
string
✔️
ID of an invoice
getOrderDeliverables()
getOrderDeliverables()id
string
✔️
ID of an invoices
title
string
✔️
The product's title.
description
string
✔️
The product's description.
image
object/null
❌
An image binary which will be visible when someone views your product.
order
int/null
❌
The product's order in which it is sorted on your storefront.
visibility
string
✔️
Either "PUBLIC", "HIDDEN", or "PRIVATE" - depending on whether you want this product to be visible.
deliverable
object
✔️
The product's deliverable which will be sent to the customer. Consists of three pieces of nested data, being "delivery_text", "type", and "data"
price
object
✔️
The product's price in nested format. Consists of two variables "PRICE" (in cents) and "CURRENCY".
humble
boolean
❌
Whether you want to allow the customer to pay more than the product's price. ( ͡° ͜ʖ ͡°)
payment_methods
array of string
✔️
Items Enum: "COINBASE" "PAYDASH" "PAYPAL" "STRIPE". The product's payment methods in array format.
additional_information
array
❌
Additional info that can be requested from the customer during the checkout process.
bulk_discount
array
❌
An array of discounts when a customer purchases more than a specified quantity.
minimum_purchase_quantity
int
✔️
The minimum amount a customer is able to purchase.
maximum_purchase_quantity
int/null
❌
The maximum amount a customer is able to purchase.
webhook
string/null
❌
A webhook URL that will receive updates when orders are placed.
warranty
object/null
❌
The warranty time in which a customer is able to request a refund.
locked
boolean
❌
Whether this product is locked by the admins or moderators.
section
int/null
❌
The ID of a section to associate with this product. Use null to disassociate a section.
createInvoice()
createInvoice()fields
object
✔️
Product's field
customer_email
string
❌
The email of the customer who placed this order.
total
string
❌
The total amount to pay for this order. Can be excluded to create free-of-charge orders.
payment_method
string
❌
Enum: "COINBASE" "PAYDASH" "PAYPAL" "STRIPE". The payment gateway to process this order with.The selected payment gateway must be configured for the issuing store and should only be included in the request if the total of the order is greater than zero.
coupon
string
❌
The coupon code to apply to this order.
products
object
❌
Association of products with quantity and additional information to include in the order. The object keys must be the ids of the listings to include
issueReplacement()
issueReplacement()id
string
✔️
ID of the order you want to issue a replacement
fields
array
❌
The listings that should be replaced. If no listings are provided, all listings will be replaced.
createPayment()
createPayment()id
string
✔️
Generates a payment session for the given ORDER ID.
Last updated