--- schema_version: "1" id: 8289093156bd22b345cb5a1587b51ed4ae3f99be7548bfdc33cfb1881b31132e title: ShipStation Connector 0.1.0 Reference collection: mulesoft version: current locale: en-us portal_url: https://docs.salesforce.com/mulesoft/current/en-us/shipstation-connector/0.1/shipstation-connector-reference.md canonical_url: https://docs.mulesoft.com/shipstation-connector/0.1/shipstation-connector-reference source_site: docs.mulesoft.com content_type: documentation content_hash: fa56117361b38989e7ec67faa5b824a7a50a08adeb9c9ab628721b0a2fa1be11 description: MuleSoft Documentation Site release: "0.1" latest: false --- --- product: ShipStation Connector version: 0.1 --- # ShipStation Connector 0.1.0 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt ## Configurations --- ### Config Default configuration. #### Parameters

Name	Type	Description	Required
Name	String	The name for this configuration. Connectors reference the configuration with this name.	x
Connection	API Key	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 ##### API Key ###### Parameters

Name	Type	Description	Required
apiKey	String	API key for authentication.	x
baseUri	String	The base URI for the ShipStation API.	x
TLS Configuration	TLS	Configures TLS. If using the HTTPS protocol, you must configure TLS.
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 - [Add Funds To Carrier](#AddFundsToCarrier) - [Add To Batch](#AddToBatch) - [Create Batch](#CreateBatch) - [Create Label](#CreateLabel) - [Create Shipments](#CreateShipments) - [Delete Batch](#DeleteBatch) - [Get Batch By External ID](#GetBatchByExternalId) - [Get Batch By ID](#GetBatchById) - [Get Carrier By ID](#GetCarrierById) - [Get Label By ID](#GetLabelById) - [Get Shipment By ID](#GetShipmentById) - [Get Tracking Log](#GetTrackingLog) - [List Account Settings](#ListAccountSettings) - [List Batch Errors](#ListBatchErrors) - [List Carrier Package Types](#ListCarrierPackageTypes) - [List Carrier Services](#ListCarrierServices) - [List Carriers](#ListCarriers) - [List Tags](#ListTags) - [List Warehouses](#ListWarehouses) - [Parse Address](#ParseAddress) - [Process Batch](#ProcessBatch) - [Remove From Batch](#RemoveFromBatch) - [Start Tracking](#StartTracking) - [Void Label](#VoidLabel) ## Operations ## Add Funds To Carrier `` Add Funds To Carrier. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
carrier_id	String	Carrier ID.		x
body	Any	The request body content.	#[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 the 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 - [Config](#Config) ### Throws - SHIPSTATION:BAD\_REQUEST - SHIPSTATION:CLIENT\_ERROR - SHIPSTATION:CONNECTIVITY - SHIPSTATION:FORBIDDEN - SHIPSTATION:INTERNAL\_SERVER\_ERROR - SHIPSTATION:NOT\_FOUND - SHIPSTATION:SECURITY - SHIPSTATION:SERVER\_ERROR - SHIPSTATION:TIMEOUT - SHIPSTATION:UNAUTHORIZED ## Add To Batch `` Add To Batch. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
batch_id	String	Batch ID.		x
body	Any	The request body content.	#[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 the 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	Null
Attributes Type	Any

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
body	Any	The request body content.	#[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 the 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	Null
Attributes Type	Any

### For Configurations - [Config](#Config) ### Throws - SHIPSTATION:BAD\_REQUEST - SHIPSTATION:CLIENT\_ERROR - SHIPSTATION:CONNECTIVITY - SHIPSTATION:FORBIDDEN - SHIPSTATION:INTERNAL\_SERVER\_ERROR - SHIPSTATION:SECURITY - SHIPSTATION:SERVER\_ERROR - SHIPSTATION:TIMEOUT - SHIPSTATION:UNAUTHORIZED ## Create Label `` Create Label. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
body	Any	The request body content.	#[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 the 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

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
body	Any	The request body content.	#[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 the 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 - [Config](#Config) ### Throws - SHIPSTATION:BAD\_REQUEST - SHIPSTATION:CLIENT\_ERROR - SHIPSTATION:CONNECTIVITY - SHIPSTATION:FORBIDDEN - SHIPSTATION:INTERNAL\_SERVER\_ERROR - SHIPSTATION:SECURITY - SHIPSTATION:SERVER\_ERROR - SHIPSTATION:TIMEOUT - SHIPSTATION:UNAUTHORIZED ## Delete Batch `` Delete Batch. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
batch_id	String	Batch ID.		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 the 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	Null
Attributes Type	Any

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
external_batch_id	String	External batch ID.		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 the 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

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
batch_id	String	Batch ID.		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 the 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

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
carrier_id	String	Carrier ID.		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 the 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

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
label_id	String	Label ID.		x
label_download_type	Enumeration, one of: url inline	Label download type.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Target Variable	String	Name of the variable that stores the 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

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
shipment_id	String	Shipment ID.		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 the 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

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
carrier_code	String	Carrier code.		x
tracking_number	String	Tracking number.		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 the 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

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		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 the 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

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
batch_id	String	Batch ID.		x
page	Number	Page.
pagesize	Number	Page size.
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component.		x
Streaming Strategy	Repeatable In Memory Iterable Repeatable File Store Iterable non-repeatable-iterable	Configures how Mule processes streams. Repeatable streams are the default behavior.
Target Variable	String	Name of the variable that stores the 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	Array of Any

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
carrier_id	String	Carrier ID.		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 the 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

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
carrier_id	String	Carrier ID.		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 the 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

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		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 the 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	Null
Attributes Type	Any

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		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 the 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

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		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 the 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

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
body	Any	The request body content.	#[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 the 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 - [Config](#Config) ### Throws - SHIPSTATION:BAD\_REQUEST - SHIPSTATION:CLIENT\_ERROR - SHIPSTATION:CONNECTIVITY - SHIPSTATION:FORBIDDEN - SHIPSTATION:INTERNAL\_SERVER\_ERROR - SHIPSTATION:SECURITY - SHIPSTATION:SERVER\_ERROR - SHIPSTATION:TIMEOUT - SHIPSTATION:UNAUTHORIZED ## Process Batch `` Process Batch. ### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
batch_id	String	Batch ID.		x
body	Any	The request body content.	#[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 the 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	Null
Attributes Type	Any

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
batch_id	String	Batch ID.		x
body	Any	The request body content.	#[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 the 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	Null
Attributes Type	Any

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
carrier_code	String	Carrier code.		x
tracking_number	String	Tracking number.		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 the 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	Null
Attributes Type	Any

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
label_id	String	Label ID.		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 the 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

Field	Type	Description
Enabled Protocols	String	A comma-separated list of protocols enabled for this context.
Enabled Cipher Suites	String	Comma-separated list of cipher suites enabled for this context.
Trust Store	Truststore	Configures the TLS trust store.
Key Store	Key Store	Configures the TLS keystore.
Revocation Check	Standard Revocation Check Custom OCSP Responder CRL File	Configures a revocation checking mechanism.

### Truststore Configures the truststore for TLS.

Field	Type	Description
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 Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.

Field	Type	Description
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 Configures standard revocation checks for TLS certificates.

Field	Type	Description
Only End Entities	Boolean	Which elements to verify in the certificate chain: `true` Verify only the last element in the certificate chain. `false` Verify all elements in the certificate chain.
Prefer Crls	Boolean	How to check certificate validity: `true` Check the Certification Revocation List (CRL) for certificate validity. `false` Use the Online Certificate Status Protocol (OCSP) to check certificate validity.
No Fallback	Boolean	Whether to use the secondary method to check certificate validity: `true` Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity. `false` Do not use the secondary method to check certificate validity.
Soft Fail	Boolean	What to do if the revocation server can’t be reached or is busy: `true` Avoid verification failure. `false` Allow the verification to fail.

### Custom OCSP Responder Configures a custom OCSP responder for certification revocation checks.

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. If specified, the alias must be in the trust store.

### CRL File Specifies the location of the certification revocation list (CRL) file.

Field	Type	Description	Default Value	Required
Path	String	The path to the CRL file.

### Reconnection Configures a reconnection strategy for an operation.

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	Reconnect Reconnect Forever	The reconnection strategy to use.

### Reconnect Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.

Field	Type	Description
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 the Mule app can make.

### Reconnect Forever Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.

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 Configures an expiration policy strategy.

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	Error source type.
Target	String	Target error type.		x

### Repeatable In Memory Iterable

Field	Type	Description
Initial Buffer Size	Number	The amount of instances that is initially be allowed to be kept in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxBufferSize. Default value is 100 instances.
Buffer Size Increment	Number	This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.
Max Buffer Size	Number	The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

### Repeatable File Store Iterable

Field	Type	Description	Default Value	Required
In Memory Objects	Number	The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.
Buffer Unit	Enumeration, one of: BYTE KB MB GB	Unit for the In Memory Objects field.