Skip to main content

Non official Shipstation API wrapper

Project description

Description:

This Python package serves as a comprehensive wrapper for the ShipStation API, designed to simplify the integration of ShipStation's shipping, fulfillment, and order management functionalities into your Python applications. By abstracting the complexities of direct API calls, this wrapper provides an intuitive interface for developers to interact with ShipStation, making it easier to automate shipping operations, manage orders, and streamline logistics processes directly from Python code.

Features

  • Easy Configuration: Set up your API keys once, and you're ready to interact with all available endpoints.
  • Order Management: Retrieve, filter, and manage orders with simple method calls.
  • Shipment Handling: List and update shipment details effortlessly.
  • Customer Insights: Access and manage customer information, including filtering by specific criteria.
  • Customs Declarations: Simplify international shipping with easy customs declaration updates.
  • Tag Management: Apply tags to orders for easy organization and tracking.
  • Comprehensive Filters: Utilize built-in filtering to easily manage and search through orders and shipments based on custom criteria.

Installation:

Install the package using pip:

pip install shipstation-api-wrapper

Getting Started:

from shipstation_api_wrapper.api import ShipStationClient

api_key = 'your_api_key_here'
client = ShipStationClient(api_key)

Basic Usage:

Orders

  • Retrieve an order by ID:
order = client.orders.get_by_id(order_id="123456")
print(order.json())
  • List orders with custom filtering
from shipstation_api_wrapper.filter import ShipStationOrderFilter

order_filter = ShipStationOrderFilter()
order_filter.add_order_number("1001")
orders = client.orders.list_with_filter(order_filter=order_filter)
print(orders.json())

Advanced Features

Refer to the ShipStation API Documentation for more details on the advanced usage of the API.

Contributing

I welcome contributions from the community! Please refer to the project's contributing guidelines for more information.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shipstation_api_wrapper-0.1.2.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

shipstation_api_wrapper-0.1.2-py3-none-any.whl (7.0 kB view details)

Uploaded Python 3

File details

Details for the file shipstation_api_wrapper-0.1.2.tar.gz.

File metadata

  • Download URL: shipstation_api_wrapper-0.1.2.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.10.12 Linux/5.15.146.1-microsoft-standard-WSL2

File hashes

Hashes for shipstation_api_wrapper-0.1.2.tar.gz
Algorithm Hash digest
SHA256 6e432fb3f9268eaaef7f1374a5f047ebc2d0499fdb0c3185895edd163a93610b
MD5 177890482df153302db6331e84835df3
BLAKE2b-256 4e30ebdbbb7ce36d80d59a73903977c84106bf93fcf9dd8bcd184e5e527bc378

See more details on using hashes here.

File details

Details for the file shipstation_api_wrapper-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: shipstation_api_wrapper-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 7.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.10.12 Linux/5.15.146.1-microsoft-standard-WSL2

File hashes

Hashes for shipstation_api_wrapper-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9268ba48d82f8a742f48a470f51f25f163e58e7d6412d8e7228f899a0d26c729
MD5 28bf090572e2cfcd44a89a64832813af
BLAKE2b-256 bdd3f03df41db752a139c04cc30bd41406b2e5b9abc33bb3388f8263fb69ea92

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page