Skip to main content
API docs by Redocly

Kemiex SAP API (0.1.14)

Download OpenAPI specification:Download

The Kemiex APIs provide methods for connecting your systems directly with the Kemiex application.

They emerged out of Kemiex customers' need to integrate with their SAP workflows. For this reason, they are designed around this primary need but will evolve to cover more generic usage.

The trade object

  • A Trade object is the agreement reached at the end of a negotiation between buyer and seller.
  • Each Trade can have one or more Trade.productTerms (if Trade.deliveryType = 'combinedShipment').
  • Each Trade can have one or more Trade.deliveries, which is the equivalent of a Purchase Order in SAP.
  • Deliveries can be added or modified by Buyer, so they contain the final product terms, Trade.deliveries.productTerms, including SAP fields like providerCode.

Flattened schemas

  • DeliveryTerms.source, DeliveryTerms.destination
    Platform users can select 3 types of locations, depending on the Via parameter: A Google Places API object, an internal Port object, or an internal Airport object.
    However, the API returns a flattened string, e.g. El Dorado International Airport (Bogotá) BOG.

Rate limits

A rate limit of 300 quota units per minute is enforced. Exceeding this limit returns HTTP code 429. The table below lists the corresponding quota units consumed per api endpoint.

Endpoint Quota units
/files/{fileUuid} 5 units
/trades 1 unit
/trades/{tradeUUID} 1 unit

trade

The trade object contains only SAP-relevant attributes of a Kemiex trade object.

List trades

Use parameter filters to narrow down results.

Authorizations:
ApiKey
query Parameters
dateFrom
required
string <date-time>
Example: dateFrom=2020-11-21T08:30:00Z

Return trades updated later than date-time.

dateTo
string <date-time>
Example: dateTo=2020-11-21T08:30:00Z

Return trades updated earlier than date-time.

sapReady
boolean
Example: sapReady=true

Return trades that have at least one delivery marked as SAP Ready.

Responses

Response samples

Content type
application/json
[
  • {
    • "id": 3421,
    • "created": "2019-08-24T14:15:22Z",
    • "lastUpdated": "2019-08-24T14:15:22Z",
    • "sapReady": true
    }
]

Find trade by UUID

Returns a single trade

Authorizations:
ApiKey
path Parameters
tradeUuid
required
string <uuid>

UUID of trade to return

Responses

Response samples

Content type
{
  • "uuid": "88d53ba0-b8fa-4f98-8417-f771fb01bcd7",
  • "id": 3421,
  • "created": "2019-08-24T14:15:22Z",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "buyerEmail": "buyer@example.com",
  • "buyerCompany": {
    • "name": "Last Inc"
    },
  • "sellerCompany": {
    • "name": "Last Inc"
    },
  • "deliveryType": "SINGLE_PRODUCT",
  • "deliveryTerms": {
    • "incotermsType": "EXW",
    • "via": "LAND",
    • "source": "string",
    • "destination": "string"
    },
  • "calloffTerms": {
    • "startDate": "2019-08-24",
    • "endDate": "2019-08-24"
    },
  • "sapReady": true,
  • "state": "OPEN",
  • "confirmationDate": "2019-08-24T14:15:22Z",
  • "contractId": "ID 1234",
  • "fxHedgeNeeded": true,
  • "productTerms": [
    • {
      }
    ],
  • "deliveries": [
    • {
      }
    ],
  • "buyerDocuments": [
    • {
      }
    ],
  • "sellerDocuments": [
    • {
      }
    ]
}

Find file by UUID

Returns a single file

Authorizations:
ApiKey
path Parameters
fileUuid
required
string <uuid>

UUID of file to return

Responses