Create article

Creates a new article with the provided data. Required fields: id (article code), description, article_type, vat_id, measurement_unit_id. Optional: initial stock quantity, warehouse_id for stock registration. Module-specific fields (OFICINAS, PRESTASYNC, LOGISTICA, TPV, etc.) are available based on active modules.

Authorization

AuthorizationBearer <token>

In: header

Request Body

descriptionstring

Article name/description

article_typestring

Article type (product, service, etc.)

vat_idstring

VAT rate ID

measurement_unit_idstring

Measurement unit code (e.g., UN, KG, LT)

cost_price?number

selling_price?number

Selling price

selling_price_option?string

Selling price option

Value in"PRV" | "PCU"

cost_price_margin?number

cost_price_margin_type?string

Value in"P" | "V"

family_id?string

Family/article group ID

sub_family_id?string

Sub-family ID

sub_sub_family_id?string

Sub-sub-family ID

barcode?string

Main barcode

brand_id?string

Brand ID

active?boolean

Whether article is active

active_for_web?boolean

Whether article is visible on web

part_number?string

Manufacturer part number

abbreviation?string

Short name/abbreviation

location?string

Storage location

discount?number

Default discount percentage

energy_classification?string

minimum_stock?number

maximum_stock?number

customs_duty_rate?number

Customs duty percentage

commission_rate?number

Commission rate

discount_classification?string

Valid value from descontos_classif.codclassif,.

use_lots?boolean

Uses lot tracking

use_serial_numbers?boolean

Uses serial number tracking

manufactured?boolean

Is manufactured in-house

withholding_tax?boolean

Subject to withholding tax

quantity_per_vehicle?number

quantity_per_pallet?number

quantity_per_box?number

saft_product_type?string

SAF-T product type

saft_product_category?string

SAF-T product category

is_component?boolean

Is a component

component_brand?string

Component brand

component_model?string

Component model

component_version?string

Component version

is_tire?boolean

tire_load_index?string

tire_speed_index?string

Value in

"A1" | "A2" | "A3" | "A4" | "A5" | "A6" | "A7" | "A8" | "B" | "C" | "D" | "E" | "F" | "G" | "J" | "K" | "L" | "M" | "N" | "P" | "Q" | "R" | "S" | "T" | "H" | "V" | "W" | "Y" | "ZR"

tire_energy_efficiency?string

Value in"A" | "B" | "C" | "D" | "E"

tire_safety?string

Value in"A" | "B" | "C" | "D" | "E"

tire_external_noise?string

Value in"A" | "B" | "C"

tire_decibels?number

tire_measure?string

tire_width?integer

tire_height?integer

tire_diameter?integer

tire_type_id?integer

Valid value from artigos_pneu_tipo.id.

tire_season_id?integer

Valid value from artigos_pneu_temporada.id.

tire_snow_certification?boolean

tire_ice_certification?boolean

web_id?string

web_price?number

web_reference?string

long_description?string

short_description?string

weight?number

logistics_type?string

logistics_quantity?number

width?number

height?number

depth?number

active_for_pos?boolean

drive360_autoorder?boolean

alternative_measurement_unit_id?string

alternative_measurement_unit_conversion?number

ams_active?boolean

fuel_type_id?string

Valid value from tipos_combustiveis.id,.

operation_type?string

Valid value from tipologia_operacao.code,.

statistical_classification?string

tecdoc_code?string

tecdoc_supplier?string

id_code_mr?string

price1?number

block1?boolean

price2?number

block2?boolean

price3?number

block3?boolean

price4?number

block4?boolean

price5?number

block5?boolean

price6?number

block6?boolean

price7?number

block7?boolean

price8?number

block8?boolean

price9?number

block9?boolean

price10?number

block10?boolean

price11?number

block11?boolean

price12?number

block12?boolean

price13?number

block13?boolean

price14?number

block14?boolean

price15?number

block15?boolean

idstring

Article code/identifier (unique)

quantity?number

Initial stock quantity to register

warehouse_id?integer

Warehouse ID for initial stock registration

purchasing_price?number

Cost/purchase price

margin_pcu?number

Unit cost margin

margin_pcu_type?string

Margin type (value or percentage)

energy_class?string

Energy efficiency class

stock_min?number

Minimum stock level

stock_max?number

Maximum stock level

discount_classif?string

Discount classification

qty_vehicle?number

Quantity per vehicle

qty_pallet?number

Quantity per pallet

qty_box?number

Quantity per box

Response Body

curl -X POST "https://og-tenant1.test:8003/api/v2/stocks/articles" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "string",
    "article_type": "string",
    "vat_id": "string",
    "measurement_unit_id": "string",
    "id": "string"
  }'

{
  "data": {
    "id": "string",
    "description": "string",
    "article_type": "string",
    "purchasing_price": 0,
    "selling_price": 0,
    "vat_id": "string",
    "measurement_unit_id": "string",
    "stock_quantity": 0,
    "family_id": "string",
    "sub_family_id": "string",
    "sub_sub_family_id": "string",
    "barcode": "string",
    "brand_id": "string",
    "brand": {
      "id": "string",
      "name": "string"
    },
    "active": true,
    "active_for_web": true,
    "re": "string",
    "set": "string",
    "part_number": "string",
    "purchasing_price_last": 0,
    "purchasing_price_avg": 0,
    "margin": 0,
    "selling_price_option": "string",
    "margin_pcu": 0,
    "margin_pcu_type": "string",
    "discount_classif": "string",
    "commission_rate": 0,
    "barcode_prefix": "string",
    "sale_multiples": 0,
    "use_lots": true,
    "use_serial_numbers": true,
    "manufactured": true,
    "withholding_tax": true,
    "customs_duty_rate": 0,
    "location": "string",
    "discount": 0,
    "energy_class": "string",
    "abbreviation": "string",
    "saft_product_type": "string",
    "saft_product_category": "string",
    "ordered_qty_client": 0,
    "ordered_qty_supplier": 0,
    "stock_min": 0,
    "stock_max": 0,
    "qty_vehicle": 0,
    "qty_pallet": 0,
    "qty_box": 0,
    "codx": "string",
    "cody": "string",
    "codz": "string",
    "image_link": "string",
    "spaces_dimensions": "string",
    "id_spaces_dimensions": "string",
    "dimensions": "string",
    "is_component": true,
    "component_brand": "string",
    "component_model": "string",
    "component_version": "string",
    "manually_updated_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z"
  }
}

{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}

{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}

{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}

{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}

Create article

Authorization

Request Body

Response Body

201

401

403

422

429