• Getting Started
  • API Reference
  • Orders API
  • Get Order
Show / Hide Table of Contents
  • Introduction
  • Orders API
    • Get Order Summaries
    • Get Order
    • Get Bulk Order
    • Get Stock
    • Get Order Packing
    • Create Order
    • Create Bulk Order
    • Add Order Attachment
    • Cancel Order
    • Cancel Bulk Order
  • Purchase Orders API
    • Get Purchase Orders
    • Create Purchase Order
    • Cancel Purchase Order
  • Returns API
    • Get Returns
    • Create Return
    • Cancel Return

GetOrderDetail

https://sbm.kuberwms.com/api/v1/docs/redoc/#operation/public\_mtg\_orders\_read

Input

Name Data Type
order_no
required
string

Response

Name Data Type Description
order_no string (Order no) non-empty WMS Generated order number
client integer (Client) Client of this outgoing shipment
ship_by string (Ship by) Nullable Date for delivery of outgoing order for urgent orders
priority string (Priority)Enum: "HIGH" "NORMAL" "LOW" Priority of outgoing shipment (Options: LOW, NORMAL, HIGH), Default: NORMAL
notes string (Notes) Nullable Notes related to this order
status string (Status)Enum: "NEW" "ACCEPTED" "REJECTED" "BACKORDERED" "IN_PROGRESS" "CANCELLED" "COMPLETE" The current status of this order. Cannot be modified directly
process_status string (Process status) non-empty Detailed status of order's process
awbs Array of strings (Awbs) Nullable Airway Bill Nos for shipping
order_source string (Order source) <= 50 characters Nullable
Order Source (e.g. Website, Phone, Email, CRM)
shipment_mode string (Shipment mode) Nullable
shipment_type string (Shipment type) Nullable
transport
required
string (Transport) Nullable
warehouse
required
string (Warehouse) Nullable
client_order_no
required
string (Client order no) <= 100 characters Nullable Order Number of Client for client's own purposes
total_order_value
required
string (Total order value) Nullable Total value of this order (inclusive of taxes)
freight_payable string (Freight payable) <= 50 characters Nullable Freight payable (if any)
payment_terms string (Payment terms) <= 50 characters Nullable Payment terms (if any)
billing_address_line_1 string (Billing address line 1) <= 100 characters Nullable
billing_address_line_2 string (Billing address line 2) <= 100 characters Nullable
billing_address_city string (Billing address city) <= 50 characters Nullable
billing_address_state string (Billing address state) <= 50 characters Nullable
billing_address_postal_code string (Billing address postal code) <= 10 characters Nullable
billing_address_country string (Billing address country) <= 50 characters Nullable
billing_address_first_name string (Billing address first name) <= 40 characters Nullable
billing_address_last_name string (Billing address last name) <= 40 characters Nullable
billing_address_avatar string (Billing address avatar) <= 200 characters Nullable
billing_address_email string (Billing address email) <= 100 characters Nullable
billing_address_work_phone string (Billing address work phone) <= 20 characters Nullable
billing_address_mobile string (Billing address mobile) <= 20 characters Nullable
shipping_address_line_1 string (Shipping address line 1) <= 100 characters Nullable
shipping_address_line_2 string (Shipping address line 2) <= 100 characters Nullable
shipping_address_city string (Shipping address city) <= 50 characters Nullable
shipping_address_state string (Shipping address state) <= 50 characters Nullable
shipping_address_postal_code string (Shipping address postal code) <= 10 characters Nullable
shipping_address_country string (Shipping address country) <= 50 characters Nullable
shipping_address_first_name string (Shipping address first name) <= 40 characters Nullable
shipping_address_last_name string (Shipping address last name) <= 40 characters Nullable
shipping_address_avatar string (Shipping address avatar) <= 200 characters Nullable
shipping_address_email string (Shipping address email) <= 100 characters Nullable
shipping_address_work_phone string (Shipping address work phone) <= 20 characters Nullable
shipping_address_mobile string (Shipping address mobile) <= 20 characters Nullable
no_of_boxes integer (No of boxes) No of boxes shipped
bulk_order string (Bulk order) non-empty
Bulk Order reference if any
gross_weight_gms integer (Gross weight gms) Gross weight (of complete order) in grams
net_weight_gms integer (Net weight gms) Net weight (of complete order) in grams
customer_code string (Customer code) <= 100 characters Nullable
Customer Number
billing_tax_state string (Billing tax state) <= 50 characters Nullable
billing_tax_statecode string (Billing tax statecode) <= 50 characters Nullable
place_of_supply
required
string (Place of supply) [1 - 50] characters
Place of supply (e.g.: Ship to State)
shipping_station string (Shipping station) <= 50 characters Nullable
use_resereved boolean True if we want to use reserved_quantity for this order.
dispatched_awbs string Actual consignment number dispatched by warehouse team
uids string Actual consignment number dispatched by warehouse team
bos_first boolean (Bos first) Bill of supply first copy
bos_second boolean (Bos second) Bill of supply second copy
bos_third boolean (Bos third) Bill of supply third copy
order_modified boolean True if order details have been modified/changed.
details
required
Array of JSON objects with following values:
E.g.:
{
"id": "24",
"code": "5845",
"quantity": 1,
"serial_nos": null,
"discount": "string",
"price": "string",
}
integer(ID)
string(ISBN/code) non-empty
integer(quantity) Defaults to 0
array of strings(serial_nos) Nullable
string(Discount) non-empty
string(Price) non-empty
extra_charges Array of JSON objects with following values:
E.g.:
{
"name": "string",
"price": "string",
"quantity": 1,
}
string(Charge Name/Title) non-empty
string(Price) non-empty
integer(quantity) Defaults to 0
logs Array (containing Log's messages and creation datetime) E.g:
{

"client_order_no": "string",
"order_no": "string",
"timestamp": "2020-01-03 12:53",
"status": "CREATED"
}
In This Article
Back to top Generated by DocFX