{"info":{"_postman_id":"54be67bd-abde-4f89-9338-18e5ba242e03","name":"Shipway Experience - Exellent Post Purchase Experience APIs.","description":" $\"\"$ \n\n

Shipway Experience is an eCommerce automation platform that provides a top-notch post-purchase experience, where you get automatic shipment status updates, enhance customer experience, analytics for your orders flow and follow the orders in delivery issues. It helps you to reduce customer support costs and scale your business by improving the customer experience.

Our automatic (plug n play) API integration seamlessly helps you to track all the major shipping carriers in one place i.e. Bluedart, FedEx India, Aramex, DTDC, DHL, Ecom Express, APIs India Post, XpressBees and many others as per your requirement.

Shipway API Requirements

To use Shipway's APIs, You need to register at Shipway Experience.

You can find an email from Shipway in your registered email inbox with your Username and Licence Key/Password.

You need to use the Username and Licence key in API Requests.

You can also find the Required Details in Shipway's Panel:

Menu > Settings > General Settings > UserName and Licence Key\n\n

How to Use APIs:

Using Shipway's API is quite simple, all you need to do is push the order data into Shipway by using (PushOrderData) API
After pushing the data you will be enabled to track all your Shipments by using (GetOrderShipmentDetails) API

\n\n

API Usage Guidelines

Our APIs use the basic HTTP request codes: POST, GET
You can select the required response and request code language by selecting it from the drop-down menu at the top.
You can test all our APIs by importing the full API collection through the 'Run in Postman' button and running them in the Postman app.
Note: Any requests made using valid API credentials will affect the real-time data in your Shipway account.

\n\n

All the APIs are provided with their appropriate example requests and responses for successful and failed calls. The example definitions are:

\n\n

Successful Call: The correct API call was made
Invalid Data: The invalid data was entered

\n\n

Errors and Response codes

Status Code	Response	Description
200	success	The request is successful
500	Internal Server Error	Shipway has encountered an error
401	failed	The request is failed

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Shipway API Requirements","slug":"shipway-api-requirements"},{"content":"How to Use APIs:","slug":"how-to-use-apis"},{"content":"API Usage Guidelines","slug":"api-usage-guidelines"},{"content":"Errors and Response codes","slug":"errors-and-response-codes"}],"owner":"15458967","collectionId":"54be67bd-abde-4f89-9338-18e5ba242e03","publishedId":"TzeWJ8iR","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-07-22T12:40:53.000Z"},"item":[{"name":"APIs","item":[{"name":"User Authentication","id":"8f436506-f5b8-4cf7-b230-272337fec511","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\r\n\r\n{\r\n\"username\":\"myshopstore1234@gmailcom\",\r\n\"password\":\"397c407771c7b278cbdc6a61e86be13c\"\r\n }\r\n\r\n","options":{"raw":{"language":"json"}}},"url":"https://shipway.in/api/authenticateUser","description":"

User Authentication API

Use this API to validate your user account in Shipway Experience. In response, you will receive the \"Success\" status and \"user_id\" of your shipway account.

Parameters:

Field Name	Description	Mandatory	Data Type
Username	Valid login id /username (user_demo)	Yes	string
password	Licence key/ (0551dba1lka12880a37066xxxxxx)	Yes	string

\n\n

Headers

Content-Type

application/json

","urlObject":{"protocol":"https","path":["api","authenticateUser"],"host":["shipway","in"],"query":[],"variable":[]}},"response":[{"id":"e58d89b7-e7c7-40cc-9b7b-5bcb983c5337","name":"Successfull call","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\r\n\r\n{\r\n\"username\":\"myshopstore1234@gmail.com\",\r\n\"password\":\"397c407771c7b278cbdc6a61e86be13c\"\r\n }","options":{"raw":{"language":"json"}}},"url":"https://shipway.in/api/authenticateUser"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Wed, 24 Feb 2021 05:38:20 GMT"},{"key":"Server","value":"Apache/2.2.22 (Ubuntu)"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"57"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":"{\"status\":\"Success\",\"user_id\":\"49093\"}"},{"id":"c0d67596-20ea-48cf-bd2e-1b3d39edf9d6","name":"Invalid data","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\r\n\r\n{\r\n\"username\":\"myshopstore1234@gmailcom\",\r\n\"password\":\"397c407771c7b278cbdc6a61e86be13c\"\r\n }","options":{"raw":{"language":"json"}}},"url":"https://shipway.in/api/authenticateUser"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Wed, 24 Feb 2021 05:51:37 GMT"},{"key":"Server","value":"Apache/2.2.22 (Ubuntu)"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"78"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":"{\"status\":\"Failed\",\"msg\":\"Invalid Email address or Password\"}"}],"_postman_id":"8f436506-f5b8-4cf7-b230-272337fec511"},{"name":"Carriers list with ID","id":"1bfb58d1-c98d-400c-be82-5c53ffdff279","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://shipway.in/api/carriers","description":"

Carriers List with ID

Using this API, you will get the complete list of all the integrated and available carriers in our system alongside their Carrier Ids. You will require the \"Carrier Id\" further to push orders into Shipway Experience.

Parameters:

Field Name	Description	Mandatory	Data Type
Username	Valid login id /username	No	string
Password	Licence Key	No	string

\n\n

Headers

Content-Type

application/json

","urlObject":{"protocol":"https","path":["api","carriers"],"host":["shipway","in"],"query":[],"variable":[]}},"response":[],"_postman_id":"1bfb58d1-c98d-400c-be82-5c53ffdff279"},{"name":"Push Orders Data","id":"4e60c039-975f-4e19-97ba-b128ef3c622d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\"username\":\"myshopstore1234@gmail.com\",\r\n\"password\":\"397c407771c7b278cbdc6a61e86be13c\",\r\n\"carrier_id\":\"1\",\r\n\"awb\":\"1122334455\",\r\n\"order_id\":\"1003\",\r\n\"first_name\":\"My\",\r\n\"last_name\":\"Customer\",\r\n\"email\":\"myshopstore1234@gmail.com\",\r\n\"phone\":\"87654321\",\r\n\"products\":\"N/A\",\r\n\"company\":\"Shipway\",\r\n\"shipment_type\":\"1\"\r\n }","options":{"raw":{"language":"json"}}},"url":"https://shipway.in/api/PushOrderData","description":"

