Skip to main content

3PL REST API Client

Project description

A Python wrapper for the 3PL Central REST API

Usage

set up a .env file in the root of the project:

BASE_URL="https://secure-wms.com"
AUTH_PATH="AuthServer/api/Token"
CLIENT_ID="your-id"
CLIENT_SECRET="your-secret"
FACILITY_ID=99
TPL_KEY="your-tpl-key"
GRANT_TYPE="client_credentials"
USER_LOGIN_ID="name-this-whatever-you-want"
ROUTING_INFO_ACCOUNT_NUMBER="ups-account-number"

Verify that you can access the api by running

python3 -m verify_credentials

Then, run the following get a list of methods you can try out, with a handy run-in-place CLI:

python3 -m examples
Which endpoint do you want to try?
1) cancel_test_order

2) create_test_item

3) create_test_order

4) get_carriers_list

5) get_order

Enter a number:

License

MIT

See LICENSE for more details

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

tplcentral-0.1.2.tar.gz (4.2 kB view hashes)

Uploaded Source

Supported by

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