Order
Manages orders, including processing, tracking, and updating order status.
Announcements
Announcements are a way to communicate important information to your platform users, which can be sellers. They could be about upcoming promotions, system maintenance downtime, policy changes, or new features on the platform
List announcements
List announcements
getAnnouncements
Bag
Bag represents a virtual entity to group same items which contains single or multi quantity. Bags are part of a shipment. An order will have one or more than one shipments. A shipment can contain zero or more bags.
List bag cancellation reasons
List bag cancellation reasons
getShipmentReasons
Get bag
Get bag
getBagById
List bags
List bags
getBags
Bulk Operations
Bulk operations allow you to perform actions on a large number of orders. This can save significant time compared to managing them individually. For example, bulk order fulfillment, bulk invoice download etc.
Upload bulk state transitions file
Upload bulk state transitions file
bulkStateTransistion
Lists bulk operations
Lists bulk operations
bulkListing
Get bulk operation details
Get bulk operation details
jobDetails
Download file used for Bulk operation
Download file used for Bulk operation
getFileByStatus
List supported templates
List supported templates
getBulkActionTemplate
Download bulk template
Download bulk template
downloadBulkActionTemplate
List bulk operation templates
List bulk operation templates
getAllowedTemplatesForBulk
Download bulk operation templates
Download bulk operation templates
getTemplate
Manifest
Manifest
List manifest shipments
List manifest shipments
getManifestShipments
List manifests
List manifests
getManifests
Generate manifest
Generate manifest
processManifests
Get a manifest
Get a manifest
getManifestDetails
Dispatch manifest
Dispatch manifest
dispatchManifests
Upload consent
Upload consent
uploadConsents
List filters
List filters
getManifestfilters
Order
Order represents a customer's intent to purchase a specific set of products from your platform. Here platform could be a Website, POS machine, External integrations etc. It typically includes details like customer information, billing/shipping addresses, items ordered, quantities, pricing, and chosen fulfillment method.
Get role-based actions
Get role-based actions
getRoleBasedActions
Create order
Create order
createOrder
Get channel configuration
Get channel configuration
getChannelConfig
Create channel configuration
Create channel configuration
createChannelConfig
Update an order
Update an order
orderUpdate
Debug order
Debug order
checkOrderStatus
Get credit balance detail
Get credit balance detail
fetchCreditBalanceDetail
List refund modes
List refund modes
fetchRefundModeConfig
Attach order to a user
Attach order to a user
attachOrderUser
List failed order logs
List failed order logs
failedOrderLogs
Get failed order log
Get failed order log
failedOrderLogDetails
Get order
Get order
getOrderById
List orders
List orders
getOrders
List filters
List filters
getfilters
Generate POS receipt by order Id
Generate POS receipt by order Id
generatePOSReceiptByOrderId
Reports
Reports are summaries of various data points related to your orders. These can include order reports for example - New, Confirmed, To be packed, Return Delivered, etc, Lane download, etc. Use this to download shipment's data on the basis of status, download shipments on the basis of type of lane selected.
Download Lane report
Download Lane report
downloadLanesReport
Generate the report
Generate the report
getBulkShipmentExcelFile
Shipment
Shipment represents the physical movement of goods from the seller (or your warehouse) to the customer. It's associated with a specific order and includes details like tracking information, carrier used, weight, dimensions, and estimated delivery date. An Order can contain multiple shipments. Shipments are created based on multiple factors like selling location assigned to that shipment, the packaging material available etc. A shipment will get created whenever there is a partial transition of items also when there is a negative state transition is invoked. Negative state transition can be defined against a state. Currently only some defined states are configured as negative. If any state is to be added as negative state then please contact support team.