Ballerina library

shipstation

Module shipstation

OverviewPrerequisitesQuickstart

API

Client

Definitions

AddFundsrequest
AddFundsresponse
AddTagtoOrderrequest
AddTagtoOrderresponse
AdvancedOptions
AdvancedOptions4
AssignUsertoOrderrequest
AssignUsertoOrderresponse
BillTo
BillTo1
ClientHttp1Settings
ConnectionConfig
CreateLabelforOrderrequest
CreateLabelforOrderresponse
CreateOrUpdateMultipleOrdersrequest
CreateOrUpdateMultipleOrdersresponse
CreateOrUpdateOrderrequest
CreateOrUpdateOrderresponse
CreateShipmentLabelrequest
CreateShipmentLabelresponse
CreateWarehouserequest
CreateWarehouseresponse
Customer
CustomsItem
DeactivateStorerequest
DeactivateStoreresponse
DeleteOrderresponse
DeleteWarehouseresponse
Dimensions
Fulfillment
GetCarrierresponse
GetCustomerresponse
GetOrderresponse
GetProductresponse
GetRatesrequest
GetRatesresponse
GetStoreRefreshStatusresponse
GetStoreresponse
GetWarehouseresponse
HoldOrderUntilrequest
HoldOrderUntilresponse
InsuranceOptions
InsuranceOptions4
InternationalOptions
InternationalOptions1
InternationalOptions4
Item
Item1
Item2
Item4
Item6
ListCarriersresponse
ListCustomersResponse
ListFulfillmentsResponse
ListMarketplacesresponse
ListOrdersbyTagresponse
ListOrdersResponse
ListPackagesresponse
ListProductsResponse
ListServicesresponse
ListShipmentsResponse
ListStoresresponse
ListTagsresponse
ListUsersresponse
ListWarehousesresponse
ListWebhooksresponse
MarkanOrderasShippedrequest
MarkanOrderasShippedresponse
MarketplaceUsername
Option
Order
Order2
OriginAddress
OriginAddress3
OriginAddress4
Product
ProductCategory
ProxyConfig
ReactivateStorerequest
ReactivateStoreresponse
RefreshStorerequest
RefreshStoreresponse
RegisterAccountrequest
RegisterAccountresponse
RemoveTagfromOrderrequest
RemoveTagfromOrderresponse
RestoreOrderfromOnHoldrequest
RestoreOrderfromOnHoldresponse
Result
ReturnAddress
ReturnAddress3
ShipFrom
Shipment
ShipmentItem
ShipTo
ShipTo11
ShipTo2
ShipTo3
ShipTo6
ShipTo9
StatusMapping
SubscribetoWebhookrequest
SubscribetoWebhookresponse
Tag
UnassignUserfromOrderrequest
UnassignUserfromOrderresponse
UpdateProductrequest
UpdateProductresponse
UpdateStorerequest
UpdateStoreresponse
UpdateWarehouserequest
UpdateWarehouseresponse
VoidLabelrequest
VoidLabelresponse
Webhook
Weight

OrderStatus
SortBy
SortBy1
SortBy2
SortBy3
SortDir

ballerinax/shipstation Ballerina library

1.4.1

Overview

This is a generated connector for ShipStation API v1.0 OpenAPI specification.

ShipStation strives to streamline shipping for online sellers, no matter where they sell their products online.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Quickstart

To use the ShipStation connector in your Ballerina application, update the .bal file as follows:

Step 1: Import connector

First, import the ballerinax/shipstation module into the Ballerina project.

Copy
import ballerinax/shipstation;

Step 2: Create a new connector instance

Create a shipstation:ClientConfig with the API key and API Secretobtained, and initialize the connector with it.

Copy
shipstation:ClientConfig clientConfig = {
    auth: {
        username: <API_KEY>,
        password: <API_SECRET>
    }
};
shipstation:Client baseClient = check new Client(clientConfig);

Step 3: Invoke connector operation

  1. Now you can use the operations available within the connector. Note that they are in the form of remote operations.

    Following is an example on how to list customers using the connector.

    Copy
    public function main() returns error? {
    shipstation:ListCustomersResponse response = check baseClient->listCustomers();
    log:printInfo(response.toString());
}

  2. Use bal run command to compile and run the Ballerina program.

Clients

