How to make API requests
An API request consist of:
The API supports
GETto get a specific JSON object, like a purchase order, or to download a document (one JSON object or document is returned) or to query objects (a JSON collection is returned)
POSTto create a new JSON object or upload a document
PUTto update an existing JSON object
DELETEto delete an existing JSON object or document
Content-Type: application/jsonheader in case of
PUTwith a JSON body.
Content-Type: application/xmlheader in case of
PUTwith an XML body.
The API uses the REST software architectural style that defines a set of constraints to be used for creating Web services. The API additionally uses a command and query style.
An URL is build up like this:
Each environment has a set of services which you can find on each environment page, like the acceptance test environment and production environment
On the environment page for each service the API endpoint you can find the OpenAPI 2.0 Specification YAML file, the OpenAPI UI rendering, the health and label (version) is published.
Common used services are:
authenticationfor authentication, to get a token
api-connectorfor buyer and supplier ERP integration
object-storageto upload and download documents
orderfor order/line commands
order-searchfor order queries
order-line-searchfor order-line queries
sci-connectorfor buyer ERP integration using SCSN
In each OpenAPI 2.0 Specification you can find the methods supported by the service. For example the
POST /api-connector/order-responsesends an order response by the supplier
A request can have a path parameter such as an
A GET request can have a query parameter such as a
A POST request has a JSON body (payload), such as a purchase order sent to the
- JSON strings: for date/time values ISO 8601 date format
YYYY-MM-DDor local date/time format
A request can have an XML body, such as purchase order sent to the
<?xml version="1.0" encoding="UTF-8"?>