Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NCR Catalog API

Item, item-price, and item-attribute management plus item-details search.

NCR Catalog API is one of 7 APIs that NCR publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Catalog. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and code examples.

This API exposes 11 operations across 9 paths, and defines 9 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 2 base URLs: https://api.ncr.com, https://gateway-staging.ncrcloud.com.

11 operations 9 paths 9 schemas 4 GET2 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.ncr.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

NCR Catalog API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmacAccessKey). By default, every request must be authenticated.

  • hmacAccessKey — AccessKey (HMAC) authentication. The Authorization header carries "AccessKey {sharedKey}:{signature}", where the signature is a Base64 SHA-512 HMAC computed ov…

Paths & Operations 11

Across 9 paths, the API surfaces 11 operations — 4 GET, 2 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Catalog 11

Item, item-price, and item-attribute management plus item-details search.

GET
/catalog/items
NCR Voyix List Catalog Items
listCatalogItems 4 params → 200
PUT
/catalog/items
NCR Voyix Create Catalog Items
createCatalogItems body → 200
GET
/catalog/items/{itemCode}
NCR Voyix Get Catalog Item
getCatalogItem 1 param → 200404
PUT
/catalog/items/{itemCode}
NCR Voyix Create or Update Catalog Item
putCatalogItem 1 param body → 200
PUT
/catalog/item-prices
NCR Voyix Create or Update Item Prices
createCatalogItemPrices body → 200
PUT
/catalog/item-prices/{itemCode}/{priceCode}
NCR Voyix Update Item Price by Item Code
updateItemPriceByItemCode 3 params body → 200
POST
/catalog/item-prices/get-multiple
NCR Voyix Get Multiple Item Prices
getMultipleItemPrices 1 param body → 200
POST
/catalog/item-attributes/get-multiple
NCR Voyix Get Multiple Item Attributes
getMultipleItemAttributes 1 param body → 200
PUT
/catalog/item-attributes/{itemCode}
NCR Voyix Update Item Attributes by Item Code
updateItemAttributesByItemCode 2 params body → 200
GET
/catalog/item-details/{itemCode}
NCR Voyix Get Item Details by Item Code
getItemDetailsByItemCode 2 params → 200404
GET
/catalog/item-details/search
NCR Voyix Search Item Details
searchItemDetails 7 params → 200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are ItemInput (7 properties), ItemPriceInput (5 properties), Error (2 properties), ItemCodeList (1 property). Each schema is shown below with its type and property counts.

ItemPage
object
1 property
ItemInput
object
7 properties 2 required
Item
ItemPrice
LocalizedText
object
A set of locale-specific values.
1 property
Status
string
Error
object
2 properties
ItemCodeList
object
1 property 1 required
ItemPriceInput
object
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ncr-catalog-api-openapi.yml Raw ↑

Other APIs NCR publishes across the network.

NCR Category API
NCR Order API
NCR Provisioning API
NCR Security API
NCR Selling API
NCR Site API