About the Shipstation category

[anon99371720]

Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

System documentation:

Connector package documentation

Setting up HTTP Client Shipstation

Steps

1. In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Shipstation HTTP Client as the prototype of the HTTP Client.
2. Fill in the Base URI, API Key, and API Secret
3. Save.

Subscribing to Entities from Shipstation

Steps

1. Go to Connections → Incoming and create a new incoming configuration and select Shipstation Subscriber as the subscriber.
2. Select the entity you want to subscribe from Shipstation.
3. Add any request parameters needed to subscribe to the entity (optional).
4. You can optionally add a transformer to transform the request parameters into something you need.
5. Select the Shipstation HTTP Client to use.

General Concept

We follow Shipstation documentation on building this connector so you can easily use the connector based on Shipstation API Reference.

Entity
It’s the entity you want to subscribe from Shipstation. Please refer to the entities in Management APIs from the Shipstation API Reference page.

Request Parameters
These are the parameters you can provide to get the needed entity based on Shipstation API Reference. Please look at the example below on how to fill the Request Parameters field when Retrieve Get Order entity

That’s why we need to define the orderId property inside the path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. Here is the final URL that will be called when using such Request Parameters field on the Get Order entity.

/orders/94113592

Input Transformer
Any transformers set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need either as path parameters and/or as query parameters of an entity.

HTTP Client
It’s the HTTP Client configuration or prototype you will use to access Shipstation.

Publishing Entity to Shipstation

Steps

1. Go to Connections → Outgoing, create a new outgoing configuration, and select Shipstation Publisher as the publisher.
2. Select the action that you want the publisher to do with the data.
3. Select the Shipstation entity you want the data to be published.
4. Select the HTTP Client to use.
   
   

General Concept

Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration).

Method
Currently, we support Post (HTTP POST method), Put (HTTP PUT method), and Delete (HTTP DELETE method).

Entity
We support publishing to most Shipstation endpoints. Please refer to the entities in Management APIs from the Shipstation API Reference page. Based on the documentation, some endpoints may need one or more path parameters.

For endpoints that require an object as the request payload, please look at the example below. For example, we want to Update Warehouse. Please select “Put” as the action and “Update Warehouse” as the entity of the publisher.

PUT /warehouses/warehouseId HTTP/1.1
Host: ssapi.shipstation.com
Authorization: __YOUR_AUTH_HERE__
Content-Type: application/json

{
    "warehouseId": 12345,
    "warehouseName": "API Ship From Location",
    "originAddress": {
        "name": "API Warehouse",
        "company": "ShipStation",
        "street1": "2815 Exposition Blvd",
        "street2": null,
        "street3": null,
        "city": "Austin",
        "state": "TX",
        "postalCode": "78703",
        "country": "US",
        "phone": "512-555-5555",
        "residential": true,
        "addressVerified": null
    },
    "returnAddress": {
        "name": "API Ship From Location",
        "company": "ShipStation",
        "street1": "2815 Exposition Blvd",
        "street2": null,
        "street3": null,
        "city": "Austin",
        "state": "TX",
        "postalCode": "78703",
        "country": "US",
        "phone": "512-555-5555",
        "residential": null,
        "addressVerified": null
    },
    "createDate": "2015-07-02T08:38:31.4870000",
    "isDefault": true
}

You can put the payload you want to send to Shipstation into the payload property in the data. Here is an example of the Possible Response after Creation.

Alumio will send an API request to Shipstation with URL /warehouses/12345

HTTP Client

It’s the HTTP Client configuration or prototype you will use to access Shipstation.