shipstation: Client

Isolated

This is a generated connector for ShipStation API v1.0 OpenAPI specification. ShipStation strives to streamline shipping for online sellers, no matter where they sell their products online.

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Create a ShipStation account and obtain tokens by following this guide.

init (ConnectionConfig config, string serviceUrl)
  • config ConnectionConfig - The configurations to be used when initializing the connector
  • serviceUrl string "https://ssapi.shipstation.com/" - URL of the target service

registerAccount

Isolated FunctionRemote Function
function registerAccount(string contentType, RegisterAccountrequest payload) returns RegisterAccountresponse|error

Creates a new ShipStation account and generates an apiKey and apiSecret to be used by the newly created account.

Parameters

listTags

Isolated FunctionRemote Function
function listTags() returns ListTagsresponse[]|error

Lists all tags defined for this account.

listCarriers

Isolated FunctionRemote Function
function listCarriers() returns ListCarriersresponse[]|error

Lists all shipping providers connected to this account.

getCarrier

Isolated FunctionRemote Function
function getCarrier(string carrierCode) returns GetCarrierresponse|error

Retrieves the shipping carrier account details for the specified carrierCode. Use this method to determine a carrier's account balance.

Parameters
  • carrierCode string - The code for the carrier account to retrieve.

addFunds

Isolated FunctionRemote Function
function addFunds(AddFundsrequest payload) returns AddFundsresponse|error

Adds funds to a carrier account using the payment information on file.

Parameters

listPackages

Isolated FunctionRemote Function
function listPackages(string carrierCode) returns ListPackagesresponse[]|error

Retrieves a list of packages for the specified carrier

Parameters
  • carrierCode string - The carrier's code

listServices

Isolated FunctionRemote Function
function listServices(string carrierCode) returns ListServicesresponse[]|error

Retrieves the list of available shipping services provided by the specified carrier

Parameters
  • carrierCode string - The carrier's code

getCustomer

Isolated FunctionRemote Function
function getCustomer(int customerId) returns GetCustomerresponse|error

Get Customer

Parameters
  • customerId int - The system generated identifier for the Customer.

listCustomers

Isolated FunctionRemote Function
function listCustomers(string? stateCode, string? countryCode, int? marketplaceId, int? tagId, SortBy? sortBy, SortDir? sortDir, int? page, int? pageSize) returns ListCustomersResponse|error

Obtains a list of customers that match the specified criteria.

Parameters
  • stateCode string? (default ()) - Returns customers that reside in the specified stateCode.
  • countryCode string? (default ()) - Returns customers that reside in the specified countryCode.
  • marketplaceId int? (default ()) - Returns customers that purchased items from the specified marketplaceId.
  • tagId int? (default ()) - Returns customers that have been tagged with the specified tagId.
  • sortBy SortBy? (default ()) - Sorts the order of the response based off the specified value.
  • sortDir SortDir? (default ()) - Sets the direction of the sort order.
  • page int? (default ()) - Page number.
  • pageSize int? (default ()) - Requested page size. Max value is 500.

listFulfillments

Isolated FunctionRemote Function
function listFulfillments(int? fulfillmentId, int? orderId, string? orderNumber, string? trackingNumber, string? recipientName, string? createDateStart, string? createDateEnd, string? shipDateStart, string? shipDateEnd, SortBy1? sortBy, SortDir? sortDir, int? page, int? pageSize) returns ListFulfillmentsResponse|error

Obtains a list of fulfillments that match the specified criteria. Please note the following:

  • Orders that have been marked as shipped either through the UI or the API will appear in the response as they are considered fulfillments. All of the available filters are optional. They do not need to be included in the URL. If you do include them, here's what the URL may look like: Url format with filters:
