Skip to content
Komplett LogoKomplett Platform

Create checkout

POST
/v1/create
curl --request POST \
  --url https://example.com/checkout/v1/create \
  --header 'Content-Type: application/json' \
  --data '{ "soldTo": { "customerId": "example" }, "orderLines": [ { "materialId": { "type": "example", "value": "example" }, "quantity": 1, "references": { "deliveryReference": "example" } } ], "delivery": { "deliveryAddress": { "name": "example", "addressLine1": "example", "addressLine2": "example", "postCode": "example", "city": "example", "country": "example", "contactPersonName": "example", "phone": "example", "mobilePhone": "example", "email": "example", "globalLocationNumber": "example" }, "preferences": { "carrier": "example", "carrierCollectionPointId": "example", "deliverDate": "2026-04-15T12:00:00Z" } }, "references": { "billingReference": "example", "deliveryReference": "example" }, "notes": { "messageToSalesDepartment": "example" } }'

Creates checkout draft and returns generated checkout identifier.

Request Bodyrequired

Section titled “Request Bodyrequired”
object
soldTo
required
One of:
null
orderLines
required
Array<object>
object
materialId
required
One of:
null
quantity
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
references
required
One of:
null
delivery
required
object
deliveryAddress
required
object
name
required
string
addressLine1
required
string
addressLine2
required
null | string
postCode
required
string
city
required
string
country
required
string
contactPersonName
required
null | string
phone
required
null | string
mobilePhone
required
null | string
email
required
string
globalLocationNumber
required
null | string
preferences
required
One of:
null
references
required
One of:
null
notes
required
One of:
null
Examplegenerated
{
  "soldTo": {
    "customerId": "example"
  },
  "orderLines": [
    {
      "materialId": {
        "type": "example",
        "value": "example"
      },
      "quantity": 1,
      "references": {
        "deliveryReference": "example"
      }
    }
  ],
  "delivery": {
    "deliveryAddress": {
      "name": "example",
      "addressLine1": "example",
      "addressLine2": "example",
      "postCode": "example",
      "city": "example",
      "country": "example",
      "contactPersonName": "example",
      "phone": "example",
      "mobilePhone": "example",
      "email": "example",
      "globalLocationNumber": "example"
    },
    "preferences": {
      "carrier": "example",
      "carrierCollectionPointId": "example",
      "deliverDate": "2026-04-15T12:00:00Z"
    }
  },
  "references": {
    "billingReference": "example",
    "deliveryReference": "example"
  },
  "notes": {
    "messageToSalesDepartment": "example"
  }
}

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json
object
name
required
string
value
required
string
Examplegenerated
{
  "name": "example",
  "value": "example"
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
errors
required
Array<object>
object
fieldName
required
string
message
required
string
code
required
string
traceId
required
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "fieldName": "example",
      "message": "example"
    }
  ],
  "code": "example",
  "traceId": "example"
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
code
required
string
traceId
required
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example",
  "traceId": "example"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
code
required
string
traceId
required
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example",
  "traceId": "example"
}

500

Section titled “500”

Internal Server Error

Media typeapplication/json
object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string
code
required
string
traceId
required
string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example",
  "traceId": "example"
}