API version: unstable
API version: 2021-07 Release candidate
API version: 2021-04 Latest
API version: 2021-01
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

Sale object

Version unstable

An auto-generated type for paginating through multiple Sales.

Fields

Types that return Sale

Version unstable

An auto-generated type which holds one Sale and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (Sale!)

    The item at the end of SaleEdge.

Types that return Sale

Version unstable

An individual sale record associated with a sales agreement.

Fields

  • actionType (SaleActionType!)

    The type of order action that the sale represents.

  • id (ID!)

    The unique identifier for the sale.

  • lineType (SaleLineType!)

    The line type assocated with the sale.

  • quantity (Int)

    The number of units either ordered or intended to be returned.

  • taxes ([SaleTax!]!)

    All individual taxes associated with the sale.

  • totalAmount (MoneyBag!)

    The total sale amount after taxes and discounts.

  • totalDiscountAmountAfterTaxes (MoneyBag!)

    The total discounts allocated to the line item after taxes.

  • totalDiscountAmountBeforeTaxes (MoneyBag!)

    The total discounts allocated to the line item before taxes.

  • totalTaxAmount (MoneyBag!)

    The total amount of taxes for the sale.

Types that implement Sale

Version 2021-07 (Release candidate)

An auto-generated type for paginating through multiple Sales.

On this page

Fields

Version 2021-07 (Release candidate)

An auto-generated type which holds one Sale and a cursor during pagination.

Fields

  • cursor (String!)

    A cursor for use in pagination.

  • node (Sale!)

    The item at the end of SaleEdge.

Types that return SaleEdge

Version 2021-07 (Release candidate)

An individual sale record associated with a sales agreement.

Fields

  • actionType (SaleActionType!)

    The type of order action that the sale represents.

  • id (ID!)

    The unique identifier for the sale.

  • lineType (SaleLineType!)

    The line type assocated with the sale.

  • quantity (Int)

    The number of units either ordered or intended to be returned.

  • taxes ([SaleTax!]!)

    All individual taxes associated with the sale.

  • totalAmount (MoneyBag!)

    The total sale amount after taxes and discounts.

  • totalDiscountAmountAfterTaxes (MoneyBag!)

    The total discounts allocated to the line item after taxes.

  • totalDiscountAmountBeforeTaxes (MoneyBag!)

    The total discounts allocated to the line item before taxes.

  • totalTaxAmount (MoneyBag!)

    The total amount of taxes for the sale.

Types that implement Sale