CreateReturns

https://sbm.kuberwms.com/api/v1/docs/redoc/#operation/public_mtg_returns_create

Input

Name Data Type Description
client_return_no
required		 string (Client return no) Return Number of Client for client's own purposes
warehouse
required		 string (Warehouse) non-empty
no_of_boxes integer (No of boxes) Nullable No of boxes in return
booked_wt_gms integer (Booked wt gms) Nullable
pickup_transporter string (Pickup transporter) <= 200 characters Nullable Transport for Pickup
pickup_amount_paid
required		 string (Pickup amount paid) non-empty
pickup_remarks string (Pickup remarks) Nullable
booking_date
required		 string (Booking date)
shipping_station string (Shipping station) <= 50 characters Nullable Shipping Station (e.g. KANPUR)
transport_address string (Transport address) Nullable
customer_code string (Customer code) <= 100 characters Nullable Customer Number
customer_first_name string (Customer first name) <= 100 characters Nullable
customer_last_name string (Customer last name) <= 100 characters Nullable
customer_avatar string (Customer avatar) <= 200 characters Nullable
customer_email string (Customer email) <= 100 characters Nullable
customer_work_phone string (Customer work phone) <= 50 characters Nullable
customer_mobile string (Customer mobile) <= 50 characters Nullable
customer_tax_number string (Customer tax number) <= 100 characters Nullable
customer_line_1 string (Customer line 1) <= 500 characters Nullable
customer_line_2 string (Customer line 2) <= 500 characters Nullable
customer_city string (Customer city) <= 50 characters Nullable
customer_state string (Customer state) <= 50 characters Nullable
customer_postal_code string (Customer postal code) <= 10 characters Nullable
customer_country string (Customer country) <= 50 characters Nullable
customer_company_name string (Customer company name) <= 200 characters Nullable
details
required		 Array of JSON objects with following values:
E.g.: 
{ 
  "code": "string", 
  "quantity": 1
}

string (Code) ISBN/sku of the item to be returned. 
integer (Quantity) Quantity of items, Defaults to 0		






Response






Name
Data Type
Description






id
integer
(ID)




return_no
string
(Return no) non-empty  PIM Generated order number




status
string
(Status) Enum: "NEW" "APPROVED" "REJECTED" "RECEIVED" "COMPLETE" "CANCELLED"  The current status of this return. Cannot be modified directly




client_return_no 
 required		
string
(Client return no) Return Number of Client for client's own purposes




client
string
(Client) non-empty




warehouse 
 required		
string
(Warehouse) non-empty




no_of_boxes
integer
(No of boxes) Nullable  No of boxes in return




booked_wt_gms
integer
(Booked wt gms) Nullable




approved_wt_gms
integer
(Approved wt gms)




pickup_transporter
string
(Pickup transporter) <= 200 characters Nullable  Transport for Pickup




pickup_amount_paid 
 required		
string
(Pickup amount paid) non-empty




pickup_remarks
string
(Pickup remarks) Nullable




booking_date 
 required		
string 
(Booking date)




shipping_station
string
(Shipping station) <= 50 characters Nullable  Shipping Station (e.g. KANPUR)




transport_address
string
(Transport address) Nullable




customer_code
string
(Customer code) <= 100 characters Nullable  Customer Number




customer_first_name
string
(Customer first name) <= 100 characters Nullable




customer_last_name
string
(Customer last name) <= 100 characters Nullable




customer_avatar
string
 (Customer avatar) <= 200 characters Nullable




customer_email
string
 (Customer email) <= 100 characters Nullable




customer_work_phone
string
(Customer work phone) <= 50 characters Nullable




customer_mobile
string
(Customer mobile) <= 50 characters Nullable




customer_tax_number
string
(Customer tax number) <= 100 characters Nullable




customer_line_1
string
(Customer line 1) <= 500 characters Nullable




customer_line_2
string
(Customer line 2) <= 500 characters Nullable




customer_city
string
(Customer city) <= 50 characters Nullable




customer_state
string
(Customer state) <= 50 characters Nullable




customer_postal_code
string
(Customer postal code) <= 10 characters Nullable




customer_country
string
(Customer country) <= 50 characters Nullable




customer_company_name
string
(Customer company name) <= 200 characters Nullable




approved_by
integer
(Approved By)




approved_on
string 
(Approved on)




received_by
integer
(Received By)




received_on
string 
(Received on)




completed_by
integer
(Completed By)




completed_on
string 
(Completed on)




details 
required		
Array of JSON objects with following values: 
E.g.: 
{ 
  "id": 0,
  "code": "string", 
  "quantity": 1
}

integer (ID) 
string (Code) ISBN/sku of the item to be returned. 
integer (Quantity) Quantity of items, Defaults to 0