Skip to content

Orders

Endpoints related to orders

Operations

Retrieve a list of orders within a date range

Request

🚦 Rate Limit: 100 requests / minute

Security
BearerAuth
Query
modifiedFromDatestring, (date-time)

Filter orders modified from this date (ISO 8601 format). If specified without modifiedToDate, current date will be used as end date.

Example:modifiedFromDate=2026-01-01T00:00:00Z
modifiedToDatestring, (date-time)

Filter orders modified up to this date (ISO 8601 format). Cannot be specified without modifiedFromDate.

Example:modifiedToDate=2026-01-31T23:59:59Z
offsetinteger, >= 0

Number of records to skip for pagination (default: 0)

Example:offset=0
pageSizeinteger, [ 1 .. 1000 ]

Number of records to return per page (default: 1000, max: 1000)

Example:pageSize=50
orderNumberinteger

Fetch a single order by order number. When provided, the response will include only that order (if found).

Example:orderNumber=21654
curl -i -X GET \
  'https://staging.corksy.io/connect-api/v1/orders?modifiedFromDate=2026-01-01T00%3A00%3A00Z&modifiedToDate=2026-01-31T23%3A59%3A59Z&offset=0&pageSize=50&orderNumber=21654' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

A list of orders within the specified date range

Bodyapplication/json
dataArray of objects(Order)
paginationobject(PaginationInfo)
Response
{
  "data": [
    { … }
  ],
  "pagination": {
    "current_offset": 0,
    "page_size": 50,
    "total_records": 1250,
    "total_pages": 25,
    "current_page": 1,
    "pages_remaining": 24,
    "has_next_page": true,
    "has_previous_page": false
  }
}