Product

Each merchant maintains a completely unique catalog of products managed at ShipStream whether in stock or not. It is preferable that a merchant creates all of their products with accurate names, goods type and barcodes before actually shipping physical inventory to aid in accurate processing of deliveries.

Entity Properties

Product

`product.search`

product.search(null|object $filters = null, null|array $options = null) Retrieve list of products with basic info (id, sku, type, set, name).

Parameters

filters

null | object

null - Retrieve list of all products.
object - Retrieve list of products using specified Search Filters. Allowed properties for filtering: “sku”, “vendor_sku”, “status”, “availability”, “visibility”, “created_at”, “updated_at”, “external_id”.

options

null | array

null - No options will be applied.
object - Apply specified Search Options.

Return Value

An array of objects. Each object will contain Product Properties.

Example Request

Get product information for one product SKU:

Request

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "product.search",
        [
            {
                "sku" : { "eq" : "product2" }
            }
        ]
    ]
}

Example Response

Response

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "error" : null,
    "result" : [
        {
            "sku" : "productsku",
            "name" : "product name",
            "barcode" : "productbarcode",
            "goods_type" : "NORMAL",
            "status" : 1,
            "availability" : 1,
            "visibility" : 2,
            "weight" : 12.75,
            "weight_unit" : "lb",
            "length" : null,
            "width" : null,
            "height" : null,
            "customs_value" : "24.5600",
            "customs_value_currency" : "USD",
            "country_of_manufacture" : "DK",
            "hts_base_code" : 1234.56,
            "hts_country_code" : [
                {
                    "country_id" : "BB",
                    "extension" : "01"
                },
                {
                    "country_id" : "FO",
                    "extension" : "02"
                }
            ],
            "vendor_sku" : "vendorsku",
            "requires_packaging" : 1,
            "can_contain_other_items" : 0,
            "valid_containers" : ["containersku1", "containersku2"],
            "special_supplies" : [ "supplysku1", "supplysku2" ],
            "special_other" : [ "specialsku1", "specialsku2" ],
            "unit_qty" : 5
        }
    ]
}

Error Codes

code	message
108	Invalid filters given. Details in error message.

`product.create`

product.create (string $sku, object $productData) Create new product.

Parameters

sku

string

Product SKU.

productData

object

Product data.

Return Value

true if product was successfully created.

Example Request

Request

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "product.create",
        [
            "product3",
            {
                "name" : "Product 3",
                "barcode" : "product3",
                "goods_type" : "NORMAL",
                "weight" : 1.75,
                "weight_unit": "lb",
                "length" : 123,
                "width" : 100,
                "height" : 28,
                "dimension_unit" : "in",
                "customs_value" : "24.5600",
                "customs_value_currency" : "USD",
                "country_of_manufacture" : "DK",
                "hts_base_code" : 1234.56,
                "hts_country_code" : "BH:1000|ZW:1001",
                "vendor_sku" : "vendorsku",
                "requires_packaging" : 1,
                "can_contain_other_items" : 1,
                "valid_containers" : [ "containersku1", "containersku2" ],
                "special_supplies" : [ "supplysku1", "supplysku2" ],
                "special_other" : [ "specialsku1", "specialsku2" ],
                "unit_qty" : 5
            }
        ]
    ]
}

Example Response

Response

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "error" : null,
    "result" : true
}

Error Codes

code	message
102	Invalid data given. Details in error message.
104	Product type is not in allowed types.
105	Product’s attribute set does not exist.
106	Product’s attribute set is not a Catalog Product entity type.
107	Another product with this SKU already exists.

`product.info`

product.info (string $sku) Retrieve product info.

Parameters

sku

string

Product SKU.

Return Value

Object with Product Properties.

Example Request

Request

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "product.info",
        [
            "product1"
        ]
    ]
}

Example Response

Response

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "error" : null,
    "result" : {
        "sku" : "productsku",
        "name" : "product name",
        "barcode" : "productbarcode",
        "goods_type" : "NORMAL",
        "status" : 1,
        "availability" : 1,
        "visibility" : 2,
        "weight" : 12.75,
        "weight_unit" : "lb",
        "length" : null,
        "width" : null,
        "height" : null,
        "dimension_unit" : "in",
        "customs_value" : "24.5600",
        "customs_value_currency" : "USD",
        "country_of_manufacture" : "DK",
        "hts_base_code" : 1234.56,
        "hts_country_code" : [
            {
                "country_id" : "BB",
                "extension" : "01"
            },
            {
                "country_id" : "FO",
                "extension" : "02"
            }
        ],
        "vendor_sku" : "vendorsku",
        "requires_packaging" : 1,
        "can_contain_other_items" : 0,
        "valid_containers" : [ "containersku1", "containersku2" ],
        "special_supplies" : [ "supplysku1", "supplysku2" ],
        "special_other" : [ "othersku1", "othersku2" ],
        "unit_qty" : 5
    }
}

Error Codes

code	message
101	Product not exists.

`product.update`

product.update (string $sku, object $productData) Update product data.

Parameters

sku

string

Product SKU.

productData

object

Product data.

Return Value

true if product was successfully updated.

Example Request

