Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.shipstream.io/llms.txt

Use this file to discover all available pages before exploring further.

ShipStream has full support for having multiple brands under one merchant account. Use this API endpoint to retrieve your list of Brands and their corresponding codes which are required for submitting orders to a specific brand.
For legacy purposes the “brands” are sometimes referred to as “stores”.

​
Methods

​
Entity Properties

​
store.list

store.list() Retrieve stores list.

​
Parameters

The method is used without parameters.

​
Return Value

An array of objects with store information.

​
Example Request

Retrieve stores information:
Request
{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "store.list",
        []
    ]
}

​
Example Response

Response
{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "error" : null,
    "result" : [
        {
            "store_id" : 1,
            "code" : "default",
            "name" : "Default Store View",
            "sort_order" : 0,
            "is_active" : 1
        }
    ]
}

​
Entity Properties

​
Store Properties

​
store_id
integer
The internal store ID.
​
code
string
The “Code” property.
​
name
string
The “Name” property.
​
sort_order
integer
The “Sort Order” property.
​
is_active
integer
Flag whether store is active.