fulfillments?fulfillmentId={fulfillmentId}
&orderId={orderId}
&orderNumber={orderNumber}
&trackingNumber={trackingNumber}
&recipientName={recipientName}
&createDateStart={createDateStart}
&createDateEnd={createDateEnd}
&shipDateStart={shipDateStart}
&shipDateEnd={shipDateEnd}
&sortBy={sortBy}
&sortDir={sortDir}
&page={page}
&pageSize={pageSize}
Parameters
  • fulfillmentId int? (default ()) - Returns the fulfillment with the specified fulfillment ID.
  • orderId int? (default ()) - Returns fulfillments whose orders have the specified order ID.
  • orderNumber string? (default ()) - Returns fulfillments whose orders have the specified order number.
  • trackingNumber string? (default ()) - Returns fulfillments with the specified tracking number.
  • recipientName string? (default ()) - Returns fulfillments shipped to the specified recipient name.
  • createDateStart string? (default ()) - Returns fulfillments created on or after the specified createDate
  • createDateEnd string? (default ()) - Returns fulfillments created on or before the specified createDate
  • shipDateStart string? (default ()) - Returns fulfillments with the shipDate on or after the specified date
  • shipDateEnd string? (default ()) - Returns fulfillments with the shipDate on or before the specified date
  • sortBy SortBy1? (default ()) - Sort the responses by a set value. The response will be sorted based off the ascending dates (oldest to most current.) If left empty, the response will be sorted by ascending createDate.
  • sortDir SortDir? (default ()) - Sets the direction of the sort order.
  • page int? (default ()) - page number.
  • pageSize int? (default ()) - page size.

getOrder

Isolated FunctionRemote Function
function getOrder(int orderId) returns GetOrderresponse|error

Retrieves a single order from the database.

Parameters
  • orderId int - The system generated identifier for the order.

deleteOrder

Isolated FunctionRemote Function
function deleteOrder(int orderId) returns DeleteOrderresponse|error

Removes order from ShipStation's UI. Note this is a "soft" delete action so the order will still exist in the database, but will be set to inactive

Parameters
  • orderId int - The system generated identifier for the order.

addTagToOrder

Isolated FunctionRemote Function
function addTagToOrder(string contentType, AddTagtoOrderrequest payload) returns AddTagtoOrderresponse|error

Adds a tag to an order

Parameters

assignUserToOrder

Isolated FunctionRemote Function
function assignUserToOrder(string contentType, AssignUsertoOrderrequest payload) returns AssignUsertoOrderresponse|error

Assigns a user to an order

Parameters

createLabelForOrder

Isolated FunctionRemote Function
function createLabelForOrder(string contentType, CreateLabelforOrderrequest payload) returns CreateLabelforOrderresponse|error

Creates a shipping label for a given order.

Parameters

createUpdateorder

Isolated FunctionRemote Function
function createUpdateorder(string contentType, CreateOrUpdateOrderrequest payload) returns CreateOrUpdateOrderresponse|error

Create a new order or update an existing order. If the orderKey is specified, ShipStation will attempt to locate the order with the specified orderKey. If found, the existing order with that key will be updated. If the orderKey is not found, a new order will be created with that orderKey.

Parameters

createUpdatemultipleorders

Isolated FunctionRemote Function
function createUpdatemultipleorders(string contentType, CreateOrUpdateMultipleOrdersrequest[] payload) returns CreateOrUpdateMultipleOrdersresponse|error

Create or update multiple orders in one request. If the orderKey is specified, ShipStation will attempt to locate the order with the specified orderKey. If found, the existing order with that key will be updated. If the orderKey is not found, a new order will be created with that orderKey.

Parameters

holdOrderUntil

Isolated FunctionRemote Function
function holdOrderUntil(string contentType, HoldOrderUntilrequest payload) returns HoldOrderUntilresponse|error

Change the status of the given order to On Hold until the date specified, when the status will automatically change to Awaiting Shipment.

Parameters

listOrders

Isolated FunctionRemote Function
function listOrders(string? customerName, string? itemKeyword, string? createDateStart, string? createDateEnd, string? modifyDateStart, string? modifyDateEnd, string? orderDateStart, string? orderDateEnd, string? orderNumber, OrderStatus? orderStatus, string? paymentDateStart, string? paymentDateEnd, int? storeId, SortBy2? sortBy, SortDir? sortDir, string? page, string? pageSize) returns ListOrdersResponse|error

List orders.