Request

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "product.update",
        [
            "product3",
            {
                "name" : "product name",
                "barcode" : "productbarcode",
                "goods_type" : "NORMAL",
                "status" : 1,
                "availability" : 1,
                "visibility" : 2,
                "weight" : 12.75,
                "weight_unit" : "lb",
                "length" : null,
                "width" : null,
                "height" : null,
                "dimension_unit" : "lb",
                "customs_value" : "24.5600",
                "customs_value_currency" : "USD",
                "country_of_manufacture" : "DK",
                "hts_base_code" : 1234.56,
                "hts_country_code" : [
                    {
                        "country_id" : "BB",
                        "extension" : "01"
                    },
                    {
                        "country_id" : "FO",
                        "extension" : "02"
                    }
                ],
                "vendor_sku" : "vendorsku",
                "requires_packaging" : 1,
                "can_contain_other_items" : 0,
                "valid_containers" : [ "containersku1", "containersku2" ],
                "special_supplies" : [ "supplysku1", "supplysku2" ],
                "special_other" : [ "specialsku1", "specialsku2" ],
                "unit_qty" : 5
            }
        ]
    ]
}

Example Response

Response

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "error" : null,
    "result" : true
}

Error Codes

code	message
101	Product not exists.
102	Invalid data given. Details in error message.

Entity Properties

Product Properties

Show Product Properties

sku

string

A unique identifier for a product. The SKU does appear on the packing slip. It is recommended that this be human-readable and end with a per-pack quantity to facilitate proper receiving. For example, a single blue widget may be “BlueWidget-1” and a pack of 5 blue widgets may be “BlueWidget-5”. Maximum character length is 64.

name

string

The “Name” property.

export_description

string

Harmonized Tariff Schedule article description.

barcode

string

The “Barcode” property. Single or comma separated barcodes.

goods_type

string

The “Goods Type” property. Allowed: “NORMAL”, “ORM_D”, “LIMITED_QUANTITIES_COMMODITIES”, “HAZMAT”.

status

integer

The “Status” property. Allowed: “0” - Disabled, “1” - Enabled.

availability

integer

The “Availability” property. Allowed: “1” - available. “2” - not available.

visibility

integer

The “Visibility” property. Allowed: “1” - not visible, “2” - visible.

weight

number

The “Weight” property.

weight_unit

string

The unit of measure used for weight. See: Weight Units.

length

number

The “Length” property.

width

number

The “Width” property.

height

number

The “Height” property.

dimension_unit

string

The unit of measure used for length, width, and height. See: Length Units. Note that this field is shared between length, width, and height; updating a single dimension will change the unit for all three.

freight_class

string

The “Freight Class” property.

freight_category

string

The “Freight Category” property.

customs_value

string

The “Customs Value” property.

customs_value_currency

string

The currency of the “Customs Value” property. Must be a valid ISO 4217 alphabetic code.

country_of_manufacture

string

The “Country of Manufacture” property.

hts_base_code

number

The “HTS Base Code” property.

hts_country_code

string

The “HTS Country Code” property. Format: ”:”. Separator: ”|”.

requires_packaging

integer

The “Requires Packaging” property. Allowed: “0” - not required. “1” - required.

can_contain_other_items

integer

The “Can Contain Other Items” property. Allowed: “0” - cannot contain other items. “1” - can contain other items.

valid_containers

array

The “Valid Containers” property. An array of SKUs for valid containers.

special_supplies

array

The “Special Supplies” property. An array of SKUs for special packaging supplies.

special_other

array

The “Other Special Features” property. An array of SKUs for other special packaging features.

unit_qty

integer

The “Unit Quantity” property. Number of individually packaged items contained therein for purposes of special packaging features.

external_id

integer

The “External ID” property. The external unique numeric identifier for the product.

vendor_sku

string

The “Vendor SKU” property. Use if different from the “SKU” property.

Get Started

Common Features

Shipping

Receiving

Inventory

System

Methods

Entity Properties

`product.search`

Parameters

Return Value

Example Request

Example Response

Error Codes

`product.create`

Parameters

Return Value

Example Request

Example Response

Error Codes

`product.info`

Parameters

Return Value

Example Request

Example Response

Error Codes

`product.update`

Parameters

Return Value

Example Request

Example Response

Error Codes

Entity Properties

Product Properties

Get Started

Common Features

Shipping

Receiving

Inventory

System

Documentation Index

​Methods

​Entity Properties

​product.search

​Parameters

​Return Value

​Example Request

​Example Response

​Error Codes

​product.create

​Parameters

​Return Value

​Example Request

​Example Response

​Error Codes

​product.info

​Parameters

​Return Value

​Example Request

​Example Response

​Error Codes

​product.update

​Parameters

​Return Value

​Example Request

​Example Response

​Error Codes

​Entity Properties

​Product Properties

Methods

Entity Properties

`product.search`

Parameters

Return Value

Example Request

Example Response

Error Codes

`product.create`

Parameters

Return Value

Example Request

Example Response

Error Codes

`product.info`

Parameters

Return Value

Example Request

Example Response

Error Codes

`product.update`

Parameters

Return Value

Example Request

Example Response

Error Codes

Entity Properties

Product Properties