Gestiono
Referencia de APIResources / Resource

Create Resource

POST /v1/resource • validated by `postResource`

← Back to full API reference
POST/v1/resourceAuthentication required

Resource endpoints let you create and maintain catalog items used across sales, purchasing, and inventory workflows.

  • Validated by Zod schema: postResource.

Request details

Path params

No path parameters for this endpoint.

Query params

No explicit query schema was captured for this endpoint.

Body fields

  • name (required)

    Type: string

  • description

    Type: string

  • divisionId

    Type: number

  • variantOf

    Type: number

  • type (required)

    Enum-like validator generated by zodFromObj

  • relation (required)

    Enum-like validator generated by zodFromObj

  • unit (required)

    Type: string

  • priceStrategy (required)

    Enum-like validator generated by zodFromObj

  • costStrategy

    Enum-like validator generated by zodFromObj

  • variation

    Type: number

  • currency

    Enum-like validator generated by zodFromObj

  • bulkVariation

    Type: number

  • bulkVariationLabel

    Type: string

  • bulkVariationMinQuantity

    Type: number

  • canSellWithoutStock

    Boolean parser helper from common/utils.zBoolean

    Example: true

  • canBeSold

    Boolean parser helper from common/utils.zBoolean

    Example: true

  • followsInventory

    Boolean parser helper from common/utils.zBoolean

    Example: true

  • requiresSerialNumbers

    Boolean parser helper from common/utils.zBoolean

    Example: false

  • sku

    Type: string

  • barCode

    Type: string

  • minStockAlert

    Type: number

  • maxStockAlert

    Type: number

  • quantityDecimals

    Type: number

    Example: 0

  • taxes

    Type: array

    Example:

  • taxes[] (required)

    Type: object

  • taxes[].taxRateId (required)

    Type: number

  • defaultCost

    Type: number

  • initialStock

    Type: number

  • multimedia

    Type: array

    Example:

  • multimedia[] (required)

    Type: object

  • multimedia[].url (required)

    Type: string

  • multimedia[].type

    Type: enum

    Example: IMAGE

  • multimedia[].alt

    Type: string

  • labels

    Type: array

    Example:

  • labels[] (required)

    Type: string

  • serialNumbers

    Type: array

    Example:

  • serialNumbers[] (required)

    Type: string

  • clientdata

    Type: object

  • metadata

    Type: unknown

Default payloads

Path params

json
{}

Query

json
{}

Body

json
{
  "name": "string",
  "type": "string",
  "relation": "string",
  "unit": "string",
  "priceStrategy": "string"
}

Sample response

json
"<result>"

Test this endpoint now

Use your own credentials and execute a live request directly from this page.

1. Configure authentication for testing

You can test endpoints with signed API keys, a raw Authorization token, or browser cookies. Select one mode and fill in the required fields.

2. Select endpoint

POST/v1/resourceAuthentication required

Group: Resources / Resource

POST /v1/resource • validated by `postResource`

Resource endpoints let you create and maintain catalog items used across sales, purchasing, and inventory workflows.

  • Validated by Zod schema: postResource.

Body fields

  • namerequired
    Type: string
  • description
    Type: string
  • divisionId
    Type: number
  • variantOf
    Type: number
  • typerequired
    Enum-like validator generated by zodFromObj
  • relationrequired
    Enum-like validator generated by zodFromObj
  • unitrequired
    Type: string
  • priceStrategyrequired
    Enum-like validator generated by zodFromObj
  • costStrategy
    Enum-like validator generated by zodFromObj
  • variation
    Type: number
  • currency
    Enum-like validator generated by zodFromObj
  • bulkVariation
    Type: number
  • bulkVariationLabel
    Type: string
  • bulkVariationMinQuantity
    Type: number
  • canSellWithoutStock
    Boolean parser helper from common/utils.zBoolean
    Ejemplo: true
  • canBeSold
    Boolean parser helper from common/utils.zBoolean
    Ejemplo: true
  • followsInventory
    Boolean parser helper from common/utils.zBoolean
    Ejemplo: true
  • requiresSerialNumbers
    Boolean parser helper from common/utils.zBoolean
    Ejemplo: false
  • sku
    Type: string
  • barCode
    Type: string
  • minStockAlert
    Type: number
  • maxStockAlert
    Type: number
  • quantityDecimals
    Type: number
    Ejemplo: 0
  • taxes
    Type: array
    Ejemplo:
  • taxes[]required
    Type: object
  • taxes[].taxRateIdrequired
    Type: number
  • defaultCost
    Type: number
  • initialStock
    Type: number
  • multimedia
    Type: array
    Ejemplo:
  • multimedia[]required
    Type: object
  • multimedia[].urlrequired
    Type: string
  • multimedia[].type
    Type: enum
    Ejemplo: IMAGE
  • multimedia[].alt
    Type: string
  • labels
    Type: array
    Ejemplo:
  • labels[]required
    Type: string
  • serialNumbers
    Type: array
    Ejemplo:
  • serialNumbers[]required
    Type: string
  • clientdata
    Type: object
  • metadata
    Type: unknown

3. Prepare request payload

4. Server response

Run a request to inspect the real-time response for your environment.

GET /v1/resource/list

Previous Page

PATCH /v1/resource

Next Page