REST Service API for SAWS Tables (Prices, Stock, Channels & Complex Articles)

(Since connector version 1.17.0)

All SAWS tables can be read and altered via a REST Service API in the CRUD schema (Create/Read/Update/Delete). The following page contains all endpoints with example payloads.

This REST endpoint, together with all future REST endpoints, lies below admin/rest/scapiapp/. With that, the admin/rest/scchannelapp/ endpoint is officially deprecated and we recommend migrating your existing implementations to this newer version.

To utilize this REST service to its full extent, set your product number attribute in the SAWS settings.

Prices (admin/rest/scapiapp/price/)

Method	Endpoint	Description
POST	price/:productNumber	Creates or updates existing prices of the product
PUT	price/:productNumber	Replaces all prices of the product with the sent prices
GET	price/:productNumber	Gets all prices of the product
DELETE	price/:productNumber	Deletes all prices of the product

Example payload

[
  {
    "Price": "19.00",
    "Currency": "EUR",
    "ValidFrom": "2022-03-02 10:22:39",
    "ValidTo": "0000-00-00 00:00:00",
    "PriceTyp": "EK",
    "PriceSubTyp": "EK2",
    "ChannelID": "BRITAIN",
    "AmountFrom": "0",
    "AmountTo": "0",
    "PriceUnit": "1.00",
    "Unit": "",
  },
  ...
]

Special Keys

:productNumber	Product number or external key of the product
filter	An optional filter can be added in the URL to filter the query e.g. ?filter[PriceTyp]=EK (Only for GET and DELETE) (Since 1.18.0)

Stock (admin/rest/scapiapp/stock/)

Method	Endpoint	Description
POST	stock/:productNumber	Creates or updates existing stock entries of the product
PUT	stock/:productNumber	Replaces all stock entries of the product with the sent stock entries
GET	stock/:productNumber	Gets all stock entries of the product
DELETE	stock/:productNumber	Deletes all stock entries of the product

Example payload

[
  {
    "ExternalKey": "stock1",
    "Amount": "417",
    "VirtuellAmount": "0",
    "UseVirtuell": "0",
    "MinAmount": null,
    "ReserveAmount": null,
    "SendAmount": null,
    "OrderAmount": null,
    "NotifyAmount": null,
    "Unit": "",
    "StockKey": "EK_7841",
    "AreaKey": "EK_10254",
  },
  ...
]

Special Keys

:productNumber	Product number or external key of the product
StockKey	Product number or external key of the PIM stock object
AreaKey	Product number or external key of the PIM area object
filter	An optional filter can be added in the URL to filter the query e.g. ?filter[StockKey]=EK_7841 (Only for GET and DELETE) (Since 1.18.0)

Sales Channels (admin/rest/scapiapp/sales-channel/)

Method	Endpoint	Description
POST	sales-channel/:productNumber	Creates or updates existing sales channels of the product
PUT	sales-channel/:productNumber	Replaces all sales channels of the product with the sent sales channels
GET	sales-channel/:productNumber	Gets all sales channels of the product
DELETE	sales-channel/:productNumber	Deletes all sales channels of the product

Example payload

[
  {
    "IsTemplate": "0",
    "ChannelID": "BRITAIN",
    "ChannelKeys": "EK_2246,EK_2920",
    "Status": "1",
    "ValidFrom": "0000-00-00 00:00:00",
    "ValidTo": "0000-00-00 00:00:00",
    "FirstDeliveryDate": "0000-00-00 00:00:00",
    "LastDeliveryDate": "0000-00-00 00:00:00",
  },
  ...
]

Special Keys

:productNumber	Product number or external key of the product
ChannelKeys	Comma separated list of external keys of the linked Contentserv channels
filter	An optional filter can be added in the URL to filter the query e.g. ?filter[ChannelID]=BRITAIN (Only for GET and DELETE) (Since 1.18.0)

Complex Articles (admin/rest/scapiapp/complex-article/)

Method	Endpoint	Description
POST	complex-article/:productNumber	Creates or updates existing complex articles of the product
PUT	complex-article/:productNumber	Replaces all complex articles of the product with the sent complex articles
GET	complex-article/:productNumber	Gets all complex articles of the product
DELETE	complex-article/:productNumber	Deletes all complex articles of the product

Example payload

[
  {
    "VariantNumber": "PN_12764",
    "Quantity": "1",
    "ChangeableQuantity": "0",
    "IsDefault": "0",
    "IsDisabled": "0",
    "SortOrder": "0",
    "LinkTypeKey": "SET_COMPONENT"
  },
  ...
]

Special Keys

:productNumber	Product number or external key of the product
VariantNumber	Product number or external key of the connected variant product
LinkTypeKey	External key of the value range entry for the variant link type
filter	An optional filter can be added in the URL to filter the query e.g. ?filter[LinkTypeKey]=SET_COMPONENT (Only for GET and DELETE) (Since 1.18.0)

Single Complex Article Connections

Method	Endpoint	Description
POST	complex-article/:productNumber/:variantNumber/:linkTypeKey	Creates or updates an existing complex articles entry of the product
PUT	complex-article/:productNumber/:variantNumber/:linkTypeKey	Replaces a complex articles entry of the product with the sent complex articles entry
GET	complex-article/:productNumber/:variantNumber/:linkTypeKey	Gets a complex articles entry of the product
DELETE	complex-article/:productNumber/:variantNumber/:linkTypeKey	Deletes a complex articles entry of the product

Example payload

{
  "Quantity": "888888",
  "ChangeableQuantity": "0",
  "IsDefault": "0",
  "IsDisabled": "0",
  "SortOrder": "0"
}

Special Keys

:productNumber	Product number or external key of the product
:variantNumber	Product number or external key of the connected variant product
:linkTypeKey (optional)	External key of the value range entry for the variant link type

Was this article helpful?

3 0

How can we improve this article?

Please submit the reason for your vote so that we can improve the article.

Name

Email

Submit