Orders

Retrieve your store's orders including line items, customer addresses, and fulfillment status.

List Orders

GET/api/v1/orders

Permission required: orders:read

Query Parameters

Parameter	Type	Default	Description
`market`	string \| array	None	Filter orders by market. Pass a single value (`market=US`) or multiple (`market[]=US&market[]=EU`). Max 20 values, each a 2-letter country code.
`limit`	integer	`20`	Number of results per page. Range: 1–50.
`page`	integer	`1`	Page number for pagination. Min: 1.
`sort_field`	string	`created_at`	Field to sort by. Options: `created_at`, `updated_at`.
`sort_order`	string	`DESC`	Sort direction. Options: `ASC`, `DESC`.

Example Request

cURL

curl -X GET "https://api.storeep.com/v1/orders?market[]=US&market[]=EU&limit=5&sort_field=updated_at" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response

200 OK

{
    "data": [
        {
            "id": 298437652918374563,
            "number": 1042,
            "subtotal": 59.98,
            "discount": 5.00,
            "shipping": 4.99,
            "vat": 0,
            "total": 59.97,
            "currency": "USD",
            "market": "US",
            "shipping_method": "Standard Shipping",
            "payment_method": "Credit Card",
            "status": "confirmed",
            "is_abandoned": false,
            "is_duplicated": false,
            "is_returning": false,
            "is_paid": true,
            "is_test": false,
            "created_at": "2025-02-10 08:15:00",
            "updated_at": "2025-02-10 09:30:00",
            "utm_source": "facebook",
            "utm_medium": "cpc",
            "utm_campaign": "summer_sale",
            "utm_term": null,
            "utm_content": "video_ad",
            "items": [
                {
                    "name": "Classic Cotton T-Shirt",
                    "price": 29.99,
                    "quantity": 2,
                    "sku": "SHIRT-M-BLUE",
                    "barcode": "1234567890123",
                    "weight": 0.25,
                    "variants": [
                        {
                            "type": "text",
                            "name": "Size",
                            "options": [{ "name": "M" }]
                        }
                    ]
                }
            ],
            "addresses": [
                {
                    "type": "shipping",
                    "fullname": "John Doe",
                    "firstname": "John",
                    "lastname": "Doe",
                    "company": null,
                    "address1": "123 Main St",
                    "address2": "Apt 4B",
                    "national_id": null,
                    "neighborhood": "Downtown",
                    "district": null,
                    "apartment": "4B",
                    "floor": "4",
                    "state_or_region": "California",
                    "city": "Los Angeles",
                    "commune": null,
                    "province": null,
                    "postal_code": "90001",
                    "phone": "+1234567890",
                    "whatsapp": null,
                    "link": null,
                    "color": null,
                    "note": "Leave at door"
                }
            ]
        }
    ],
    "meta": {
        "pagination": {
            "total": 230,
            "count": 5,
            "per_page": 5,
            "current_page": 1,
            "total_pages": 46,
            "links": {
                "next": "https://api.storeep.com/v1/orders?limit=5&sort_field=updated_at&page=2"
            }
        }
    }
}

Get Order

GET/api/v1/orders/{order_id}

Permission required: orders:read

Retrieve a single order by its id. The response holds the same order object the list endpoint returns, without the pagination wrapper. The list parameters (market, limit, page, sort_field and sort_order) do not apply here.

Example Request

cURL

curl -X GET "https://api.storeep.com/v1/orders/298437652918374563" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response

200 OK

