Skip to content
Komplett LogoKomplett Platform

Get order by ID

GET
/v2/{orderId}
curl --request GET \
  --url https://example.com/orders/v2/example

Retrieves a single order by its unique identifier.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
orderId
required
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
order
required
object
orderId
required
null | string
checkoutId
required
null | string
currency
required
null | string
events
required
object
key
additional properties
string format: date-time
parties
required
object
soldTo
required
string
shipTo
required
string
billTo
required
string
contactTo
required
null | string
placedBy
required
null | string
references
required
One of:
null
orderLines
required
Array<object>
object
lineNumber
required
string
name
required
string
description
required
null | string
materialNumber
required
string
quantity
required
object
total
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
fulfilled
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
cancelled
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
unitPrice
required
object
gross
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
net
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
vat
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
references
required
One of:
null
categories
required
Array
Allowed values: PHYSICAL_ITEM SERVICE DELIVERY VIRTUAL_ITEM
orderLines
required
Array<object> recursive
expectedDeliveries
required
Array<object>
object
estimatedDeliveryDate
required
null | string format: date-time
expectedLines
required
Array<object>
object
orderLineNumber
required
string
quantity
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
references
required
One of:
null
status
required
Allowed values: Unknown Unavailable UnconfirmedRestock ConfirmedRestock Available
availableAt
required
null | string format: date-time
collectionPoint
required
One of:
null
deliveryAddress
required
One of:
null
deliveries
required
Array<object>
object
deliveryId
required
string
trackingNumber
required
null | string
events
required
object
key
additional properties
string format: date-time
deliveryLines
required
Array<object>
object
lineNumber
required
string
quantity
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
orderLineNumber
required
string
serialNumbers
required
Array<string>
collectionPoint
required
One of:
null
deliveryAddress
required
One of:
null
billings
required
Array<object>
object
billingId
required
string
events
required
object
key
additional properties
string format: date-time
type
required
Allowed values: Invoice CreditNote
billingLine
required
Array<object>
object
lineNumber
required
string
quantity
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
orderLineNumber
required
null | string
serialNumbers
required
Array<string>
notes
required
One of:
null
Example
{
  "order": {
    "orderLines": [
      {
        "categories": [
          "PHYSICAL_ITEM"
        ]
      }
    ],
    "expectedDeliveries": [
      {
        "expectedLines": [
          {
            "status": "Unknown"
          }
        ]
      }
    ],
    "billings": [
      {
        "type": "Invoice"
      }
    ]
  }
}

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"
}

404

Section titled “404”

Not Found

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"
}