Parameters
  • customerName string? (default ()) - Returns orders that match the specified name.
  • itemKeyword string? (default ()) - Returns orders that contain items that match the specified keyword. Fields searched are Sku, Description, and Options
  • createDateStart string? (default ()) - Returns orders that were created in ShipStation after the specified date
  • createDateEnd string? (default ()) - Returns orders that were created in ShipStation before the specified date
  • modifyDateStart string? (default ()) - Returns orders that were modified after the specified date
  • modifyDateEnd string? (default ()) - Returns orders that were modified before the specified date
  • orderDateStart string? (default ()) - Returns orders greater than the specified date
  • orderDateEnd string? (default ()) - Returns orders less than or equal to the specified date
  • orderNumber string? (default ()) - Filter by order number, performs a "starts with" search.
  • orderStatus OrderStatus? (default ()) - Filter by order status. If left empty, orders of all statuses are returned.
  • paymentDateStart string? (default ()) - Returns orders that were paid after the specified date
  • paymentDateEnd string? (default ()) - Returns orders that were paid before the specified date
  • storeId int? (default ()) - Filters orders to a single store. Call List Stores to obtain a list of store Ids.
  • sortBy SortBy2? (default ()) - Sort the responses by a set value. The response will be sorted based off the ascending dates (oldest to most current.) If left empty, the response will be sorted by ascending orderId.
  • sortDir SortDir? (default ()) - Sets the direction of the sort order.
  • page string? (default ()) - Page number
  • pageSize string? (default ()) - Requested page size. Max value is 500.

listOrdersByTag

Isolated FunctionRemote Function
function listOrdersByTag(OrderStatus? orderStatus, int? tagId, string? page, string? pageSize) returns ListOrdersbyTagresponse|error

Lists all orders that match the specified status and tag ID

Parameters
  • orderStatus OrderStatus? (default ()) - The order's status.
  • tagId int? (default ()) - ID of the tag. Call Accounts/ListTags to obtain a list of tags for this account.
  • page string? (default ()) - Page number
  • pageSize string? (default ()) - Requested page size. Max value is 500.

markAnOrderAsShipped

Isolated FunctionRemote Function
function markAnOrderAsShipped(string contentType, MarkanOrderasShippedrequest payload) returns MarkanOrderasShippedresponse|error

Marks an order as shipped without creating a label in ShipStation.

Parameters

removeTagFromOrder

Isolated FunctionRemote Function
function removeTagFromOrder(string contentType, RemoveTagfromOrderrequest payload) returns RemoveTagfromOrderresponse|error

Removes a tag from the specified order.

Parameters

restoreOrderFromOnHold

Isolated FunctionRemote Function
function restoreOrderFromOnHold(string contentType, RestoreOrderfromOnHoldrequest payload) returns RestoreOrderfromOnHoldresponse|error

Change the status of the given order from On Hold to Awaiting Shipment

Parameters

unassignUserFromOrder

Isolated FunctionRemote Function
function unassignUserFromOrder(string contentType, UnassignUserfromOrderrequest payload) returns UnassignUserfromOrderresponse|error

Unassigns a user from an order.

Parameters

getProduct

Isolated FunctionRemote Function
function getProduct(int productId) returns GetProductresponse|error

Get product

Parameters
  • productId int - The system generated identifier for the Product.

updateProduct

Isolated FunctionRemote Function
function updateProduct(int productId, string contentType, UpdateProductrequest payload) returns UpdateProductresponse|error

Updates an existing product.

Parameters
  • productId int - The system generated identifier for the Product.

listProducts

Isolated FunctionRemote Function
function listProducts(string? sku, string? name, string? productCategoryId, string? productTypeId, string? tagId, string? startDate, string? endDate, SortBy3? sortBy, SortDir? sortDir, string? page, string? pageSize, string? showInactive) returns ListProductsResponse|error

List products.

Parameters
  • sku string? (default ()) - Returns products that match the specified SKU.
  • name string? (default ()) - Returns products that match the specified product name.
  • productCategoryId string? (default ()) - Returns products that match the specified productCategoryId.
  • productTypeId string? (default ()) - Returns products that match the specified productTypeId.
  • tagId string? (default ()) - Returns products that match the specified tagId.
  • startDate string? (default ()) - Returns products that were created after the specified date.
  • endDate string? (default ()) - Returns products that were created before the specified date.
  • sortBy SortBy3? (default ()) - Sorts the order of the response based off the specified value.
  • sortDir SortDir? (default ()) - Sets the direction of the sort order.
  • page string? (default ()) - Page number.
  • pageSize string? (default ()) - Requested page size. Max value is 500.
  • showInactive string? (default ()) - Specifies whether the list should include inactive products.