Push Order Data

This API allows you to push Shipment along with the related customer information, tracking number, etc. to Shipway Experience. The pushed order customer will be notified via email, SMS, or WhatsApp as the status of their consignment is changed. Many other premium features will also be provided.

*Features are dependent on the plan you have subscribed for.

Parameters:

Field Name	Description	Mandatory	Data Type
Username	Valid login id /username (user_demo)	Yes	string
password	Licence key/ (0551dba1lka12880a37066xxxxxx)	Yes	string
carrier_id	Carrier Id of Shipment	Yes	int
awb	Air Waybill/Tracking number	Yes	string
order_id	Order id	Yes	Alphanumeric
email	Email of customer	Yes	string
phone	Phone no of customer	Yes	string
first_name	First name of customer	Yes	string
last_name	Last name of customer	Yes	string
products	Small Description of products(Max 35 characters)	Yes	string
Company	Your company name(Max 35 characters)	Yes	string
Shipment_type	Your Shipment Type(1 = forward ,2 = reverse)	No	int
order_data	Add extra data	No	string

\n\n

Headers

Content-Type

application/json

","urlObject":{"protocol":"https","path":["api","PushOrderData"],"host":["shipway","in"],"query":[],"variable":[]}},"response":[{"id":"df45396c-a814-4793-b154-3a341afb625a","name":"Successfull call","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\"username\":\"myshopstore1234@gmail.com\",\r\n\"password\":\"397c407771c7b278cbdc6a61e86be13c\",\r\n\"carrier_id\":\"1\",\r\n\"awb\":\"1122334455\",\r\n\"order_id\":\"1004\",\r\n\"first_name\":\"My\",\r\n\"last_name\":\"Customer\",\r\n\"email\":\"myshopstore1234@gmail.com\",\r\n\"phone\":\"87654321\",\r\n\"products\":\"N/A\",\r\n\"company\":\"Shipway\",\r\n\"shipment_type\":\"1\"\r\n }","options":{"raw":{"language":"json"}}},"url":"https://shipway.in/api/PushOrderData"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Mon, 22 Feb 2021 11:42:25 GMT"},{"key":"Server","value":"Apache/2.2.22 (Ubuntu)"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"81"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":"{\"status\":\"Success\",\"message\":\"Order has been pushed successfully.\"}"},{"id":"c6fefb63-e558-478c-a7b5-8bc33e67719b","name":"Invalid data","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\"username\":\"myshopstore1234@gmail.com\",\r\n\"password\":\"397c407771c7b278cbdc6a61e86be13c\",\r\n\"carrier_id\":\"1\",\r\n\"awb\":\"1122334455\",\r\n\"order_id\":\"1003\",\r\n\"first_name\":\"My\",\r\n\"last_name\":\"Customer\",\r\n\"email\":\"myshopstore1234@gmail.com\",\r\n\"phone\":\"87654321\",\r\n\"products\":\"N/A\",\r\n\"company\":\"Shipway\",\r\n\"shipment_type\":\"1\"\r\n }","options":{"raw":{"language":"json"}}},"url":"https://shipway.in/api/PushOrderData"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Mon, 22 Feb 2021 11:42:53 GMT"},{"key":"Server","value":"Apache/2.2.22 (Ubuntu)"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"74"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":"{\"status\":\"failed\",\"message\":\"Order cannot be pushed.\"}"}],"_postman_id":"4e60c039-975f-4e19-97ba-b128ef3c622d"},{"name":"Bulk Push Orders Data","id":"28764527-8f25-4635-aa5e-1df0b4eb570f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\":\"myshopstore1234@gmail.com\",\r\n \"password\":\"397c407771c7b278cbdc6a61e86be13c\",\r\n \"shipments\": [{\r\n \"carrier_id\": \"1\",\r\n \"awb\": \"1122334455\",\r\n \"order_id\": \"1003\",\r\n \"first_name\": \"My\",\r\n \"last_name\": \"Customer\",\r\n \"email\": \"myshopstore1234@gmail.com\",\r\n \"phone\": \"87654321\",\r\n \"products\": \"N/A\",\r\n \"company\": \"Shipway\",\r\n \"shipment_type\": \"1\" \r\n }, \r\n {\r\n \"carrier_id\": \"1\",\r\n \"awb\": \"5544332211\",\r\n \"order_id\": \"1004\",\r\n \"first_name\": \"My\",\r\n \"last_name\": \"Customer\",\r\n \"email\": \"myshopstore1234@gmail.com\",\r\n \"phone\": \"87654321\",\r\n \"products\": \"N/A\",\r\n \"company\": \"Shipway\",\r\n \"shipment_type\": \"1\"\r\n\r\n }]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://shipway.in/api/pushOrders","description":"

Bulk Push Order Data

This API allows you to push bulk Shipments along with the related customer information and tracking number to Shipway Experience. All the pushed customers will be notified by email and SMS when the status of their consignment is changed. Ideally, it takes 694 milliseconds to push 10 orders. A Maximum of 100 Shipments are allowed in one go. Many other premium features will also be provided.

*Features are dependent on the plan you have subscribed for.

Parameters:

Field Name	Description	Mandatory	Data Type
Username	Valid login id /username (user_demo)	Yes	string
password	Licence key/ (0551dba1lka12880a37066xxxxxx)	Yes	string
Shipment Details:
carrier_id	Carrier Id of Shipment	Yes	int
awb	Air Waybill/Tracking number	Yes	string
order_id	Order id	Yes	Alphanumeric
email	Email of customer	Yes	string
phone	Phone no of customer	Yes	string
first_name	First name of customer	Yes	string
last_name	Last name of customer	Yes	string
products	Small Description of products(Max 3 characters)	Yes	string
Company	Your company name(Max 35 characters)	Yes	string
Shipment_type	Your Shipment Type(1 = forward ,2 = reverse)	No	int
order_data	Add extra data	No	string

\n\n

Headers

Content-Type

application/json

","urlObject":{"protocol":"https","path":["api","pushOrders"],"host":["shipway","in"],"query":[],"variable":[]}},"response":[{"id":"cb90e2bb-4054-4462-a9b4-06956d522b15","name":"Successful call","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\":\"myshopstore1234@gmail.com\",\r\n \"password\":\"397c407771c7b278cbdc6a61e86be13c\",\r\n \"shipments\": [{\r\n \"carrier_id\":\"1\",\r\n \"awb\":\"1212121212\",\r\n \"order_id\":\"1003\",\r\n \"first_name\":\"My\",\r\n \"last_name\":\"Customer\",\r\n \"email\":\"myshopstore1234@gmail.com\",\r\n \"phone\":\"87654321\",\r\n \"products\":\"N/A\",\r\n \"company\":\"Shipway\",\r\n \"shipment_type\":\"1\" \r\n }, \r\n {\r\n \"carrier_id\":\"1\",\r\n \"awb\":\"544332211\",\r\n \"order_id\":\"1004\",\r\n \"first_name\":\"My\",\r\n \"last_name\":\"Customer\",\r\n \"email\":\"myshopstore1234@gmail.com\",\r\n \"phone\":\"87654321\",\r\n \"products\":\"N/A\",\r\n \"company\":\"Shipway\",\r\n \"shipment_type\":\"1\"\r\n }]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://shipway.in/api/pushOrders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 22 Feb 2021 12:20:01 GMT"},{"key":"Server","value":"Apache/2.2.22 (Ubuntu)"},{"key":"Content-Length","value":"563"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"carrier_id\": \"1\",\n \"awb\": \"544332211\",\n \"order_id\": \"1004\",\n \"first_name\": \"My\",\n \"last_name\": \"Customer\",\n \"email\": \"myshopstore1234@gmail.com\",\n \"phone\": \"87654321\",\n \"products\": \"N/A\",\n \"company\": \"Shipway\",\n \"shipment_type\": \"1\",\n \"user_id\": \"49093\",\n \"status\": \"Failed\",\n \"msg\": \"Record already exists\"\n },\n {\n \"carrier_id\": \"1\",\n \"awb\": \"1212121212\",\n \"order_id\": \"1005\",\n \"first_name\": \"My\",\n \"last_name\": \"Customer\",\n \"email\": \"myshopstore1234@gmail.com\",\n \"phone\": \"87654321\",\n \"products\": \"N/A\",\n \"company\": \"Shipway\",\n \"shipment_type\": \"1\",\n \"user_id\": \"49093\",\n \"status\": \"Success\",\n \"msg\": \"Shipment inserted successfully.\"\n }\n]"},{"id":"113e171c-d8d1-4a68-9d88-b686150b13f8","name":"Invalid data","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\":\"myshopstore1234@gmail.com\",\r\n \"password\":\"397c407771c7b278cbdc6a61e86be13c\",\r\n \"shipments\": [{\r\n \"carrier_id\":\"1\",\r\n \"awb\":\"1212121212\",\r\n \"order_id\":\"1004\",\r\n \"first_name\":\"My\",\r\n \"last_name\":\"Customer\",\r\n \"email\":\"myshopstore1234@gmail.com\",\r\n \"phone\":\"87654321\",\r\n \"products\":\"N/A\",\r\n \"company\":\"Shipway\",\r\n \"shipment_type\":\"1\" \r\n }, \r\n {\r\n \"carrier_id\":\"1\",\r\n \"awb\":\"544332211\",\r\n \"order_id\":\"1004\",\r\n \"first_name\":\"My\",\r\n \"last_name\":\"Customer\",\r\n \"email\":\"myshopstore1234@gmail.com\",\r\n \"phone\":\"87654321\",\r\n \"products\":\"N/A\",\r\n \"company\":\"Shipway\",\r\n \"shipment_type\":\"1\"\r\n }]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://shipway.in/api/pushOrders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 22 Feb 2021 12:34:11 GMT"},{"key":"Server","value":"Apache/2.2.22 (Ubuntu)"},{"key":"Content-Length","value":"563"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"carrier_id\": \"1\",\n \"awb\": \"544332211\",\n \"order_id\": \"1004\",\n \"first_name\": \"My\",\n \"last_name\": \"Customer\",\n \"email\": \"myshopstore1234@gmail.com\",\n \"phone\": \"87654321\",\n \"products\": \"N/A\",\n \"company\": \"Shipway\",\n \"shipment_type\": \"1\",\n \"user_id\": \"49093\",\n \"status\": \"Failed\",\n \"msg\": \"Record already exists\"\n },\n {\n \"carrier_id\": \"1\",\n \"awb\": \"1212121212\",\n \"order_id\": \"1004\",\n \"first_name\": \"My\",\n \"last_name\": \"Customer\",\n \"email\": \"myshopstore1234@gmail.com\",\n \"phone\": \"87654321\",\n \"products\": \"N/A\",\n \"company\": \"Shipway\",\n \"shipment_type\": \"1\",\n \"user_id\": \"49093\",\n \"status\": \"Success\",\n \"msg\": \"Shipment inserted successfully.\"\n }\n]"}],"_postman_id":"28764527-8f25-4635-aa5e-1df0b4eb570f"},{"name":"Order Shipment Details","id":"209d16d4-5eab-4474-a2a1-c7b216aeb1f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\":\"myshopstore1234@gmail.com\",\r\n \"password\":\"397c407771c7b278cbdc6a61e86be13c\",\r\n \"order_id\":\"1004\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://shipway.in/api/getOrderShipmentDetails","description":"

Shipment Details

The API helps you to get the current tracking status, history and other details for any order that is pushed into Shipway Experience.

Parameters:

Field Name	Description	Mandatory	Data Type
Username	Shipway Username	Yes	string
Password	Licence Key	Yes	string
Order_id	Order Id, for which you need Shipment details	Yes	Alphanumeric

\n\n

Headers

Content-Type

application/json

\n\n

Shipment Statuses and their meaning

Current_status_code is the current status code you will receive in Get Order Shipment Details API

No.	current_status_code	Status Description
1	DEL	Delivered
2	INT	In Transit
3	UND	Undelivered
4	RTO	RTO
5	RTD	RTO Delivered
6	CAN	Cancelled
7	SCH	Shipment Booked
8	PKP	Picked Up
9	ONH	On Hold
10	OOD	Out for Delivery
11	NWI	Network Issue
12	DNB	Delivery Next Day
13	NFI	Not Found/Incorrect
14	ODA	Out of Delivery Area
15	OTH	Others
16	SMD	Delivery Delayed
17	CRTA	Customer Refused
18	CNA	Consignee Unavailable
19	DEX	Delivery Exception
20	DRE	Delivery Rescheduled
21	PNR	COD Payment Not Ready
22	LOST	Shipment Lost
23	PKF	Pick up Failed
24	PCAN	Pick up Cancelled
25	FDR	Future Delivery Requested
26	22	Address Incorrect
27	23	Delivery Attempted
28	24	Pending - Undelivered
29	25	Delivery Attempted-Premises Closed
30	OFP	Out For Pickup
The below-mentioned status are for Reverse Shipments
31	RCAN	Return Request Cancelled
32	RCLO	Return Request Closed
33	RDEL	Return Delivered
34	RINT	Return In Transit
35	ROOP	Return Out for Pickup
36	RPKP	Return Shipment Picked Up
37	RPSH	Return Pickup Rescheduled
38	RSMD	Return Pickup Delayed
39	RSCH	Return Pickup Scheduled
40	ROOD	Return Out for Delivery
41	RUND	Return Undelivered
42	RPEX	Reverse Pickup Exception

","urlObject":{"protocol":"https","path":["api","getOrderShipmentDetails"],"host":["shipway","in"],"query":[],"variable":[]}},"response":[{"id":"5583815c-b07d-4a03-b2a9-707c86883308","name":"Successfull call","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\":\"myshopstore1234@gmail.com\",\r\n \"password\":\"397c407771c7b278cbdc6a61e86be13c\",\r\n \"order_id\":\"1122334455\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://shipway.in/api/getOrderShipmentDetails"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 23 Feb 2021 05:53:07 GMT"},{"key":"Server","value":"Apache/2.2.22 (Ubuntu)"},{"key":"Content-Length","value":"236"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\",\n \"response\": {\n \"current_status\": \"No Information Yet\",\n \"current_status_code\": \"NFI\",\n \"carrier\": \"Bluedart\",\n \"from\": \"\",\n \"to\": \"\",\n \"customer_name\": \"My Customer\",\n \"order_data\": \"\",\n \"pickup_date\": null,\n \"time\": null,\n \"awbno\": \"1122334455\"\n }\n}"},{"id":"ec5ad840-0f0c-4baf-8a0d-f4ddc29eb2bc","name":"Invalid data","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\":\"myshopstore1234@gmailcom\",\r\n \"password\":\"397c407771c7b278cbdc6a61e86be13c\",\r\n \"order_id\":\"1004\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://shipway.in/api/getOrderShipmentDetails"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Wed, 24 Feb 2021 05:33:38 GMT"},{"key":"Server","value":"Apache/2.2.22 (Ubuntu)"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"78"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":"{\"status\":\"Failed\",\"msg\":\"Invalid Email address or Password\"}"}],"_postman_id":"209d16d4-5eab-4474-a2a1-c7b216aeb1f4"},{"name":"Add Webhooks","id":"caf62b74-e220-44cf-bcb5-4743cb64c72c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\"username\":\"myshopstore1234@gmail.com\",\r\n\"password\":\"397c407771c7b278cbdc6a61e86be13c\",\r\n\"callback_url\":\"http://abc.com/push_back2.php\",\r\n\"events\":\"INT,OOD,DEL,UND,RTO,RTD\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://shipway.in/api/addwebhooks","description":"

Add Webhooks

The API allows you to add the callback URL and select the events for which you want to receive updates through webhooks.

The same setting can be accessed directly by logging into Shipway Experience and following the given steps:

Menu > Settings > Webhooks

Parameters:

Field Name	Description	Mandatory	Data Type
Username	Valid login id /username (user_demo)	Yes	string
password	Licence key/ (0551dba1lka12880a37066xxxxxx)	Yes	string
callback_url	http://xyz/abcwebhook.php	Yes	string
events	DEL,INT,OOD,UND,RTO,RTD (Delivered, In Transit, Out for Delivery, Undelivered, RTO, RTO Delivered etc) or you can see above all status and meanings	Yes	string

\n\n

Headers

Content-Type

application/json

","urlObject":{"protocol":"https","path":["api","addwebhooks"],"host":["shipway","in"],"query":[],"variable":[]}},"response":[{"id":"fd0aa496-46f1-4231-b04b-5aeca2aa869d","name":"Successfull call","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\"username\":\"myshopstore1234@gmail.com\",\r\n\"password\":\"397c407771c7b278cbdc6a61e86be13c\",\r\n\"callback_url\":\"http://abc.com/push_back2.php\",\r\n\"events\":\"INT,OOD,DEL,UND,RTO,RTD\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://shipway.in/api/addwebhooks"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Tue, 23 Feb 2021 05:01:44 GMT"},{"key":"Server","value":"Apache/2.2.22 (Ubuntu)"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"92"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":"{\"status\":\"success\",\"message\":\"Webhooks has Inserted successfully\",\"status_code\":\"200\"}"},{"id":"7ce3e364-c892-441c-9798-7e9df9c96e56","name":"Invalid data","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\"username\":\"myshopstore1234@gmail\",\r\n\"password\":\"397c407771c7b278cbdc6a61e86be13c\",\r\n\"callback_url\":\"http://abc.com/push_back2.php\",\r\n\"events\":\"INT,OOD,DEL,UND,RTO,RTD\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://shipway.in/api/addwebhooks"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Tue, 23 Feb 2021 05:04:14 GMT"},{"key":"Server","value":"Apache/2.2.22 (Ubuntu)"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"77"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":"{\"status\":\"Failed\",\"message\":\"Invalid Inputs\",\"status_code\":\"401\"}"}],"_postman_id":"caf62b74-e220-44cf-bcb5-4743cb64c72c"},{"name":"Delete Webhooks","id":"37a05f0f-8123-4672-8d80-6f49a8aaa296","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\"username\":\"myshopstore1234@gmailcom\",\r\n\"password\":\"397c407771c7b278cbdc6a61e86be13c\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://shipway.in/api/delete_webhooks","description":"

Delete Webhooks

The API allows you to delete the webhook settings including the callback URL.

The same setting can be accessed directly by logging into Shipway Experience and following the given steps:

Menu > Settings > Webhooks

Parameters:

Field Name	Description	Mandatory	Data Type
Username	Valid login id /username (user_demo)	Yes	string
password	Licence key/ (0551dba1lka12880a37066xxxxxx)	Yes	string

\n\n

Headers

Content-Type

application/json

","urlObject":{"protocol":"https","path":["api","delete_webhooks"],"host":["shipway","in"],"query":[],"variable":[]}},"response":[{"id":"18860cbc-cedb-4fce-85f3-984dfa31a2ed","name":"Successfull call","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\"username\":\"myshopstore1234@gmail.com\",\r\n\"password\":\"397c407771c7b278cbdc6a61e86be13c\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://shipway.in/api/delete_webhooks"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Tue, 23 Feb 2021 05:07:37 GMT"},{"key":"Server","value":"Apache/2.2.22 (Ubuntu)"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"91"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":"{\"status\":\"success\",\"message\":\"Webhooks has deleted successfully\",\"status_code\":\"200\"}"},{"id":"0b8c0984-30d0-4f0a-bf48-47b620c3f75f","name":"Invalid data","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\"username\":\"myshopstore1234@gmailcom\",\r\n\"password\":\"397c407771c7b278cbdc6a61e86be13c\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://shipway.in/api/delete_webhooks"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Date","value":"Tue, 23 Feb 2021 05:46:05 GMT"},{"key":"Server","value":"Apache/2.2.22 (Ubuntu)"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"77"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":"{\"status\":\"Failed\",\"message\":\"Invalid Inputs\",\"status_code\":\"401\"}"}],"_postman_id":"37a05f0f-8123-4672-8d80-6f49a8aaa296"}],"id":"3951414b-d6c8-42fd-9b46-e513791f0a73","description":"

Shipway Experience provides these APIs to create, get tracking details and manage orders:

Carriers List with id- For getting all carrier ids
PushOrderData – To push the tracking and other details into Shipway
GetOrderShipmentDetails – Get the tracking status and details
Shipment Status codes & their definitions
Add Webhooks - To add webhooks settings to receive order tracking details
Delete Webhooks - To delete webhooks settings

","_postman_id":"3951414b-d6c8-42fd-9b46-e513791f0a73"}]}