Orders

Create Order

Create an Order

post/orders

Request

Base URL
https://api.kyckr.com/v2
Auth
HTTP bearer
TypeScript
https://skmtc.dev/kyckr/apis/kyckr-companies-v2-api/docs/orders/post.ts
A function with typed inputs. Its response is checked against the schema.

kyckrIdstring

productIdstring

customerReferencestring

contactEmailstring email

An email address that can be contacted in case of issues with the order

Created

orderIdstring

The related orderId.

correlationIdstring

The related correlationId to this request, for support purposes.

customerReferencestring

A customer provided reference, which appears in the order list.

timeStampstring date-time

The UTC time at which the request occurred.

detailsstring

The response status details for the current request.

status'Success' | 'Pending' | 'Failed'

{
  "orderId": "12345",
  "cost": {
    "type": "credit",
    "value": 3
  },
  "links": {
    "self": "/orders/12345"
  }
}