---
title: "Add new article"
method: POST
path: "/api/Article"
tags: ["Article"]
---

# Add new article

`POST /api/Article`

## Request body

- ArticleDTO — The ArticleDTO Class. Contains relevant fields of Article DTO by masking actual Article entity's fields in application.
  - `activeStatus` boolean — Active Status
  - `applyForAllGyms` boolean
  - `articleId` integer
  - `availableGyms` GymDTO[], required
    - `externalGymNumber` integer
    - `gymId` integer
    - `gymName` string, nullable
    - `location` string, nullable
  - `availableQty` number — Default AvailableQty
  - `barcode` string, nullable
  - `createdDate` string, date-time
  - `createdUser` string, nullable
  - `cronExpression` string, nullable — Access Schedule CRON Expression
  - `description` string, nullable
  - `discount` number
  - `employeeDiscount` number — Default EmployeeDiscount
  - `employeePrice` number — Default EmployeePrice
  - `gymArticles` GymArticleDetailsDTO[], nullable — Gym Customizations
    - `articleId` integer
    - `availableQty` number
    - `createdUser` string, nullable — Created User
    - `employeeDiscount` number
    - `employeePrice` number
    - `gymId` integer — Gym Id where article is related
    - `gymIdList` string, nullable — GymId - Gym Id string with comma separated GymIds
    - `gymName` string, nullable — Gym Name
    - `id` integer
    - `isDefault` boolean — Set as the default values for the article
    - `isInventoryItem` boolean
    - `isObsolete` boolean
    - `modifiedUser` string, nullable — Modified user
    - `reorderLevel` number
    - `revenueAccountId` integer — Revenue account Id
    - `sellingPrice` number
  - `isAddOn` boolean
  - `isInventoryItem` boolean — Default IsInventoryItem of the Article
  - `isObsolete` boolean — Default IsObsolete of the Article
  - `measureUnit` string, required
  - `modifiedDate` string, date-time
  - `modifiedUser` string, nullable
  - `name` string, required
  - `number` integer
  - `price` number, required
  - `reorderLevel` number — Deafault ReorderLevel
  - `revenueAccountId` integer — Default Revenue account
  - `sellingPrice` number — Default SellingPrice
  - `tags` string, nullable
  - `type` string, required
  - `vat` number
  - `vatApplicable` boolean — VAT Applicable

## Response `202`

messageId that can use to get the status of import later on.!

- DefaultResponseDTOOfStatusDTO — The DefaultResponseDTO Class. Contains fields of DefaultResponse DTO in application.
  - `isError` boolean
  - `message` string, nullable
  - `responseException` unknown
  - `result` StatusDTO — Imideate response for long running api call.
    - `messageId` string, nullable — Reference id for status endpoint
    - `statusText` string, nullable — Status of API Call
    - `url` string, nullable — Relative url for stauts check

## Other responses

- `500`

---

[API](https://skmtc.net/tlapi/apis/tl-api.md) · [All operations](https://skmtc.net/tlapi/apis/tl-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tlapi/tl-api/versions/349096cc3ded/schema)
