Home
Home
  1. Sales
  • BizeeBuy API Introduction
  • V1
    • Authentication
      • Generate Access Token
      • Refresh Access Token
    • Masters
      • Get Warehouse List
      • Finished Goods List
      • Material List
    • Purchase
    • GRN
    • Inventory
      • FG Stock Status
      • Material Stock Status
    • Production
      • Batch List
      • Material Consumption
    • Sales
      • Sales Order Dispatch
        POST
      • Sales Order Status
        POST
      • Turnover & Gross Margin Report
        POST
      • FG Demand Status Report
        POST
      • Get Sales
        POST
      • Get Sales Invoices
        POST
    • TrueGradient
      • Item Master - FG
      • Sales Order Status
      • FG Inventory-Batchwise
      • Open Purchase Orders
      • Item Master - Materials
      • FG BoM
  1. Sales

Sales Order Dispatch

POST
https://api.bizeebuy.com/v1/sales/order-dispatch
This API is designed to facilitate exposing Sales Orders wise Dispatch related data in two different formats basis the inclusion or exclusion of Returned [RTO/RTV] Orders with in a specified Date Range.
There are are following two versions of this data set available for access through this API:
Sales order dispatch data Inclusive of All the Returned Orders ie. Report type =WR ie "With Return".
Sales order dispatch data Exclusive of the Returned Orders ie. Report type =R .

Request

Header Params
Authorization
string 
required
Example:
Bearer 3e4b6e748d872a95aa39483ca54b27cb49eb464f
Warehouse
string  | null 
optional
Example:
95aa39483ca54b27cb49eb464f
Body Params application/json
version
string 
required
With Return or Without Return
from_date
string 
required
From date
to_date
string 
required
To Date
Example
{
    "version":"R",
    "from_date":"2024-12-01",
    "to_date":"2024-12-31"
}

{
    "version":"WR",
    "from_date":"2024-01-01",
    "to_date":"2025-01-31"
}

Responses

