Skip to content

ortega-io/ShipStation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ShipStation Php API Wrapper

This is a Php Wrapper Class for the ShipStation API, it is a work in progress but it is enough to get started those looking to push orders to ShipStation, retrieve them and get the respective tracking numbers for shipments.

The Wrapper currently supports the following operations:

  • Get the list of warehouses available
  • Get the list of stores available
  • Get the list of orders on the system (filtered or unfiltered)
  • Get the details for an specific order (like the ShipStation order ID)
  • Send a new order to ShipStation
  • Delete an order on ShipStation
  • Get the list of shipments on the system (filtered or unfiltered)
  • Get the list of Carriers available
  • Get the details of a specific Carrier
  • Get the list of Services available from a Carrier
  • Get the list of Packages available from a Carrier
  • Get shipment rates
  • Create shipping labels

Using the demo file

To get your feet wet with the code just look for the places where you have to put your own credentials and keys ( marked with brackets {} ) on the demo.php and Shipstation.class.php files.

About ShipStation API Request Cap

The Wrapper class is designed to support the API Request Cap as defined by ShipStation, however on my experience such Request Cap is NOT being honored and has never been... so be aware that you won't ever reach the 40 requests per second throughput advertised.

Extending the Wrapper Class

You are more than welcome to add the missing methods on the Wrapper Class, just follow the coding style and the naming conventions, you can find more information about the API at:

http://www.shipstation.com/developer-api/
http://docs.shipstation.apiary.io/

If you happen to do that, just send me a pull request and I will be more than happy to pull, just be aware that ShipStation's documentation is... well... let's say is not very good, so be sure to test thoroughly.

DISCLAIMERS:

  • "ShipStation" and is a registered trademark property of its respective owners and is used here and on the code just for reference purposes.

  • If you have troubles with the indentation, this code was edited using sublime text 3 and a tab size of 4.

About

ShipStation API Wrapper

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages