Git Product home page Git Product logo

shipstation's Introduction

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.

shipstation's People

Contributors

ortega-io avatar t3chguy avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.