🟢200Success
application/json
Body
order_no
string 
required
po_no
string 
required
order_date
string 
required
company_name
string 
required
city
string 
required
warehouse
string 
required
order_sku
string 
required
order_item
string 
required
order_qty
number 
optional
order_uom
string 
required
product_sku
string 
required
product_name
string 
required
required_qty
string 
required
sku_uom
string 
required
dispatched_qty
number 
required
batches
string 
required
Examples
{
    "data": [
        {
            "order_no": "ORD/00000357",
            "po_no": "",
            "order_date": "2024-12-18",
            "company_name": "Ravi & Company",
            "city": "Delhi",
            "warehouse": "Central Warehouse",
            "order_sku": "SGA00001",
            "order_item": "Sales Gross Product",
            "order_qty": "10.0000000000",
            "order_uom": "Nos",
            "product_sku": "SGA00001",
            "product_name": "Sales Gross Product",
            "required_qty": "10.00",
            "sku_uom": "Nos",
            "dispatched_qty": "10.0000000000",
            "batches": "542107654(10 Nos) "
        },
        {
            "order_no": "ORD/00000359",
            "po_no": "",
            "order_date": "2024-12-20",
            "company_name": "Vendord twog pvt limited",
            "city": "Delhi",
            "warehouse": "Central Warehouse",
            "order_sku": "FEFO00021",
            "order_item": "Demo One",
            "order_qty": "10.0000000000",
            "order_uom": "Bunches",
            "product_sku": "FEFO00021",
            "product_name": "Demo One",
            "required_qty": "10.00",
            "sku_uom": "Bunches",
            "dispatched_qty": "10.0000000000",
            "batches": "8745120(10 Bunches) "
        },
        {
            "order_no": "ORD/00000360",
            "po_no": "",
            "order_date": "2024-12-20",
            "company_name": "Vendord twog pvt limited",
            "city": "Delhi",
            "warehouse": "Central Warehouse",
            "order_sku": "FEFO00021",
            "order_item": "Demo One",
            "order_qty": "15.0000000000",
            "order_uom": "Bunches",
            "product_sku": "FEFO00021",
            "product_name": "Demo One",
            "required_qty": "15.00",
            "sku_uom": "Bunches",
            "dispatched_qty": "15.0000000000",
            "batches": "8745120(8 Bunches) ,8745120(7 Bunches) "
        },
        {
            "order_no": "ORD/00000360",
            "po_no": "",
            "order_date": "2024-12-20",
            "company_name": "Vendord twog pvt limited",
            "city": "Delhi",
            "warehouse": "Central Warehouse",
            "order_sku": "RTD09890",
            "order_item": "Group 7 Prod New",
            "order_qty": "20.0000000000",
            "order_uom": "Pack",
            "product_sku": "MSM03",
            "product_name": "Mehta Semi 03",
            "required_qty": "24.00",
            "sku_uom": "Liter",
            "dispatched_qty": "24.0000000000",
            "batches": "6001546(6 Liter) ,6001546(18 Liter) "
        },
        {
            "order_no": "ORD/00000360",
            "po_no": "",
            "order_date": "2024-12-20",
            "company_name": "Vendord twog pvt limited",
            "city": "Delhi",
            "warehouse": "Central Warehouse",
            "order_sku": "RTD09890",
            "order_item": "Group 7 Prod New",
            "order_qty": "20.0000000000",
            "order_uom": "Pack",
            "product_sku": "NL012255452",
            "product_name": "New lamp 2",
            "required_qty": "20.00",
            "sku_uom": "Nos",
            "dispatched_qty": "20.0000000000",
            "batches": "15487/874512(5 Nos) ,15487/874512(15 Nos) "
        },
        {
            "order_no": "ORD/00000361",
            "po_no": "",
            "order_date": "2024-12-20",
            "company_name": "Vendord twog pvt limited",
            "city": "Delhi",
            "warehouse": "Central Warehouse",
            "order_sku": "FEFO00021",
            "order_item": "Demo One",
            "order_qty": "5.0000000000",
            "order_uom": "Bunches",
            "product_sku": "FEFO00021",
            "product_name": "Demo One",
            "required_qty": "5.00",
            "sku_uom": "Bunches",
            "dispatched_qty": "5.0000000000",
            "batches": "8745120(5 Bunches) "
        },
        {
            "order_no": "ORD/00000361",
            "po_no": "",
            "order_date": "2024-12-20",
            "company_name": "Vendord twog pvt limited",
            "city": "Delhi",
            "warehouse": "Central Warehouse",
            "order_sku": "SOFG0002",
            "order_item": "Sales Product Two",
            "order_qty": "10.0000000000",
            "order_uom": "Nos",
            "product_sku": "SOFG0002",
            "product_name": "Sales Product Two",
            "required_qty": "10.00",
            "sku_uom": "Nos",
            "dispatched_qty": "10.0000000000",
            "batches": "BT/24/00046(10 Nos) "
        },
        {
            "order_no": "ORD/00000362",
            "po_no": "",
            "order_date": "2024-12-21",
            "company_name": "Vendord twog pvt limited",
            "city": "Delhi",
            "warehouse": "Central Warehouse",
            "order_sku": "FEFO00021",
            "order_item": "Demo One",
            "order_qty": "10.0000000000",
            "order_uom": "Bunches",
            "product_sku": "FEFO00021",
            "product_name": "Demo One",
            "required_qty": "10.00",
            "sku_uom": "Bunches",
            "dispatched_qty": "10.0000000000",
            "batches": "8745120(5 Bunches) ,8745120(5 Bunches) "
        },
        {
            "order_no": "ORD/00000362",
            "po_no": "",
            "order_date": "2024-12-21",
            "company_name": "Vendord twog pvt limited",
            "city": "Delhi",
            "warehouse": "Central Warehouse",
            "order_sku": "SOFG0002",
            "order_item": "Sales Product Two",
            "order_qty": "15.0000000000",
            "order_uom": "Nos",
            "product_sku": "SOFG0002",
            "product_name": "Sales Product Two",
            "required_qty": "15.00",
            "sku_uom": "Nos",
            "dispatched_qty": "15.0000000000",
            "batches": "BT/24/00046(5 Nos) ,BT/24/00046(10 Nos) "
        },
        {
            "order_no": "ORD/00000363",
            "po_no": "",
            "order_date": "2024-12-23",
            "company_name": "Ravi & Company",
            "city": "Delhi",
            "warehouse": "Central Warehouse",
            "order_sku": "FEFO00021",
            "order_item": "Demo One",
            "order_qty": "5.0000000000",
            "order_uom": "Bunches",
            "product_sku": "FEFO00021",
            "product_name": "Demo One",
            "required_qty": "5.00",
            "sku_uom": "Bunches",
            "dispatched_qty": "5.0000000000",
            "batches": "8745120(5 Bunches) "
        },
        {
            "order_no": "ORD/00000363",
            "po_no": "",
            "order_date": "2024-12-23",
            "company_name": "Ravi & Company",
            "city": "Delhi",
            "warehouse": "Central Warehouse",
            "order_sku": "SOFG0002",
            "order_item": "Sales Product Two",
            "order_qty": "4.0000000000",
            "order_uom": "Nos",
            "product_sku": "SOFG0002",
            "product_name": "Sales Product Two",
            "required_qty": "4.00",
            "sku_uom": "Nos",
            "dispatched_qty": "4.0000000000",
            "batches": "BT/24/00046(4 Nos) "
        },
        {
            "order_no": "ORD/00000364",
            "po_no": "",
            "order_date": "2024-12-23",
            "company_name": "Sales Order Customer",
            "city": "Kanpur",
            "warehouse": "Central Warehouse",
            "order_sku": "FEFO00021",
            "order_item": "Demo One",
            "order_qty": "10.0000000000",
            "order_uom": "Bunches",
            "product_sku": "FEFO00021",
            "product_name": "Demo One",
            "required_qty": "10.00",
            "sku_uom": "Bunches",
            "dispatched_qty": "6.0000000000",
            "batches": "8745120(6 Bunches) "
        },
        {
            "order_no": "ORD/00000364",
            "po_no": "",
            "order_date": "2024-12-23",
            "company_name": "Sales Order Customer",
            "city": "Kanpur",
            "warehouse": "Central Warehouse",
            "order_sku": "GRDFG0006",
            "order_item": "Group 6 Prod New",
            "order_qty": "6.0000000000",
            "order_uom": "Pack",
            "product_sku": "KJJH/ASD/9898",
            "product_name": "Jsdvba Sdvaskda",
            "required_qty": "24.00",
            "sku_uom": "Nos",
            "dispatched_qty": "16.0000000000",
            "batches": "34986545(16 Nos) "
        },
        {
            "order_no": "ORD/00000364",
            "po_no": "",
            "order_date": "2024-12-23",
            "company_name": "Sales Order Customer",
            "city": "Kanpur",
            "warehouse": "Central Warehouse",
            "order_sku": "GRDFG0006",
            "order_item": "Group 6 Prod New",
            "order_qty": "6.0000000000",
            "order_uom": "Pack",
            "product_sku": "SOFG0001",
            "product_name": "Sales Product One",
            "required_qty": "12.00",
            "sku_uom": "Nos",
            "dispatched_qty": "8.0000000000",
            "batches": "56985620(8 Nos) "
        },
        {
            "order_no": "ORD/00000365",
            "po_no": "",
            "order_date": "2024-12-23",
            "company_name": "Ravi & Company",
            "city": "Delhi",
            "warehouse": "Central Warehouse",
            "order_sku": "FEFO00021",
            "order_item": "Demo One",
            "order_qty": "10.0000000000",
            "order_uom": "Bunches",
            "product_sku": "FEFO00021",
            "product_name": "Demo One",
            "required_qty": "10.00",
            "sku_uom": "Bunches",
            "dispatched_qty": "10.0000000000",
            "batches": "8745120(10 Bunches) "
        },
        {
            "order_no": "ORD/00000365",
            "po_no": "",
            "order_date": "2024-12-23",
            "company_name": "Ravi & Company",
            "city": "Delhi",
            "warehouse": "Central Warehouse",
            "order_sku": "SOFG0002",
            "order_item": "Sales Product Two",
            "order_qty": "5.0000000000",
            "order_uom": "Nos",
            "product_sku": "SOFG0002",
            "product_name": "Sales Product Two",
            "required_qty": "5.00",
            "sku_uom": "Nos",
            "dispatched_qty": "5.0000000000",
            "batches": "BT/24/00046(5 Nos) "
        },
        {
            "order_no": "ORD/00000381",
            "po_no": null,
            "order_date": "2024-12-18",
            "company_name": "Test Mehta Private Limited",
            "city": "New Delhi",
            "warehouse": "Central Warehouse",
            "order_sku": "FIFO001",
            "order_item": "Fifo testing 001",
            "order_qty": "30.0000000000",
            "order_uom": "Nos",
            "product_sku": "FIFO001",
            "product_name": "Fifo testing 001",
            "required_qty": "30.00",
            "sku_uom": "Nos",
            "dispatched_qty": "30.0000000000",
            "batches": "BTFG00012(10 Nos) ,BTFG00012(1 Nos) ,BTFG00012#R1(4 Nos) ,984521025(15 Nos) "
        },
        {
            "order_no": "ORD/00000381",
            "po_no": null,
            "order_date": "2024-12-18",
            "company_name": "Test Mehta Private Limited",
            "city": "New Delhi",
            "warehouse": "Central Warehouse",
            "order_sku": "PHY-COM-0001",
            "order_item": "Physical Combo One",
            "order_qty": "15.0000000000",
            "order_uom": "Kg",
            "product_sku": "PHY-COM-0001",
            "product_name": "Physical Combo One",
            "required_qty": "15.00",
            "sku_uom": "Kg",
            "dispatched_qty": "15.0000000000",
            "batches": "BATCH0258542(10 Kg) ,BATCH0258542(5 Kg) "
        },
        {
            "order_no": "ORD/00000381",
            "po_no": null,
            "order_date": "2024-12-18",
            "company_name": "Test Mehta Private Limited",
            "city": "New Delhi",
            "warehouse": "Central Warehouse",
            "order_sku": "SOFG0001",
            "order_item": "Sales Product One",
            "order_qty": "24.0000000000",
            "order_uom": "Nos",
            "product_sku": "SOFG0001",
            "product_name": "Sales Product One",
            "required_qty": "24.00",
            "sku_uom": "Nos",
            "dispatched_qty": "24.0000000000",
            "batches": "56985620(15 Nos) ,21548909452(9 Nos) "
        },
        {
            "order_no": "ORD/00000382",
            "po_no": null,
            "order_date": "2024-12-24",
            "company_name": "Test Mehta Private Limited",
            "city": "New Delhi",
            "warehouse": "Central Warehouse",
            "order_sku": "FIFO001",
            "order_item": "Fifo testing 001",
            "order_qty": "10.0000000000",
            "order_uom": "Nos",
            "product_sku": "FIFO001",
            "product_name": "Fifo testing 001",
            "required_qty": "10.00",
            "sku_uom": "Nos",
            "dispatched_qty": "10.0000000000",
            "batches": "BTFG00012(10 Nos) "
        }
    ],
    "_links": {
        "self": {
            "href": "http://127.0.0.1/bizeebuy/rest/web/v1/sales/order-dispatch?page=1"
        },
        "first": {
            "href": "http://127.0.0.1/bizeebuy/rest/web/v1/sales/order-dispatch?page=1"
        },
        "last": {
            "href": "http://127.0.0.1/bizeebuy/rest/web/v1/sales/order-dispatch?page=2"
        },
        "next": {
            "href": "http://127.0.0.1/bizeebuy/rest/web/v1/sales/order-dispatch?page=2"
        }
    },
    "_meta": {
        "totalCount": 27,
        "pageCount": 2,
        "currentPage": 1,
        "perPage": 20
    }
}
Previous
Material Consumption
Next
Sales Order Status
Built with