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.
Methods
Entity Properties
enumeration.list
enumeration.list (int|null $warehouseId)
Get all enumerations.
Parameters
Return Value
An array of Enumerations or an empty array.
Example Request
Get all enumerations:
{
"jsonrpc" : 2.0,
"id" : 1234,
"method" : "call",
"params" : [
"be1c13ed4e03f0ed7f1e4053dfff9658",
"enumeration.list"
]
}
{
"jsonrpc" : 2.0,
"id" : 1234,
"method" : "call",
"params" : [
"be1c13ed4e03f0ed7f1e4053dfff9658",
"enumeration.list",
[2]
]
}
Example Response
{
"jsonrpc" : 2.0,
"id" : 1234,
"result" : {
"catalog": {
"goods_type": {
"singular_name": "Goods Type",
"plural_name": "Goods Types",
"data": [
{
"key": "HAZMAT",
"label": "Regulated"
},
{
"key": "LIMITED_QUANTITIES_COMMODITIES",
"label": "Limited Quantities: Consumer Commodity"
},
{
"key": "NORMAL",
"label": "Not Regulated"
}
]
}
},
"shipment": {
"status": {
"singular_name": "Status",
"plural_name": "Statuses",
"data": [
{
"key": "canceled",
"label": "Canceled"
},
{
"key": "shipped",
"label": "Shipped"
},
{
"key": "new",
"label": "New"
},
{
"key": "packed",
"label": "Packed"
},
{
"key": "packing",
"label": "Packing"
},
{
"key": "picked",
"label": "Picked"
},
{
"key": "picking",
"label": "Picking"
},
{
"key": "voided",
"label": "Voided"
}
]
}
}
}
}
enumeration.info
enumeration.info (string $path, int|null $warehouseId)
Get enumeration info.
Parameters
Return Value
Enumeration.
Example Request
Get enumeration info:
{
"jsonrpc" : 2.0,
"id" : 1234,
"method" : "call",
"params" : [
"be1c13ed4e03f0ed7f1e4053dfff9658",
"enumeration.info",
["catalog/goods_type"]
]
}
Example Response
{
"jsonrpc" : 2.0,
"id" : 1234,
"result" : {
"singular_name": "Goods Type",
"plural_name": "Goods Types",
"data": [
{
"key": "HAZMAT",
"label": "Regulated"
},
{
"key": "LIMITED_QUANTITIES_COMMODITIES",
"label": "Limited Quantities: Consumer Commodity"
},
{
"key": "NORMAL",
"label": "Not Regulated"
}
]
}
}
Entity Properties
Enumeration Properties
Show Enumeration Properties
Depends on merchant flag is only returned when the value is true.
Depends on warehouse flag is only returned when the value is true.
