Batch Update Articles

POST

/v1/articles/{companyId}/{brandId}/batch-update

const url = 'https://api.dev.caspeco.net/api/am/v1/articles/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/batch-update';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"items":[{"articleId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","name":"example","description":"example","customerFacingName":"example","customerFacingDescription":"example","prices":{"regular":{"inclVat":1,"exclVat":1},"takeAway":{"inclVat":1,"exclVat":1},"conference":{"inclVat":1,"exclVat":1}},"attributes":{"colorHexValue":"example","resetColor":true,"allowDiscount":true,"resetAllowDiscount":true,"allowPriceOverride":true,"resetAllowPriceOverride":true,"salesUnit":"Piece","resetSalesUnit":true,"keepStockBalance":true,"resetKeepStockBalance":true,"isLoyaltyContributing":true,"resetIsLoyaltyContributing":true,"ageRestriction":1,"resetAgeRestriction":true,"nonSale":true,"resetNonSale":true}}]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.dev.caspeco.net/api/am/v1/articles/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/batch-update \
  --header 'Content-Type: application/json' \
  --data '{ "items": [ { "articleId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "description": "example", "customerFacingName": "example", "customerFacingDescription": "example", "prices": { "regular": { "inclVat": 1, "exclVat": 1 }, "takeAway": { "inclVat": 1, "exclVat": 1 }, "conference": { "inclVat": 1, "exclVat": 1 } }, "attributes": { "colorHexValue": "example", "resetColor": true, "allowDiscount": true, "resetAllowDiscount": true, "allowPriceOverride": true, "resetAllowPriceOverride": true, "salesUnit": "Piece", "resetSalesUnit": true, "keepStockBalance": true, "resetKeepStockBalance": true, "isLoyaltyContributing": true, "resetIsLoyaltyContributing": true, "ageRestriction": 1, "resetAgeRestriction": true, "nonSale": true, "resetNonSale": true } } ] }'

Updates up to 50 articles in a single all-or-nothing batch. Only provided fields are updated. Setting an attribute Reset flag to true resets that attribute to the inherited value.

Parameters

Path Parameters

companyId

required

string format: uuid

brandId

required

string format: uuid

Request Body

object

items

required

Array<object>

object

articleId

required

string format: uuid

name

string

nullable

description

string

nullable

customerFacingName

string

nullable

customerFacingDescription

string

nullable

prices

object

regular

object

inclVat

number format: double

nullable

exclVat

number format: double

nullable

takeAway

object

inclVat

number format: double

nullable

exclVat

number format: double

nullable

conference

object

inclVat

number format: double

nullable

exclVat

number format: double

nullable

attributes

object

colorHexValue

string

nullable

resetColor

boolean

nullable

allowDiscount

boolean

nullable

resetAllowDiscount

boolean

nullable

allowPriceOverride

boolean

nullable

resetAllowPriceOverride

boolean

nullable

salesUnit

string

Allowed values: Piece Kg Liter Centiliter

resetSalesUnit

boolean

nullable

keepStockBalance

boolean

nullable

resetKeepStockBalance

boolean

nullable

isLoyaltyContributing

boolean

nullable

resetIsLoyaltyContributing

boolean

nullable

ageRestriction

integer format: int32

nullable

resetAgeRestriction

boolean

nullable

nonSale

boolean

nullable

resetNonSale

boolean

nullable

Responses

200

Returns updated articles

object

items

required

Array<object>

object

articleId

required

string format: uuid

categoryId

required

string format: uuid

externalId

string

nullable

articleNumber

required

integer format: int64

categoryExternalId

string

nullable

name

required

string

nullable

description

required

string

nullable

customerFacingName

required

string

nullable

customerFacingDescription

required

string

nullable

publicationStatus

required

string

Allowed values: Draft Active Inactive

prices

required

object

priceSource

required

string

Allowed values: IncludingVat ExcludingVat

regular

required

object

inclVat

number format: double

nullable

exclVat

number format: double

nullable

takeAway

required

object

inclVat

number format: double

nullable

exclVat

number format: double

nullable

conference

required

object

inclVat

number format: double

nullable

exclVat

number format: double

nullable

images

required

object

imageIdOneByOneUrl

string

nullable

imageIdSixteenByNineUrl

string

nullable

attributes

required

object

color

object

name

required

string

hexValue

required

string

allowDiscount

boolean

