The super most efficient eCommerce back-office automation system.
Shipway offers an easy API solution that lets your eCommerce store integrate with all the leading shipping solutions, warehouse management systems, and 3PL providers. The integration enables eCommerce brands to streamline forward and reverse shipments quickly and efficiently.
To get started you need to
\n\nfirst, create an account and complete the signup process.
Now, to Integrate your store and courier partner with your eCommerce platform follow these steps, Log In
Select Settings >
\n\n> Select your channel to import orders
\nSelect Settings >
\n\n> Select courier and fill the API credentials
\nUsing Shipway API, Developers can interface their system with Shipway Platform. The API is used to automate tasks and processing orders fast and efficiently.
\nThe Shipway API uses Basic HTTP authentication. Use your Shipway Email as the username and License Key as the password. You can find your License Key as the password from,
Shipway >Profile>Manage profile.
The Authorization header is constructed as follows:
\nPHP example:
$token = base64_encode(\"email:License key\");
$authHeaderString = 'Authorization: Basic ' . $token;
Please note that in order to use the generated token in your own code, you will need to pass the token in the following format in the appropriate header of your code :
Authorization: Bearer \n
All the APIs are provided with their appropriate example requests and responses for successful and failure calls. The example definitions are:
\n\n| Status Code | Response | Description |
|---|---|---|
201 | Created | The request is successful and an order is created. |
400 | Bad Request | The request is missing required parameters. |
401 | Unauthorized | Authentication failed. |
403 | Forbidden | Access denied. |
404 | Not Found | Resource is not found. |
405 | Method not allowed | Requested method is not supported for the specified resource. |
500 | Internal Server Error | Shipway has encountered an error. |
Shipway provides Push Orders to interact with Shipway system This Rest API enables merchants to PUSH orders in Shipway system.
\nParameters
\n| Field Name | Description | Mandatory | Data Type |
|---|---|---|---|
order_id | Merchant's Order ID | Yes | string |
products | Products JSON (More Details) | Yes | json |
payment_type | P - Prepaid, C - COD | Yes | string |
email | Customer email | No | string |
ewaybill | Please provide E-waybill. It is mandatory for shipments with amount greater than Rs.50,000 | No | string |
discount | Total discount for order (Value should be positive) | No | decimal |
gift_card_amt | Gift card amount if apply gift card on orders (Value should be positive) | No | decimal |
taxes | Oders Taxes | No | decimal |
tax_rate | Tax Rate | No | decimal |
tax_title | Tax Title (IGST,SGST,CGST) | No | string |
shipping | Total shipping amount for order | No | decimal |
order_total | Total order value( Final amount after checkout ) | No | string |
billing_address | Billing address | No | string |
billing_address2 | Billing address - Line 2 | No | string |
billing_city | City(billing address) | No | string |
billing_state | State(billing address) | No | string |
billing_country | Country (billing address) [Country code or country name PleaseClick Here] | No | string |
billing_firstname | First Name(billing address) | No | string |
billing_lastname | Last Name(billing address) | No | string |
billing_phone | Phone (billing address) | No | string |
billing_zipcode | Zipcode (billing address) | No | string |
billing_latitude | Latitude (billing address) | No | string |
billing_longitude | Longitude (billing address) | No | string |
shipping_address | Shipping address | No | string |
shipping_address2 | Shipping address - Line 2 | No | string |
shipping_city | City(Shipping address) | No | string |
shipping_state | State(Shipping address) | No | string |
shipping_country | Country (Shipping address) [Country code or country name PleaseClick Here] | Yes | string |
shipping_firstname | First Name(Shipping address) | No | string |
shipping_lastname | Last Name(Shipping address) | No | string |
shipping_phone | Phone (Shipping address) | Yes | string |
shipping_zipcode | Zipcode (Shipping address) | Yes | string |
shipping_latitude | Latitude (Shipping address) | No | string |
shipping_longitude | Longitude (Shipping address) | No | string |
order_weight | Order weight (grams) | No | float |
box_length | Box length (cms) | No | integer |
box_breadth | Box breadth (cms) | No | integer |
box_height | Box height (cms) | No | integer |
order_date | Date of purchase (yyyy-mm-dd hh:mm:ss) | No | Date |
Contain product data in json format. for more details please find the below e.g:
\n\"products\":[
{
\"product\": \"My Test Product 4\",
\"price\": \"200\",
\"product_code\": \"JSN909\",
\"hsn_code\": \"123456\",
\"product_quantity\": \"1\",
\"discount\": \"0\",
\"tax_rate\": \"5\",
\"tax_title\": \"IGST\"
},
{
\"product\": \"My Test Product 23\",
\"price\": \"120\",
\"product_code\": \"JSN9999\",
\"hsn_code\": \"213456\",
\"product_quantity\": \"5\",
\"discount\": \"0\",
\"tax_rate\": \"5\",
\"tax_title\": \"IGST\"
}
]
| Name | Description |
|---|---|
product | name of the product |
price | price per quantity |
product_code | sku code of the product |
hsn_code | hsn code of the product |
product_quantity | no of quantity |
discount | discount per quantity (product discount and order discount can not be clubbed together) |
tax_rate | tax rate in percentage e.g., 18. If taxes in order request is 0 then it consider as including taxes else excluding taxes. |
tax_title | tax title e.g., IGST, SGST |
Note: All Calculations should be proper including tax rate, tax amount, discount, etc otherwise after insertion in shipway your order calculations mismatched.
\nHeaders
\nContent-Type | application/json |
Authorization | < Enter your $token (which is described inauthentication section) > |
Authorization
\n","urlObject":{"protocol":"https","path":["api","v2orders"],"host":["app","shipway","com"],"query":[],"variable":[]}},"response":[{"id":"633ecbc1-defe-46a2-9798-bc79eb21c82f","name":"Successful Call","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic YXJjaGl0c2FyZWVuMDdAZ21haWwuY29tOjN3Mk1YMWZabDR2bTlvM3E0ZzJtMDgyMW0wajIzMTQ3","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"order_id\": \"OD-10001-SS\",\r\n \"ewaybill\": \"AD767435878734PR\",\r\n \"products\": [\r\n {\r\n \"product\": \"My Test Product 4\",\r\n \"price\": \"200\",\r\n \"product_code\": \"JSN909\",\r\n \"product_quantity\": \"1\",\r\n \"discount\": \"0\",\r\n \"tax_rate\": \"5\",\r\n \"tax_title\": \"IGST\"\r\n },\r\n {\r\n \"product\": \"My Test Product 23\",\r\n \"price\": \"120\",\r\n \"product_code\": \"JSN9999\",\r\n \"product_quantity\": \"15\",\r\n \"discount\": \"0\",\r\n \"tax_rate\": \"5\",\r\n \"tax_title\": \"IGST\"\r\n }\r\n ],\r\n \"discount\": \"0\",\r\n \"shipping\": \"30\",\r\n \"order_total\": \"870\",\r\n \"gift_card_amt\": \"100\",\r\n \"taxes\": \"40\",\r\n \"payment_type\": \"P\",\r\n \"email\": \"customer@email.com\",\r\n \"billing_address\": \"#321\",\r\n \"billing_address2\": \"MG Road\",\r\n \"billing_city\": \"Gurgaon\",\r\n \"billing_state\": \"Haryana\",\r\n \"billing_country\": \"India\",\r\n \"billing_firstname\": \"John\",\r\n \"billing_lastname\": \"Doe\",\r\n \"billing_phone\": \"9999999999\",\r\n \"billing_zipcode\": \"122001\",\r\n \"billing_latitude\": \"10\",\r\n \"billing_longitude\": \"20\",\r\n \"shipping_address\": \"#321\",\r\n \"shipping_address2\": \"MG Road\",\r\n \"shipping_city\": \"Gurgaon\",\r\n \"shipping_state\": \"Haryana\",\r\n \"shipping_country\": \"India\",\r\n \"shipping_firstname\": \"John\",\r\n \"shipping_lastname\": \"Doe\",\r\n \"shipping_phone\": \"9999999999\",\r\n \"shipping_zipcode\": \"122001\",\r\n \"shipping_latitude\": \"10\",\r\n \"shipping_longitude\": \"20\",\r\n \"order_weight\": \"110\",\r\n \"box_length\": \"20\",\r\n \"box_breadth\": \"15\",\r\n \"box_height\": \"10\",\r\n \"order_date\": \"2022-06-21 15:30:02\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.shipway.com/api/v2orders"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 21 Jun 2022 10:00:02 GMT"},{"key":"Server","value":"Apache"},{"key":"Expires","value":"Mon, 26 Jul 1997 05:00:00 GMT"},{"key":"Last-Modified","value":"Tue, 21 Jun 2022 10:00:02 GMT"},{"key":"Cache-Control","value":"private"},{"key":"Content-Length","value":"63"},{"key":"Keep-Alive","value":"timeout=10, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Order has been added successfully.\"\n}"},{"id":"4aed7f67-0f34-4680-944f-08f0249a9d38","name":"Invalid Data","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Basic YXJjaGl0c2FyZWVuMDdAZ21haWwuY29tOjN3Mk1YMWZabDR2bTlvM3E0ZzJtMDgyMW0wajIzMTQ3","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"order_id\": \"\",\r\n \"ewaybill\": \"\",\r\n \"products\": [\r\n {\r\n \"product\": \"My Test Product 5\",\r\n \"price\": \"200\",\r\n \"product_code\": \"JSN909\",\r\n \"amount\": \"1\",\r\n \"discount\": \"0\",\r\n \"tax_rate\": \"5\",\r\n \"tax_title\": \"IGST\"\r\n },\r\n {\r\n \"product\": \"My Test Product 23\",\r\n \"price\": \"120\",\r\n \"product_code\": \"JSN9999\",\r\n \"amount\": \"150\",\r\n \"discount\": \"0\",\r\n \"tax_rate\": \"5\",\r\n \"tax_title\": \"IGST\"\r\n }\r\n ],\r\n \"discount\": \"0\",\r\n \"shipping\": \"30\",\r\n \"order_total\": \"870\",\r\n \"gift_card_amt\": \"100\",\r\n \"taxes\": \"40\",\r\n \"payment_type\": \"P\",\r\n \"email\": \"customer@email.com\",\r\n \"billing_address\": \"#321\",\r\n \"billing_address2\": \"MG Road\",\r\n \"billing_city\": \"Gurgaon\",\r\n \"billing_state\": \"Haryana\",\r\n \"billing_country\": \"India\",\r\n \"billing_firstname\": \"John\",\r\n \"billing_lastname\": \"Doe\",\r\n \"billing_phone\": \"9999999999\",\r\n \"billing_zipcode\": \"122001\",\r\n \"billing_latitude\": \"10\",\r\n \"billing_longitude\": \"20\",\r\n \"shipping_address\": \"#321\",\r\n \"shipping_address2\": \"MG Road\",\r\n \"shipping_city\": \"Gurgaon\",\r\n \"shipping_state\": \"Haryana\",\r\n \"shipping_country\": \"India\",\r\n \"shipping_firstname\": \"John\",\r\n \"shipping_lastname\": \"Doe\",\r\n \"shipping_phone\": \"9999999999\",\r\n \"shipping_zipcode\": \"122001\",\r\n \"shipping_latitude\": \"10\",\r\n \"shipping_longitude\": \"20\",\r\n \"order_weight\": \"110\",\r\n \"box_length\": \"20\",\r\n \"box_breadth\": \"15\",\r\n \"box_height\": \"10\",\r\n \"order_date\": \"2022-06-21 15:30:02\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.shipway.com/api/v2orders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 21 Jun 2022 10:00:59 GMT"},{"key":"Server","value":"Apache"},{"key":"Expires","value":"Mon, 26 Jul 1997 05:00:00 GMT"},{"key":"Last-Modified","value":"Tue, 21 Jun 2022 10:00:59 GMT"},{"key":"Cache-Control","value":"private"},{"key":"Content-Length","value":"58"},{"key":"Keep-Alive","value":"timeout=10, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"Field order_id is mandatory.\"\n}"}],"_postman_id":"a6b797f2-4f3b-4f5d-b9a2-ea91788fb29e"},{"name":"Push order with label generation","id":"8418c7c5-201c-492a-81b4-44ab640a25b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"Shipway provides Shipment booking / Generate Shipping Labels to interact with Shipway system merchants to PUSH orders in Shipway system enables merchants to PUSH orders in Shipway system.
\nParameters
\n| Field Name | Description | Mandatory | Data Type |
|---|---|---|---|
order_id | Merchant's Order ID | Yes | string |
carrier_id | To assign your required carrier enter desired \"Carrier ID\" otherwise if \"Carrier ID\" field is left empty, \"Shipway's Recommended Carrier\" will be automatically assigned. | No | integer |
warehouse_id | Warehouse ID | Yes | integer |
return_warehouse_id | Return Warehouse ID | Yes | integer |
ewaybill | Please provide E-waybill. It is mandatory for shipments with amount greater than Rs.50,000 | No | string |
products | Products belonging to order | Yes | json |
payment_type | P - Prepaid, C - COD | Yes | string |
email | Customer email | No | string |
discount | Total discount for order (Value should be positive) | No | decimal |
gift_card_amt | Gift card amount if apply gift card on orders (Value should be positive) | No | decimal |
taxes | Total tax amount for order (INR) | No | decimal |
tax_rate | Tax percentage | No | decimal |
tax_title | Tax Title (IGST,SGST,CGST) | No | string |
shipping | Total shipping amount for order (INR) | No | decimal |
order_total | Total order value (Final amount after checkout) | No | string |
billing_address | Billing address | No | string |
billing_address2 | Billing address - Line 2 | No | string |
billing_city | City(billing address) | No | string |
billing_state | State(billing address) | No | string |
billing_country | Country (billing address) [Country code or country name PleaseClick Here] | No | string |
billing_firstname | First Name(billing address) | No | string |
billing_lastname | Last Name(billing address) | No | string |
billing_phone | Phone (billing address) | No | string |
billing_zipcode | Zipcode (billing address) | No | string |
billing_latitude | Latitude (billing address) | No | string |
billing_longitude | Longitude (billing address) | No | string |
shipping_address | Shipping address | No | string |
shipping_address2 | Shipping address - Line 2 | No | string |
shipping_city | City(Shipping address) | No | string |
shipping_state | State(Shipping address) | No | string |
shipping_country | Country (Shipping address) [Country code or country name PleaseClick Here] | Yes | string |
shipping_firstname | First Name(Shipping address) | No | string |
shipping_lastname | Last Name(Shipping address) | No | string |
shipping_phone | Phone (Shipping address) | Yes | string |
shipping_zipcode | Zipcode (Shipping address) | Yes | string |
shipping_latitude | Latitude (Shipping address) | No | string |
shipping_longitude | Longitude (Shipping address) | No | string |
order_weight | Order weight (grams) | No | float |
box_length | Box length (cms) | No | integer |
box_breadth | Box breadth (cms) | No | integer |
box_height | Box height (cms) | No | integer |
order_date | Date of purchase (yyyy-mm-dd hh:mm:ss) | No | Date |
invoice_number_prefix | Y - Prefix Required, Set from Shipway > Manage Invoice > General Settings , N - Prefix Not Required (Default - N) | No | string |
invoice_number | Invoice Number (Prefix = Y, Numeric Only, Prefix = N, Alphanumeric) | No | string |
order_status | A - Processed, G - Dispatch (Required - If order_tracking_number is not empty) | Optional | string |
order_tracking_number | AWB Number (Required - If order_status is not empty) | Optional | string |
Headers
\nContent-Type | application/json |
Authorization | < Enter your $token (which is described inauthentication section) > |
Authorization
\n","urlObject":{"protocol":"https","path":["api","v2orders"],"host":["app","shipway","com"],"query":[],"variable":[]}},"response":[{"id":"761fa9ea-b84c-456c-bf10-8abebda55af7","name":"Successful call","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic YXJjaGl0c2FyZWVuMDdAZ21haWwuY29tOjN3Mk1YMWZabDR2bTlvM3E0ZzJtMDgyMW0wajIzMTQ3","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"order_id\": \"OD-10003-SS\",\r\n \"carrier_id\": 3411,\r\n \"warehouse_id\": \"6430\",\r\n \"return_warehouse_id\": \"6430\",\r\n \"ewaybill\": \"AD767435878734PR\",\r\n \"products\": [\r\n {\r\n \"product\": \"My Test Product 5\",\r\n \"price\": \"200\",\r\n \"product_code\": \"JSN909\",\r\n \"product_quantity\": \"1\",\r\n \"discount\": \"0\",\r\n \"tax_rate\": \"5\",\r\n \"tax_title\": \"IGST\"\r\n },\r\n {\r\n \"product\": \"My Test Product 23\",\r\n \"price\": \"120\",\r\n \"product_code\": \"JSN9999\",\r\n \"product_quantity\": \"10\",\r\n \"discount\": \"0\",\r\n \"tax_rate\": \"5\",\r\n \"tax_title\": \"IGST\"\r\n }\r\n ],\r\n \"discount\": \"0\",\r\n \"shipping\": \"30\",\r\n \"order_total\": \"870\",\r\n \"gift_card_amt\": \"100\",\r\n \"taxes\": \"40\",\r\n \"payment_type\": \"P\",\r\n \"email\": \"customer@email.com\",\r\n \"billing_address\": \"#321\",\r\n \"billing_address2\": \"MG Road\",\r\n \"billing_city\": \"Gurgaon\",\r\n \"billing_state\": \"Haryana\",\r\n \"billing_country\": \"India\",\r\n \"billing_firstname\": \"John\",\r\n \"billing_lastname\": \"Doe\",\r\n \"billing_phone\": \"9999999999\",\r\n \"billing_zipcode\": \"122001\",\r\n \"billing_latitude\": \"10\",\r\n \"billing_longitude\": \"20\",\r\n \"shipping_address\": \"#321\",\r\n \"shipping_address2\": \"MG Road\",\r\n \"shipping_city\": \"Gurgaon\",\r\n \"shipping_state\": \"Haryana\",\r\n \"shipping_country\": \"India\",\r\n \"shipping_firstname\": \"John\",\r\n \"shipping_lastname\": \"Doe\",\r\n \"shipping_phone\": \"9999999999\",\r\n \"shipping_zipcode\": \"122001\",\r\n \"shipping_latitude\": \"30\",\r\n \"shipping_longitude\": \"40\",\r\n \"order_weight\": \"110\",\r\n \"box_length\": \"20\",\r\n \"box_breadth\": \"15\",\r\n \"box_height\": \"10\",\r\n \"order_date\": \"2022-06-21 15:35:02\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.shipway.com/api/v2orders"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 21 Jun 2022 10:07:44 GMT"},{"key":"Server","value":"Apache"},{"key":"Expires","value":"Mon, 26 Jul 1997 05:00:00 GMT"},{"key":"Last-Modified","value":"Tue, 21 Jun 2022 10:07:44 GMT"},{"key":"Cache-Control","value":"private"},{"key":"Content-Length","value":"285"},{"key":"Keep-Alive","value":"timeout=10, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Order has been added successfully.\",\n \"awb_response\": {\n \"success\": true,\n \"message\": \"AWB No. assigned Successfully\",\n \"AWB\": \"1333110020164\",\n \"carrier_id\": \"3411\",\n \"shipping_url\": \"https://app.shipway.com/shipping_labels/a3359e03e70ae96dd4f97cfe788fa859_thermal.pdf\"\n }\n}"},{"id":"41b67616-172b-40f1-a819-a8f93d5decec","name":"Invalid Data","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic YXJjaGl0c2FyZWVuMDdAZ21haWwuY29tOjN3Mk1YMWZabDR2bTlvM3E0ZzJtMDgyMW0wajIzMTQ3","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"order_id\": \"OD-10004-SS\",\r\n \"carrier_id\": 3411,\r\n \"ewaybill\": \"AD767435878734PR\",\r\n \"products\": [\r\n {\r\n \"product\": \"My Test Product 5\",\r\n \"price\": \"200\",\r\n \"product_code\": \"JSN909\",\r\n \"product_quantity\": \"1\",\r\n \"discount\": \"0\",\r\n \"tax_rate\": \"5\",\r\n \"tax_title\": \"IGST\"\r\n },\r\n {\r\n \"product\": \"My Test Product 23\",\r\n \"price\": \"120\",\r\n \"product_code\": \"JSN9999\",\r\n \"product_quantity\": \"10\",\r\n \"discount\": \"0\",\r\n \"tax_rate\": \"5\",\r\n \"tax_title\": \"IGST\"\r\n }\r\n ],\r\n \"discount\": \"0\",\r\n \"shipping\": \"30\",\r\n \"order_total\": \"870\",\r\n \"gift_card_amt\": \"100\",\r\n \"taxes\": \"40\",\r\n \"payment_type\": \"P\",\r\n \"email\": \"customer@email.com\",\r\n \"billing_address\": \"#321\",\r\n \"billing_address2\": \"MG Road\",\r\n \"billing_city\": \"Gurgaon\",\r\n \"billing_state\": \"Haryana\",\r\n \"billing_country\": \"India\",\r\n \"billing_firstname\": \"John\",\r\n \"billing_lastname\": \"Doe\",\r\n \"billing_phone\": \"9999999999\",\r\n \"billing_zipcode\": \"122001\",\r\n \"billing_latitude\": \"10\",\r\n \"billing_longitude\": \"20\",\r\n \"shipping_address\": \"#321\",\r\n \"shipping_address2\": \"MG Road\",\r\n \"shipping_city\": \"Gurgaon\",\r\n \"shipping_state\": \"Haryana\",\r\n \"shipping_country\": \"India\",\r\n \"shipping_firstname\": \"John\",\r\n \"shipping_lastname\": \"Doe\",\r\n \"shipping_phone\": \"9999999999\",\r\n \"shipping_zipcode\": \"122001\",\r\n \"shipping_latitude\": \"30\",\r\n \"shipping_longitude\": \"40\",\r\n \"order_weight\": \"110\",\r\n \"box_length\": \"20\",\r\n \"box_breadth\": \"15\",\r\n \"box_height\": \"10\",\r\n \"order_date\": \"2022-06-21 15:35:02\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.shipway.com/api/v2orders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 21 Jun 2022 10:08:55 GMT"},{"key":"Server","value":"Apache"},{"key":"Expires","value":"Mon, 26 Jul 1997 05:00:00 GMT"},{"key":"Last-Modified","value":"Tue, 21 Jun 2022 10:08:55 GMT"},{"key":"Cache-Control","value":"private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"84"},{"key":"Keep-Alive","value":"timeout=10, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"warehouse_id not exists., return_warehouse_id not exists.\"\n}"}],"_postman_id":"8418c7c5-201c-492a-81b4-44ab640a25b6"},{"name":"Orders using diff parameter","id":"fba0ff55-b1e2-4d1a-b329-452e4df7ca1f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"Shipway provides GET API to interact with Shipway system. This Rest API enables merchants to GET orders from Shipway system.
\nGET Orders:
Shipway provide you access to get your order from Shipway system. In this, you can get orders in chunks of 100 at use of URL for following status:
Headers
\nAuthorization. | < Enter your $token (which is described inauthentication section) > |
Parameter
\nOrder Status Description
\nStatus Description\nO:- New order\nA:- Processing\nE:- Manifested\nG:- Dispatched\n\nShipment Status Description
\nShipment Status Description\nDEL:- Delivered\nINT:- In Transit\nUND:- Undelivered\nRTO:- RTO\nRTD:- RTO Delivered\nCAN:- Canceled\nSCH:- Shipment Booked\nONH:- On Hold\nOOD:- Out For Delivery\nNFI:- Status Pending\nNFIDS:- NFID\nRSCH:- Pickup Scheduled\nROOP:- Out for Pickup\nRPKP:- Shipment Picked Up\nRDEL:- Return Delivered\nRINT:- Return In Transit\nRPSH:- Pickup Rescheduled\nRCAN:- Return Request Cancelled\nRCLO:- Return Request Closed\nRSMD:- Pickup Delayed\nPCAN:- Pickup Cancelled\nROTH:- Others\nRPF:- Pickup Failed\n\nShipway provides Manifest order API to interact with Shipway system. This Rest API enables merchants to create Manifest order in Shipway system.
\nParameter
| Field Name | \nDescription | \nMandatory | \nData Type | \n
|---|---|---|---|
order_ids | \n order ids added in json format like [\"test\",\"test\"] | \nYes | \nstring |
| Authorization | \n< Enter your $token (which is described in authentication section) > | \n
Shipway provides Onhold order API to interact with Shipway system. This Rest API enables merchants to create onhold order in Shipway system.
\nParameter
| Field Name | \nDescription | \nMandatory | \nData Type | \n
|---|---|---|---|
order_ids | \n order ids added in json format like [\"test\",\"test\"] (You can mark as Onhold only New Orders) | \nYes | \nstring | \n
Headers
| Authorization | \n< Enter your $token (which is described in authentication section) > | \n
Shipway provides Cancel order API to interact with Shipway system. This Rest API enables merchants to create Cancel order in Shipway system.\n
Parameter
| Field Name | \nDescription | \nMandatory | \nData Type | \n
|---|---|---|---|
order_ids | \n Order ids added in json format like [\"test\",\"test\"] (You can Cancel only New and Onhold Orders) | \nYes | \nstring |
| Authorization | \n< Enter your $token (which is described in authentication section) > | \n
Shipway provides Pickup Create to interact with Shipway system. This Rest API enables merchants to Pickup Create from Shipway system.
Parameter
| Field Name | Description | Mandatory | Data Type |
|---|---|---|---|
pickup_date | Pickup Date (yyyy-dd-mm) | Yes | date |
pickup_time | Pickup Time (hh:mm) | Yes | time |
carrier_id | Carrier Id Of Carrier | Yes | integer |
office_close_time | Office Closing time (hh:mm) | Yes | time |
warehouse_id | Warehouse id from where You want to Pickup | Yes | integer |
return_warehouse_id | Warehouse id of return | Yes | integer |
payment_type | P - Prepaid, C - COD | Yes | string |
order_ids | Merchant's Order IDs | Yes | string |
Headers
\nContent-Type | application/json |
Authorization | < Enter your $token (which is described in authentication section) > |
Authorization
\n","urlObject":{"protocol":"https","path":["api","createpickup",""],"host":["app","shipway","com"],"query":[],"variable":[]}},"response":[{"id":"9e7d5da3-8023-4114-8683-c36d546e0681","name":"Successful Call","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Basic YXJjaGl0c2FyZWVuMDdAZ21haWwuY29tOjN3Mk1YMWZabDR2bTlvM3E0ZzJtMDgyMW0wajIzMTQ3","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"pickup_date\":\"2019-10-16\",\r\n \"pickup_time\":\"14:30\",\r\n \"office_close_time\":\"18:00\",\r\n \"package_count\":\"1\",\r\n \"carrier_id\":\"1\",\r\n \"warehouse_id\":\"5163\",\r\n \"return_warehouse_id\":\"1\",\r\n \"payment_type\":\"C\",\r\n \"order_ids\":\r\n [\r\n \"1002\",\r\n \"10757958\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.shipway.com/api/createpickup/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 04 Mar 2021 11:51:34 GMT"},{"key":"Server","value":"Apache"},{"key":"Expires","value":"Mon, 26 Jul 1997 05:00:00 GMT"},{"key":"Last-Modified","value":"Thu, 04 Mar 2021 11:51:34 GMT"},{"key":"Cache-Control","value":"private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"145"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": \"\",\n \"error\": 1,\n \"message\": \"Order Ids may be not match with payment type OR Order Ids may be not in (Processing or manifested) OR Order Ids may be not found OR Order Ids may not belong to carrier id\"\n}"},{"id":"bf14d337-fe6d-4a51-b4a0-ddfdb41bfe92","name":"Invalid Data","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Basic YXJjaGl0c2FyZWVuMDdAZ21haWwuY29tOjN3Mk1YMWZabDR2bTlvM3E0ZzJtMDgyMW0wajIzMTQ3","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"pickup_date\":\"2019-10-16\",\r\n \"pickup_time\":\"14:30\",\r\n \"office_close_time\":\"18:00\",\r\n \"package_count\":\"1\",\r\n \"carrier_id\":\"1\",\r\n \"warehouse_id\":\"3451\",\r\n \"return_warehouse_id\":\"1\",\r\n \"payment_type\":\"C\",\r\n \"order_ids\":\r\n [\r\n \"5189\",\r\n \"5202\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.shipway.com/api/createpickup/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 04 Mar 2021 11:55:50 GMT"},{"key":"Server","value":"Apache"},{"key":"Expires","value":"Mon, 26 Jul 1997 05:00:00 GMT"},{"key":"Last-Modified","value":"Thu, 04 Mar 2021 11:55:50 GMT"},{"key":"Cache-Control","value":"private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"161"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": \"\",\n \"error\": 1,\n \"message\": \"warehouse Id does not exists, Order Ids may be not match with payment type OR Order Ids may be not in (Processing or manifested) OR Order Ids may be not found OR Order Ids may not belong to carrier id\"\n}"}],"_postman_id":"d700bf49-cd37-4af6-9ec6-1c5afbcf8cee"},{"name":"Cancel Shipment","id":"c42f2ba0-7af0-4ead-afc6-b08af58320f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"Shipway provides Cancel Shipment API to interact with the Shipway system to cancel shipments. This Rest API enables merchants to create a Cancel order in the Shipway system as well courier side.
\nParameter
\n| Field Name | Description | Mandatory | Data Type |
|---|---|---|---|
| awb_number | - Shipway order status must be processing and shipment status must not be In-transit, Delivered & RTO - You can cancel the return shipment also. But Cancel Return Shipment allowed only for Return Awaited, Shipped by Customer and Pickup Generated status | Yes | String |
Note: we are providing order unassignment on the following courier at carrier side. For the other courier, shipment cancel will be happening at Shipway side only.
\n| 1 | Amazon Shipping |
| 2 | DTDC DP |
| 3 | Dunzo |
| 4 | Ecom Express |
| 5 | Fedex |
| 6 | Ithink Logisticsclick here |
| 7 | Pickrr |
| 8 | Shiprocket |
Shipway provides Push Orders to interact with Shipway system. This Rest API enables merchants to PUSH orders in Shipway system.
\n","_postman_id":"e5ab6e56-caaa-4e2c-bdd9-a163ca8591d8"},{"name":"Returns","item":[{"name":"Create Returns Shipment","id":"ffa4edb1-16f2-4c1c-b324-18df0d41e10f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"Create Return Shipment:\nThe API creates an Return Order on Shipway. The body of this request should specify the following parameters:\n
\nParameters
| Field Name | \nDescription | \nMandatory | \nData Type | \n
|---|---|---|---|
order_id | \n Merchant's Order ID | \nYes | \nstring | \n
return_order_status | \n E - Exchange, R - Refund | \nYes | \nstring | \n
return_reason_id | \n Return Reasons id By Using this click here | \nYes | \ninteger | \n
refund_payment_id | \n Get Refund Payment id (For more details Please check Refund Payment Methods) | \nYes( Mandatory for return_order_status='R') | \ninteger | \n
transfer_details | \n In which refund mode you want to refund Like (Bank transfer,Upi,Paytm,Gift card and Store credits) | \nYes( Mandatory for return_order_status='R') | \njson | \n
return_products_images | \n Return Product Image ask to Customer | \nConditional (Depends on return settings save in your panel) | \njson | \n
customer_notes | \n Customer Notes/Feedback | \nNo | \nstring | \n
products | \n Products belonging to order | \nYes | \njson | \n
payment_type | \n P - Prepaid, C - COD | \nYes | \nstring | \n
email | \n Customer email | \nNo | \nstring | \n
discount | \n Total discount for order (INR) | \nNo | \ndecimal | \n
gift_card_amt | \n Gift card amount if apply gift card on orders (INR) | \nNo | \ndecimal | \n
taxes | \n Oders Taxes (INR) | \nNo | \ndecimal | \n
tax_rate | \n Tax Rate | \nNo | \ndecimal | \n
tax_title | \n Tax Title (IGST,SGST,CGST) | \nNo | \nstring | \n
shipping | \n Total shipping amount for order (INR) | \nNo | \ndecimal | \n
order_total | \n Grand total of order | \nNo | \nstring | \n
billing_address | \n Billing address | \nNo | \nstring | \n
billing_address2 | \n Billing address - Line 2 | \nNo | \nstring | \n
billing_city | \n City(billing address) | \nNo | \nstring | \n
billing_state | \n State(billing address) | \nNo | \nstring | \n
billing_country | \n Country (billing address) [Country code or country name Please Click Here] | \n No | \nstring | \n
billing_firstname | \n First Name(billing address) | \nNo | \nstring | \n
billing_lastname | \n Last Name(billing address) | \nNo | \nstring | \n
billing_phone | \n Phone (billing address) | \nNo | \nstring | \n
billing_zipcode | \n Zipcode (billing address) | \nNo | \nstring | \n
shipping_address | \n Shipping address | \nNo | \nstring | \n
shipping_address2 | \n Shipping address - Line 2 | \nNo | \nstring | \n
shipping_city | \n City(Shipping address) | \nNo | \nstring | \n
shipping_state | \n State(Shipping address) | \nNo | \nstring | \n
shipping_country | \n Country (Shipping address) [Country code or country name Please Click Here] | \n Yes | \nstring | \n
shipping_firstname | \n First Name(Shipping address) | \nNo | \nstring | \n
shipping_lastname | \n Last Name(Shipping address) | \nNo | \nstring | \n
shipping_phone | \n Phone (Shipping address) | \nYes | \nstring | \n
shipping_zipcode | \n Zipcode (Shipping address) | \nYes | \nstring | \n
order_weight | \n Order weight (grams) | \nNo | \nfloat | \n
box_length | \n Box length (cms) | \nNo | \ninteger | \n
box_breadth | \n Box breadth (cms) | \nNo | \ninteger | \n
box_height | \n Box height (cms) | \nNo | \ninteger | \n
order_date | \n Date of purchase (yyyy-mm-dd hh:mm:ss) | \nNo | \nDate | \n
| refund_payment_id | \npayment_mode | \n
|---|---|
1 | \n Bank Account | \n
2 | \n UPI | \n
3 | \n Paytm | \n
4 | \n Gift Card | \n
5 | \n Store Credits | \n
| refund_payment_id | \npayment_mode | \n
|---|---|
4 | \n Gift Card | \n
5 | \n Store Credits | \n
6 | \n Original payment method | \n
| Content-Type | \napplication/json | \n
| Authorization | \n< Enter your $token (which is described in authentication section) > | \n
This Rest API enables merchants to create return orders with Assign awb in Shipway system. Please be noted that you do not need to use Create Returns Shipment API when using this Rest API.
\nPlease enable reverse auto-assignment in the system before utilising this API.
\nParameters
\n| Field Name | Description | Mandatory | Data Type |
|---|---|---|---|
order_id | Merchant's Order ID | Yes | string |
return_order_status | E - Exchange, R - Refund | Yes | string |
return_reason_id | Return Reasons id | Yes | integer |
refund_payment_id | Get Refund Payment id (For more details Please check Refund Payment Methods) | Yes( Mandatory for return_order_status='R') | integer |
transfer_details | In which refund mode you want to refund Like (Bank transfer,Upi,Paytm,Gift card and Store credits) | Yes( Mandatory for return_order_status='R') | json |
return_products_images | Return Product Image ask to Customer | Conditional (Depends on return settings save in your panel) | json |
customer_notes | Customer Notes/Feedback | No | string |
return_warehouse_id | Return Warehouse id where you want to return orders | Yes | integer |
products | Products belonging to order | Yes | json |
payment_type | P - Prepaid, C - COD | Yes | string |
email | Customer email | No | string |
discount | Total discount for order (INR) | No | decimal |
gift_card_amt | Gift card amount if apply gift card on orders (INR) | No | decimal |
taxes | Oders Taxes (INR) | No | decimal |
tax_rate | Tax Rate | No | decimal |
tax_title | Tax Title (IGST,SGST,CGST) | No | string |
shipping | Total shipping amount for order (INR) | No | decimal |
order_total | Grand total of order | No | string |
billing_address | Billing address | No | string |
billing_address2 | Billing address - Line 2 | No | string |
billing_city | City(billing address) | No | string |
billing_state | State(billing address) | No | string |
billing_country | Country (billing address) [Country code or country name PleaseClick Here] | No | string |
billing_firstname | First Name(billing address) | No | string |
billing_lastname | Last Name(billing address) | No | string |
billing_phone | Phone (billing address) | No | string |
billing_zipcode | Zipcode (billing address) | No | string |
shipping_address | Shipping address | No | string |
shipping_address2 | Shipping address - Line 2 | No | string |
shipping_city | City(Shipping address) | No | string |
shipping_state | State(Shipping address) | No | string |
shipping_country | Country (Shipping address) [Country code or country name PleaseClick Here] | Yes | string |
shipping_firstname | First Name(Shipping address) | No | string |
shipping_lastname | Last Name(Shipping address) | No | string |
shipping_phone | Phone (Shipping address) | Yes | string |
shipping_zipcode | Zipcode (Shipping address) | Yes | string |
order_weight | Order weight (grams) | No | float |
box_length | Box length (cms) | No | integer |
box_breadth | Box breadth (cms) | No | integer |
box_height | Box height (cms) | No | integer |
order_date | Date of purchase (yyyy-mm-dd hh:mm:ss) | No | Date |
pickup_datetime | Pickup Date time (yyyy-mm-dd hh:mm:ss) | No | Date |
Refund Payment Methods
\nFor COD Refunds
\n\n| refund_payment_id | payment_mode |
|---|---|
1 | Bank Account |
2 | UPI |
4 | Gift Card |
5 | Store Credits |
For Prepaid Refunds
| refund_payment_id | payment_mode |
|---|---|
4 | Gift Card |
5 | Store Credits |
6 | Original payment method |
Headers
\nContent-Type | application/json |
Authorization | < Enter your $token (which is described inauthentication section) > |
Authorization
\n","urlObject":{"protocol":"https","path":["api","Createreturns"],"host":["app","shipway","com"],"query":[],"variable":[]}},"response":[{"id":"ea18b5e2-7b5a-4393-882f-d3f43597b497","name":"Refund Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic YXJjaGl0c2FyZWVuMDdAZ21haWwuY29tOjN3Mk1YMWZabDR2bTlvM3E0ZzJtMDgyMW0wajIzMTQ3","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"order_id\": \"TEST7\",\r\n \"return_order_status\": \"R\",\r\n \"carrier_id\": \"7449\",\r\n \"return_warehouse_id\": \"10490\",\r\n \"refund_payment_id\": \"1\",\r\n \"transfer_details\": {\r\n \"account_number\": \"12345678904444\",\r\n \"phone\": \"xxxxxxxx78\",\r\n \"ifsc_code\": \"HDFC0004393\",\r\n \"account_type\": \"saving\",\r\n \"beneficiary_name\": \"Pooja\",\r\n \"bank_name\": \"HDFC Bank\"\r\n },\r\n \"products\": [\r\n {\r\n \"product\": \"My Test Product 56\",\r\n \"price\": \"200\",\r\n \"product_code\": \"JSN909\",\r\n \"amount\": \"1\",\r\n \"discount\": \"0\",\r\n \"tax_rate\": \"5\",\r\n \"tax_title\": \"IGST\",\r\n \"return_reason_id\": \"6204\",\r\n \"return_products_images\": [\r\n \"https://example.com/bournvita-500-g-0-20210311.JPG\",\r\n \"https://example.com/bournvita.gif\"\r\n ],\r\n \"customer_notes\": \"Need small size \",\r\n \"variants\": \"red\"\r\n }\r\n ],\r\n \"discount\": \"0\",\r\n \"shipping\": \"30\",\r\n \"order_total\": \"870\",\r\n \"gift_card_amt\": \"100\",\r\n \"taxes\": \"40\",\r\n \"payment_type\": \"C\",\r\n \"email\": \"customer@email.com\",\r\n \"billing_address\": \"#321\",\r\n \"billing_address2\": \"MG Road\",\r\n \"billing_city\": \"Gurgaon\",\r\n \"billing_state\": \"Haryana\",\r\n \"billing_country\": \"India\",\r\n \"billing_firstname\": \"John\",\r\n \"billing_lastname\": \"Doe\",\r\n \"billing_phone\": \"9999999999\",\r\n \"billing_zipcode\": \"122001\",\r\n \"shipping_address\": \"#321\",\r\n \"shipping_address2\": \"MG Road\",\r\n \"shipping_city\": \"Gurgaon\",\r\n \"shipping_state\": \"Haryana\",\r\n \"shipping_country\": \"India\",\r\n \"shipping_firstname\": \"John\",\r\n \"shipping_lastname\": \"Doe\",\r\n \"shipping_phone\": \"9999999999\",\r\n \"shipping_zipcode\": \"122001\",\r\n \"order_weight\": \"110\",\r\n \"box_length\": \"20\",\r\n \"box_breadth\": \"15\",\r\n \"box_height\": \"10\",\r\n \"order_date\": \"2021-09-01 12:05:00\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.shipway.com/api/Createreturns"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 06 Sep 2021 08:51:59 GMT"},{"key":"Server","value":"Apache"},{"key":"Expires","value":"Mon, 26 Jul 1997 05:00:00 GMT"},{"key":"Last-Modified","value":"Mon, 06 Sep 2021 08:51:59 GMT"},{"key":"Cache-Control","value":"private"},{"key":"Content-Length","value":"317"},{"key":"Keep-Alive","value":"timeout=10, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": 1,\n \"error\": 0,\n \"message\": \"Order has been added successfully.\",\n \"create_return_response\": {\n \"success\": 1,\n \"error\": 0,\n \"rma_no\": \"70694.TEST7-R\",\n \"message\": \" Return is created successfully\"\n },\n \"awb_response\": {\n \"success\": 1,\n \"error\": 0,\n \"rma_no\": \"70694.TEST7-R\",\n \"message\": \"AWB No assigned Successfully\",\n \"AWB\": \"241404214500006\"\n }\n}"},{"id":"eaed0591-1bbc-4ab0-a0c0-4895f87146d9","name":"Exchange Success","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Basic YXJjaGl0c2FyZWVuMDdAZ21haWwuY29tOjN3Mk1YMWZabDR2bTlvM3E0ZzJtMDgyMW0wajIzMTQ3","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"order_id\": \"TEST6\",\r\n \"return_order_status\": \"E\",\r\n \"carrier_id\": \"1\",\r\n \"return_warehouse_id\": \"1\",\r\n \"products\": [\r\n {\r\n \"product\": \"My Test Product 56\",\r\n \"price\": \"200\",\r\n \"product_code\": \"JSN909\",\r\n \"amount\": \"1\",\r\n \"discount\": \"0\",\r\n \"tax_rate\": \"5\",\r\n \"tax_title\": \"IGST\",\r\n \"return_reason_id\": \"0\",\r\n \"return_products_images\": [\r\n \"https://example.com/bournvita1.JPG\",\r\n \"https://example.com/bournvita2.JPG\"\r\n ],\r\n \"customer_notes\": \"Need small size \",\r\n \"variants\": \"red\"\r\n },\r\n {\r\n \"product\": \"My Test Product 23\",\r\n \"price\": \"120\",\r\n \"product_code\": \"JSN9999\",\r\n \"amount\": \"5\",\r\n \"discount\": \"0\",\r\n \"tax_rate\": \"5\",\r\n \"tax_title\": \"IGST\",\r\n \"return_reason_id\": \"0\",\r\n \"return_products_images\": [\r\n \"https://example.com/bournvita1.JPG\",\r\n \"https://example.com/bournvita2.JPG\"\r\n ],\r\n \"customer_notes\": \"Need small size \",\r\n \"variants\": \"green\"\r\n }\r\n ],\r\n \"discount\": \"0\",\r\n \"shipping\": \"30\",\r\n \"order_total\": \"870\",\r\n \"gift_card_amt\": \"0\",\r\n \"taxes\": \"40\",\r\n \"payment_type\": \"P\",\r\n \"email\": \"customer@email.com\",\r\n \"billing_address\": \"#321\",\r\n \"billing_address2\": \"MG Road\",\r\n \"billing_city\": \"Gurgaon\",\r\n \"billing_state\": \"Haryana\",\r\n \"billing_country\": \"India\",\r\n \"billing_firstname\": \"John\",\r\n \"billing_lastname\": \"Doe\",\r\n \"billing_phone\": \"9999999999\",\r\n \"billing_zipcode\": \"122001\",\r\n \"shipping_address\": \"#321\",\r\n \"shipping_address2\": \"MG Road\",\r\n \"shipping_city\": \"Gurgaon\",\r\n \"shipping_state\": \"Haryana\",\r\n \"shipping_country\": \"India\",\r\n \"shipping_firstname\": \"John\",\r\n \"shipping_lastname\": \"Doe\",\r\n \"shipping_phone\": \"9999999999\",\r\n \"shipping_zipcode\": \"122001\",\r\n \"order_weight\": \"110\",\r\n \"box_length\": \"20\",\r\n \"box_breadth\": \"15\",\r\n \"box_height\": \"10\",\r\n \"order_date\": \"2019-07-01 12:05:00\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.shipway.com/api/Createreturns"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Jun 2021 11:41:08 GMT"},{"key":"Server","value":"Apache"},{"key":"Expires","value":"Mon, 26 Jul 1997 05:00:00 GMT"},{"key":"Last-Modified","value":"Thu, 03 Jun 2021 11:41:08 GMT"},{"key":"Cache-Control","value":"private"},{"key":"Vary","value":"User-Agent"},{"key":"Content-Length","value":"303"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": 1,\n \"error\": 0,\n \"message\": \"Order has been added successfully.\",\n \"create_return_response\": {\n \"success\": 1,\n \"error\": 0,\n \"rma_no\": \"50613.TEST6-E\",\n \"message\": \" Return is created successfully\"\n },\n \"awb_response\": {\n \"success\": 1,\n \"rma_no\": \"50613.TEST6-E\",\n \"message\": \"AWB No assigned Successfully\",\n \"AWB\": \"69541467133\"\n }\n}"},{"id":"f231a6d6-b4bc-4f4e-af60-65208ada0969","name":"Invalid Data","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Basic YXJjaGl0c2FyZWVuMDdAZ21haWwuY29tOjN3Mk1YMWZabDR2bTlvM3E0ZzJtMDgyMW0wajIzMTQ3","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"order_id\": \"TESTAPRIL008\",\r\n \"carrier_id\": \"1\",\r\n \"return_warehouse_id\": \"1\",\r\n \"return_order_status\": \"E\",\r\n \"products\": [\r\n {\r\n \"product\": \"My Test Product 56\",\r\n \"price\": \"200\",\r\n \"product_code\": \"JSN909\",\r\n \"amount\": \"1\",\r\n \"discount\": \"0\",\r\n \"tax_rate\": \"5\",\r\n \"tax_title\": \"IGST\",\r\n \"return_reason_id\": \"0\",\r\n \"return_products_images\": [\r\n \"https://example.com/bournvita1.JPG\",\r\n \"https://example.com/bournvita2.JPG\"\r\n ],\r\n \"customer_notes\": \"Need small size \",\r\n \"variants\": \"red\"\r\n },\r\n {\r\n \"product\": \"My Test Product 23\",\r\n \"price\": \"120\",\r\n \"product_code\": \"JSN9999\",\r\n \"amount\": \"5\",\r\n \"discount\": \"0\",\r\n \"tax_rate\": \"5\",\r\n \"tax_title\": \"IGST\",\r\n \"return_reason_id\": \"0\",\r\n \"return_products_images\": [\r\n \"https://example.com/bournvita1.JPG\",\r\n \"https://example.com/bournvita2.JPG\"\r\n ],\r\n \"customer_notes\": \"Need small size \",\r\n \"variants\": \"green\"\r\n }\r\n ],\r\n \"discount\": \"0\",\r\n \"shipping\": \"30\",\r\n \"order_total\": \"870\",\r\n \"gift_card_amt\": \"0\",\r\n \"taxes\": \"40\",\r\n \"payment_type\": \"P\",\r\n \"email\": \"customer@email.com\",\r\n \"billing_address\": \"#321\",\r\n \"billing_address2\": \"MG Road\",\r\n \"billing_city\": \"Gurgaon\",\r\n \"billing_state\": \"Haryana\",\r\n \"billing_country\": \"India\",\r\n \"billing_firstname\": \"John\",\r\n \"billing_lastname\": \"Doe\",\r\n \"billing_phone\": \"9999999999\",\r\n \"billing_zipcode\": \"122001\",\r\n \"shipping_address\": \"#321\",\r\n \"shipping_address2\": \"MG Road\",\r\n \"shipping_city\": \"Gurgaon\",\r\n \"shipping_state\": \"Haryana\",\r\n \"shipping_country\": \"India\",\r\n \"shipping_firstname\": \"John\",\r\n \"shipping_lastname\": \"Doe\",\r\n \"shipping_phone\": \"9999999999\",\r\n \"shipping_zipcode\": \"122001\",\r\n \"order_weight\": \"110\",\r\n \"box_length\": \"20\",\r\n \"box_breadth\": \"15\",\r\n \"box_height\": \"10\",\r\n \"order_date\": \"2019-07-01 12:05:00\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.shipway.com/api/Createreturns"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 04 Mar 2021 11:41:03 GMT"},{"key":"Server","value":"Apache"},{"key":"Expires","value":"Mon, 26 Jul 1997 05:00:00 GMT"},{"key":"Last-Modified","value":"Thu, 04 Mar 2021 11:41:03 GMT"},{"key":"Cache-Control","value":"private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"101"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": \"\",\n \"error\": 1,\n \"message\": \"return_reason_id is not Exist,please contact administrator.\"\n}"}],"_postman_id":"a9c5d7a3-776c-4d8d-acf8-bdd39099b938"},{"name":"Generate Reverse Pickup with QC","id":"2d9e98bb-9bee-48ce-8cfa-137cca0ee2b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"This Rest API enables merchants to create return orders with Assign awb with QC in the Shipway system. Please note that you do not need to use the Create Returns Shipment API when using this Rest API.
\nPlease enable reverse auto-assignment in the system before utilising this API.
\nParameters
\n| Field Name | Description | Mandatory | Data Type |
|---|---|---|---|
order_id | Merchant's Order ID | Yes | string |
return_order_status | E - Exchange, R - Refund | Yes | string |
return_reason_id | Return Reasons id | Yes | integer |
refund_payment_id | Get Refund Payment id (For more details Please check Refund Payment Methods) | Yes( Mandatory for return_order_status='R') | integer |
transfer_details | In which refund mode you want to refund Like (Bank transfer,Upi,Paytm,Gift card and Store credits) | Yes( Mandatory for return_order_status='R') | json |
return_products_images | Return Product Image ask to Customer | Conditional (Depends on return settings save in your panel) | json |
customer_notes | Customer Notes/Feedback | No | string |
return_warehouse_id | Return Warehouse id where you want to return orders | Yes | integer |
products | Products belonging to order | Yes | json |
payment_type | P - Prepaid, C - COD | Yes | string |
email | Customer email | No | string |
discount | Total discount for order (INR) | No | decimal |
gift_card_amt | Gift card amount if apply gift card on orders (INR) | No | decimal |
taxes | Oders Taxes (INR) | No | decimal |
tax_rate | Tax Rate | No | decimal |
tax_title | Tax Title (IGST,SGST,CGST) | No | string |
shipping | Total shipping amount for order (INR) | No | decimal |
order_total | Grand total of order | No | string |
billing_address | Billing address | No | string |
billing_address2 | Billing address - Line 2 | No | string |
billing_city | City(billing address) | No | string |
billing_state | State(billing address) | No | string |
billing_country | Country (billing address) [Country code or country name PleaseClick Here] | No | string |
billing_firstname | First Name(billing address) | No | string |
billing_lastname | Last Name(billing address) | No | string |
billing_phone | Phone (billing address) | No | string |
billing_zipcode | Zipcode (billing address) | No | string |
shipping_address | Shipping address | No | string |
shipping_address2 | Shipping address - Line 2 | No | string |
shipping_city | City(Shipping address) | No | string |
shipping_state | State(Shipping address) | No | string |
shipping_country | Country (Shipping address) [Country code or country name PleaseClick Here] | Yes | string |
shipping_firstname | First Name(Shipping address) | No | string |
shipping_lastname | Last Name(Shipping address) | No | string |
shipping_phone | Phone (Shipping address) | Yes | string |
shipping_zipcode | Zipcode (Shipping address) | Yes | string |
order_weight | Order weight (grams) | No | float |
box_length | Box length (cms) | No | integer |
box_breadth | Box breadth (cms) | No | integer |
box_height | Box height (cms) | No | integer |
order_date | Date of purchase (yyyy-mm-dd hh:mm:ss) | No | Date |
pickup_datetime | Pickup Date time (yyyy-mm-dd hh:mm:ss) | No | Date |
quality_check | Choose if you want your product to be checked while being picked up or not(values:1 or 0) (This field is applicable only for QC applicable couriers.) | No(1 for open pickup and 0 for closed pickup) | String |
qc_checkurl | URL of the image in case of QC (Make sure the link shared is not password protected ) | No(required if quality_check is 1) | json |
Refund Payment Methods
\nFor COD Refunds
\n\n| refund_payment_id | payment_mode |
|---|---|
1 | Bank Account |
2 | UPI |
4 | Gift Card |
5 | Store Credits |
For Prepaid Refunds
| refund_payment_id | payment_mode |
|---|---|
4 | Gift Card |
5 | Store Credits |
6 | Original payment method |
Headers
\nContent-Type | application/json |
Authorization | < Enter your $token (which is described inauthentication section) > |
Authorization
\n","urlObject":{"protocol":"https","path":["api","Createreturns"],"host":["app","shipway","com"],"query":[],"variable":[]}},"response":[{"id":"c35281d3-086f-4673-9b32-53fb8cb5e1e6","name":"Refund Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic YXJjaGl0c2FyZWVuMDdAZ21haWwuY29tOjN3Mk1YMWZabDR2bTlvM3E0ZzJtMDgyMW0wajIzMTQ3","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"order_id\": \"TEST7\",\r\n \"return_order_status\": \"R\",\r\n \"carrier_id\": \"7449\",\r\n \"return_warehouse_id\": \"10490\",\r\n \"refund_payment_id\": \"1\",\r\n \"transfer_details\": {\r\n \"account_number\": \"12345678904444\",\r\n \"phone\": \"xxxxxxxx78\",\r\n \"ifsc_code\": \"HDFC0004393\",\r\n \"account_type\": \"saving\",\r\n \"beneficiary_name\": \"Pooja\",\r\n \"bank_name\": \"HDFC Bank\"\r\n },\r\n \"products\": [\r\n {\r\n \"product\": \"My Test Product 56\",\r\n \"price\": \"200\",\r\n \"product_code\": \"JSN909\",\r\n \"amount\": \"1\",\r\n \"discount\": \"0\",\r\n \"tax_rate\": \"5\",\r\n \"tax_title\": \"IGST\",\r\n \"return_reason_id\": \"6204\",\r\n \"return_products_images\": [\r\n \"https://example.com/bournvita-500-g-0-20210311.JPG\",\r\n \"https://example.com/bournvita.gif\"\r\n ],\r\n \"customer_notes\": \"Need small size \",\r\n \"variants\": \"red\"\r\n }\r\n ],\r\n \"discount\": \"0\",\r\n \"shipping\": \"30\",\r\n \"order_total\": \"870\",\r\n \"gift_card_amt\": \"100\",\r\n \"taxes\": \"40\",\r\n \"payment_type\": \"C\",\r\n \"email\": \"customer@email.com\",\r\n \"billing_address\": \"#321\",\r\n \"billing_address2\": \"MG Road\",\r\n \"billing_city\": \"Gurgaon\",\r\n \"billing_state\": \"Haryana\",\r\n \"billing_country\": \"India\",\r\n \"billing_firstname\": \"John\",\r\n \"billing_lastname\": \"Doe\",\r\n \"billing_phone\": \"9999999999\",\r\n \"billing_zipcode\": \"122001\",\r\n \"shipping_address\": \"#321\",\r\n \"shipping_address2\": \"MG Road\",\r\n \"shipping_city\": \"Gurgaon\",\r\n \"shipping_state\": \"Haryana\",\r\n \"shipping_country\": \"India\",\r\n \"shipping_firstname\": \"John\",\r\n \"shipping_lastname\": \"Doe\",\r\n \"shipping_phone\": \"9999999999\",\r\n \"shipping_zipcode\": \"122001\",\r\n \"order_weight\": \"110\",\r\n \"box_length\": \"20\",\r\n \"box_breadth\": \"15\",\r\n \"box_height\": \"10\",\r\n \"order_date\": \"2021-09-01 12:05:00\",\r\n \"quality_check\": 1,\r\n \"qc_checkurl\": [\r\n \"https://example.com/bournvita-500-g-0-20210311.JPG\",\r\n \"https://assetscdn1.paytm.com/images/catalog/product/A/AP/APPUS-PEPPER-MAASHA322624D9D2334E/1562934257812_0..jpg\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.shipway.com/api/Createreturns"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 06 Sep 2021 08:51:59 GMT"},{"key":"Server","value":"Apache"},{"key":"Expires","value":"Mon, 26 Jul 1997 05:00:00 GMT"},{"key":"Last-Modified","value":"Mon, 06 Sep 2021 08:51:59 GMT"},{"key":"Cache-Control","value":"private"},{"key":"Content-Length","value":"317"},{"key":"Keep-Alive","value":"timeout=10, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": 1,\n \"error\": 0,\n \"message\": \"Order has been added successfully.\",\n \"create_return_response\": {\n \"success\": 1,\n \"error\": 0,\n \"rma_no\": \"70694.TEST7-R\",\n \"message\": \" Return is created successfully\"\n },\n \"awb_response\": {\n \"success\": 1,\n \"error\": 0,\n \"rma_no\": \"70694.TEST7-R\",\n \"message\": \"AWB No assigned Successfully\",\n \"AWB\": \"241404214500006\"\n }\n}"},{"id":"703169c6-7f9f-414f-badf-d0d3ea34afef","name":"Exchange Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic YXJjaGl0c2FyZWVuMDdAZ21haWwuY29tOjN3Mk1YMWZabDR2bTlvM3E0ZzJtMDgyMW0wajIzMTQ3","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"order_id\": \"TEST6\",\r\n \"return_order_status\": \"E\",\r\n \"carrier_id\": \"1\",\r\n \"return_warehouse_id\": \"1\",\r\n \"products\": [\r\n {\r\n \"product\": \"My Test Product 56\",\r\n \"price\": \"200\",\r\n \"product_code\": \"JSN909\",\r\n \"amount\": \"1\",\r\n \"discount\": \"0\",\r\n \"tax_rate\": \"5\",\r\n \"tax_title\": \"IGST\",\r\n \"return_reason_id\": \"0\",\r\n \"return_products_images\": [\r\n \"https://example.com/bournvita1.JPG\",\r\n \"https://example.com/bournvita2.JPG\"\r\n ],\r\n \"customer_notes\": \"Need small size \",\r\n \"variants\": \"red\"\r\n },\r\n {\r\n \"product\": \"My Test Product 23\",\r\n \"price\": \"120\",\r\n \"product_code\": \"JSN9999\",\r\n \"amount\": \"5\",\r\n \"discount\": \"0\",\r\n \"tax_rate\": \"5\",\r\n \"tax_title\": \"IGST\",\r\n \"return_reason_id\": \"0\",\r\n \"return_products_images\": [\r\n \"https://example.com/bournvita1.JPG\",\r\n \"https://example.com/bournvita2.JPG\"\r\n ],\r\n \"customer_notes\": \"Need small size \",\r\n \"variants\": \"green\"\r\n }\r\n ],\r\n \"discount\": \"0\",\r\n \"shipping\": \"30\",\r\n \"order_total\": \"870\",\r\n \"gift_card_amt\": \"0\",\r\n \"taxes\": \"40\",\r\n \"payment_type\": \"P\",\r\n \"email\": \"customer@email.com\",\r\n \"billing_address\": \"#321\",\r\n \"billing_address2\": \"MG Road\",\r\n \"billing_city\": \"Gurgaon\",\r\n \"billing_state\": \"Haryana\",\r\n \"billing_country\": \"India\",\r\n \"billing_firstname\": \"John\",\r\n \"billing_lastname\": \"Doe\",\r\n \"billing_phone\": \"9999999999\",\r\n \"billing_zipcode\": \"122001\",\r\n \"shipping_address\": \"#321\",\r\n \"shipping_address2\": \"MG Road\",\r\n \"shipping_city\": \"Gurgaon\",\r\n \"shipping_state\": \"Haryana\",\r\n \"shipping_country\": \"India\",\r\n \"shipping_firstname\": \"John\",\r\n \"shipping_lastname\": \"Doe\",\r\n \"shipping_phone\": \"9999999999\",\r\n \"shipping_zipcode\": \"122001\",\r\n \"order_weight\": \"110\",\r\n \"box_length\": \"20\",\r\n \"box_breadth\": \"15\",\r\n \"box_height\": \"10\",\r\n \"order_date\": \"2019-07-01 12:05:00\",\r\n \"quality_check\": 1,\r\n \"qc_checkurl\": [\r\n \"https://example.com/bournvita-500-g-0-20210311.JPG\",\r\n \"https://assetscdn1.paytm.com/images/catalog/product/A/AP/APPUS-PEPPER-MAASHA322624D9D2334E/1562934257812_0..jpg\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.shipway.com/api/Createreturns"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 03 Jun 2021 11:41:08 GMT"},{"key":"Server","value":"Apache"},{"key":"Expires","value":"Mon, 26 Jul 1997 05:00:00 GMT"},{"key":"Last-Modified","value":"Thu, 03 Jun 2021 11:41:08 GMT"},{"key":"Cache-Control","value":"private"},{"key":"Vary","value":"User-Agent"},{"key":"Content-Length","value":"303"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": 1,\n \"error\": 0,\n \"message\": \"Order has been added successfully.\",\n \"create_return_response\": {\n \"success\": 1,\n \"error\": 0,\n \"rma_no\": \"50613.TEST6-E\",\n \"message\": \" Return is created successfully\"\n },\n \"awb_response\": {\n \"success\": 1,\n \"rma_no\": \"50613.TEST6-E\",\n \"message\": \"AWB No assigned Successfully\",\n \"AWB\": \"69541467133\"\n }\n}"},{"id":"e5849526-e718-4b9d-b3ba-5f0437fa941f","name":"Invalid Data","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic YXJjaGl0c2FyZWVuMDdAZ21haWwuY29tOjN3Mk1YMWZabDR2bTlvM3E0ZzJtMDgyMW0wajIzMTQ3","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"order_id\": \"TESTAPRIL008\",\r\n \"carrier_id\": \"1\",\r\n \"return_warehouse_id\": \"1\",\r\n \"return_order_status\": \"E\",\r\n \"products\": [\r\n {\r\n \"product\": \"My Test Product 56\",\r\n \"price\": \"200\",\r\n \"product_code\": \"JSN909\",\r\n \"amount\": \"1\",\r\n \"discount\": \"0\",\r\n \"tax_rate\": \"5\",\r\n \"tax_title\": \"IGST\",\r\n \"return_reason_id\": \"0\",\r\n \"return_products_images\": [\r\n \"https://example.com/bournvita1.JPG\",\r\n \"https://example.com/bournvita2.JPG\"\r\n ],\r\n \"customer_notes\": \"Need small size \",\r\n \"variants\": \"red\"\r\n },\r\n {\r\n \"product\": \"My Test Product 23\",\r\n \"price\": \"120\",\r\n \"product_code\": \"JSN9999\",\r\n \"amount\": \"5\",\r\n \"discount\": \"0\",\r\n \"tax_rate\": \"5\",\r\n \"tax_title\": \"IGST\",\r\n \"return_reason_id\": \"0\",\r\n \"return_products_images\": [\r\n \"https://example.com/bournvita1.JPG\",\r\n \"https://example.com/bournvita2.JPG\"\r\n ],\r\n \"customer_notes\": \"Need small size \",\r\n \"variants\": \"green\"\r\n }\r\n ],\r\n \"discount\": \"0\",\r\n \"shipping\": \"30\",\r\n \"order_total\": \"870\",\r\n \"gift_card_amt\": \"0\",\r\n \"taxes\": \"40\",\r\n \"payment_type\": \"P\",\r\n \"email\": \"customer@email.com\",\r\n \"billing_address\": \"#321\",\r\n \"billing_address2\": \"MG Road\",\r\n \"billing_city\": \"Gurgaon\",\r\n \"billing_state\": \"Haryana\",\r\n \"billing_country\": \"India\",\r\n \"billing_firstname\": \"John\",\r\n \"billing_lastname\": \"Doe\",\r\n \"billing_phone\": \"9999999999\",\r\n \"billing_zipcode\": \"122001\",\r\n \"shipping_address\": \"#321\",\r\n \"shipping_address2\": \"MG Road\",\r\n \"shipping_city\": \"Gurgaon\",\r\n \"shipping_state\": \"Haryana\",\r\n \"shipping_country\": \"India\",\r\n \"shipping_firstname\": \"John\",\r\n \"shipping_lastname\": \"Doe\",\r\n \"shipping_phone\": \"9999999999\",\r\n \"shipping_zipcode\": \"122001\",\r\n \"order_weight\": \"110\",\r\n \"box_length\": \"20\",\r\n \"box_breadth\": \"15\",\r\n \"box_height\": \"10\",\r\n \"order_date\": \"2019-07-01 12:05:00\",\r\n \"quality_check\": 1,\r\n \"qc_checkurl\": [\r\n \"https://example.com/bournvita-500-g-0-20210311.JPG\",\r\n \"https://assetscdn1.paytm.com/images/catalog/product/A/AP/APPUS-PEPPER-MAASHA322624D9D2334E/1562934257812_0..jpg\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://app.shipway.com/api/Createreturns"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 04 Mar 2021 11:41:03 GMT"},{"key":"Server","value":"Apache"},{"key":"Expires","value":"Mon, 26 Jul 1997 05:00:00 GMT"},{"key":"Last-Modified","value":"Thu, 04 Mar 2021 11:41:03 GMT"},{"key":"Cache-Control","value":"private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"101"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": \"\",\n \"error\": 1,\n \"message\": \"return_reason_id is not Exist,please contact administrator.\"\n}"}],"_postman_id":"2d9e98bb-9bee-48ce-8cfa-137cca0ee2b8"},{"name":"Cancel Returns Shipment","id":"23138dfc-039c-4ea5-9241-4037a75def73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"Shipway provides Cancel Return Shipment API to interact with Shipway system.This Rest API enables merchants to cancel return shipment.
\nParameter
| Field Name | \nDescription | \nMandatory | \nData Type | \n
|---|---|---|---|
rma_no | \n rma no (You can mark as cancel shipment on Return Awaited, Shipped by Customer and Pickup Generated status) | \nOptional | \nstring |
order_id | \n order id (Note: all RMA No's linked with this order_id is marked as cancel return shipment) | \noptional | \nstring |
| Authorization | \n< Enter your $token (which is described in authentication section) > | \n
Shipway provides GET API to interact with Shipway system. This Rest API enables merchants to get All Return reason from Shipway system.
\nHeaders
| Authorization | \n< Enter your $token (which is described in authentication section) > | \n
Shipway provides CREATE API to interact with Shipway system. This Rest API enables merchants to create Return reason from Shipway system.
\nHeaders
| Authorization | \n< Enter your $token (which is described in authentication section) > | \n
Shipway provides UPDATE API to interact with Shipway system. This Rest API enables merchants to Update Return reason from Shipway system.
\nHeaders
| Authorization | \n< Enter your $token (which is described in authentication section) > | \n
Shipway provides GET API to interact with Shipway system. This Rest API enables merchants to get return reason using return reason id from Shipway system.
\nParameter
| Field Name | \nDescription | \nMandatory | \nData Type | \n
|---|---|---|---|
return_reason_id | \n Reason id of Return reason | \nYes | \ninteger |
| Authorization | \n< Enter your $token (which is described in authentication section) > | \n
Shipway provides GET API to interact with Shipway system. This Rest API enables merchants to GET Returns from Shipway system.
GET Returns: Shipway provide you access to get your returns from Shipway system. In this, you can get returns in chunks of 10 at use of URL for following status:
Order Status Description
\nStatus Description\n\nO :- Requested\n\n\nA :- Approved\n\n\nH :- Return Rejected\n\n\n(S,L,P) :- Awaited\n\n\n(G,B) :- Recieved\n\n\n(E,I,Q,T,C,D,R,K) :- Processed\n\nParameters
\nGET Returns Using Page: Shipway provides you access to get your returns from Shipway system. In this you can get returns using Page.On one page, You can get 2 orders.Pages can be accessed using counting all returns.
\nParameters
\n","urlObject":{"protocol":"https","path":["api","getorders"],"host":["app","shipway","com"],"query":[{"key":"order_type","value":"R"}],"variable":[]}},"response":[{"id":"c1c26073-eeba-4ea6-9b76-2fe3c2decc5b","name":"Successful Call","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"https://app.shipway.com/api/getorders?order_type=R","protocol":"https","host":["app","shipway","com"],"path":["api","getorders"],"query":[{"key":"order_type","value":"R"},{"key":"status","value":"L,O,A","disabled":true},{"key":"requested_date_from","value":"2021-12-25","disabled":true},{"key":"requested_date_to","value":"2022-12-30","disabled":true},{"key":"rma_no","value":"31438.v8-1033-v8-PR","type":"default","disabled":true},{"key":"orderid","value":"v8-1033-v8","type":"default","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Jan 2022 12:33:48 GMT"},{"key":"Server","value":"Apache/2.4.18 (Ubuntu)"},{"key":"Expires","value":"Mon, 26 Jul 1997 05:00:00 GMT"},{"key":"Last-Modified","value":"Wed, 12 Jan 2022 12:33:48 GMT"},{"key":"Cache-Control","value":"private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"565"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"payload\": [\n {\n \"order_id\": \"v8-1033-v8\",\n \"payment_id\": \"6\",\n \"payment_method\": \"Cash on Delivery (COD)\",\n \"b_firstname\": \"Vishal\",\n \"b_lastname\": \"Singh\",\n \"b_address\": \"Sector 40\",\n \"b_address_2\": \"\",\n \"b_city\": \"Gurgain\",\n \"b_country\": \"IN\",\n \"b_state\": \"Haryana\",\n \"b_zipcode\": \"122001\",\n \"b_phone\": \"+919758546591\",\n \"s_firstname\": \"Vishal\",\n \"s_lastname\": \"Singh\",\n \"s_address\": \"Sector 40\",\n \"s_address_2\": \"\",\n \"s_city\": \"Gurgain\",\n \"s_state\": \"Haryana\",\n \"s_country\": \"IN\",\n \"s_zipcode\": \"122001\",\n \"s_phone\": \"+919758546591\",\n \"store_code\": \"374\",\n \"weight\": \"945\",\n \"box_length\": \"10\",\n \"box_breadth\": \"10\",\n \"box_height\": \"10\",\n \"email\": \"vishal.singh@shipway.in\",\n \"invoice_number\": \"1163\",\n \"order_date\": \"2021-12-31 13:34:58\",\n \"coupon_code\": \"\",\n \"coupon_status\": \"0\",\n \"ezyslip_order_id\": \"36433\",\n \"order_type\": \"REVERSE\",\n \"total_return_order_amount\": 0.08,\n \"rma_data\": [\n {\n \"return_id\": \"31438\",\n \"rma_no\": \"31438.v8-1033-v8-PR\",\n \"status\": \"Requested\",\n \"reject_reason\": \"\",\n \"return_order_amount\": \"0.08\",\n \"return_request_date\": \"2021-12-31 13:53:59\",\n \"refund_amount\": \"0.00\",\n \"exchange_order_id\": \"0\",\n \"return_order_status\": \"PR\",\n \"policy\": {\n \"refund_code\": \"\",\n \"refund_payment_details\": \"\",\n \"logistic_code\": \"N\"\n },\n \"label\": {\n \"carrier\": \"\",\n \"tracking\": \"\"\n },\n \"state\": {\n \"Requested\": {\n \"at\": \"2021-12-31 13:54:01\"\n }\n }\n }\n ]\n }\n ]\n}"},{"id":"a9c00831-2f34-4916-aeaa-1c78e68330f7","name":"Invalid Data","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"https://app.shipway.com/api/getorders?order_type=R","protocol":"https","host":["app","shipway","com"],"path":["api","getorders"],"query":[{"key":"order_type","value":"R"},{"key":"status","value":"L,O,A","disabled":true},{"key":"requested_date_from","value":"2021-12-25","disabled":true},{"key":"requested_date_to","value":"2022-12-30","disabled":true},{"key":"rma_no","value":"31438.v8-1033-v8-PR","type":"default","disabled":true},{"key":"orderid","value":"v8-1033-v","type":"default","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 12 Jan 2022 12:35:50 GMT"},{"key":"Server","value":"Apache/2.4.18 (Ubuntu)"},{"key":"Expires","value":"Mon, 26 Jul 1997 05:00:00 GMT"},{"key":"Last-Modified","value":"Wed, 12 Jan 2022 12:35:50 GMT"},{"key":"Cache-Control","value":"private"},{"key":"Content-Length","value":"44"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"No order found\"\n}"}],"_postman_id":"d1348b12-3c09-461e-bfb7-f7abf1e1a118"},{"name":"Reject Reasons","id":"fee0599a-536c-4808-809f-6dfc602bd4f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"GET Reject Reasons: Shipway provides you access to get your returns reason from Shipway system. In this you can get all returns reason added in your panel.
\n","urlObject":{"protocol":"https","path":["api","getrejectreasons"],"host":["app","shipway","com"],"query":[],"variable":[]}},"response":[{"id":"60d1a822-e8f4-44a3-bc08-b53b42196cbc","name":"Successful Call","originalRequest":{"method":"GET","header":[],"url":"https://app.shipway.com/api/getrejectreasons"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 27 Jan 2022 10:34:50 GMT"},{"key":"Server","value":"Apache"},{"key":"Expires","value":"Mon, 26 Jul 1997 05:00:00 GMT"},{"key":"Last-Modified","value":"Thu, 27 Jan 2022 10:34:50 GMT"},{"key":"Cache-Control","value":"private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"154"},{"key":"Keep-Alive","value":"timeout=10, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"payloads\": [\n {\n \"id\": \"24781\",\n \"reason\": \"Customer sent used product\"\n },\n {\n \"id\": \"24783\",\n \"reason\": \"Return Period got over\"\n },\n {\n \"id\": \"25386\",\n \"reason\": \"Non-Returnable Item test\"\n },\n {\n \"id\": \"25387\",\n \"reason\": \"Customer reason\"\n }\n ]\n}"},{"id":"7fc52e09-5c13-4ca7-a2ff-2a12851aaf06","name":"Invalid Data","originalRequest":{"method":"GET","header":[],"url":"https://app.shipway.com/api/getrejectreasons"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 27 Jan 2022 10:46:51 GMT"},{"key":"Server","value":"Apache"},{"key":"Expires","value":"Mon, 26 Jul 1997 05:00:00 GMT"},{"key":"Last-Modified","value":"Thu, 27 Jan 2022 10:46:51 GMT"},{"key":"Cache-Control","value":"private"},{"key":"WWW-Authenticate","value":"Basic realm=\"User email/API key\""},{"key":"Content-Length","value":"39"},{"key":"Keep-Alive","value":"timeout=10, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\",\n \"status\": 401\n}"}],"_postman_id":"fee0599a-536c-4808-809f-6dfc602bd4f6"},{"name":"Create Reject Reasons","id":"8c5d741e-b916-495e-99e4-3c98727fb299","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"Create Reject Reasons:
The API creates an Return reason on Shipway system. The body of this request should specify the following parameters:
Parameters
\n| Field Name | Description | Mandatory | Data Type |
|---|---|---|---|
Reason | Return Reason | Yes | string |
Reject Return shipment:
This Reject Return shipment API provides you access to Reject return orders and move them from 'return awaited' to 'Rejected' in Shipway system.\nThe body of this request should specify the following parameters:
Parameters
\n| Field Name | Description | Mandatory | Data Type |
|---|---|---|---|
order_id | order no | Yes | String |
rma_nos | RMA order no | Yes | Json |
status | Return order status ('H') | No | String |
reject_reason_id | Reject Reason id | Yes | Integer |
Update Reject reasons:\nThis Update Reject reason API provides you access to Update Reject reasons in Shipway system. \nThe body of this request should specify the following parameters:
\nParameters
\n| Field Name | \nDescription | \nMandatory | \nData Type | \n
|---|---|---|---|
id | \nreason id | \nYes | \nInteger | \n
reason | \nUpdated reject reason | \nYes | \nstring | \n
Shipway provides Push Orders with Assign awb no API to interact with Shipway system. This Rest API enables merchants to create return orders in Shipway system.
\n","_postman_id":"c3ced9f2-fa13-43e1-824a-315d2fa1a1f1"},{"name":"NDR","item":[{"name":"InsertOrder","id":"8bccbd3a-ee33-4577-9880-af9746473ac2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"Shipway provides Insert Orders to interact with the Shipway system. The Insert API enables merchants to Insert orders in the Shipway NDR system.
\n| Field Name | \nDescription | \nMandatory | \nData Type | \n
|---|---|---|---|
order_id | \n Merchant's Order ID | \nYes | \nstring | \n
order_tracking_number | \n AWB Number | \nYes | \nstring | \n
shipment_status_update | \n Shipment Status Update(If Order Already Exist in Shipway then value is \"1\" and not changeable; Yes - if order not exist in Shipway (Default 0)) | \nOptional | \nstring | \n
shipment_status | \n Shipemnt Status (Yes if shipment_status_update is 0) (UND/RTO (UND - Undelivered, RTO - Return to Origin)) | \nOptional | \nstring | \n
und_reason | \n Shipemnt Status (Yes if shipment_status_update is 0) (For UND Reason, please check below table ) | \nOptional | \nstring | \n
| Field Name | \nDescription | \nMandatory | \nData Type | \n
|---|---|---|---|
order_id | \n Merchant's Order ID | \nYes | \nstring | \n
order_tracking_number | \n AWB Number | \nYes | \nstring | \n
shipment_status_update | \n Shipment Status Update(If Order Already Exist in Shipway then value is \"1\" and not changeable; Yes - if order not exist in Shipway (Default 0)) | \nOptional | \nstring | \n
shipment_status | \n Shipemnt Status (Yes if shipment_status_update is 0) (UND/RTO (UND - Undelivered, RTO - Return to Origin)) | \nOptional | \nstring | \n
und_reason | \n Shipemnt Status (Yes if shipment_status_update is 0) (For UND Reason, please check below table ) | \nOptional | \nstring | \n
carrier_id | \n Carrier's Carrier ID, Click Here | \nYes | \ninteger | \n
warehouse_id | \n Warehouse ID, Click Here | \nYes | \ninteger | \n
return_warehouse_id | \n Return Warehouse ID, Click Here | \nYes | \ninteger | \n
products | \n Products belonging to order | \nYes | \njson | \n
payment_type | \n P - Prepaid, C - COD | \nYes | \nstring | \n
email | \n Customer email | \nNo | \nstring | \n
discount | \n Total discount for order (INR) | \nNo | \ndecimal | \n
gift_card_amt | \n Gift card amount if apply gift card on orders (INR) | \nNo | \ndecimal | \n
taxes | \n Oders Taxes (INR) | \nNo | \ndecimal | \n
tax_rate | \n Tax Rate | \nNo | \ndecimal | \n
tax_title | \n Tax Title (IGST,SGST,CGST) | \nNo | \nstring | \n
shipping | \n Total shipping amount for order (INR) | \nNo | \ndecimal | \n
order_total | \n Grand total of order | \nNo | \nstring | \n
billing_address | \n Billing address | \nNo | \nstring | \n
billing_address2 | \n Billing address - Line 2 | \nNo | \nstring | \n
billing_city | \n City(billing address) | \nNo | \nstring | \n
billing_state | \n State(billing address) | \nNo | \nstring | \n
billing_country | \n Country (billing address) [Country code or country name Please Click\n Here] | \n No | \nstring | \n
billing_firstname | \n First Name(billing address) | \nNo | \nstring | \n
billing_lastname | \n Last Name(billing address) | \nNo | \nstring | \n
billing_phone | \n Phone (billing address) | \nNo | \nstring | \n
billing_zipcode | \n Zipcode (billing address) | \nNo | \nstring | \n
shipping_address | \n Shipping address | \nNo | \nstring | \n
shipping_address2 | \n Shipping address - Line 2 | \nNo | \nstring | \n
shipping_city | \n City(Shipping address) | \nNo | \nstring | \n
shipping_state | \n State(Shipping address) | \nNo | \nstring | \n
shipping_country | \n Country (Shipping address) [Country code or country name Please Click\n Here] | \n Yes | \nstring | \n
shipping_firstname | \n First Name(Shipping address) | \nNo | \nstring | \n
shipping_lastname | \n Last Name(Shipping address) | \nNo | \nstring | \n
shipping_phone | \n Phone (Shipping address) | \nYes | \nstring | \n
shipping_zipcode | \n Zipcode (Shipping address) | \nYes | \nstring | \n
order_weight | \n Order weight (grams) | \nNo | \nfloat | \n
box_length | \n Box length (cms) | \nNo | \ninteger | \n
box_breadth | \n Box breadth (cms) | \nNo | \ninteger | \n
box_height | \n Box height (cms) | \nNo | \ninteger | \n
order_date | \n Date of purchase (yyyy-mm-dd hh:mm:ss) | \nNo | \nDate | \n
invoice_number_prefix | \n Y - Prefix Required, Set from Ezyslips > Manage Invoice > General Settings , N - Prefix\n Not Required (Default - N) | \nNo | \nstring | \n
invoice_number | \n Invoice Number (Prefix = Y, Numeric Only, Prefix = N, Alphanumeric) | \nNo | \nstring | \n
UND Reasons
\n| Code | \nDescription | \n
|---|---|
| CAN | \nCanceled | \n
| NWI | \nNetwork Issue | \n
| DNB | \nDelivery Next Day | \n
| ODA | \nOut of Delivery Area | \n
| 22 | \nAddress Incorrect | \n
| 23 | \nDelivery Attempted | \n
| 24 | \nPending - Undelivered | \n
| 25 | \nDelivery Attempted-Premises Closed | \n
| CRTA | \nCustomer Refused | \n
| CNA | \nConsignee Unavailable | \n
| DEX | \nDelivery Exception | \n
| DRE | \nDelivery Rescheduled | \n
| PNR | \nCOD Payment Not Ready | \n
| LOST | \nLost | \n
| FDR | \nFuture delivery requested | \n
#Re-Attempt\nShipway provides Re-Attempt Order to interact with Shipway system. The Re-Attempt Order API enable merchants to Insert Re-Attempt Order address, date and time in Shipway NDR system.\n
\nParameters
| Field Name | \nDescription | \nMandatory | \nData Type | \n
|---|---|---|---|
order_id | \n Merchant's Order ID | \nYes | \nstring | \n
order_tracking_number | \n AWB Number | \nRequired | \nstring | \n
date_time | \n Re-Attempt Date and Time (Format YYYY-MM-DD HH:MM:SS) | \nRequired | \nstring | \n
customer_notification | \n Send sms notification to customer (1 - Yes, 0 - No) (default - 0) | \nNo | \nstring | \n
update_carrier | \n Send request to Carrier (1 - Yes, 0 - No) (default - 0) | \nNo | \nstring | \n
address | \n Delivery Address (Required, When reason is incorrect Address) | \nOptional | \nstring | \n
landmark | \n Delivery Address (Required, When reason is incorrect Address) | \nOptional | \nstring | \n
phone | \n Delivery Address (Required, When reason is incorrect Address) | \nOptional | \nstring | \n
#RTO
Shipway provides RTO Orders to interact with Shipway system. The RTO Order API enable merchants to mark RTO Order in Shipway NDR system.
Parameters
\n| Field Name | Description | Mandatory | Data Type |
|---|---|---|---|
order_id | Merchant's Order ID | Yes | string |
order_tracking_number | AWB Number | Required | string |
date_time | Re-Attempt Date and Time (Format YYYY-MM-DD HH:MM-SS) | Required | string |
reason | Reason ID to mark RTO \"1\" => \"Order place by mistake\", \"2\" => \"Changed of mind\", \"3\" => \"Not needed\", \"4\" => \"Found better deals\", \"5\" => \"Others\" | Required | string |
customer_notification | Send sms notification to customer (1 - Yes, 0 - No) (default - 0) | Optional | string |
update_carrier | Send request to Carrier (1 - Yes, 0 - No) (default - 0) | Optional | string |
Shipway provides to Get Order Details to interact with Shipway system. The Order Details API enable merchants to view Order Details in Shipway NDR system.\n
\nParameters
| Field Name | \nDescription | \nMandatory | \nData Type | \n
|---|---|---|---|
order_id | \n Merchant's Order ID | \nYes | \nstring | \n
Get Carriers:\nShipway provide you access to get all Carriers from Shipway system.
\nHeaders
| Authorization | \n< Enter your $token (which is described in authentication section) > | \n
Shipway provides GET API to interact with Shipway system. This Rest API enables merchants to get Carrier using carrier id from Shipway system.
\nParameter
| Field Name | \nDescription | \nMandatory | \nData Type | \n
|---|---|---|---|
carrierid | \n Carrier's Carrierid ID | \nYes | \ninteger |
| Authorization | \n< Enter your $token (which is described in authentication section) > | \n
Shipway provides GET API to interact with Shipway system. This API Restful that enables merchants to get All Carriers from Shipway system.
\n","_postman_id":"f0f9d8ce-06b9-4f3d-96b7-9b0238bb2cda"},{"name":"Warehouse","item":[{"name":"Create Warehouse","id":"62a390ef-bbb0-4d25-8ab7-2fb5e7446c13","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"Shipway provides Create Warehouse API to interact with Shipway system. This Rest API enables merchants to create warehouse in Shipway system.
\n| Field Name | Description | Mandatory | Data Type |
|---|---|---|---|
title | Warehouse's Title Name | Yes | string |
contact_person_name | Warehouse Contact Person Name | Yes | string |
email | Warehouse Email Id | Yes | string |
phone (pass with country code) | Warehouse Phone number | Yes | integer |
phone_print | For using on Shipping Label | Optional | string |
address_1 | Warehouse Address | Yes | string |
address_2 | Warehouse Address | Optional | string |
city | Warehouse City | Yes | string |
state | Warehouse State Name, e.g. HR, DL, UP | Yes | string |
country | Warehouse Country Name, e.g IN, AUS | Yes | string |
pincode | Warehouse Pincode Number | Yes | integer |
latitude | Warehouse Latitude | No | string |
longitude | Warehouse Longitude | No | string |
gst_no | GST number | No | string |
fssai_code | FSSAI Code | No | string |
Headers
\n| Authorization | < Enter your $token (which is described in authentication section) > |
Authorization
\n","urlObject":{"protocol":"https","path":["api","warehouse",""],"host":["app","shipway","com"],"query":[],"variable":[]}},"response":[{"id":"342f9323-3cc3-436b-9e5b-3123a101201b","name":"Successful Call","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Basic YXJjaGl0c2FyZWVuMDdAZ21haWwuY29tOjN3Mk1YMWZabDR2bTlvM3E0ZzJtMDgyMW0wajIzMTQ3","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":" \r\n{\r\n \"title\": \"Warehouse Title\",\r\n \"company\": \"Company Name\",\r\n \"contact_person_name\": \"Test Name\",\r\n \"email\": \"contact@ezyslips.com\",\r\n \"phone\": \"+91-9999999999\",\r\n \"phone_print\": \"\",\r\n \"address_1\": \"Spaze Tech Park\",\r\n \"address_2\": \"10 Floor\",\r\n \"city\": \"Gurgaon\",\r\n \"state\": \"HR\",\r\n \"country\": \"IN\",\r\n \"pincode\": \"122001\",\r\n \"longitude\":\"10\",\r\n \"latitude\":\"20\",\r\n \"gst_no\":\"AD5465765670P\",\r\n \"fssai_code\":\"47656587\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://app.shipway.com/api/warehouse/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 21 Jun 2022 10:15:11 GMT"},{"key":"Server","value":"Apache"},{"key":"Expires","value":"Mon, 26 Jul 1997 05:00:00 GMT"},{"key":"Last-Modified","value":"Tue, 21 Jun 2022 10:15:11 GMT"},{"key":"Cache-Control","value":"private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"114"},{"key":"Keep-Alive","value":"timeout=10, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"error\": false,\n \"message\": \"Warehouse Created Successfully\",\n \"warehouse_response\": {\n \"warehouse_id\": 19576\n }\n}"},{"id":"82de5c94-c60d-49f1-b1df-21326f0f9741","name":"Invalid Data","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Basic YXJjaGl0c2FyZWVuMDdAZ21haWwuY29tOjN3Mk1YMWZabDR2bTlvM3E0ZzJtMDgyMW0wajIzMTQ3","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":" \r\n{\r\n \"title\": \"Warehouse Title\",\r\n \"company\": \"Company Name\",\r\n \"contact_person_name\": \"Test Name\",\r\n \"email\": \"\",\r\n \"phone\": \"+91-9999999999\",\r\n \"phone_print\": \"\",\r\n \"address_1\": \"Spaze Tech Park\",\r\n \"address_2\": \"10 Floor\",\r\n \"city\": \"Gurgaon\",\r\n \"state\": \"HR\",\r\n \"country\": \"IN\",\r\n \"pincode\": \"122001\",\r\n \"longitude\":\"10\",\r\n \"latitude\":\"20\",\r\n \"gst_no\":\"AD5465765670P\",\r\n \"fssai_code\":\"47656587\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://app.shipway.com/api/warehouse/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 21 Jun 2022 10:17:08 GMT"},{"key":"Server","value":"Apache"},{"key":"Expires","value":"Mon, 26 Jul 1997 05:00:00 GMT"},{"key":"Last-Modified","value":"Tue, 21 Jun 2022 10:17:08 GMT"},{"key":"Cache-Control","value":"private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"102"},{"key":"Keep-Alive","value":"timeout=10, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": true,\n \"message\": \"Field Email is mandatory\",\n \"warehouse_response\": []\n}"}],"_postman_id":"62a390ef-bbb0-4d25-8ab7-2fb5e7446c13"},{"name":"Warehouse","id":"40b4a3aa-7bc0-4a7d-a78c-0f3da656f1e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"Shipway provides GET API to interact with Shipway system. This API Restful that enables merchants to get All warehouse from Shipway system.
\nHeaders
| Authorization | \n< Enter your $token (which is described in authentication section) > | \n
Shipway provides GET API to interact with Shipway system. This API Restful that enables merchants to get warehouse using warehouse id from Shipway system.
\nParameter
| Field Name | \nDescription | \nMandatory | \nData Type | \n
|---|---|---|---|
warehouseid | \n Warehouse's Warehouse ID | \nYes | \ninteger |
| Authorization | \n< Enter your $token (which is described in authentication section) > | \n
Pincode Serviceable:\nShipway provide you access to find Pincode Serviceable from Shipway system.
\nParameter
| Field Name | \nDescription | \nMandatory | \nData Type | \n
|---|---|---|---|
pincode | \n Billing or Shipping Zipcode | \nYes | \ninteger | \n
| Authorization | \n< Enter your $token (which is described in authentication section) > | \n
Shipway provides GET API to interact with Shipway system. This Rest API enables merchants to get Pincode Serviceable using Payment Type from Shipway system.
\nParameter
| Field Name | \nDescription | \nMandatory | \nData Type | \n
|---|---|---|---|
pincode | \n Billing or Shipping Zipcode | \nYes | \ninteger | \n
payment_type | \n P - Prepaid, C - COD | \nYes | \nstring | \n
| Authorization | \n< Enter your $token (which is described in authentication section) > | \n
Shipway provides Pincode Serviceable to interact with Shipway system. This Rest API enables merchants to get Pincode Serviceable from Shipway system.
\n","_postman_id":"d966dc00-ca9f-4663-8406-0da2951527a6"},{"name":"Rate API","item":[{"name":"Carrier Rates","id":"8215d7f9-2cf8-448b-b13d-af022103f3fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"Shipway provides RATE API to interact with the shipway system. This REST API enables merchants to GET carrier rates from shipway.com on the basis of “from Pin code”, “to Pin code” and “payment type”.
\nHeaders
\nAuthorization. | < Enter your $token (which is described inauthentication section) > |
Request and Response
\n","urlObject":{"protocol":"https","path":["api","getshipwaycarrierrates"],"host":["app","shipway","com"],"query":[{"key":"fromPincode","value":"400703"},{"key":"toPincode","value":"400706"},{"key":"paymentType","value":"prepaid"}],"variable":[]}},"response":[{"id":"ca9a52c1-3cb7-4b4b-b5d4-99981cb77ed3","name":"Carrier Rates","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://app.shipway.com/api/getshipwaycarrierrates?fromPincode=400703&toPincode=400706&paymentType=prepaid","protocol":"https","host":["app","shipway","com"],"path":["api","getshipwaycarrierrates"],"query":[{"key":"fromPincode","value":"400703"},{"key":"toPincode","value":"400706"},{"key":"paymentType","value":"prepaid"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 13 Oct 2023 12:20:04 GMT"},{"key":"Server","value":"Apache/2.4.52 (Ubuntu)"},{"key":"Expires","value":"Mon, 26 Jul 1997 05:00:00 GMT"},{"key":"Last-Modified","value":"Fri, 13 Oct 2023 12:20:04 GMT"},{"key":"Cache-Control","value":"private"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"153"},{"key":"Keep-Alive","value":"timeout=10, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": \"success\",\n \"rate_card\": [\n {\n \"carrier_id\": 7377,\n \"courier_name\": \"Shipway Bluedart Express (0.5kg)\",\n \"delivery_charge\": 50,\n \"rto_charge\": 50,\n \"charged_weight\": 0.5,\n \"zone\": 1\n }\n ]\n}"}],"_postman_id":"8215d7f9-2cf8-448b-b13d-af022103f3fb"}],"id":"765e334e-cc84-4862-a737-20da273aa836","description":"Shipway provides RATE API to interact with the shipway system. This REST API enables merchants to GET carrier rates from shipway.com on the basis of “from Pin code”, “to Pin code” and “payment type”.
\nIt shows the zone-wise carrier rate In the responsein example:
\nThe Shipment Tracking API enables real-time tracking of shipments using Air Waybill (AWB) numbers. This endpoint provides comprehensive tracking information including shipment status, courier details, delivery progress, and historical tracking events. It supports both single and batch tracking operations, allowing you to track multiple shipments in a single API call.
\nThe Shipway API uses Basic HTTP Authentication.
\nCredentials Required:
\nUsername: Your Shipway registered email address
\nPassword: Your License Key (found in Shipway > Profile > Manage Profile)
\nAuthorization Header Format:
\nAuthorization: Basic <base64_encoded_credentials>\n\nExample (PHP):
\n$token = base64_encode(\"your-email@example.com:your-license-key\");\n$authHeaderString = 'Authorization: Basic ' . $token;\n\nNote: All API requests must include valid authentication credentials. Unauthorized requests will return a 401 Unauthorized error.
\nGET https://app.shipway.com/api/tracking\n\nawb_numbers
\nAccepts alphanumeric AWB numbers from various courier partners
\nNo spaces allowed between comma-separated values
\nInvalid or non-existent AWB numbers will return tracking details with an appropriate error status
\ntracking_history
\nOptional parameter that defaults to showing current status only
\nWhen set to 1, includes detailed scan history with timestamps and locations
\nUseful for debugging delivery issues or providing detailed tracking to customers
\nMay increase response size significantly for shipments with extensive history
\nThe API returns a JSON array containing tracking details for each requested AWB number.
\n[\n {\n \"awb\": \"string|number\",\n \"tracking_details\": {\n \"shipment_status\": \"string\",\n \"shipment_details\": [\n {\n \"courier_id\": \"string\",\n \"courier_name\": \"string\",\n \"order_id\": \"string\",\n \"pickup_date\": \"string|null\",\n \"delivered_date\": \"string|null\",\n \"weight\": \"string\",\n \"packages\": number,\n \"current_status\": \"string\",\n \"delivered_to\": \"string|null\",\n \"destination\": \"string\",\n \"consignee_name\": \"string\",\n \"origin\": \"string\"\n }\n ],\n \"track_url\": \"string\",\n \"tracking_history\": [\n {\n \"status\": \"string\",\n \"location\": \"string\",\n \"timestamp\": \"string\",\n \"remarks\": \"string\"\n }\n ]\n }\n }\n]\n\nShipway provides a Tracking API that allows merchants to interact with Shipway’s system. This REST API enables merchants to fetch real-time shipment tracking status along with the complete tracking history.
\n","_postman_id":"b603b0b3-1508-4035-8161-0e6c22719b44"},{"name":"Webhooks","item":[{"name":"Callback Response format (Webhooks)","event":[{"listen":"test","script":{"id":"487389e2-ec6d-4a42-b093-4a8d31829e66","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"0d186ab4-d899-4c76-ba4a-66a6b8295bc8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"description":"{{ Callback / Endpoint url }}
This webhook payload contains shipment tracking and delivery information.
\nPlease note that to consume webhooks, you must have a registered account with us.
\nYou are required to configure your callback/endpoint URL in Shipway by following the steps below:
\nPath:
Login to Shipway → Navigate to Track → Click on Tracking Webhooks → Add the URL
{\n \"store_code\": \"1\",\n \"awbno\": \"12345678901234\",\n \"company_id\": \"99999\",\n \"pod\": \"dummy_pod\",\n \"pickupdate\": \"2025-01-01 10:00:00\",\n \"expected_delivery_date\": \"2025-01-05\",\n \"scans_current_status_time\": \"2025-01-04 15:00:00\",\n \"scans_current_status\": \"Delivered to consignee\",\n \"epod\": \"dummy_epod\",\n \"carrier\": \"DummyCarrier\",\n \"api_input\": {\n \"awbno\": \"12345678901234\",\n \"company_id\": \"99999\",\n \"pickupdate\": \"2025-01-01 10:00:00\",\n \"last_name\": \"Doe\",\n \"webhook_sent_date\": \"2025-01-04 15:30:00\",\n \"carrier_id\": \"99\",\n \"callback_url\": \"https://dummywebhook.com/callback\",\n \"country_code\": \"IN\",\n \"carrier\": \"DummyCarrier\",\n \"received_by\": \"John Doe\",\n \"current_status_desc\": \"Delivered\",\n \"scans\": {\n \"0\": {\n \"location\": \"Dummy_Location_A\",\n \"time\": \"2025-01-04 15:00:00\",\n \"status\": \"Delivered to consignee\"\n },\n \"1\": {\n \"location\": \"Dummy_Location_A\",\n \"time\": \"2025-01-04 14:00:00\",\n \"status\": \"Call placed to consignee\"\n },\n \"2\": {\n \"location\": \"Dummy_Location_B\",\n \"time\": \"2025-01-04 12:00:00\",\n \"status\": \"Out for delivery\"\n },\n \"3\": {\n \"location\": \"Dummy_Location_B\",\n \"time\": \"2025-01-04 10:00:00\",\n \"status\": \"Shipment Received at Facility\"\n },\n \"4\": {\n \"location\": \"Dummy_Location_C\",\n \"time\": \"2025-01-04 08:00:00\",\n \"status\": \"Bag Received at Facility\"\n }\n },\n \"phone\": \"9999999999\",\n \"order_data\": \"dummy@domain.com\",\n \"current_status\": \"DEL\",\n \"from\": \"Dummy_Location_A\",\n \"extra_fields\": {\n \"dispatchCount\": \"1\",\n \"site_url\": \"https://dummywebsite.com\",\n \"sub_carrier_id\": \"99\",\n \"StatusType\": \"DL\",\n \"expected_delivery_date\": \"2025-01-05 23:59:59\",\n \"packageType\": \"Box\",\n \"ReferenceNo\": \"999999\"\n },\n \"to\": \"Dummy_Location_B\",\n \"status_time\": \"2025-01-04 15:00:00\",\n \"order_id\": \"99999999\",\n \"first_name\": \"John\",\n \"tracking_url\": \"https://dummytracking.com/track/12345678901234\",\n \"email\": \"dummy@domain.com\"\n },\n \"current_status\": \"DEL\",\n \"status_time\": \"2025-01-04 15:00:00\",\n \"order_id\": \"99999999\",\n \"reverse_tracking_number\": \"99999999999999\"\n}\n\nThe api_input object contains detailed information about the shipment:
The scans object contains an array of tracking events in chronological order:
The extra_fields object contains additional shipment metadata:
Available forward shipment statuses:
\nShipment Booked
\nOut for Pickup
\nPick up Failed
\nPick up Cancelled
\nIn transit
\nUndelivered
\nRTO Delivered
\nOut for Delivery
\nDelivered
\nRTO
\nCancelled
\nAvailable Reverse shipment statuses:
\nPickup Scheduled
\nOut for Pickup
\nShipment Picked Up
\nReturn Delivered
\nReturn In Transit
\nReturn Request Cancelled
\nReturn Request Closed
\nThe following table outlines the various NPR (Non Pickup Report) statuses that can be encountered during the pickup process:
\nThis table serves as a reference for understanding the different statuses that may be returned in relation to pickup exceptions.
\nThis table serves as a reference for understanding the different statuses that may be returned in relation to Delivery exceptions.
\nThis table serves as a reference for understanding the different statuses that may be returned in relation to Return Delivery exceptions.
\nThis table serves as a reference for understanding the different statuses that may be returned in relation to Reverse NPR and QC(Quality Check) Delivery exceptions.
\nThis table serves as a reference for understanding the different statuses that may be returned in relation to Reverse NDR exceptions.
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"0d186ab4-d899-4c76-ba4a-66a6b8295bc8"}],"id":"72e7a288-bc5f-4fd2-8839-dd97d26bf6f1","description":"StartFragmentThis API provides Webhook for Shipment Status Push and POD PushEndFragment
\n","_postman_id":"72e7a288-bc5f-4fd2-8839-dd97d26bf6f1"}]}