Shipwire API

Component ID

2260409

Component name

Shipwire API

Component type

module

Maintenance status

Development status

Component security advisory coverage

covered

Downloads

1613

Component created

Component changed

Component body

The Shipwire API module handles communication with the Shipwire shipping service. It provides a ShipwireShipment entity, classes for all API requests, and required methods to handle all API interactions. This module can be used in conjuction with the Shipwire Commerce, Shipwire Ubercart, or to develop custom and future integrations with Drupal stores. The API current supports 4 methods of request.

  • Rate request - Submit orders with associated products and recieve a response with real time shipping quotes.
  • Fulfillment request - Submit orders with products to have Shipwire ship the order. Returns a response with information about the shipped orders.
  • Tracking request - Query Shipwire using order numbers, Shipwire IDs, warehouse filters, and bookmark to get a response with real time information on shipment status and tracking.
  • Inventory request - Submit a list of product SKUs or warehouse filters to get a response indicating real time stock levels.

PHP classes are are provided to build request and format data for trasfer to Shipwire. Please look at the shipwire/includes/shipwire.inc file for information on their properties and methods. For examples of use please look at one of the existing modules referenced above.

The ShipwireShipment entity is provided to store and view information about shipments. It is built on top of the Entity API module and supports: CRUD functions, Views, Rules, and Tokens integration.