Tradecloud API v2 manual
  • Introduction
    • Welcome
      • Checklist
      • Support
    • API
      • Rules
      • Requests
      • JSON versus XML
      • Environments
      • Standards
      • Compatibility
      • Tools
        • Swagger UI
        • Postman
        • .NET SDK
      • Webhook versus polling
        • Polling usage
        • Polling echo
      • Delivery schedule
    • Security
      • Security overview
      • Authentication
      • Authorization
      • Encryption
      • Document storage
  • Guide
    • 1. Getting an Account
    • 2. Sending your first order
      • Option A: Sending a Delivery Schedule per order line
      • Option B: Sending a Single Delivery per order line
  • Processes
    • Forecasts
      • Issue a new forecast
      • Issue a new Slimstock forecast
    • Orders
      • Buyer order process
        • Issue a new order
          • Delivery schedule
          • Indicators
          • No delivery expected
          • Propose when accepted
          • Attach a document to an order
          • Choose attach document API
        • Update an existing order
        • Receive an order response
          • Download a document attached to an order response
          • Single delivery order response
        • Receive goods
        • Complete an order
        • Reopen an order
        • Cancel an order
      • Supplier order process
        • Receive an order
          • Download a document attached to an order
          • Single delivery order
        • Send order response
          • Attach a document to an order response
        • Reopen an order
        • Cancel an order
    • Shipments
      • Supplier shipment process
        • Send despatch advice
      • Buyer shipment process
        • Receive a shipment event
          • Download a document attached to a shipment
Powered by GitBook
On this page
  • Making an API request
  • HTTP method
  • HTTP headers
  • Authorization
  • Content-Type
  • URL
  • HTTPS scheme
  • Environments
  • Services
  • Methods
  • Parameters
  • JSON body
  • XML body
  1. Introduction
  2. API

Requests

How to make API requests

PreviousRulesNextJSON versus XML

Last updated 5 months ago

Making an API request

An API request consist of:

  • : GET, POST or DELETE

  • : authorization and content type

  • : HTTPS, environment, service, method and parameters

  • which contains the payload

HTTP method

The API supports

  • GET to 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)

  • POST to create a new JSON object or upload a document

  • DELETE to delete an existing JSON object or document

HTTP headers

Authorization

Use the Authorization header for basic authentication and token authorization, see

Content-Type

Use the Content-Type: application/json header in case of a POST with a JSON body.

Use the Content-Type: application/xml header in case of a POST with an XML body.

URL

An URL is build up like this: https://environment/service/method/parameters?parameters

HTTPS scheme

Environments

Services

Common used services are:

  • authentication for authentication, to get a token

  • api-connector for buyer and supplier ERP integration

  • object-storage to upload and download documents

  • order for order/line commands

  • order-search for order queries

  • order-line-search for order-line queries

  • sci-connector for buyer ERP integration using SCSN

Methods

POST /api-connector/order-response sends an order response by the supplier

Parameters

Path parameters

A request can have a path parameter such as an {id} in object-storage service download method:

Query parameters

A GET request can have a query parameter such as a query in company-search:

JSON body

A POST request has a JSON body (payload), such as a purchase order sent to the api-connector service order method:

{
  "order": {
    "companyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "supplierAccountNumber": "12345",
    "purchaseOrderNumber": "PO123456789",
    "destination": {
        ...

XML body

tXML

The Tradecloud API supports a proprietary XML format, called tXML, which is a 1-on-1 translation of the proprietary JSON format:

A POST request has a tXML body (payload), such as a purchase order sent to the api-connector service order method:

<?xml version="1.0" encoding="UTF-8"?>
<SendOrderByBuyer>
    <companyId>00f03b98-2511-489f-9695-13791b3f66b6</companyId>
    <supplierAccountNumber>12345</supplierAccountNumber>
    <purchaseOrderNumber>PO123456789</purchaseOrderNumber>
    <destination>
       ...

Isah SCI API

<?xml version="1.0" encoding="UTF-8"?>
<Order>
    <ID>123</ID>
    <IssueDate>2018-10-06</IssueDate>
    <Note>[Free-form text]</Note>
    <BuyerCustomerParty>
        ...

The API uses the 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.

The API only supports HTTPS, see .

Tradecloud has :

have a short dynamic life cycle and have NO availability SLA

the has an availability SLA of 95% 10/5

the has an availability SLA of 99.5% 24/7

Each environment has a set of services which you can find on each environment page, like the and

On the environment page for each service the API endpoint you can find the file, the OpenAPI UI rendering, the health and label (version) is published.

In each you can find the methods supported by the service. For example the service:

POST /api-connector/order

Most service methods have either path parameters, query parameters and/or a or

The Tradecloud API supports a proprietary format:

JSON is a standard published as and

JSON text

JSON strings:

JSON strings: for date/time values date format YYYY-MM-DD or local date/time format YYYY-MM-DDThh:mm:ss is used

Tradecloud supports :

Following the for some api-connector and order-webhook-connector API endpoints.

Following the for the sci-connector API endpoint.

XML text

A sci-connector POST request has a body (payload), such as a purchase order sent to the sci-connector service order method:

XML text

REST
Encryption
three environments
test environments
acceptance test environment
production environment
Environments
acceptance test environment
production environment
OpenAPI 2.0 Specification
YAML
OpenAPI 2.0 Specification
api-connector
sends an order by the buyer
GET /object-storage/download/{id}
GET /company-search?query=name
POST /api-connector/order
RFC 8259
ECMA-404
(PDF)
MUST be encoded using UTF-8
some characters, like the quote, MUST be escaped
ISO 8601
tXML standard
SCSN Standard
POST /api-connector/order
MUST be encoded using UTF-8
SCSN
PUT /sci-connector/order
MUST be encoded using UTF-8
Authentication
HTTP method
HTTP headers
URL
JSON body
JSON body
XML body
JSON
XML