Introduction Here you will find requirements for integrating with PRO SHIPPING API. The documentation specifically covers how the API can be used by business customers to conduct shipping activity with available carriers and provides the technical information to build this integration. The API allows customers to create and manage shipments, produce labels, customs documentation, and collection manifests, retrieve reference data such as carriers and countries, and maintain their own data such as shipping account details. Pro Shipping API is a fully RESTful service implemented using JSON messaging. You, as the customer are responsible for sending JSON messages and for maintaining the capability of receiving JSON messages in the format described in this specification. Request and response examples for each API service are included in this specification. # Authentication The PRO SHIPPING API uses OAuth2 authentication. To request the authorization token you need to create API credentials (Client ID and Secret) on the system first. If you have not done it already, log into your account and go to API Credentials or follow the link [add a link here with the path to the API Credentials menu]. Use the credentials to retrieve the authorization token. Note: Make sure you copy the Secret and keep it secure as you won't be able to view it again on the system.
This Python package is automatically generated by the Swagger Codegen project:
- API version: v4.0-RM
- Package version: 0.0.4
- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
Python 2.7 and 3.4+
If the python package is hosted on Github, you can install directly from Github
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
)
Then import the package:
import rmail_api
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import rmail_api
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import rmail_api
from rmail_api.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: oauth2
configuration = rmail_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = rmail_api.OfflineBarcodingApi(rmail_api.ApiClient(configuration))
body = rmail_api.RoyalMailGetOfflineBarcodingRequest() # RoyalMailGetOfflineBarcodingRequest | The request. (optional)
try:
# Get Barcode Range
api_response = api_instance.v4_offline_barcode_number_range_rm_post(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OfflineBarcodingApi->v4_offline_barcode_number_range_rm_post: %s\n" % e)
All URIs are relative to https://api.proshipping.net/
Class | Method | HTTP request | Description |
---|---|---|---|
OfflineBarcodingApi | v4_offline_barcode_number_range_rm_post | POST /v4/offlineBarcodeNumberRange/rm | Get Barcode Range |
ShipmentsApi | v4_shipments_defer_put | PUT /v4/shipments/defer | Defer Shipments |
ShipmentsApi | v4_shipments_preallocate_tracking_number_rm_post | POST /v4/shipments/preallocateTrackingNumber/rm | Pre Allocate Tracking Number |
ShipmentsApi | v4_shipments_print_document_carrier_code_shipment_id_post | POST /v4/shipments/printDocument/{carrierCode}/{shipmentId} | Print Document |
ShipmentsApi | v4_shipments_print_label_rm_shipment_id_get | GET /v4/shipments/printLabel/rm/{shipmentId} | Print Label |
ShipmentsApi | v4_shipments_print_my_label_qr_code_rm_shipment_id_get | GET /v4/shipments/printMyLabelQRCode/rm/{shipmentId} | Print My Label QR Code |
ShipmentsApi | v4_shipments_rm_post | POST /v4/shipments/rm | Create Shipment |
ShipmentsApi | v4_shipments_shipping_location_id_get | GET /v4/shipments/{shippingLocationId} | Get Shipments |
ShipmentsApi | v4_shipments_status_put | PUT /v4/shipments/status | Update Status |
ShippingAccountsApi | v4_shipping_accounts_carrier_code_shipping_account_id_delete | DELETE /v4/shippingAccounts/{carrierCode}/{shippingAccountId} | Delete Account |
ShippingAccountsApi | v4_shipping_accounts_carrier_code_shipping_account_id_unlink_locations_put | PUT /v4/shippingAccounts/{carrierCode}/{shippingAccountId}/unlinkLocations | Unlink Locations |
ShippingAccountsApi | v4_shipping_accounts_get | GET /v4/shippingAccounts | Get Accounts |
ShippingAccountsApi | v4_shipping_accounts_rm_get | GET /v4/shippingAccounts/rm | Get Carrier Accounts |
ShippingAccountsApi | v4_shipping_accounts_rm_post | POST /v4/shippingAccounts/rm | Add Account |
ShippingAccountsApi | v4_shipping_accounts_rm_shipping_account_id_get | GET /v4/shippingAccounts/rm/{shippingAccountId} | Get Account |
ShippingAccountsApi | v4_shipping_accounts_rm_shipping_account_id_link_locations_post | POST /v4/shippingAccounts/rm/{shippingAccountId}/linkLocations | Link Locations |
ShippingAccountsApi | v4_shipping_accounts_rm_shipping_account_id_put | PUT /v4/shippingAccounts/rm/{shippingAccountId} | Update Account |
ShippingAccountsApi | v4_shipping_accounts_rm_shipping_account_id_shipping_locations_get | GET /v4/shippingAccounts/rm/{shippingAccountId}/shippingLocations | Get Associated Locations |
ShippingAccountsApi | v4_shipping_accounts_rm_shipping_account_id_shipping_locations_shipping_location_id_get | GET /v4/shippingAccounts/rm/{shippingAccountId}/shippingLocations/{shippingLocationId} | Get Associated Location |
ShippingAccountsApi | v4_shipping_accounts_rm_shipping_account_id_shipping_locations_shipping_location_id_put | PUT /v4/shippingAccounts/rm/{shippingAccountId}/shippingLocations/{shippingLocationId} | Update Associated Location |
- AccountType
- AddShippingAccountLocationNewLocation
- AddShippingAccountResponse
- BusinessTransactionType
- ContentType
- CreateShipmentAction
- Customs
- DeferShipmentRequest
- Destination
- DestinationDetails
- Dimensions
- DimensionsUnitOfMeasure
- DocumentFormat
- DocumentType
- ErrorDetail
- ErrorResponse
- GetShipmentsStatusType
- Item
- OrderDirection
- PreAllocateTrackingNumberRequest
- PreAllocateTrackingNumberResponse
- PrintDocumentRequest
- PrintDocumentResponse
- QRCodeResponse
- ReturnToSender
- RoyalMailAccountLocationStatus
- RoyalMailAddShippingAccountLocation
- RoyalMailAddShippingAccountRequest
- RoyalMailDataStreamDetails
- RoyalMailEnhancementCode
- RoyalMailGazetteerCodes
- RoyalMailGetOfflineBarcodingRequest
- RoyalMailGetOfflineBarcodingResponse
- RoyalMailLabelFormat
- RoyalMailLabelFormatRoyalMailShipmentResponseCarrierSpecificsPackageResponseCreateShipmentResponse
- RoyalMailLabelFormatRoyalMailShipmentResponseCarrierSpecificsPrintLabelResponse
- RoyalMailLabelFormatShipmentInformation
- RoyalMailLinkShippingAccountLocation
- RoyalMailOfflineBarcode
- RoyalMailOfflineBarcodingEnhancementCode
- RoyalMailPackage
- RoyalMailPackageTypeCode
- RoyalMailPreAllocatedTrackingNumberEnhancementCode
- RoyalMailServiceEnhancement
- RoyalMailShipmentRequestCarrierSpecifics
- RoyalMailShipmentRequestCarrierSpecificsRoyalMailPackageRoyalMailLabelFormatCreateShipmentRequest
- RoyalMailShipmentResponseCarrierSpecifics
- RoyalMailShipmentResponseCarrierSpecificsPackageResponse
- RoyalMailShippingAccount
- RoyalMailShippingAccountShippingAccountsPagedResponse
- RoyalMailUpdateShippingAccountLocation
- RoyalMailUpdateShippingAccountRequest
- RoyalMailViewShippingAccountLocation
- RoyalMailViewShippingAccountLocationShippingLocationForAccount
- RoyalMailViewShippingAccountLocationShippingLocationsForAccountPagedResponse
- ShipmentAddress
- ShipmentResponse
- ShipmentsPagedResponse
- Shipper
- ShipperAddress
- ShippingAccount
- ShippingAccountsPagedResponse
- ShippingAccountsSortBy
- ShippingLocationAddress
- ShippingLocationIdRequest
- ShippingLocationsSortBy
- TermsOfTrade
- UpdateStatusRequest
- UpdateStatusType
- WeightUnitOfMeasure
- Type: OAuth
- Flow: application
- Authorization URL:
- Scopes: