Get details of article

GET /api-v1/article/{id}

Headers

TARGET-ORGANIZATION-ID integer(int32)

ID of organization, for which the operation must be performed
WEAL-TOKEN string Required

API token (can be retrieved from account settings)

Path parameters

id integer Required

id

Responses

200

OK
Hide response attributes Show response attributes object
- archived boolean
- articleId string
- categoryId integer
- categoryName string
- currency object
  
  Additional properties are allowed.
  
  Hide currency attributes Show currency attributes object
  
  code string
  
  id integer
  
  name string
- description object
  
  Additional properties are allowed.
  
  Hide description attributes Show description attributes object
  
  de string
  
  en string
  
  fr string
  
  id integer
  
  it string
- ean string
- endDate string
- id integer
- imageId integer
- isLinkedToShipments boolean
- isManufactured boolean
- items array[object]
  
  Hide items attributes Show items attributes object
  
  amount string
  
  articleId integer
  
  articleName object
  
  Additional properties are allowed.
  
  Hide articleName attributes Show articleName attributes object
  
  de string
  
  en string
  
  fr string
  
  it string
  
  discount string
  
  id integer
  
  price string
  
  totalPrice string
- localizations object
  
  Additional properties are allowed.
  
  Hide localizations attributes Show localizations attributes object
  
  de string
  
  en string
  
  fr string
  
  id integer
  
  it string
- margin number
- measurement string
  
  Values are UNIT, ML, DL, L, HL, G, KG, T, H, M, M_2, M_3, KM, or DAY.
- name object
  
  Additional properties are allowed.
  
  Hide name attributes Show name attributes object
  
  de string
  
  en string
  
  fr string
  
  id integer
  
  it string
- quantity number
- saleAccountId integer
- saleAccountName object
  
  Additional properties are allowed.
  
  Hide saleAccountName attributes Show saleAccountName attributes object
  
  de string
  
  en string
  
  fr string
  
  it string
- startDate string
- type string
  
  Values are PRODUCT, SERVICE, or BUNDLE.
- unitCost string
- unitPrice string
- vatRateId integer
- weightKg number
400

400 Bad Request
401

401 Unauthorized
403

403 Access Denied
404

404 Not Found
500

500 Internal Server Error

GET /api-v1/article/{id}

curl \
 -X GET http://10.10.10.132/api-v1/article/{id} \
 -H "TARGET-ORGANIZATION-ID: 42" \
 -H "WEAL-TOKEN: string"

Response examples (200)

{
  "archived": true,
  "articleId": "string",
  "categoryId": 42,
  "categoryName": "string",
  "currency": {
    "code": "string",
    "id": 42,
    "name": "string"
  },
  "description": {
    "de": "string",
    "en": "string",
    "fr": "string",
    "id": 42,
    "it": "string"
  },
  "ean": "string",
  "endDate": "string",
  "id": 42,
  "imageId": 42,
  "isLinkedToShipments": true,
  "isManufactured": true,
  "items": [
    {
      "amount": "string",
      "articleId": 42,
      "articleName": {
        "de": "string",
        "en": "string",
        "fr": "string",
        "it": "string"
      },
      "discount": "string",
      "id": 42,
      "price": "string",
      "totalPrice": "string"
    }
  ],
  "localizations": {
    "de": "string",
    "en": "string",
    "fr": "string",
    "id": 42,
    "it": "string"
  },
  "margin": 42.0,
  "measurement": "UNIT",
  "name": {
    "de": "string",
    "en": "string",
    "fr": "string",
    "id": 42,
    "it": "string"
  },
  "quantity": 42.0,
  "saleAccountId": 42,
  "saleAccountName": {
    "de": "string",
    "en": "string",
    "fr": "string",
    "it": "string"
  },
  "startDate": "string",
  "type": "PRODUCT",
  "unitCost": "string",
  "unitPrice": "string",
  "vatRateId": 42,
  "weightKg": 42.0
}