listShipments

Isolated FunctionRemote Function
function listShipments(string? recipientName, string? recipientCountryCode, string? orderNumber, int? orderId, string? carrierCode, string? serviceCode, string? trackingNumber, string? createDateStart, string? createDateEnd, string? shipDateStart, string? shipDateEnd, string? voidDateStart, string? voidDateEnd, int? storeId, boolean? includeShipmentItems, SortBy1? sortBy, SortDir? sortDir, int? page, int? pageSize) returns ListShipmentsResponse|error

List shipments.

Parameters
  • recipientName string? (default ()) - Returns shipments shipped to the specified recipient name.
  • recipientCountryCode string? (default ()) - Returns shipments shipped to the specified country code.
  • orderNumber string? (default ()) - Returns shipments whose orders have the specified order number.
  • orderId int? (default ()) - Returns shipments whose orders have the specified order ID.
  • carrierCode string? (default ()) - Returns shipments shipped with the specified carrier.
  • serviceCode string? (default ()) - Returns shipments shipped with the specified shipping service.
  • trackingNumber string? (default ()) - Returns shipments with the specified tracking number.
  • createDateStart string? (default ()) - Returns shipments created on or after the specified createDate
  • createDateEnd string? (default ()) - Returns shipments created on or before the specified createDate
  • shipDateStart string? (default ()) - Returns shipments with the shipDate on or after the specified date
  • shipDateEnd string? (default ()) - Returns shipments with the shipDate on or before the specified date
  • voidDateStart string? (default ()) - Returns shipments voided on or after the specified date
  • voidDateEnd string? (default ()) - Returns shipments voided on or before the specified date
  • storeId int? (default ()) - Returns shipments whose orders belong to the specified store ID.
  • includeShipmentItems boolean? (default ()) - Specifies whether to include shipment items with results Default value: false.
  • sortBy SortBy1? (default ()) - Sort the responses by a set value. The response will be sorted based off the ascending dates (oldest to most current.) If left empty, the response will be sorted by ascending createDate.
  • sortDir SortDir? (default ()) - Sets the direction of the sort order.
  • page int? (default ()) - page number.
  • pageSize int? (default ()) - page size.

createShipmentLabel

Isolated FunctionRemote Function
function createShipmentLabel(string contentType, CreateShipmentLabelrequest payload) returns CreateShipmentLabelresponse|error

Create a shipment label

Parameters

getRates

Isolated FunctionRemote Function
function getRates(string contentType, GetRatesrequest payload) returns GetRatesresponse[]|error

Retrieves shipping rates for the specified shipping details.

Parameters

voidLabel

Isolated FunctionRemote Function
function voidLabel(string contentType, VoidLabelrequest payload) returns VoidLabelresponse|error

Voids the specified label by shipmentId.

Parameters

getStore

Isolated FunctionRemote Function
function getStore(int storeId) returns GetStoreresponse|error

Get store

Parameters
  • storeId int - A unique ID generated by ShipStation and assigned to each store.

updateStore

Isolated FunctionRemote Function
function updateStore(int storeId, string contentType, UpdateStorerequest payload) returns UpdateStoreresponse|error

Update store

Parameters
  • storeId int - A unique ID generated by ShipStation and assigned to each store.

getStoreRefreshStatus

Isolated FunctionRemote Function
function getStoreRefreshStatus(int? storeId) returns GetStoreRefreshStatusresponse|error

Retrieves the refresh status of a given store.

Parameters
  • storeId int? (default ()) - Specifies the store whose status will be retrieved.

refreshStore

Isolated FunctionRemote Function
function refreshStore(string contentType, RefreshStorerequest payload, int? storeId, string? refreshDate) returns RefreshStoreresponse|error

Refresh store

Parameters
  • storeId int? (default ()) - Specifies the store which will get refreshed. If the storeId is not specified, a store refresh will be initiated for all refreshable stores on that account.
  • refreshDate string? (default ()) - Specifies the starting date for new order imports. If the refreshDate is not specified, ShipStation will use the last recorded refreshDate for that store.

listStores

Isolated FunctionRemote Function
function listStores(boolean? showInactive, int? marketplaceId) returns ListStoresresponse[]|error

Retrieve the list of installed stores on the account.

