Wyzio API documentation

Modify batch of articles

POST /api-v1/article/batch

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)

Body Required

articles

archived boolean
articleId string
categoryId integer
categoryName string
currency object
Hide currency attributes Show currency attributes
- code string
- id integer
- name string
description object
Hide description attributes Show description attributes
- 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
  Hide articleName attributes Show articleName attributes
  
  de string
  
  en string
  
  fr string
  
  it string
- discount string
- id integer
- price string
- totalPrice string
localizations object
Hide localizations attributes Show localizations attributes
- 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
Hide name attributes Show name attributes
- de string
- en string
- fr string
- id integer
- it string
quantity number
saleAccountId integer
saleAccountName object
Hide saleAccountName attributes Show saleAccountName attributes
- 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

Responses

• 200

OK
Hide response attribute Show response attribute object
- items array[object]
  
  Hide items attributes Show items attributes object
  
  error boolean
  
  errorCode object
  
  Hide errorCode attributes Show errorCode attributes
  
  errorCode string
  
  Values are NO_ERROR, NOT_IMPLEMENTED_YET, CONTACT_NOT_FOUND, FIELD_REQUIRED, VALIDATION_ERROR, DUPLICATION_ERROR, UNIQUE_CONSTRAINT_VIOLATION, WRONG_PASSWORD_FORMAT, WRONG_PASSWORD, ACTION_DENIED, NOT_FOUND, EXPECTED_ONE_FILE, UNIQUE_VIOLATION, CONTENT_EMPTY, INVALID_TYPE, CONVERSION_ERROR, FILE_PARSE_EXCEPTION, or IN_USE.
  
  errorDetailValues array[object]
  
  Hide errorDetailValues attributes Show errorDetailValues attributes object
  
  data string
  
  errorCode string
  
  fieldName string
  
  isSevere boolean
  
  freshData object
  
  freshRow object
  
  possibleWorkflows array[object]
  
  Hide possibleWorkflows attributes Show possibleWorkflows attributes object
  
  id integer
  
  name string
  
  severeError boolean
• 400

400 Bad Request
• 401

401 Unauthorized
• 403

403 Access Denied
• 404

404 Not Found
• 500

500 Internal Server Error

POST /api-v1/article/batch

curl \
 -X POST http://wyzio.app/api-v1/article/batch \
 -H "TARGET-ORGANIZATION-ID: 42" \
 -H "WEAL-TOKEN: string" \
 -d '[{"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}]'

Request example

# Headers
TARGET-ORGANIZATION-ID: 42
WEAL-TOKEN: string

# Payload
[
  {
    "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
  }
]

Response examples (200)

{
  "items": [
    {
      "error": true,
      "errorCode": {
        "errorCode": "NO_ERROR",
        "errorDetailValues": [
          {
            "data": "string",
            "errorCode": "string",
            "fieldName": "string",
            "isSevere": true
          }
        ]
      },
      "freshData": {},
      "freshRow": {},
      "possibleWorkflows": [
        {
          "id": 42,
          "name": "string"
        }
      ],
      "severeError": true
    }
  ]
}