@izak0s/spacebring-api - v7.1.0
    Preparing search index...

    Interface GetOrdersQuery

    Query parameters for sb.shop.orders.list().

    interface GetOrdersQuery {
        categoryRef?: string;
        "createDate[gte]"?: string;
        "createDate[lte]"?: string;
        customerRef?: string;
        limit?: number;
        locationRef?: string;
        nextPageToken?: string;
        productRef?: string;
        status?: string;
        userRef?: string;
    }
    Index
    categoryRef? createDate[gte]? createDate[lte]? customerRef? limit? locationRef? nextPageToken? productRef? status? userRef?
    categoryRef?: string

    Comma-separated shop category UUIDs used to filter orders, e.g. uuid1,uuid2.

    "createDate[gte]"?: string

    Filter orders created on or after this date (ISO 8601). Use with createDate[lte] for a range.

    "createDate[lte]"?: string

    Filter orders created on or before this date (ISO 8601). Use with createDate[gte] for a range.

    customerRef?: string

    UUID of the customer whose orders to list.

    limit?: number

    Maximum number of orders per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100.

    locationRef?: string

    UUID of the location whose orders to list.

    nextPageToken?: string

    Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page.

    productRef?: string

    Comma-separated product UUIDs used to filter orders, e.g. uuid1,uuid2.

    status?: string

    Filter by order status. Comma-separated values, e.g. new,inProgress. Defaults to new, inProgress, and completed when omitted.

    Supported values:

    • new — placed, awaiting fulfillment
    • inProgress — being fulfilled
    • completed — fulfilled
    • canceled — canceled
    userRef?: string

    UUID of the user whose orders to list.

    Settings
    Member Visibility

    On This Page
    Properties