List
Get all order list by GET Method with filter function customized option for you. below list of route with parameter
https://ecom.coderorbit.com/public/api/admin/{{app_token}}/orders
headers:{
"Accept": "application/json"
"Authorization" : `Bearer ${token}`
}
### Result
{
"orders": [
{
"id": 5,
"unique_id": "1688272740",
"user_id": 14,
"status": {
"id": 2,
"unique_id": "L1yhz8QZil0fYw1",
"name": "Processing"
},
"discount": 18,
"quantity": 2,
"total": 90,
"grand_total": 72,
"payment_status": "Unpiad",
"promo_code": "MS20",
"description": "This is a note",
"extend_props": {
"vat": 0,
"tax": 0,
"boundle_name": "Bundle Offer 2 products",
"type": "Bundle",
"contact": {
"address": "current address",
"delivery_address": "Delivery Address",
"email": "majadul.dev@gmail.com",
"mobile": "01677270944"
},
"others": {
"check": "test"
}
},
"created_by": 14,
"updated_by": 14,
"deleted_at": null,
"created_at": "2023-07-02T04:39:00.000000Z",
"updated_at": "2023-07-02T11:34:50.000000Z",
"order_items": [
{
"id": 9,
"unique_id": "",
"order_id": 1688272740,
"vendor_id": 1,
"brand_id": 1,
"item_id": 4,
"item_name": "this first add product from vs code",
"icon": "",
"regular_price": 50,
"current_price": 40,
"discount_amount": 0,
"quantity": 1,
"grand_total": 0,
"extend_props": {
"vat": 0,
"tax": 0
},
"created_by": 14,
"updated_by": 14,
"deleted_at": null,
"created_at": "2023-07-02T04:39:00.000000Z",
"updated_at": "2023-07-02T04:39:00.000000Z"
},
{
"id": 10,
"unique_id": "",
"order_id": 1688272740,
"vendor_id": 1,
"brand_id": 1,
"item_id": 5,
"item_name": "this first add product from vs code",
"icon": "",
"regular_price": 50,
"current_price": 40,
"discount_amount": 0,
"quantity": 1,
"grand_total": 0,
"extend_props": {
"vat": 0,
"tax": 0
},
"created_by": 14,
"updated_by": 14,
"deleted_at": null,
"created_at": "2023-07-02T04:39:00.000000Z",
"updated_at": "2023-07-02T04:39:00.000000Z"
}
]
},
{
...
}
]
}
Basic Query Parameters
limit_per_page = 1 // Default 15
name = ''
page = 1 // number of page for pagination
data = all
orderBy = desc // desc|asc
Here is example url:
==============================================================================================================
GET = https://ecom.coderorbit.com/public/api/admin/{{app_token}}/orders
==============================================================================================================
GET = https://ecom.coderorbit.com/public/api/admin/{{app_token}}/orders?limit_per_page=1
==============================================================================================================
GET = https://ecom.coderorbit.com/public/api/admin/{{app_token}}/orders?name=apple
==============================================================================================================
GET = https://ecom.coderorbit.com/public/api/admin/{{app_token}}/orders?page=1
==============================================================================================================
GET = https://ecom.coderorbit.com/public/api/admin/{{app_token}}/orders?data=all&limit_per_page=1&name=admin&page=1
==============================================================================================================
### Result
{
"orders": {
"current_page": 1,
"data": [
{
"id": 1,
"unique_id": "580831273",
"user_id": 1,
"vendor_id": 2,
"status": {
"id": 8,
"unique_id": "1tQJg9a7grO1Yfj",
"name": "Delivered"
},
"discount": 0,
"quantity": 2,
"total": 80,
"grand_total": 80,
"commission": 8.8,
"affiliate": 0,
"payment_status": "1",
"promo_code": "",
"description": "this is test order",
"extend_props": {
"vat": 0,
"tax": 0,
"boundle_name": null,
"contact": {
"address": "current address",
"delivery_address": "Delivery Address",
"email": "majadul.dev@gmail.com",
"mobile": "01677270944"
},
"type": "Sigle",
"others": {
"check": "test"
}
},
"created_by": {
"id": 1,
"role_id": 1,
"country_id": 18,
"name": "Admin",
"email": "admin@gmail.com",
"extend_props": null,
"email_verified_at": null,
"created_at": "2023-09-17T02:19:46.000000Z",
"updated_at": "2023-10-04T02:49:51.000000Z",
"unique_id": "8660998812",
"otp": 874613,
"status": 1,
"description": null,
"created_by": 0,
"updated_by": 0,
"deleted_at": null
},
"updated_by": {
"id": 1,
"role_id": 1,
"country_id": 18,
"name": "Admin",
"email": "admin@gmail.com",
"extend_props": null,
"email_verified_at": null,
"created_at": "2023-09-17T02:19:46.000000Z",
"updated_at": "2023-10-04T02:49:51.000000Z",
"unique_id": "8660998812",
"otp": 874613,
"status": 1,
"description": null,
"created_by": 0,
"updated_by": 0,
"deleted_at": null
},
"deleted_at": null,
"created_at": "2023-09-17T04:34:23.000000Z",
"updated_at": "2023-09-17T06:06:48.000000Z",
"order_items": [
{
"id": 2,
"unique_id": "9142885777",
"vendor_order": 580831273,
"order_id": "580831273",
"vendor_id": 2,
"brand_id": 1,
"item_id": 4,
"item_name": "this first add product from vs code",
"icon": "",
"regular_price": 50,
"current_price": 40,
"discount_amount": 0,
"quantity": 1,
"grand_total": 40,
"extend_props": {
"vat": 0,
"tax": 0
},
"created_by": 1,
"updated_by": 1,
"deleted_at": null,
"created_at": "2023-09-17T04:34:23.000000Z",
"updated_at": "2023-09-17T04:34:23.000000Z",
"vendor": null,
"products": {
"id": 4,
"unique_id": "EhO9uaoEEZytOXy",
"category": [
"2",
"3",
"4"
],
"brand_id": 1,
"vendor_id": 2,
"country_id": 1,
"district_id": 1,
"police_station_id": 1,
"name": "this first add product from vs code",
"slug": "this_first_add_product_from_vs_code_EhO9uaoEEZytOXy",
"sequence": 0,
"icon": null,
"thumbnails": null,
"banner": "",
"description": "this first add product from vs code description",
"status": 1,
"attributes": null,
"additional": [],
"regular_price": 50,
"current_price": 40,
"dicount": 10,
"dicount_type": "fixed",
"stock": 20,
"unit": "pcs",
"minimum_order": null,
"start_offer": "2023-02-19 12:55:51",
"end_offer": "2023-11-19 12:55:51",
"extend_props": {
"test": "test one",
"test2": "test two"
},
"created_by": {
...
},
"updated_by": {
...
},
"created_at": "2023-05-10T21:23:36.000000Z",
"updated_at": "2023-05-10T21:23:46.000000Z",
"deleted_at": null,
"additional_media": [],
"categories": [
{
...
},
{
...
}
],
"brand": {
...
},
"vendor": {
...
},
"country": {
...
},
"district": {
...
},
"police_station": {
...
},
"referrals": [],
"bundles": []
}
}
],
"vendor": {
...
},
"user": {
...
}
},
{
...
}
],
"first_page_url": "http://localhost/coder_orbit/ecom/public/api/admin/hNpkY2FxW280gBp/orders?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://localhost/coder_orbit/ecom/public/api/admin/hNpkY2FxW280gBp/orders?page=1",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "http://localhost/coder_orbit/ecom/public/api/admin/hNpkY2FxW280gBp/orders?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"next_page_url": null,
"path": "http://localhost/coder_orbit/ecom/public/api/admin/hNpkY2FxW280gBp/orders",
"per_page": 15,
"prev_page_url": null,
"to": 2,
"total": 2
}
}
Advance Query Parameters
Here you can find order advance auery by POST Method with your own order. below list of route with parameter
https://ecom.coderorbit.com/public/api/admin/{{app_token}}/orders
headers:{
"Accept": "application/json"
"Authorization" : `Bearer ${token}`
}
body: {
"order_id": "80", // it will match with total, grand_total, quantity, order id, so many field are mathch this parameter
"vendor_id" : 1,
"user_id" : 1,
"from_date" : "", // data formate "2023-06-01"
"to_date" : "", // data formate "2023-06-01"
"status": 1
}
### Result
{
"orders": {
"current_page": 1,
"data": [
{
"id": 2,
"unique_id": "7198054772",
"user_id": 1,
"vendor_id": 1,
"status": {
"id": 3,
"unique_id": "L1yhz8QZil0fYw1",
"name": "Processing"
},
"discount": 0,
"quantity": 2,
"total": 80,
"grand_total": 80,
"commission": 0,
"affiliate": 0,
"payment_status": "1",
"promo_code": "",
"description": "this is test order",
"extend_props": {
"vat": 0,
"tax": 0,
"boundle_name": null,
"contact": {
"address": "current address",
"delivery_address": "Delivery Address",
"email": "majadul.dev@gmail.com",
"mobile": "01677270944"
},
"type": "Sigle",
"others": {
"check": "test"
}
},
"created_by": {
....
},
"updated_by": {
...
},
"deleted_at": null,
"created_at": "2023-09-17T04:34:23.000000Z",
"updated_at": "2024-06-11T03:28:14.000000Z",
"order_items": [
{
"id": 3,
"unique_id": "4285922117",
"vendor_order": 7198054772,
"order_id": "7198054772",
"vendor_id": 1,
"brand_id": 1,
"item_id": 7,
"item_name": "this first add product from vs code",
"icon": "",
"regular_price": 50,
"current_price": 40,
"discount_amount": 0,
"quantity": 2,
"grand_total": 80,
"extend_props": {
"vat": 0,
"tax": 0
},
"created_by": 1,
"updated_by": 1,
"deleted_at": null,
"created_at": "2023-09-17T04:34:23.000000Z",
"updated_at": "2023-09-17T04:34:23.000000Z",
"vendor": null,
"products": {
"id": 7,
"unique_id": "yuc4xCmIScxiRPG",
"category": [
"1",
"2"
],
"brand_id": 1,
"vendor_id": 1,
"country_id": 1,
"district_id": 1,
"police_station_id": 1,
"name": "this first add product from vs code",
"slug": "this_first_add_product_from_vs_code_yuc4xCmIScxiRPG",
"sequence": 0,
"icon": null,
"thumbnails": null,
"banner": "https://drive.google.com/uc?id=17f770p6JjhkvPLeWjyZP9mQpvAjSbj-V&export=media",
"description": "this first add product from vs code description",
"status": 1,
"attributes": null,
"additional": [],
"regular_price": 50,
"current_price": 40,
"dicount": 10,
"dicount_type": "fixed",
"stock": 20,
"unit": "pcs",
"minimum_order": 1,
"start_offer": "2023-02-19 12:55:51",
"end_offer": "2023-11-19 12:55:51",
"extend_props": {
"test": "test one",
"test2": "test two"
},
"created_by": {
...
},
"updated_by": {
...
},
"created_at": "2023-05-10T21:54:42.000000Z",
"updated_at": "2023-05-10T21:54:50.000000Z",
"deleted_at": null,
"additional_media": [],
"categories": [
{
...
},
{
...
}
],
"brand": {
...
},
"vendor": {
...
},
"country": {
...
},
"district": {
...
},
"police_station": {
...
},
"referrals": [],
"bundles": [
{
...
}
]
}
}
],
"vendor": {
},
"user": {
}
}
],
"first_page_url": "",
"from": 1,
"last_page": 1,
"last_page_url": "",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"next_page_url": null,
"path": "",
"per_page": 15,
"prev_page_url": null,
"to": 1,
"total": 1
}
}
Order Status Change
Here you can change order status by POST Method with your own status. below list of route with parameter
https://ecom.coderorbit.com/public/api/admin/{{app_token}}/order_status
headers:{
"Accept": "application/json"
"Authorization" : `Bearer ${token}`
}
body : {
"vendor_id" : 1,
"order_id" : 7198054772,
"confirm_id" : 3
}
### Result
{
"msg": "order_status_change"
}
Order Details
Get all order details by GET Method with all relational data option for you. below list of route
https://ecom.coderorbit.com/public/api/admin/{{app_token}}/orders/{{id}}
### Result
{
"id": 2,
"unique_id": "7198054772",
"user_id": 1,
"vendor_id": 1,
"status": {
"id": 2,
"unique_id": "L1yhz8QZil0fYw1",
"name": "Confirmed"
},
"discount": 0,
"quantity": 2,
"total": 80,
"grand_total": 80,
"commission": 0,
"affiliate": 0,
"payment_status": "1",
"promo_code": "",
"description": "this is test order",
"extend_props": {
"vat": 0,
"tax": 0,
"boundle_name": null,
"contact": {
"address": "current address",
"delivery_address": "Delivery Address",
"email": "majadul.dev@gmail.com",
"mobile": "01677270944"
},
"type": "Sigle",
"others": {
"check": "test"
}
},
"created_by": {
...
},
"updated_by": {
...
},
"deleted_at": null,
"created_at": "2023-09-17T04:34:23.000000Z",
"updated_at": "2023-09-17T06:00:26.000000Z",
"order_items": [
{
"id": 3,
"unique_id": "4285922117",
"vendor_order": 7198054772,
"order_id": "7198054772",
"vendor_id": 1,
"brand_id": 1,
"item_id": 7,
"item_name": "this first add product from vs code",
"icon": "",
"regular_price": 50,
"current_price": 40,
"discount_amount": 0,
"quantity": 2,
"grand_total": 80,
"extend_props": {
"vat": 0,
"tax": 0
},
"created_by": 1,
"updated_by": 1,
"deleted_at": null,
"created_at": "2023-09-17T04:34:23.000000Z",
"updated_at": "2023-09-17T04:34:23.000000Z",
"vendor": null,
"products": {
"id": 7,
"unique_id": "yuc4xCmIScxiRPG",
"category": [
"1",
"2"
],
"brand_id": 1,
"vendor_id": 1,
"country_id": 1,
"district_id": 1,
"police_station_id": 1,
"name": "this first add product from vs code",
"slug": "this_first_add_product_from_vs_code_yuc4xCmIScxiRPG",
"sequence": 0,
"icon": null,
"thumbnails": null,
"banner": "https://drive.google.com/uc?id=17f770p6JjhkvPLeWjyZP9mQpvAjSbj-V&export=media",
"description": "this first add product from vs code description",
"status": 1,
"attributes": null,
"additional": [],
"regular_price": 50,
"current_price": 40,
"dicount": 10,
"dicount_type": "fixed",
"stock": 20,
"unit": "pcs",
"minimum_order": 1,
"start_offer": "2023-02-19 12:55:51",
"end_offer": "2023-11-19 12:55:51",
"extend_props": {
"test": "test one",
"test2": "test two"
},
"created_by": {
...
},
"updated_by": {
...
},
"created_at": "2023-05-10T21:54:42.000000Z",
"updated_at": "2023-05-10T21:54:50.000000Z",
"deleted_at": null,
"vendor": {
...
},
"additional_media": [],
"categories": [
{
...
},
{
...
}
],
"brand": {
...
},
"country": {
...
},
"district": {
...
},
"police_station": {
...
},
"referrals": [],
"bundles": [
{
"id": 1,
"unique_id": "IYNocjTuvfFvzJ1",
"name": "Bundle Offer",
"slug": "bundle_offer_IYNocjTuvfFvzJ1",
"sequence": 1,
"icon": null,
"thumbnails": null,
"banner": null,
"description": "this for bundle products",
"status": 1,
"price": 100,
"bundle_price": 90,
"product_ids": [
5,
7
],
"start_offer": "2023-05-11 03:56:21",
"end_offer": "2023-12-11 03:56:21",
"extend_props": {
"test": "hello",
"test2": "check for required"
},
"created_by": 1,
"updated_by": 1,
"created_at": "2024-01-26T13:53:43.000000Z",
"updated_at": "2024-01-26T13:53:43.000000Z",
"deleted_at": null,
"pivot": {
"product_id": 7,
"bundle_id": 1
}
},
{
...
}
]
}
}
],
"vendor": {
...
},
"user": {
...
}
}