Streamdata.io API Gallery - Ship Station (Report Issue)

Organization(s):

Ship Station List Tags

Lists all tags defined for this account.

Ship Station Register Account

Creates a new ShipStation account and generates an apiKey and apiSecret to be used by the newly created account. PLEASE NOTE: This endpoint does not require API key and API Secret credentials. The Authorization header can be left off. Use of this...

Ship Station List Carriers

Lists all shipping providers connected to this account.

Ship Station Add Funds

Adds funds to a carrier account using the payment information on file. The body of this request should specify the following attributes: Name |Data Type |Description -------------------|-------------------|-----------------...

Ship Station Get Carrier

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

Ship Station List Packages

Retrieves a list of packages for the specified carrier

Ship Station List Services

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

Ship Station List Customers

Obtains a list of customers that match the specified criteria.

Ship Station List Fulfillments with parameters

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 ...

Ship Station Add Tag to Order

Adds a tag to an order. The body of this request should specify the following attributes: Name |Data Type |Description -------------------|-------------------|------------------- ``orderId`` | number, required | Identifies...

Ship Station Assign User to Order

Assigns a user to an order. The body of this request should specify the following attributes: Name |Data Type |Description -------------------|-------------------|------------------- ``orderIds`` | number, required | Ident...

Ship Station Create Label for Order

Creates a shipping label for a given order. The ``labelData`` field returned in the response is a base64 encoded PDF value. Simply decode and save the output as a PDF file to retrieve a printable label. The body of this request should specify th...

Ship Station Create/Update Order

If the ``orderKey`` is specified, the method becomes idempotent and the existing order with that key will be updated. Note: Only orders in an open status in ShipStation (``awaiting_payment``,``awaiting_shipment``, and ``on_hold``) can be updated t...

Ship Station Create/Update Multiple Orders

This endpoint can be used to create or update multiple orders in one request. If the ``orderKey`` is specified in an order, the existing order with that key will be updated. Note: Only orders in an open status in ShipStation (``awaiting_payment``,...

Ship Station List Orders with parameters

Obtains a list of orders that match the specified criteria. 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: ``` /orders...

Ship Station Hold Order Until

This method will change the status of the given order to On Hold until the date specified, when the status will automatically change to Awaiting Shipment. The body of this request should specify the following attributes: Name |Data...

Ship Station List Orders by Tag

Lists all orders that match the specified status and tag ID. Url format with filters: ``` /listbytag?orderStatus={orderStatus} &tagId={tagId} &page={page} &pageSize={pageSize} ```

Ship Station Mark an Order as Shipped

Marks an order as shipped without creating a label in ShipStation. The body of this request has the following attributes: Name |Data Type |Description -------------------|-------------------|------------------- ``orderId``...

Ship Station Delete Order

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``

Ship Station Get Order

Retrieves a single order from the database.

Ship Station Remove Tag from Order

Removes a tag from the specified order. The body of this request has the following attributes: Name |Data Type |Description -------------------|-------------------|------------------- ``orderId`` | number, required | Ident...

Ship Station Restore Order from On Hold

This method will change the status of the given order from On Hold to Awaiting Shipment. This endpoint is used when a holdUntil Date is attached to an order. The body of this request should specify the following attributes: Name |D...

Ship Station Unassign User from Order

Unassigns a user from an order. The body of this request should specify the following attributes: Name |Data Type |Description -------------------|-------------------|------------------- ``orderIds`` | number, required | I...

Ship Station Update Product

Updates an existing product. This call does not currently support partial updates. The entire resource must be provided in the body of the request.

Ship Station List Products with parameters

Obtains a list of products that match the specified criteria. 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: ``` /prod...

Ship Station Create Shipment Label

Creates a shipping label. The ``labelData`` field returned in the response is a base64 encoded PDF value. Simply decode and save the output as a PDF file to retrieve a printable label. The body of this request has the following attributes: Name...

Ship Station Get Rates

Retrieves shipping rates for the specified shipping details. The body of this request should specify the following attributes: Name |Data Type |Description -------------------|-------------------|------------------- ``car...

Ship Station List Shipments with parameters

Obtains a list of shipments that match the specified criteria. Please note the following: - Only valid shipments with labels generated in ShipStation will be returned in the response. Orders that have been marked as shipped either through the UI...

Ship Station Void Label

Voids the specified label by shipmentId. The body of this request should specify the following attributes: Name |Data Type |Description -------------------|-------------------|------------------- ``shipmentId`` | number, ...

Ship Station Deactivate Store

Deactivates the specified store. The body of this request has the following attributes: Name |Data Type |Description -------------------|-------------------|------------------- ``storeId`` | number, required | ID of the s...

Ship Station Get Store Refresh Status

Retrieves the refresh status of a given store.

Ship Station List Marketplaces

Lists the marketplaces that can be integrated with ShipStation.

Ship Station Reactivate Store

Reactivates the specified store. Note: stores are active by default The body of this request has the following attributes: Name |Data Type |Description -------------------|-------------------|------------------- ``storeId`...

Ship Station Refresh Store

Initiates a store refresh.

Ship Station List Stores

Retrieve the list of installed stores on the account.

Ship Station Update Store

Updates an existing store. This call does not currently support partial updates. The entire resource must be provided in the body of the request.

Ship Station List Warehouses

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

Ship Station Create Warehouse

Adds a Ship From Location (formerly known as warehouse) to your account. The body of this request should specify the following attributes: Name |Data Type |Description -------------------|-------------------|--------------...

Ship Station Get Warehouse

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.

Ship Station Update Warehouse

Updates an existing Ship From Location (formerly known as warehouse). This call does not currently support partial updates. The entire resource must be provided in the body of the request. If a "returnAddress" object is not specified, your "origin...

Ship Station List Webhooks

Retrieves a list of registered webhooks for the account

Ship Station Subscribe to Webhook

Subscribes to a specific type of webhook. If a ``store_id`` is passed in, the webhooks will only be triggered for that specific ``store_id``. The ``event`` type that is passed in will determine what type of webhooks will be sent. NOTE: Webhooks w...

Ship Station Unsubscribe to Webhook

Unsubscribes from a certain webhook.

Submit Your API

Join the gallery to find out how much you can save with Streamdata.io.