This codebase switches patterns between type and isinstance. Using type is not considered idiomatic and style preference is usually given to isinstance.

What's the right way to move this order to "awaiting_shipment" --

Do I recreate the order on my side, with the same order_key, and then write it again, but this time with the status "awaiting_shipment"

or

Is there a way to "GET" the order object out of shipstation, say with the order_id, update it, and write it back to SS?

Let me know your thoughts on the best practice. Really appreciate your help here! Thanks.

In [1]: import inspect
In [2]: from shipstation.api import *
In [3]: src = inspect.getsource(ShipStation)
In [4]: src
In [5]: import pprint
In [6]: pprint.PrettyPrinter(indent=4).pprint(src)

Excerpted:

 '\n'
 '    def get(self, endpoint="", payload=None):\n'
 '        url = "{}{}".format(self.url, endpoint)\n'
 '        r = requests.get(url, auth=(self.key, self.secret), params=payload)\n'
 '        if self.debug:\n'
 '            pprint.PrettyPrinter(indent=4).pprint(r.json())\n'
 '\n'
 '    def post(self, endpoint="", data=None):\n'
 '        url = "{}{}".format(self.url, endpoint)\n'
 '        headers = {"content-type": "application/json"}\n'
 '        r = requests.post(url, auth=(self.key, self.secret),\n'
 '                          data=data, headers=headers)\n'
 '        if self.debug:\n'
 '            pprint.PrettyPrinter(indent=4).pprint(r.json())\n'
 '\n'

pip list outputs: shipstation 0.1.3 which should have the fix for get here but not post. I am opening a PR to the develop branch, where you'll be able to merge in both changes to master.

I think I know the answer to this -- but can you set shipment batch ID via the shipstation API, and if so, does your library support it? I think the answer is no but would love to hear back from you. Thanks nate!

ah man, why you stopped developing this API. It is really good staring point but it lacks lots of options.

are you expecting to do some work on this library?

A PUT request is required by the "update_store" api. Please add a put method to the ShipStation class so this API method can be added in the future.

Please assign to me at your convenience

After receiving a 504 GATEWAY_TIMEOUT from ShipStation's API, a retry with a backoff would improve stability.
Here a function that would solve this issue from this retries in requests guide:

def get_session(
    retries: int = 5,
    backoff_factor: float = 1,
    status_forcelist: list = [502, 503, 504],
) -> requests.Session:
    """Returns a requests session that retries on specific failures.
    also: https://stackoverflow.com/a/35636367/2469390
    https://www.coglib.com/~icordasc/blog/2014/12/retries-in-requests.html
    """
    session = requests.Session()
    retry = Retry(
        total=retries,
        read=retries,
        connect=retries,
        backoff_factor=backoff_factor,
        status_forcelist=status_forcelist,
    )
    adapter = HTTPAdapter(max_retries=retry)
    session.mount("http://", adapter)
    session.mount("https://", adapter)
    return session

Then I think ShipStation.get would change to:

    def get(self, endpoint="", payload=None):
        url = "{}{}".format(self.url, endpoint)
       session = get_session()
        r = session.get(url, auth=(self.key, self.secret), params=payload)
        if self.debug:
            pprint.PrettyPrinter(indent=4).pprint(r.json())

        return r

And ShipStation.post to:

    def post(self, endpoint="", data=None):
        url = "{}{}".format(self.url, endpoint)
        headers = {"content-type": "application/json"}
       session = get_session()
        r = session.post(url, auth=(self.key, self.secret),
                          data=data, headers=headers)
        if self.debug:
            pprint.PrettyPrinter(indent=4).pprint(r.json())

       return r

And similar for put()

I didn't see an example that shows how to get the rate for a given carrier.

Currently, pyshipstation only supports pushing new orders via API and has no support for retrieving an existing list of orders. A new method should be added (ShipStation#fetch_orders?) to allow for this.

They need to be a Decimal value.

Having all the options collected in one place means easier maintenance.

The bot created this issue to inform you that pyup.io has been set up on this repo.
Once you have closed it, the bot will open pull requests for updates as soon as they are available.

class ShipStationAddress(ShipStationBase):
def init(
self,
name=None,
company=None,
street1=None,
street2=None,
street3=None,
city=None,
state=None,
postal_code=None,
country=None,
phone=None,
residential=None,
):
self.name = name
self.company = company
self.street1 = street1
self.street2 = street2
self.street3 = street3
self.city = city
self.state = state
self.postal_code = postal_code
self.phone = phone
self.residential = residential

*** Need to add self.country = country

I want to use this tool to count how many orders were shipped on a given date, but currently ship_date is not a parameter I can use.

I have been tinkering trying to add it myself, but haven't had any success so far :(

I don't think this is where feature requests go, but I couldn't find where else to put it so I apologize if this is the wrong spot!

Love the code though! I learned a lot snooping around, and have made something that works as a more in-depth "insights" page

requests' default behavior is to not provide a timeout, which is not recommended, even in their own documentation. Please add a timeout attribute to the ShipStation class and a timeout parameter to the get and post methods of the ShipStation class.

Please assign to me at your convenience.