Store

Methods

Entity Properties

ShipStream has full support for multiple stores under one merchant account. Use this API endpoint to retrieve your list of stores and their store codes which are required for submitting orders.

Parameters

The method is used without parameters.

store.list ()

Retrieve stores list.

Return Value

An array of objects with store information.

Example Request

Retrieve stores information:

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

Example Response

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

Store Properties

store_id 
{ "store_id" : 1 }
The internal store ID.
code 
{ "code" : "default" }
The "Code" property.
name 
{ "name" : "Default Store View" }
The "Name" property.
sort_order 
{ "sort_order" : 0 }
The "Sort Order" property.
is_active 
{ "is_active" : 1 }
Flag whether store is active.