Parameters
  • showInactive boolean? (default ()) - Determines whether inactive stores will be returned in the list of stores.
  • marketplaceId int? (default ()) - Returns stores of this marketplace type.

listMarketplaces

Isolated FunctionRemote Function
function listMarketplaces() returns ListMarketplacesresponse[]|error

Lists the marketplaces that can be integrated with ShipStation.

deactivateStore

Isolated FunctionRemote Function
function deactivateStore(string contentType, DeactivateStorerequest payload) returns DeactivateStoreresponse|error

Deactivate store

Parameters

reactivateStore

Isolated FunctionRemote Function
function reactivateStore(string contentType, ReactivateStorerequest payload) returns ReactivateStoreresponse|error

Reactivate store

Parameters

listUsers

Isolated FunctionRemote Function
function listUsers(boolean? showInactive) returns ListUsersresponse|error

List users

Parameters
  • showInactive boolean? (default ()) - Determines whether inactive users will be returned in the response.

getWarehouse

Isolated FunctionRemote Function
function getWarehouse(int warehouseId) returns GetWarehouseresponse|error

Returns a list of active Ship From Locations (formerly known as warehouses) on the ShipStation account. Warehouses are now called "Ship From Locations" in the UI.

Parameters
  • warehouseId int - A unique ID generated by ShipStation and assigned to each Ship From Location (formerly known as warehouse).

updateWarehouse

Isolated FunctionRemote Function
function updateWarehouse(string contentType, int warehouseId, UpdateWarehouserequest payload) returns UpdateWarehouseresponse|error

Updates an existing Ship From Location (formerly known as warehouse).

Parameters
  • warehouseId int - A unique ID generated by ShipStation and assigned to each Ship From Location (formerly known as warehouse).

deleteWarehouse

Isolated FunctionRemote Function
function deleteWarehouse(int warehouseId) returns DeleteWarehouseresponse|error

Delete warehouse

Parameters
  • warehouseId int - A unique ID generated by ShipStation and assigned to each Ship From Location (formerly known as warehouse).

createWarehouse

Isolated FunctionRemote Function
function createWarehouse(string contentType, CreateWarehouserequest payload) returns CreateWarehouseresponse|error

Create warehouse

Parameters

listWarehouses

Isolated FunctionRemote Function
function listWarehouses() returns ListWarehousesresponse[]|error

Retrieves a list of your Ship From Locations (formerly known as warehouses).

listWebhooks

Isolated FunctionRemote Function
function listWebhooks() returns ListWebhooksresponse|error

Retrieves a list of registered webhooks for the account

subscribeToWebhook

Isolated FunctionRemote Function
function subscribeToWebhook(string contentType, SubscribetoWebhookrequest payload) returns SubscribetoWebhookresponse|error

Subscribe to webhook

Parameters

unsubscribeToWebhook

Isolated FunctionRemote Function
function unsubscribeToWebhook(int webhookId, string contentType) returns Response|error

Unsubscribe to Webhook

Parameters
  • webhookId int - A unique ID generated by ShipStation and assigned to each webhook.

Records

shipstation: AddFundsrequest

Fields

shipstation: AddFundsresponse

Fields

shipstation: AddTagtoOrderrequest

Fields

shipstation: AddTagtoOrderresponse

Fields

shipstation: AdvancedOptions

Fields
  • warehouseId int -

shipstation: AdvancedOptions4

Fields
  • warehouseId int -

shipstation: AssignUsertoOrderrequest

Fields
  • orderIds int[] -

shipstation: AssignUsertoOrderresponse

Fields

shipstation: BillTo

Fields

shipstation: BillTo1

Fields

shipstation: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields
  • keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
  • chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

shipstation: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields
  • httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
  • timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
  • forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header
  • cache CacheConfig? - HTTP caching related configurations
  • compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header
  • circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
  • retryConfig RetryConfig? - Configurations associated with retrying
  • validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

shipstation: CreateLabelforOrderrequest

Fields
  • internationalOptions string? -

shipstation: CreateLabelforOrderresponse

Fields
  • shipmentId int -
  • insuranceCost int -

shipstation: CreateOrUpdateMultipleOrdersrequest

Fields
  • customerId int -
  • taxAmount int -
  • shippingAmount int -
  • requestedShippingService string -
  • tagIds int[] -

