API Reference

id

The unique id of the product in Fulfil. This is not the same as an SKU

attributes

Product attributes associated with the product

{
    "attribute_display_name": "HS Code #1",
    "attribute_id": 70,
    "attribute_name": "New HS code",
    "attribute_set_id": 67,
    "attribute_type": "char",
    "id": 49,
    "product_id": 2,
    "value": "423894792834",
    "value_boolean": false,
    "value_char": "423894792834",
    "value_date": null,
    "value_datetime": null,
    "value_float": null,
    "value_integer": null,
    "value_numeric": null,
    "value_selection": null
}

brand

Brand of the product

category_name

The name of the product category.

code

The user-friendly code used to identify the product. This is usually an SKU with most merchants.

customs_information

An object with customs information of the product

 "customs_information": {
      "hs_code": "100.200.300",
     "country_of_origin": "CA",
     "customs_value": "123.56",
     "customs_description": "Description of item for customs"
}

dimensions

Dimensions of the product

"dimensions": {
      "length_cm": 10.5,
      "width_cm": 5,
     "height_cm": 16.75,
     "length_in": 4.13,
     "width_in": 1.97,
     "height_in": 6.59,
}

image

URL of the product image

name

The name of the variant

scan_required

Require a barcode scan at picking, packing or both

template_name

The name of the product template. Template is a collection of variants.

upc

UPC is optional and may not exist.

weight

Weight of the product

 "weight": {
     "weight_gm": 907.185,
     "weight_oz": 32
}