Get Articles

GET

/v1/articles/{companyId}/{brandId}

const url = 'https://api.dev.caspeco.net/api/am/v1/articles/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0?pageNumber=1&pageSize=1';
const options = {method: 'GET'};

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

curl --request GET \
  --url 'https://api.dev.caspeco.net/api/am/v1/articles/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0?pageNumber=1&pageSize=1'

Returns a paginated list of articles

Parameters

Path Parameters

companyId

required

string format: uuid

brandId

required

string format: uuid

Query Parameters

pageNumber

required

integer format: int32

>= 1 <= 2147483647

pageSize

required

integer format: int32

>= 1 <= 500

Responses

200

Returns the page

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

pageNumber

required

integer format: int32

pageSize

required

integer format: int32

totalItems

required

integer format: int32

totalPages

required

integer format: int32

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

pageNumber

required

integer format: int32

pageSize

required

integer format: int32

totalItems

required

integer format: int32

totalPages

required

integer format: int32

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

pageNumber

required

integer format: int32

pageSize

required

integer format: int32

totalItems

required

integer format: int32

totalPages

required

integer format: int32

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

Get Articles

Parameters

Path Parameters

Query Parameters

Responses

200

Example

Example

400

Examplegenerated

Examplegenerated

401

403

500

Example^generated

Example^generated