shipstation: CreateOrUpdateMultipleOrdersresponse

Fields

shipstation: CreateOrUpdateOrderrequest

Fields
  • customerId int -
  • taxAmount int -
  • shippingAmount int -
  • requestedShippingService string -
  • tagIds int[] -

shipstation: CreateOrUpdateOrderresponse

Fields
  • taxAmount int -
  • shippingAmount int -
  • requestedShippingService string -
  • externallyFulfilledBy string? -

shipstation: CreateShipmentLabelrequest

Fields
  • internationalOptions string? -

shipstation: CreateShipmentLabelresponse

Fields
  • shipmentId int -
  • insuranceCost int -

shipstation: CreateWarehouserequest

Fields

shipstation: CreateWarehouseresponse

Fields
  • warehouseId int -

shipstation: Customer

Fields
  • customerId int -

shipstation: CustomsItem

Fields
  • customsItemId int -
  • quantity int -
  • harmonizedTariffCode string? -

shipstation: DeactivateStorerequest

Fields

shipstation: DeactivateStoreresponse

Fields

shipstation: DeleteOrderresponse

Fields

shipstation: DeleteWarehouseresponse

Fields

shipstation: Dimensions

Fields

shipstation: Fulfillment

Fields
  • fulfillmentId int -
  • fulfillmentProviderCode string? -
  • fulfillmentServiceCode string? -
  • fulfillmentFee int -

shipstation: GetCarrierresponse

Fields
  • shippingProviderId int -

shipstation: GetCustomerresponse

Fields
  • customerId int -

shipstation: GetOrderresponse

Fields
  • customerId int -
  • taxAmount int -
  • shippingAmount int -
  • requestedShippingService string -
  • externallyFulfilledBy string? -

shipstation: GetProductresponse

Fields
  • productId int -
  • defaultCost int -
  • weightOz int -
  • defaultIntlCarrierCode string -
  • defaultIntlServiceCode string -
  • defaultIntlPackageCode string -
  • defaultIntlConfirmation string -

shipstation: GetRatesrequest

Fields

shipstation: GetRatesresponse

Fields

shipstation: GetStoreRefreshStatusresponse

Fields
  • refreshStatusId int -

shipstation: GetStoreresponse

Fields
  • marketplaceId int -

shipstation: GetWarehouseresponse

Fields
  • warehouseId int -

shipstation: HoldOrderUntilrequest

Fields

shipstation: HoldOrderUntilresponse

Fields

shipstation: InsuranceOptions

Fields
  • insuredValue int -

shipstation: InsuranceOptions4

Fields
  • insuredValue int -

shipstation: InternationalOptions

Fields

shipstation: InternationalOptions1

Fields

shipstation: InternationalOptions4

Fields

shipstation: Item

Fields
  • orderItemId int -
  • quantity int -
  • productId int -

shipstation: Item1

Fields
  • quantity int -
  • productId int -

shipstation: Item2

Fields
  • orderItemId int -
  • quantity int -
  • shippingAmount int -

shipstation: Item4

Fields
  • orderItemId int -
  • quantity int -
  • productId int -

shipstation: Item6

Fields
  • orderItemId int -
  • quantity int -
  • shippingAmount int -
  • productId int -

shipstation: ListCarriersresponse

Fields
  • shippingProviderId int -

shipstation: ListCustomersResponse

Fields

shipstation: ListFulfillmentsResponse

Fields

shipstation: ListMarketplacesresponse

Fields
  • marketplaceId int -

shipstation: ListOrdersbyTagresponse

Fields

shipstation: ListOrdersResponse

Fields

shipstation: ListPackagesresponse

Fields

shipstation: ListProductsResponse

Fields

shipstation: ListServicesresponse

Fields

shipstation: ListShipmentsResponse

Fields

shipstation: ListStoresresponse

Fields
  • marketplaceId int -

shipstation: ListTagsresponse

Fields

shipstation: ListUsersresponse

Fields

shipstation: ListWarehousesresponse

Fields
  • warehouseId int -

shipstation: ListWebhooksresponse

Fields

shipstation: MarkanOrderasShippedrequest

Fields

shipstation: MarkanOrderasShippedresponse

Fields

shipstation: MarketplaceUsername

