Skip to content
elasticStageDeveloper Portal

List orders for a creator

GET
/api/v1/orders
curl --request GET \
  --url 'https://example.com/api/v1/orders?creator=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0&status=paid&page=1&per_page=25' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
creator
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
status
string
Allowed values: paid unpaid refunded cancelled pending
from
string format: date
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/
to
string format: date
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/
page
integer
default: 1 >= 1 <= 9007199254740991
per_page
integer
default: 25 >= 1 <= 100

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
data
required
Array<object>
object
uuid
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
human_order_id
required
string
nullable
placed_at
required
string format: date-time
nullable
currency
required
string
payment_status
required
string
Allowed values: paid unpaid refunded cancelled pending
dispatch_status
required
string
nullable
Allowed values: pending processing shipped delivered cancelled
tracking_code
required
string
nullable
totals
required
object
gross
required
integer
>= -9007199254740991 <= 9007199254740991
royalty
required
integer
>= -9007199254740991 <= 9007199254740991
items_count
required
integer
>= -9007199254740991 <= 9007199254740991
meta
required
object
page
required
integer
>= -9007199254740991 <= 9007199254740991
per_page
required
integer
>= -9007199254740991 <= 9007199254740991
total
required
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "data": [
    {
      "payment_status": "paid",
      "dispatch_status": "pending"
    }
  ]
}

400

Section titled “400”

Default Response

Media typeapplication/json
object
statusCode
required
number
code
required
string
Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR
error
required
string
message
required
string
details
Array
Example
{
  "code": "VALIDATION_ERROR"
}

401

Section titled “401”

Default Response

Media typeapplication/json
object
statusCode
required
number
code
required
string
Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR
error
required
string
message
required
string
details
Array
Example
{
  "code": "VALIDATION_ERROR"
}

403

Section titled “403”

Default Response

Media typeapplication/json
object
statusCode
required
number
code
required
string
Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR
error
required
string
message
required
string
details
Array
Example
{
  "code": "VALIDATION_ERROR"
}

404

Section titled “404”

Default Response

Media typeapplication/json
object
statusCode
required
number
code
required
string
Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR
error
required
string
message
required
string
details
Array
Example
{
  "code": "VALIDATION_ERROR"
}

429

Section titled “429”

Default Response

Media typeapplication/json
object
statusCode
required
number
code
required
string
Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR
error
required
string
message
required
string
details
Array
Example
{
  "code": "VALIDATION_ERROR"
}

500

Section titled “500”

Default Response

Media typeapplication/json
object
statusCode
required
number
code
required
string
Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR
error
required
string
message
required
string
details
Array
Example
{
  "code": "VALIDATION_ERROR"
}

503

Section titled “503”

Default Response

Media typeapplication/json
object
statusCode
required
number
code
required
string
Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR
error
required
string
message
required
string
details
Array
Example
{
  "code": "VALIDATION_ERROR"
}