Skip to main content
POST
/
2.0
/
product
Create single product to the store
curl --request POST \
  --url https://api.shipbob.com/2.0/product \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "category_id": 0,
  "name": "string",
  "sub_category_id": 0,
  "type_id": 0,
  "variants": [
    {
      "barcode": "string",
      "bundle_definition": [
        {
          "quantity": 0,
          "variant_id": 0
        }
      ],
      "channel_metadata": [
        {
          "asin": "string",
          "channel_id": 0,
          "currency": "string",
          "fnsku": "string",
          "fulfillment_channel": "string",
          "id": 0,
          "is_inventory_sync_enabled": true,
          "legacy_product_id": 0,
          "platform": "string",
          "platform_identifier": "string",
          "platform_inventory_item_id": "string",
          "price": 0.1,
          "seller_sku": "string"
        }
      ],
      "customs": {
        "country_code_of_origin": "string",
        "description": "string",
        "hs_tariff_code": "string",
        "is321_eligible": true,
        "value": 0
      },
      "dimension": {
        "height": 0.1,
        "length": 0.1,
        "width": 0.1
      },
      "fulfillment_settings": {
        "dangerous_goods": true,
        "is_bpm_parcel": true,
        "is_case_pick": true,
        "msds_url": "string",
        "requires_prop65": true,
        "serial_scan": {
          "exact_character_length": 0,
          "is_enabled": true,
          "prefix": "string",
          "suffix": "string"
        }
      },
      "gtin": "string",
      "is_digital": true,
      "lot_information": {
        "is_lot": true,
        "minimum_shelf_life_days": 0
      },
      "name": "string",
      "packaging_material_type_id": 0,
      "packaging_requirement_id": 0,
      "return_preferences": {
        "backup_action_id": 0,
        "instructions": "string",
        "primary_action_id": 0,
        "return_to_sender_backup_action_id": 0,
        "return_to_sender_primary_action_id": 0
      },
      "sku": "string",
      "status_id": 0,
      "upc": "string",
      "weight": 0.1
    }
  ]
}
'
{
  "category": {
    "id": 123,
    "name": "<string>"
  },
  "created_on": "2023-11-07T05:31:56Z",
  "id": 123,
  "name": "<string>",
  "sub_category": {
    "id": 123,
    "name": "<string>"
  },
  "type": "<string>",
  "updated_on": "2023-11-07T05:31:56Z",
  "user_id": 123,
  "variants": [
    {
      "associated_bundles": [
        {
          "product_id": 123,
          "product_name": "<string>",
          "quantity": 123,
          "variant_id": 123,
          "variant_sku": "<string>"
        }
      ],
      "barcode": "<string>",
      "bundle_definition": [
        {
          "product_id": 123,
          "quantity": 123,
          "variant_id": 123,
          "variant_name": "<string>",
          "variant_sku": "<string>"
        }
      ],
      "created_on": "2023-11-07T05:31:56Z",
      "customs": {
        "country_code_of_origin": "<string>",
        "currency": "<string>",
        "description": "<string>",
        "hs_tariff_code": "<string>",
        "is321_eligible": true,
        "value": 123
      },
      "dimension": {
        "height": 123,
        "length": 123,
        "unit": "<string>",
        "width": 123
      },
      "fulfillment_settings": {
        "dangerous_goods": true,
        "is_bpm_parcel": true,
        "is_case_pick": true,
        "msds_url": "<string>",
        "requires_prop65": true,
        "serial_scan": {
          "exact_character_length": 123,
          "is_enabled": true,
          "prefix": "<string>",
          "suffix": "<string>"
        }
      },
      "gtin": "<string>",
      "id": 123,
      "inventory": {
        "inventory_id": 123,
        "on_hand_qty": 123
      },
      "is_digital": true,
      "lot_information": {
        "is_lot": true,
        "minimum_shelf_life_days": 123
      },
      "name": "<string>",
      "packaging_material_type": {
        "id": 123,
        "name": "<string>"
      },
      "packaging_requirement": {
        "id": 123,
        "name": "<string>"
      },
      "return_preferences": {
        "backup_action": {
          "id": 123,
          "name": "<string>"
        },
        "instructions": "<string>",
        "primary_action": {
          "id": 123,
          "name": "<string>"
        },
        "return_to_sender_backup_action": {
          "id": 123,
          "name": "<string>"
        },
        "return_to_sender_primary_action": {
          "id": 123,
          "name": "<string>"
        }
      },
      "sku": "<string>",
      "status": "<string>",
      "upc": "<string>",
      "updated_on": "2023-11-07T05:31:56Z",
      "weight": {
        "unit": "<string>",
        "weight": 123
      },
      "channel_metadata": [
        {
          "channel_id": 123,
          "channel_name": "<string>",
          "currency": "<string>",
          "id": 123,
          "is_inventory_sync_enabled": true,
          "legacy_product_id": 123,
          "platform": "<string>",
          "platform_identifier": "<string>",
          "platform_inventory_item_id": "<string>",
          "price": 123,
          "seller_sku": "<string>"
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Authentication using Personal Access Token (PAT) token

Body

application/json

The product to add

category_id
integer<int32> | null
name
string | null
sub_category_id
integer<int32> | null
type_id
integer<int32>
variants
object[] | null

Response

201 - application/json

Created

category
object
created_on
string<date-time>
id
integer<int64>
name
string | null
sub_category
object
type
string | null
updated_on
string<date-time> | null
user_id
integer<int64>
variants
object[] | null