Create a product

POST 
/api/products

Required permissions:

• product.edit: allows to create products.

Here the dedicated support page.

Request

Header Parameters

Wethod-Company stringrequired

The company you want to interact with

Wethod-Version stringrequired

The API version you want to use

application/json

Body

name stringrequired

Possible values: <= 50 characters

The product name

description string

Possible values: <= 50 characters

The product description

available_from date

Product availability start date. This follows the YYYY-MM-DD format

available_to date

Product availability end date. This follows the YYYY-MM-DD format

external_cost float

Default value: 0

The external cost of the product

markup integer

Default value: 0

The markup percentage for the product

price float

The final price of the product

Responses

201

Returns the product created.

application/json

Schema

Schema

id integerrequired

Possible values: >= 1

The unique identifier of the resource

created_at date-timerequired

The date and time when the resource was created

updated_at date-timerequired

The date and time when the resource was last updated

name stringrequired

Possible values: <= 50 characters

The name of the product

description stringrequired

Possible values: <= 50 characters

The description of the product

available_from date

The availability start date of the product

available_to date

The availability end date of the product

external_cost floatrequired

The external cost of the product

markup integerrequired

The markup percentage for the product

price float

The final price of the product

Example (from schema)

{
  "id": 1,
  "created_at": "2025-11-27T15:33:51.319Z",
  "updated_at": "2025-11-27T15:33:51.319Z",
  "name": "Premium Software License",
  "description": "Annual license for premium software features",
  "available_from": "2024-01-01",
  "available_to": "2024-12-31",
  "external_cost": 100.5,
  "markup": 20,
  "price": 120.6
}

400

Validation failed

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

failures

object[]

List of validation errors

Array [

field string

Name of the field causing the error

message string

Human-readable description of the error

]

Example (from schema)

{
  "key": "invalid_data",
  "message": "You provided invalid data. Check 'failures' for details.",
  "failures": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "string",
  "message": "string"
}

403

Forbidden

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "string",
  "message": "string"
}

412

Precondition failed

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "precondition_failure",
  "message": "string"
}

Loading...