{
    "data": {
        "id": 298437652918374563,
        "number": 1042,
        "subtotal": 59.98,
        "discount": 5.00,
        "shipping": 4.99,
        "vat": 0,
        "total": 59.97,
        "currency": "USD",
        "market": "US",
        "shipping_method": "Standard Shipping",
        "payment_method": "Credit Card",
        "status": "confirmed",
        "is_abandoned": false,
        "is_duplicated": false,
        "is_returning": false,
        "is_paid": true,
        "is_test": false,
        "created_at": "2025-02-10 08:15:00",
        "updated_at": "2025-02-10 09:30:00",
        "utm_source": "facebook",
        "utm_medium": "cpc",
        "utm_campaign": "summer_sale",
        "utm_term": null,
        "utm_content": "video_ad",
        "items": [
            {
                "name": "Classic Cotton T-Shirt",
                "price": 29.99,
                "quantity": 2,
                "sku": "SHIRT-M-BLUE",
                "barcode": "1234567890123",
                "weight": 0.25,
                "variants": [
                    {
                        "type": "text",
                        "name": "Size",
                        "options": [{ "name": "M" }]
                    }
                ]
            }
        ],
        "addresses": [
            {
                "type": "shipping",
                "fullname": "John Doe",
                "firstname": "John",
                "lastname": "Doe",
                "company": null,
                "address1": "123 Main St",
                "address2": "Apt 4B",
                "national_id": null,
                "neighborhood": "Downtown",
                "district": null,
                "apartment": "4B",
                "floor": "4",
                "state_or_region": "California",
                "city": "Los Angeles",
                "commune": null,
                "province": null,
                "postal_code": "90001",
                "phone": "+1234567890",
                "whatsapp": null,
                "link": null,
                "color": null,
                "note": "Leave at door"
            }
        ]
    }
}

404 Not Found

{
    "status": "error",
    "errors": [
        "order not found"
    ]
}

Response Fields

Order Object

Field	Type	Description
`id`	integer	Unique order identifier.
`number`	number	Sequential order number.
`subtotal`	float	Subtotal before discounts and shipping.
`discount`	float	Discount amount applied, `0` when there is none.
`shipping`	float	Shipping cost, `0` when the order ships for free.
`vat`	float	VAT/tax amount, `0` when no VAT is charged.
`total`	float	Final order total.
`currency`	string	Currency code (e.g., "USD").
`market`	string	Market the order was placed in.
`shipping_method`	string \| null	Shipping method name.
`payment_method`	string \| null	Payment method used.
`status`	string	Current order status.
`is_abandoned`	boolean	Whether the order was abandoned.
`is_duplicated`	boolean	Whether the order is a duplicate (matched a prior order within the last 5 days).
`is_returning`	boolean	Whether the customer is returning (matched a prior order older than 5 days).
`is_paid`	boolean	Whether payment has been received.
`is_test`	boolean	Whether this is a test order.
`created_at`	string	Creation timestamp (UTC).
`updated_at`	string	Last update timestamp (UTC).
`utm_source`	string \| null	Campaign source from the link the customer landed on (e.g., "facebook"). Null when the link had no UTM parameters.
`utm_medium`	string \| null	Campaign medium (e.g., "cpc").
`utm_campaign`	string \| null	Campaign name.
`utm_term`	string \| null	Campaign keyword.
`utm_content`	string \| null	Campaign content, used to tell ads apart.
`items`	array	Line items in the order.
`addresses`	array	Shipping and billing addresses.

Item Object

Field	Type	Description
`name`	string	Product name at time of purchase.
`price`	float	Unit price.
`quantity`	integer	Number of units ordered.
`sku`	string \| null	Stock keeping unit.
`barcode`	string \| null	Product barcode.
`weight`	float \| null	Item weight.
`variants`	array \| null	Selected variant options for this item.

Address Object

Field	Type	Description
`type`	string	Address type (`shipping` or `billing`).
`fullname`	string \| null	The name the customer gave, a first and last name form is stored joined.
`firstname`	string \| null	First word of `fullname`.
`lastname`	string \| null	The rest of `fullname` after its first word, `null` for a one word name.
`company`	string \| null	Company name.
`address1`	string \| null	Primary address line.
`address2`	string \| null	Secondary address line.
`national_id`	string \| null	National ID number.
`neighborhood`	string \| null	Neighborhood name.
`district`	string \| null	District name.
`apartment`	string \| null	Apartment number.
`floor`	string \| null	Floor number.
`state_or_region`	string \| null	State or region.
`city`	string \| null	City.
`commune`	string \| null	Commune.
`province`	string \| null	Province.
`postal_code`	string \| null	Postal or ZIP code.
`phone`	string \| null	Phone number.
`whatsapp`	string \| null	WhatsApp number.
`link`	string \| null	Customer-provided URL.
`color`	string \| null	Customer-selected color (hex).
`note`	string \| null	Customer delivery note.