Skip to Content
StoreOSv0.27.1
Core GraphQL APIReferenceQueries

Sale__invoices

{ 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__invoices(where: CommonPaginationDto): InvoiceWithPagination!

{ 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

where?

Returns

  1. sale__invoices
meta?
nodes?
Example Request
query Sale__invoices {  sale__invoices {    meta {      currentPage      hasNextPage      totalCount      totalPages    }    nodes {      _id      commits {        action        committedAt        note      }      couponCode      couponDiscount      createdAt      customFields {        key        value      }      deliveryArea      deliveryCharge      deliverySubArea      discountTotal    }  }}
Example Response
{  "data": {    "sale__invoices": {      "meta": {        "currentPage": 10.5,        "hasNextPage": true,        "totalCount": 10.5,        "totalPages": 10.5      },      "nodes": [        {          "_id": "1",          "commits": [            {              "action": "string",              "committedAt": "<DateTime>",              "note": "string"            }          ],          "couponCode": "string",          "couponDiscount": 10.5,          "createdAt": "<DateTime>",          "customFields": [            {              "key": "string",              "value": "string"            }          ],          "deliveryArea": "string",          "deliveryCharge": 10.5,          "deliverySubArea": "string",          "discountTotal": 10.5        }      ]    }  }}

Sale__invoice Offers QUERY

Automatic Buy X Get Y offers an editable order qualifies for but doesn't have yet. { 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).

Storefront__custom Domain QUERY

The custom domain connected to this tenant's storefront, if any. { permissions: ['*', 'read'], collectionName: 'storefront__CustomDomain' } Requires a signed-in staff user. Needs the `storefront__CustomDomain` `read` permission. Send the `x-tenant` header (the gateway sets it from your API key).