Skip to main content
GET
/
orderItems
List order items
curl --request GET \
  --url https://api.sellfern.com/orderItems \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "data": [
    {
      "id": "987654321",
      "orderId": "1234567890",
      "customOrderId": "<string>",
      "name": "<string>",
      "sku": "<string>",
      "customSku": "<string>",
      "spu": "<string>",
      "quantity": 1,
      "price": 123,
      "status": "In Production",
      "assignedSupplier": "<string>",
      "subSupplier": "<string>",
      "material": "<string>",
      "materialId": "<string>",
      "designUrl": "<string>",
      "trackingCode": "<string>",
      "carrier": "<string>",
      "style": "<string>",
      "type": "<string>",
      "size": "<string>",
      "color": "<string>",
      "variations": "<string>",
      "personalization": "<string>",
      "comment": "<string>",
      "idService": "<string>",
      "phone": "<string>",
      "orderDate": "<string>",
      "storeName": "<string>",
      "isGift": true,
      "customerName": "<string>",
      "customerAddress": "<string>",
      "shipName": "<string>",
      "shipAddress1": "<string>",
      "shipAddress2": "<string>",
      "shipCity": "<string>",
      "shipState": "<string>",
      "shipZipcode": "<string>",
      "shipCountry": "<string>",
      "vatIossNumber": "<string>"
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "page_size": 50,
      "total": 125,
      "total_pages": 3
    },
    "request_id": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.sellfern.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Sellfern public API key scoped to the authenticated organization. Do not use user JWTs for public integrations.

Query Parameters

​
search
string

Search SKU, order number, item name, or related item text.

​
status
string

Filter by item status.

​
storeName
string

Filter by store name.

​
startDate
string<date>

Only include items from orders on or after this date.

​
endDate
string<date>

Only include items from orders on or before this date.

​
timezone
string

IANA timezone used for date interpretation.

Example:

"America/New_York"

​
supplier
string

Filter by supplier name or ID.

​
missingSku
boolean

Filter to items missing SKUs.

​
missingDesign
boolean

Filter to items missing design files.

​
missingCost
boolean

Filter to items missing cost in the app. Cost values are not returned in the public response schema.

​
sortField
string

Field name to sort by.

​
sortOrder
enum<string>

Sort direction.

Available options:
asc,
desc
​
page
integer
default:1

Page number, 1-indexed.

Required range: x >= 1
​
limit
integer
default:50

Number of results per page.

Required range: x >= 1

Response

Paginated order items returned successfully.

​
success
boolean
required
Example:

true

​
data
object[]
required
​
meta
object
required