Fields
  • customerUserId int -
  • customerId int -
  • marketplaceId int -

shipstation: Option

Fields

shipstation: Order

Fields
  • customerId int -
  • shippingAmount int -
  • requestedShippingService string -
  • externallyFulfilledBy string? -

shipstation: Order2

Fields
  • customerId int -
  • taxAmount int -
  • shippingAmount int -
  • requestedShippingService string -
  • tagIds int[] -
  • externallyFulfilledBy string? -

shipstation: OriginAddress

Fields

shipstation: OriginAddress3

Fields

shipstation: OriginAddress4

Fields

shipstation: Product

Fields
  • productId int -
  • defaultCost int -
  • weightOz int -
  • defaultIntlCarrierCode string -
  • defaultIntlServiceCode string -
  • defaultIntlPackageCode string -
  • defaultIntlConfirmation string -

shipstation: ProductCategory

Fields
  • categoryId int -

shipstation: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields
  • host string(default "") - Host name of the proxy server
  • port int(default 0) - Proxy server port
  • userName string(default "") - Proxy server username
  • password string(default "") - Proxy server password

shipstation: ReactivateStorerequest

Fields

shipstation: ReactivateStoreresponse

Fields

shipstation: RefreshStorerequest

Fields

shipstation: RefreshStoreresponse

Fields

shipstation: RegisterAccountrequest

Fields

shipstation: RegisterAccountresponse

Fields
  • sellerId int -

shipstation: RemoveTagfromOrderrequest

Fields

shipstation: RemoveTagfromOrderresponse

Fields

shipstation: RestoreOrderfromOnHoldrequest

Fields

shipstation: RestoreOrderfromOnHoldresponse

Fields

shipstation: Result

Fields

shipstation: ReturnAddress

Fields

shipstation: ReturnAddress3

Fields

shipstation: ShipFrom

Fields

shipstation: Shipment

Fields
  • shipmentId int -
  • insuranceCost int -
  • warehouseId int -

shipstation: ShipmentItem

Fields
  • orderItemId int -
  • quantity int -
  • unitPrice int -
  • productId int -

shipstation: ShipTo

Fields

shipstation: ShipTo11

Fields

shipstation: ShipTo2

Fields

shipstation: ShipTo3

Fields

shipstation: ShipTo6

Fields

shipstation: ShipTo9

Fields

shipstation: StatusMapping

Fields

shipstation: SubscribetoWebhookrequest

Fields

shipstation: SubscribetoWebhookresponse

Fields

shipstation: Tag

Fields

shipstation: UnassignUserfromOrderrequest

Fields
  • orderIds int[] -

shipstation: UnassignUserfromOrderresponse

Fields

shipstation: UpdateProductrequest

Fields
  • productId int -
  • defaultIntlCarrierCode string? -
  • defaultIntlServiceCode string? -
  • defaultIntlPackageCode string? -
  • defaultConfirmation string? -
  • defaultIntlConfirmation string? -

shipstation: UpdateProductresponse

Fields

shipstation: UpdateStorerequest

Fields
  • marketplaceId int -

shipstation: UpdateStoreresponse

Fields
  • marketplaceId int -

shipstation: UpdateWarehouserequest

Fields
  • warehouseId int -

shipstation: UpdateWarehouseresponse

Fields
  • warehouseId int -

shipstation: VoidLabelrequest

Fields
  • shipmentId int -

shipstation: VoidLabelresponse

Fields

shipstation: Webhook

Fields
  • WebHookID int -
  • SellerID int -

shipstation: Weight

Fields

String types

shipstation: OrderStatus

string

OrderStatus

shipstation: SortBy

string

SortBy

shipstation: SortBy1

string

SortBy1

shipstation: SortBy2

string

SortBy2

shipstation: SortBy3

string

SortBy3

shipstation: SortDir

string

SortDir

Import

import ballerinax/shipstation;Copy

Metadata

Released date: almost 2 years ago

Version: 1.4.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 4

Current verison: 4

Weekly downloads

Source repository

Keywords

Commerce/eCommerce

Cost/Paid

Contributors

Other versions

1.4.1

1.4.01.3.01.0.0

Dependencies

ballerina/url/2.2.3ballerina/http/2.6.1

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2025 WSO2 LLC