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 Order API

Order creation, lookup, update, and search.

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

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

This API exposes 4 operations across 3 paths, and defines 8 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.

4 operations 3 paths 8 schemas 1 GET1 PATCH2 POST

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 Order 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 4

Across 3 paths, the API surfaces 4 operations — 1 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Order 4

Order creation, lookup, update, and search.

POST
/order/3/orders/1
NCR Voyix Create Order
createOrder 1 param body → 201
GET
/order/3/orders/1/{orderId}
NCR Voyix Get Order by Id
getOrderById 1 param → 200404
PATCH
/order/3/orders/1/{orderId}
NCR Voyix Update Order by Id
updateOrderById 2 params body → 200
POST
/order/3/orders/1/find
NCR Voyix Find Orders
findOrders 1 param body → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are OrderInput (4 properties), Customer (3 properties), OrderLine (3 properties), Quantity (3 properties). Each schema is shown below with its type and property counts.

ProductId
object
2 properties
OrderLine
object
3 properties
Order
Customer
object
3 properties
OrderSearch
object
2 properties
Error
object
2 properties
Quantity
object
3 properties
OrderInput
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ncr-order-api-openapi.yml Raw ↑

Other APIs NCR publishes across the network.

NCR Catalog API
NCR Category API
NCR Provisioning API
NCR Security API
NCR Selling API
NCR Site API