POD API Routes
The following routes available in the POD add on.
Note: This API route needs WPCargo API Add on activated to make it works. You may try “WPCargo API add on Routes”
1. mysite.com/wp-json/wpcargo/v1/api/{api_key}/pod/settings
Method: GET
This route will return the POD Settings set up.
2. mysite.com/wp-json/wpcargo/v1/api/{api_key}/pod/search
Method: POST
This route retrieves shipments assigned to the driver.
Parameters
Note: do not use both parameters use only one.
- status (Shipment Status) – will return all assigned shipments equal to the status requested.
- search (Tracking Number) – will return all information of the provided tracking number.
3. mysite.com/wp-json/wpcargo/v1/api/{api_key}/pod/status
Method: GET
This route will return the list of shipment status available in the site.
4. mysite.com/wp-json/wpcargo/v1/api/{api_key}/pod/track
Method: POST
This route will return shipment information of the provided tracking number.
Parameters
- track – Tracking Number
5. mysite.com/wp-json/wpcargo/v1/api/{api_key}/pod/route
Method: GET
This route will return all available routes of the shipments assigned to the driver.
6. mysite.com/wp-json/wpcargo/v1/api/{api_key}/pod/status/count
Method: GET
This route will return the count\numbers of the shipments assigned to the driver with the specified status.
7. mysite.com/wp-json/wpcargo/v1/api/{api_key}/pod/shipment/{shipmentID}
Method: GET
This route will return shipment information in specified Shipment ID.
Note: For additional available routes please see “WPCargo API add on Routes”