Products

Create Product

Creates a product.

POST

/v1/products/variations

Create Product

curl --request POST \
  --url 'https://public-api.bladepro.io/v1/products/variations?expand=%3Cstring%3E' \
  --header 'Content-Type: application/json' \
  --data '
{
  "barcode": "<string>",
  "brand": 123,
  "channel": 123,
  "existing_components": "<any>",
  "name": "<string>",
  "new_component": "<any>",
  "sku": "<string>"
}
'

{
  "data": {
    "barcode": "0123456789012",
    "components": [
      {
        "instance": {
          "component": {
            "barcode": "123123123000",
            "batch_codes_enabled": "enabled",
            "battery": false,
            "count_product_component_batches": 1,
            "created": "2019-11-25T14:52:56.000Z",
            "customs_country_of_origin_country_id": 1,
            "dangerous": false,
            "fragile": false,
            "id": 1,
            "made_of": "Synthetic rubber & Polyvinyl chloride",
            "modified": "2019-11-25T14:52:56.000Z",
            "organic": false,
            "perishable": false,
            "product_component_customs_code_id": 1,
            "sku": "DEMO-SKU-01",
            "status": "active",
            "used_for": "A tool for measuring distances.",
            "what_is_it": "Tape measure."
          },
          "id": 1,
          "product_component_id": 1
        },
        "product_component_instance_id": 1,
        "product_variation_id": 1,
        "quantity": 1
      }
    ],
    "created": "2019-11-25T14:52:56.000Z",
    "descriptions": [
      {
        "created": "2019-11-25T14:52:56.000Z",
        "full_description": "Example product description",
        "id": 1,
        "locale": {
          "code": "en",
          "created": "2019-11-25T14:52:56.000Z",
          "id": 1,
          "modified": "2019-11-25T14:52:56.000Z",
          "name": "English"
        },
        "locale_id": 1,
        "modified": "2019-11-25T14:52:56.000Z",
        "name": "Example product",
        "product_variation_id": 1
      }
    ],
    "despatch_instructions": "Always pack facing upwards.",
    "discontinued_date": "2019-11-25T14:52:56.000Z",
    "id": 1,
    "modified": "2019-11-25T14:52:56.000Z",
    "primary_component": [
      {
        "barcode": "123123123000",
        "batch_codes_enabled": "enabled",
        "battery": false,
        "count_product_component_batches": 1,
        "created": "2019-11-25T14:52:56.000Z",
        "customs_country_of_origin_country_id": 1,
        "dangerous": false,
        "fragile": false,
        "id": 1,
        "made_of": "Synthetic rubber & Polyvinyl chloride",
        "modified": "2019-11-25T14:52:56.000Z",
        "organic": false,
        "perishable": false,
        "product_component_customs_code_id": 1,
        "sku": "DEMO-SKU-01",
        "status": "active",
        "used_for": "A tool for measuring distances.",
        "what_is_it": "Tape measure."
      }
    ],
    "product": {

Scope(s): APP::PRODUCTS::MANAGE

Query Parameters

expandstringquery

Usage: expand=*

Expand components, components.instance, components.instance.component, components.instance.component.doqs, components.instance.component.doqs.type, descriptions, descriptions.locale, primary_component, product, product.brand, product.brand.organisation, product.channel, product.channel.organisation, stock_data_summaries, tags, type

Body

barcodestringrequired

The product barcode.

brandintegerrequired

Product brand id.

channelintegerrequired

Product channel id.

existing_componentsany

Components to use. Required when creating a new virtual product. It can't appear in the payload along with new_component.

namestringrequired

The product's name.

new_componentany

Component data. Required when creating a new warehouse product. It can't appear in the payload along with existing_components.

skustringrequired

The product's Stock Keeping Unit.

Response

successful operation

barcodestring

The product variation barcode.

componentsany

The variation components.

createdany

Created date in BladePRO.

descriptionsany

The variation descriptions.

despatch_instructionsstring

Instructions for the staff.

discontinued_dateany

The date the product was discontinued on.

idnumber

ID of the product variation.

modifiedany

Last modified date in BladePRO.

primary_componentany

The primary component.

productobject

Product.

product_idnumber

ID of the parent product.

product_variation_type_idnumber

ID of the product variation type.

skustring

The unique stock keeping unit.

statusenum<string>

The status of the product variation.

Available options: active, draft, discontinued

stock_data_summariesany

Stock.

tagsany

The variation tags.

typeobject

The product variation type.

Show child attributes

Still need help? Share an idea