Documentation Powered by ReDoc

Commerce APIs (2.0.0)

Download OpenAPI specification:Download

Authentication

auth

Security Scheme Type OAuth2
clientCredentials OAuth Flow
Token URL: https://login.kount.com/oauth2/ausdppksgrbyM0abp357
Scopes:
  • k1_integration_api -

    Kount API Scope

CommerceOrchestrator

Orders API

Orders API Request

Authorizations:
auth (k1_integration_api)
query Parameters
riskInquiry
boolean

query parameter to include risk inquiry

excludeDevice
boolean

query parameter to exclude device collection for orders originating from a call center environment or kiosk

Request Body schema: application/json
merchantOrderId
required
string

The merchant-provided unique identifier for this order. Uniqueness for this property is not enforced.

channel
string

Unique identifier of the website or app from where the order originated.

deviceSessionId
string

Unique identifier for the customer's end-user's session on the site/app. Must be the same session ID used in the device data collection from the client-side Kount SDK. Uniqueness for this property is not enforced, but customers should provide unique values.

creationDateTime
string <date-time> YYYY-MM-DD'T'hh:mm:ss.fff'Z'

The date and time that the order was placed.

userIp
string <ipv4>

The customer/merchant's end-user's IPv4 address (in dotted decimal notation), as identified by the customer/merchant.

object (v1Account)
Array of objects (k360commonv1Item)

Shopping cart data array of objects representing each item (separate SKU with quantity) in the order.

Array of objects (k360commonv1Fulfillment)

An array of data properties about the fulfillment of the order.

Array of objects (k360commonv1Transaction)

An array containing the properties of the payment transactions made for the order.

Array of objects (v1Promotion)

An array containing all of the promotions applied to this order.

object (v1Loyalty)
customFields
object

An object that allows passing in Custom Fields. Each key is the custom field's name as a string (max length: 32 characters). Each value is the custom field’s value as a date, boolean, string (max length: 256 characters), or number. Supported date format is RFC 3339 (ex: 2023-03-30T15:41:58Z). No object or array values are allowed.

Responses

Request samples

Content type
application/json
{
  • "merchantOrderId": "d121ea2210434ffc8a90daff9cc97e76",
  • "channel": "ACME_IOS_APP",
  • "deviceSessionId": "d121ea2210434ffc8a90daff9cc97e76",
  • "creationDateTime": "2019-08-24T14:15:22Z",
  • "userIp": "192.168.0.1",
  • "account": {
    },
  • "items": [
    ],
  • "fulfillment": [
    ],
  • "transactions": [
    ],
  • "promotions": [
    ],
  • "loyalty": {
    },
  • "customFields": {
    }
}

Response samples

Content type
application/json
{
  • "version": "1.0.0",
  • "order": {
    }
}

Update Order Request

Authorizations:
auth (k1_integration_api)
path Parameters
orderId
required
string

path parameter

Request Body schema: application/json
merchantOrderId
string
deviceSessionId
string
object (v2OrderPatchBodyRiskInquiry)
Array of objects (v2OrderPatchBodyTransaction)
Array of objects (v2OrderPatchBodyFulfillment)

Responses

Request samples

Content type
application/json
{
  • "merchantOrderId": "string",
  • "deviceSessionId": "string",
  • "riskInquiry": {
    },
  • "transactions": [
    ],
  • "fulfillment": [
    ]
}

Response samples

Content type
application/json
{
  • "orderId": "string",
  • "merchantOrderId": "string",
  • "channel": "string",
  • "deviceSessionId": "string",
  • "creationDateTime": "string"
}

Batch Update Chargeback/Refund Request

Authorizations:
auth (k1_integration_api)
Request Body schema: application/json
Array of objects (v2ReversalsUpdate)

Responses

Request samples

Content type
application/json
{
  • "reversalsUpdates": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}