List orders

curl --request GET \
  --url https://api.sellfern.com/orders \
  --header 'x-api-key: <api-key>'

{
  "success": true,
  "data": [
    {
      "id": 1234567890,
      "storeName": "My Etsy Store",
      "date": "2023-11-07T05:31:56Z",
      "currency": "USD",
      "totalAmount": 123,
      "subtotal": 123,
      "tax": 123,
      "shippingCost": 123,
      "discount": 123,
      "customerName": "<string>",
      "customerAddress": "<string>",
      "shipAddress1": "<string>",
      "shipAddress2": "<string>",
      "shipCity": "<string>",
      "shipState": "<string>",
      "shipZipcode": "<string>",
      "shipCountry": "<string>",
      "isGift": true,
      "isRefunded": true,
      "isCaseClosed": true,
      "isLost": true,
      "requiresAudit": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "items": [
        {
          "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>"
  }
}

GET

orders

List orders

curl --request GET \
  --url https://api.sellfern.com/orders \
  --header 'x-api-key: <api-key>'

{
  "success": true,
  "data": [
    {
      "id": 1234567890,
      "storeName": "My Etsy Store",
      "date": "2023-11-07T05:31:56Z",
      "currency": "USD",
      "totalAmount": 123,
      "subtotal": 123,
      "tax": 123,
      "shippingCost": 123,
      "discount": 123,
      "customerName": "<string>",
      "customerAddress": "<string>",
      "shipAddress1": "<string>",
      "shipAddress2": "<string>",
      "shipCity": "<string>",
      "shipState": "<string>",
      "shipZipcode": "<string>",
      "shipCountry": "<string>",
      "isGift": true,
      "isRefunded": true,
      "isCaseClosed": true,
      "isLost": true,
      "requiresAudit": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "items": [
        {
          "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>"
  }
}

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

string

Search order number, customer name, or related order text.

string

Alias for q.

status

enum<string>

Filter by order status.

Available options:

New,

Pending Cost,

In Production,

Shipped,

Complete,

Cancelled

store_id

string

Filter by store identifier or store name accepted by the backend.

created_after

string<date-time>

Only include orders created after this timestamp.

created_before

string<date-time>

Only include orders created before this timestamp.

updated_after

string<date-time>

Only include orders updated after this timestamp.

timezone

string

IANA timezone used for date interpretation.

Example:

"America/New_York"

supplier_id

string

Filter by supplier identifier or name accepted by the backend.

missingSku

boolean

Filter to orders with items missing SKUs.

missingDesign

boolean

Filter to orders with items missing design files.

sort

string

Sort expression as field:direction.

Example:

"created_at:desc"

page

integer

default:1

Page number, 1-indexed.

Required range: x >= 1

page_size

integer

default:50

Page size. Alias: limit.

Required range: 1 <= x <= 200

limit

integer

Alias for page_size.

Required range: 1 <= x <= 200

Response

Paginated orders returned successfully.

success

boolean

required

Example:

true

data

object[]

required

Show child attributes

Documentation Index

Authorizations

Query Parameters

Response