Skip to content
Komplett LogoKomplett Platform

List orders by placed-by customer

GET
/v1/list/placed-by/{placedByCustomerId}
curl --request GET \
  --url 'https://example.com/orders/v1/list/placed-by/example?Status=Open&SortBy=PlacedAt&SortDir=Asc'

Lists orders placed by a specific customer, identified by their customerId. Supports optional status, placed-at date range, sorting and paging via the query string. Results are filtered by the caller’s per-order access, which is applied after paging: a page may therefore contain fewer than pageSize orders, or be empty while still returning a continuationToken. Keep following the continuationToken until it is null to retrieve all results.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
placedByCustomerId
required
string

Query Parameters

Section titled “Query Parameters”
Status
Allowed values: Open InProgress Completed Cancelled
From
string format: date-time
To
string format: date-time
SortBy
Allowed values: PlacedAt OrderId
SortDir
Allowed values: Asc Desc
PageSize
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
ContinuationToken
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
orders
required
Array<object>
object
orderId
required
string
checkoutId
null | string
placedAt
required
string format: date-time
status
required
Allowed values: Open InProgress Completed Cancelled
soldTo
required
string
placedBy
null | string
productNames
required
Array<string>
references
One of:
null
continuationToken
null | string
Example
{
  "orders": [
    {
      "status": "Open"
    }
  ]
}

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