Private
clientThe addFunds
method allows a user to add funds to their carrier account balance.
Not all carrier providers allow you to maintain a balance.
The connect
method connects a carrier account to a user's ShipEngine account.
Disconnect a Carrier of the given ID from the account. https://shipengine.github.io/shipengine-openapi/#operation/disconnect_carrier_by_id
The getAutoFunding
method retrieves the current auto-funding settings.
If no auto-funding rules have been set, the response will contain the default values for auto-funding. Auto-funding is disabled by default.
The getPackageRatingGroup
method retrieves a list of package rating groups.
This is primarily used for carriers that support negotiated rates, and a user
has a rate card with multiple package rating groups.
The getServices
method retrieves a list of shipping services that a given carrier offers.
The getZones
method retrieves a list of zones for which the attached carrier
provides support to.
The list
method retrieves a list of connected carriers for a given user.
Optional
props: { Optional
isThe updateAutoFunding
method allows a user to update the auto-funding settings
on their ShipEngine account.
e.g. Enable auto-funding, set a balance threshold, and a maximum number of time per day you wish to auto-fund your account.
Generated using TypeDoc
Carriers API module - /v1/carriers