nullable

allowPriceOverride

boolean

nullable

salesUnit

string

Allowed values: Piece Kg Liter Centiliter

keepStockBalance

boolean

nullable

isLoyaltyContributing

boolean

nullable

ageRestriction

integer format: int32

nullable

nonSale

boolean

nullable

object

items

required

Array<object>

object

articleId

required

string format: uuid

categoryId

required

string format: uuid

externalId

string

nullable

articleNumber

required

integer format: int64

categoryExternalId

string

nullable

name

required

string

nullable

description

required

string

nullable

customerFacingName

required

string

nullable

customerFacingDescription

required

string

nullable

publicationStatus

required

string

Allowed values: Draft Active Inactive

prices

required

object

priceSource

required

string

Allowed values: IncludingVat ExcludingVat

regular

required

object

inclVat

number format: double

nullable

exclVat

number format: double

nullable

takeAway

required

object

inclVat

number format: double

nullable

exclVat

number format: double

nullable

conference

required

object

inclVat

number format: double

nullable

exclVat

number format: double

nullable

images

required

object

imageIdOneByOneUrl

string

nullable

imageIdSixteenByNineUrl

string

nullable

attributes

required

object

color

object

name

required

string

hexValue

required

string

allowDiscount

boolean

nullable

allowPriceOverride

boolean

nullable

salesUnit

string

Allowed values: Piece Kg Liter Centiliter

keepStockBalance

boolean

nullable

isLoyaltyContributing

boolean

nullable

ageRestriction

integer format: int32

nullable

nonSale

boolean

nullable

Example

{
  "items": [
    {
      "publicationStatus": "Draft",
      "prices": {
        "priceSource": "IncludingVat"
      },
      "attributes": {
        "salesUnit": "Piece"
      }
    }
  ]
}

object

items

required

Array<object>

object

articleId

required

string format: uuid

categoryId

required

string format: uuid

externalId

string

nullable

articleNumber

required

integer format: int64

categoryExternalId

string

nullable

name

required

string

nullable

description

required

string

nullable

customerFacingName

required

string

nullable

customerFacingDescription

required

string

nullable

publicationStatus

required

string

Allowed values: Draft Active Inactive

prices

required

object

priceSource

required

string

Allowed values: IncludingVat ExcludingVat

regular

required

object

inclVat

number format: double

nullable

exclVat

number format: double

nullable

takeAway

required

object

inclVat

number format: double

nullable

exclVat

number format: double

nullable

conference

required

object

inclVat

number format: double

nullable

exclVat

number format: double

nullable

images

required

object

imageIdOneByOneUrl

string

nullable

imageIdSixteenByNineUrl

string

nullable

attributes

required

object

color

object

name

required

string

hexValue

required

string

allowDiscount

boolean

nullable

allowPriceOverride

boolean

nullable

salesUnit

string

Allowed values: Piece Kg Liter Centiliter

keepStockBalance

boolean

nullable

isLoyaltyContributing

boolean

nullable

ageRestriction

integer format: int32

nullable

nonSale

boolean

nullable

Example

{
  "items": [
    {
      "publicationStatus": "Draft",
      "prices": {
        "priceSource": "IncludingVat"
      },
      "attributes": {
        "salesUnit": "Piece"
      }
    }
  ]
}

400

Bad Request

object

statusCode

integer format: int32

message

string

validationErrors

Array<object>

nullable

object

field

required

string

errorId

required

string

entity

string

nullable

object

statusCode

integer format: int32

message

string

validationErrors

Array<object>

nullable

object

field

required

string

errorId

required

string

entity

string

nullable

Example^generated

{
  "statusCode": 1,
  "message": "example",
  "validationErrors": [
    {
      "field": "example",
      "errorId": "example"
    }
  ],
  "entity": "example"
}

object

statusCode

integer format: int32

message

string

validationErrors

Array<object>

nullable

object

field

required

string

errorId

required

string

entity

string

nullable

Example^generated

{
  "statusCode": 1,
  "message": "example",
  "validationErrors": [
    {
      "field": "example",
      "errorId": "example"
    }
  ],
  "entity": "example"
}

401

Unauthorized

403

Forbidden

500

Internal Server Error

Batch Update Articles

Parameters

Path Parameters

Request Body

Responses

200

Example

Example

400

Examplegenerated

Examplegenerated

401

403

500

Example^generated

Example^generated