Contact Us 1-800-596-4880
  1. Homepage
  2. Shippo Connector (0.1)

  3. Shippo Connector Reference

All Connectors

Shippo Connector 0.1.0 Reference

Configurations

Config

Default configuration.

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

Shippo Token

The connection types to provide to this configuration.

x

Name

String

The identifier of this element used to reference it in other components.

x

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

Connection Types

Shippo Token
Parameters
Name Type Description Default Value Required

apiKey

String

The API key for authentication.

x

baseUri

String

The base URI for the Shippo API.

x

TLS Configuration

Tls

TLS configuration for secure connections.

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Supported Operations

Operations

createAddress

<shippo:create-address>

Creates a new address in Shippo.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

body

Any

The address data to create.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • SHIPPO:BAD_REQUEST

  • SHIPPO:CLIENT_ERROR

  • SHIPPO:CONNECTIVITY

  • SHIPPO:FORBIDDEN

  • SHIPPO:SECURITY

  • SHIPPO:SERVER_ERROR

  • SHIPPO:TIMEOUT

  • SHIPPO:UNAUTHORIZED

createParcel

<shippo:create-parcel>

Creates a new parcel in Shippo.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

body

Any

The parcel data to create.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • SHIPPO:BAD_REQUEST

  • SHIPPO:CLIENT_ERROR

  • SHIPPO:CONNECTIVITY

  • SHIPPO:FORBIDDEN

  • SHIPPO:SECURITY

  • SHIPPO:SERVER_ERROR

  • SHIPPO:TIMEOUT

  • SHIPPO:UNAUTHORIZED

createShipment

<shippo:create-shipment>

Creates a new shipment in Shippo.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

body

Any

The shipment data to create.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • SHIPPO:BAD_REQUEST

  • SHIPPO:CLIENT_ERROR

  • SHIPPO:CONNECTIVITY

  • SHIPPO:FORBIDDEN

  • SHIPPO:SECURITY

  • SHIPPO:SERVER_ERROR

  • SHIPPO:TIMEOUT

  • SHIPPO:UNAUTHORIZED

createTransaction

<shippo:create-transaction>

Creates a new transaction in Shippo.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

body

  • Any

  • Any

The transaction data to create.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • SHIPPO:BAD_REQUEST

  • SHIPPO:CLIENT_ERROR

  • SHIPPO:CONNECTIVITY

  • SHIPPO:FORBIDDEN

  • SHIPPO:SECURITY

  • SHIPPO:SERVER_ERROR

  • SHIPPO:TIMEOUT

  • SHIPPO:UNAUTHORIZED

getShipmentRates

<shippo:get-shipment-rates>

Retrieves the available shipping rates for a shipment.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

shipment_id

String

The unique identifier of the shipment.

x

currency_code

String

The currency code for the rates.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • SHIPPO:BAD_REQUEST

  • SHIPPO:CLIENT_ERROR

  • SHIPPO:CONNECTIVITY

  • SHIPPO:FORBIDDEN

  • SHIPPO:NOT_FOUND

  • SHIPPO:SECURITY

  • SHIPPO:SERVER_ERROR

  • SHIPPO:TIMEOUT

  • SHIPPO:UNAUTHORIZED

listAddresses

<shippo:list-addresses>

Retrieves a list of addresses.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

page

Number

The page number for pagination.

results

Number

The number of results per page.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • SHIPPO:BAD_REQUEST

  • SHIPPO:CLIENT_ERROR

  • SHIPPO:CONNECTIVITY

  • SHIPPO:FORBIDDEN

  • SHIPPO:SECURITY

  • SHIPPO:SERVER_ERROR

  • SHIPPO:TIMEOUT

  • SHIPPO:UNAUTHORIZED

Types

Tls

Field Type Description Default Value Required

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context.

Trust Store

Trust Store

Configuration for the trust store.

Key Store

Key Store

Configuration for the key store.

Revocation Check

Configuration for certificate revocation checking.

Trust Store

Field Type Description Default Value Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.

Password

String

The password used to protect the trust store.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the trust store.

Insecure

Boolean

If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

Key Store

Field Type Description Default Value Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.

Type

String

The type of store used.

Alias

String

When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the key store.

Algorithm

String

The algorithm used by the key store.

Standard Revocation Check

Field Type Description Default Value Required

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server can not be reached or is busy.

Custom Ocsp Responder

Field Type Description Default Value Required

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

Crl File

Field Type Description Default Value Required

Path

String

The path to the CRL file.

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread.

Count

Number

How many reconnection attempts to make.

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread.

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

Error Mapping

Field Type Description Default Value Required

Source

Enumeration, one of:

  • ANY

  • REDELIVERY_EXHAUSTED

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY

  • SERVER_SECURITY

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED

  • TIMEOUT

The type of error to map.

Target

String

The target error type to map to.

x
Back to top
View on GitHub