Create a catalog item

POST

/api/v1/items

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example", "unit_price": 1, "unit": "example", "tax_percent": 1, "group": "example", "sku": "example", "is_active": true }'

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Request Body^required

Media typeapplication/json

object

name

required

string

>= 1 characters <= 500 characters

description

Any of:

string

string

<= 2000 characters

null

null

unit_price

required

number

unit

Any of:

string

string

<= 50 characters

null

null

tax_percent

number

<= 100

group

Any of:

string

string

<= 200 characters

null

null

sku

Any of:

string

string

<= 100 characters

null

null

is_active

boolean

default: true

Responses

201

The new item

Media typeapplication/json

object

item

required

object

_id

required

string

name

required

string

key

additional properties

any

Example^generated

{
  "item": {
    "_id": "example",
    "name": "example"
  }
}

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Role permission or token scope missing

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}