POST
/
v1
/
inventory
/
products
Create Product or Packaging
curl --request POST \
  --url https://{client_id}.shipstream.app/api/global/v1/inventory/products \
  --header 'Content-Type: application/json' \
  --data '{
  "resource": {
    "type": "Product",
    "vendor_sku": "Vendor-SKU-1AD2",
    "external_id": "11-993-9048",
    "barcodes": [
      "956623520-4",
      "O-VS-Oregano-p3"
    ],
    "goods_type": "NORMAL",
    "is_available": true,
    "is_visible": true,
    "lot_type": {
      "type": "LotType",
      "id": 4
    },
    "weight": {
      "value": 20,
      "unit": "lb"
    },
    "dimensions": {
      "length": 8,
      "width": 6,
      "height": 4,
      "unit": "in"
    },
    "volume": {
      "value": 300,
      "unit": "in^3"
    },
    "inventory": {
      "backorders": true,
      "dynamic_allocation": true,
      "virtual_inventory": "optimistic"
    },
    "export": {
      "description": "Plastic children'\''s toy with steel weights and ball bearings",
      "customs_value": {
        "amount": 99,
        "currency": "USD"
      },
      "country_of_manufacture": "TW",
      "hs_base_code": "8518.30",
      "hs_country_extension": [
        {
          "country_id": "TW",
          "extension": "002"
        },
        {
          "country_id": "US",
          "extension": "011"
        }
      ]
    },
    "regulated_goods": {
      "regulation": {
        "type": "Regulation",
        "id": 123
      },
      "technical_name": "Hydro Polymer Acetylene Coating",
      "additional_information": "Flamable Liquid",
      "net_weight": {
        "value": 20,
        "unit": "lb"
      },
      "container_type": "Plastic Box",
      "container_meets_hazmat_specs": true,
      "regulation_units": 5
    },
    "packaging": {
      "require_packaging": true,
      "require_weight_check": true,
      "require_confirmation_per_item": true,
      "unit_quantity": 1,
      "bulk_quantity": 10,
      "max_per_package": 15,
      "is_ship_separately": true,
      "ship_separately_tag": "PVC",
      "can_tip": true,
      "can_contain_other_items": true,
      "is_handling_surcharge": true
    },
    "custom_fields": [
      {
        "code": "color",
        "value": 13,
        "label": "Red and Black"
      },
      {
        "code": "cost_of_goods",
        "value": 41.32
      },
      {
        "code": "allow_mailer",
        "value": true
      }
    ],
    "sku": "SKU-1AD",
    "name": "Test Product",
    "is_enabled": true,
    "merchant": {
      "type": "Merchant",
      "id": 4
    }
  }
}'
{
  "resource": {
    "type": "<string>",
    "id": 1,
    "warnings": [
      "<string>"
    ]
  },
  "meta": {
    "processing_time": 123
  }
}

Body

application/json

An object conforming to the Inventory Product or PackagingFeature schema to be created.

The body is of type object.

Response

201
application/json

Created - The resource was created successfully.

The response is of type object.