Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceQueries

Sale__discounts

{ 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).

QUERYsale__discounts(where: CommonPaginationDto): DiscountsWithPagination!

{ 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).

Arguments

where?

Returns

  1. sale__discounts
meta?
nodes?
Example Request
query Sale__discounts {  sale__discounts {    meta {      currentPage      hasNextPage      totalCount      totalPages    }    nodes {      _id      appliesTo {        collectionIds        productIds        scope      }      buyXGetY {        maxUsesPerOrder      }      code      createdAt      endsAt      isActive      isDemo      method      oncePerCustomer    }  }}
Example Response
{  "data": {    "sale__discounts": {      "meta": {        "currentPage": 10.5,        "hasNextPage": true,        "totalCount": 10.5,        "totalPages": 10.5      },      "nodes": [        {          "_id": "1",          "appliesTo": {            "collectionIds": [              "string"            ],            "productIds": [              "string"            ],            "scope": "ALL"          },          "buyXGetY": {            "maxUsesPerOrder": 10          },          "code": "string",          "createdAt": "<DateTime>",          "endsAt": "<DateTime>",          "isActive": true,          "isDemo": true,          "method": "AUTOMATIC",          "oncePerCustomer": true        }      ]    }  }}

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).

Sale__invoice QUERY

{ 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).