Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceQueries

Sale__abandoned Carts

{ collectionName: 'sale__Invoice', permissions: ['*', 'read'], } Requires a signed-in staff user. Needs the `sale__Invoice` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).

QUERYsale__abandonedCarts(limit: Int, page: Int, search: String, sort: String, sortBy: String): CartWithPagination!

{ collectionName: 'sale__Invoice', permissions: ['*', 'read'], } Requires a signed-in staff user. Needs the sale__Invoice read permission. Send the x-tenant header (the gateway sets it from your API key).

Arguments

limit?Int
page?Int
search?String
sort?String
sortBy?String

Returns

  1. sale__abandonedCarts
meta?
nodes?
Example Request
query Sale__abandonedCarts {  sale__abandonedCarts {    meta {      currentPage      hasNextPage      totalCount      totalPages    }    nodes {      _id      abandonedAt      cartId      contact {        email        name        phoneNumber      }      convertedInvoiceUID      createdAt      customerId      ip      lastActiveAt      lineItems {        offerId        productId        quantity        variantId      }    }  }}
Example Response
{  "data": {    "sale__abandonedCarts": {      "meta": {        "currentPage": 10.5,        "hasNextPage": true,        "totalCount": 10.5,        "totalPages": 10.5      },      "nodes": [        {          "_id": "1",          "abandonedAt": "<DateTime>",          "cartId": "string",          "contact": {            "email": "string",            "name": "string",            "phoneNumber": "string"          },          "convertedInvoiceUID": "string",          "createdAt": "<DateTime>",          "customerId": "string",          "ip": "string",          "lastActiveAt": "<DateTime>",          "lineItems": [            {              "offerId": "string",              "productId": "1",              "quantity": 10,              "variantId": "string"            }          ]        }      ]    }  }}

Report__stock Report QUERY

Current stock mix plus movements in the selected dates. Optional from/to (YYYY-MM-DD). Stock levels are a live snapshot. Requires a signed-in staff user. Needs the `report__Analytics` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).

Sale__discount QUERY

{ collectionName: 'sale__Discount', permissions: ['*', 'read'], } Requires a signed-in staff user. Needs the `sale__Discount` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).