Skip to main content

Get Sales page

GET 
/sales

Returns a paginated list of completed sales for the company resolved from gateway context. The status filter is required; currently the only accepted value is completed. Each sale includes the full positions array. Page size is fixed at 20 items per page.

Request​

Query Parameters

    status stringrequired

    Possible values: [completed]

    Filter sales by fulfillment status. Required. Currently the only accepted value is completed. Additional values may be added in future API versions.

    cursor string

    Possible values: <= 128 characters

    Pagination cursor (opaque token). Invalid or expired cursors yield 400 with code invalid_cursor.

    order_by string

    Possible values: [initiated_at_asc, initiated_at_desc, created_at_asc, created_at_desc, updated_at_asc, updated_at_desc, number_asc, number_desc]

    Default value: initiated_at_desc

    Sort order for returned sales.

    initiated_at_from date-time

    Return only sales with initiated_at ≥ this value (inclusive). ISO 8601 date-time. When combined with initiated_at_to, defines a closed time window.

    initiated_at_to date-time

    Return only sales with initiated_at ≤ this value (inclusive). ISO 8601 date-time. When combined with initiated_at_from, defines a closed time window.

Responses​

OK

Schema

    cursor stringnullable

    Token of the next page of the list. null when there is no next page.

    items

    object[]

    required

  • Array [

    • id uuidrequired

    Sale identifier

    number stringrequired

    Possible values: non-empty and <= 36 characters

    Human-readable sale number

    ticket_number stringnullable

    Possible values: non-empty and <= 16 characters

    Short sequential number (e.g. receipt or table ticket number)

    status PublicSaleFulfillmentStatusDTO (string)required

    Possible values: [completed, unknown]

    Sale fulfillment status

    initiated_at date-timerequired

    Date and time when the sale was initiated

    comment stringnullable

    Possible values: <= 1024 characters

    Free-text comment on the sale

    point_of_sale_id uuidrequired

    Point-of-sale terminal identifier

    initiated_by_id uuidnullable

    Identifier of the employee who initiated the sale; null when not recorded

    external_data

    object

    nullable

    External system reference data; null when the sale has no external system link

    id stringrequired

    Possible values: >= 4 characters and <= 128 characters

    Unique identifier in the external system

    property name* anynullable

    External system reference data; null when the sale has no external system link

    positions

    object[]

    nullable

    required

    Line items included in the sale

  • Array [

    • id uuidrequired

    Position identifier

    name stringrequired

    Possible values: non-empty and <= 512 characters

    Product name at the time of sale

    quantity

    object

    required

    Quantity of a sold item with unit of measure information

    value integerrequired

    Quantity in the smallest unit (divide by 10^exponent to get the real quantity)

    exponent integerrequired

    Possible values: <= 3

    Decimal exponent (e.g. 3 means value is in thousandths)

    uom_id uuidrequired

    Unit of measure identifier; matches id in GET /uoms response

    uom_name stringrequired

    Possible values: >= 2 characters and <= 32 characters

    Unit of measure full name

    uom_symbol stringrequired

    Possible values: non-empty and <= 16 characters

    Unit of measure short display label

    codes

    object[]

    required

    Possible values: <= 20

    Typed identifiers (barcodes and SKUs) of the sold item

  • Array [

    • type stringrequired

    Possible values: [ean_8, ean_13, itf_14, upc_a, sku, other]

    Type of code; use other when the value does not map to a listed barcode or SKU kind.

    value stringrequired

    Possible values: >= 4 characters and <= 128 characters

  • ]

    • catalog_good_id uuidnullable

    Catalog good identifier; null when the position was added without a catalog reference

    catalog_good_variation_id uuidnullable

    Catalog good variation identifier; null when the position was added without a catalog reference

    source stringrequired

    How the position was added. Available values: catalog, manual_input, custom_amount.

    vat

    object

    required

    VAT fee item applied to this position; matches fee_items[] entries returned by GET /fees.

    fee_item_id uuidrequired

    Fee item identifier; matches id in fee_items[].

    fee_item_name stringrequired

    Possible values: >= 2 characters and <= 64 characters

    Fee item display name (e.g. tax rate label).

    fee_item_percentage double

    Possible values: <= 100

    Tax rate in percent (decimal, e.g. 5 or 5.25). Omitted when the fee item is exempt or non-percentage.

    unit_price_including_tax

    object

    required

    Unit price with tax included

    value int64required

    Amount in minimum currency units

    currency_code stringrequired

    ISO 4217 currency code. Available values: AED

    total_price

    object

    required

    Position total after discounts and taxes

    value int64required

    Amount in minimum currency units

    currency_code stringrequired

    ISO 4217 currency code. Available values: AED

    discount_amount

    object

    nullable

    required

    Total discount applied to this position; null when no discount was applied

    value int64required

    Amount in minimum currency units

    currency_code stringrequired

    ISO 4217 currency code. Available values: AED

    taxable_amount

    object

    required

    Amount subject to tax before tax is added

    value int64required

    Amount in minimum currency units

    currency_code stringrequired

    ISO 4217 currency code. Available values: AED

    tax_percentage integernullablerequired

    Possible values: <= 100

    Tax rate in percent; null when the fee is exempt or non-percentage

  • ]

    • totals

    object

    required

    Pre-calculated monetary totals for the entire sale.

    discount

    object

    nullable

    Total discount applied at sale level; null when no sale-level discount was applied

    value int64required

    Amount in minimum currency units

    currency_code stringrequired

    ISO 4217 currency code. Available values: AED

    taxable_amount

    object

    required

    Total amount subject to tax across all positions

    value int64required

    Amount in minimum currency units

    currency_code stringrequired

    ISO 4217 currency code. Available values: AED

    tax

    object

    required

    Total tax amount across all positions

    value int64required

    Amount in minimum currency units

    currency_code stringrequired

    ISO 4217 currency code. Available values: AED

    total

    object

    required

    Final sale total after all discounts and taxes

    value int64required

    Amount in minimum currency units

    currency_code stringrequired

    ISO 4217 currency code. Available values: AED

    created_at date-timerequired

    Date and time when the sale record was created

    updated_at date-timerequired

    Date and time when the sale record was last updated

  • ]

Loading...