Get Sale by id

GET 
/sales/:sale_id

Returns a single completed sale by identifier, including the full positions array. Returns 404 when the sale is not found or has a status other than completed within the resolved company scope.

Request

Path Parameters

sale_id uuidrequired

Sale identifier

Responses

200

OK

application/json

Schema

Schema

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 linked to this entity.

id stringrequired

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

Unique identifier in the external system

property name* any

External system reference data linked to this entity.

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 for the good (all variations share the same item). Values align with the matching entry in GET /fees → fee_items[] for fee_item_id.

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

Price (amount + currency). Is used to represent monetary amounts in various currencies. The minimum value includes 0.

value int64required

Amount in minimum currency units

currency_code stringrequired

ISO 4217 currency code. Available values: AED

total_price

object

required

Price (amount + currency). Is used to represent monetary amounts in various currencies. The minimum value includes 0.

value int64required

Amount in minimum currency units

currency_code stringrequired

ISO 4217 currency code. Available values: AED

discount_amount

object

nullable

required

Price (amount + currency). Is used to represent monetary amounts in various currencies. The minimum value includes 0.

value int64required

Amount in minimum currency units

currency_code stringrequired

ISO 4217 currency code. Available values: AED

taxable_amount

object

required

Price (amount + currency). Is used to represent monetary amounts in various currencies. The minimum value includes 0.

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

Price (amount + currency). Is used to represent monetary amounts in various currencies. The minimum value includes 0.

value int64required

Amount in minimum currency units

currency_code stringrequired

ISO 4217 currency code. Available values: AED

taxable_amount

object

required

Price (amount + currency). Is used to represent monetary amounts in various currencies. The minimum value includes 0.

value int64required

Amount in minimum currency units

currency_code stringrequired

ISO 4217 currency code. Available values: AED

tax

object

required

Price (amount + currency). Is used to represent monetary amounts in various currencies. The minimum value includes 0.

value int64required

Amount in minimum currency units

currency_code stringrequired

ISO 4217 currency code. Available values: AED

total

object

required

Price (amount + currency). Is used to represent monetary amounts in various currencies. The minimum value includes 0.

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

Example (from schema)

{
  "id": "bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb",
  "number": "0006-0973-152658",
  "ticket_number": "T1-4",
  "status": "completed",
  "initiated_at": "2026-07-28T10:03:43.317Z",
  "comment": "Deliver to the address",
  "point_of_sale_id": "cccccccc-cccc-4ccc-8ccc-cccccccccccc",
  "initiated_by_id": "eeeeeeee-eeee-4eee-8eee-eeeeeeeeeeee",
  "external_data": {
    "id": "external-system-id-001"
  },
  "positions": [
    {
      "id": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
      "name": "Grande Latte",
      "quantity": {
        "value": 500,
        "exponent": 3,
        "uom_id": "33333333-3333-4333-8333-333333333333",
        "uom_name": "Kilogram",
        "uom_symbol": "kg"
      },
      "codes": [
        {
          "type": "ean_8",
          "value": "string"
        }
      ],
      "catalog_good_id": "11111111-1111-4111-8111-111111111111",
      "catalog_good_variation_id": "22222222-2222-4222-8222-222222222222",
      "source": "catalog",
      "vat": {
        "fee_item_id": "66666666-6666-4666-8666-666666666666",
        "fee_item_name": "5%",
        "fee_item_percentage": 5
      },
      "unit_price_including_tax": {
        "value": 100,
        "currency_code": "AED"
      },
      "total_price": {
        "value": 100,
        "currency_code": "AED"
      },
      "discount_amount": {
        "value": 100,
        "currency_code": "AED"
      },
      "taxable_amount": {
        "value": 100,
        "currency_code": "AED"
      },
      "tax_percentage": 5
    }
  ],
  "totals": {
    "discount": {
      "value": 100,
      "currency_code": "AED"
    },
    "taxable_amount": {
      "value": 100,
      "currency_code": "AED"
    },
    "tax": {
      "value": 100,
      "currency_code": "AED"
    },
    "total": {
      "value": 100,
      "currency_code": "AED"
    }
  },
  "created_at": "2026-07-28T10:03:43.319Z",
  "updated_at": "2026-07-28T10:03:43.319Z"
}

400

Bad request — malformed syntax, invalid parameters, or failed validation. Typical code values: validation_error, invalid_request. List endpoints that accept a cursor parameter additionally return invalid_cursor when the cursor is invalid or expired.

application/problem+json

Schema

Schema

title stringrequired

Short human-readable summary

type stringrequired

URI reference identifying the problem category

instance stringnullable

URI reference identifying the specific request that caused this error (e.g. the request path).

trace_id stringrequired

Correlation id for support (report when contacting support)

status int32required

HTTP status code

code stringrequired

Machine-readable code for client branching

detail stringnullable

Human-readable explanation (optional)

reason string

Stable extension when code is existing_entity_conflict. For a duplicate external_data.id within the company, the value is duplicate_external_data_id.

errors

object

nullable

Present when code is validation_error. Keys are field names; values are arrays of human-readable error messages for that field.

property name*

string[]

nullable

Array [

string

]

Example (from schema)

{
  "title": "string",
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "instance": "/api/catalog/goods/regular",
  "trace_id": "00-84c1fd4063c38d9f3900d06e56542d48-85d1d4-00",
  "status": 0,
  "code": "validation_error",
  "detail": "string",
  "reason": "duplicate_external_data_id",
  "errors": {
    "uom_id": [
      "'uom_id' must not be empty."
    ],
    "vat": [
      "'vat' must not be empty."
    ],
    "variations": [
      "'variations' must contain between 1 and 150 items."
    ]
  }
}

validation

{
  "title": "One or more errors occurred.",
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "trace_id": "00-00000000000000000000000000000000-00000000-00",
  "status": 400,
  "instance": "/api/catalog/goods/regular",
  "code": "validation_error",
  "errors": {
    "name": [
      "'name' must not be empty."
    ]
  }
}

401

Missing or invalid credentials before the gateway forwards context (when applicable). The response has no body (empty payload).

403

Caller is not allowed to access this resource or company. The response has no body (empty payload).

404

Resource not found or not visible for the resolved company. The response has no body (empty payload).

429

Rate limit exceeded.

Response Headers

• Retry-After

  integer

  Seconds to wait before retrying

application/problem+json

Schema

Schema

title stringrequired

Short human-readable summary

type stringrequired

URI reference identifying the problem category

instance stringnullable

URI reference identifying the specific request that caused this error (e.g. the request path).

trace_id stringrequired

Correlation id for support (report when contacting support)

status int32required

HTTP status code

code stringrequired

Machine-readable code for client branching

detail stringnullable

Human-readable explanation (optional)

reason string

Stable extension when code is existing_entity_conflict. For a duplicate external_data.id within the company, the value is duplicate_external_data_id.

errors

object

nullable

Present when code is validation_error. Keys are field names; values are arrays of human-readable error messages for that field.

property name*

string[]

nullable

Array [

string

]

Example (from schema)

{
  "title": "string",
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "instance": "/api/catalog/goods/regular",
  "trace_id": "00-84c1fd4063c38d9f3900d06e56542d48-85d1d4-00",
  "status": 0,
  "code": "validation_error",
  "detail": "string",
  "reason": "duplicate_external_data_id",
  "errors": {
    "uom_id": [
      "'uom_id' must not be empty."
    ],
    "vat": [
      "'vat' must not be empty."
    ],
    "variations": [
      "'variations' must contain between 1 and 150 items."
    ]
  }
}

rateLimit

{
  "title": "Too Many Requests",
  "type": "https://tools.ietf.org/html/rfc6585#section-4",
  "trace_id": "00-00000000000000000000000000000000-00000000-00",
  "status": 429,
  "code": "unexpected_error"
}

500

Unexpected server error.

application/problem+json

Schema

Schema

title stringrequired

Short human-readable summary

type stringrequired

URI reference identifying the problem category

instance stringnullable

URI reference identifying the specific request that caused this error (e.g. the request path).

trace_id stringrequired

Correlation id for support (report when contacting support)

status int32required

HTTP status code

code stringrequired

Machine-readable code for client branching

detail stringnullable

Human-readable explanation (optional)

reason string

Stable extension when code is existing_entity_conflict. For a duplicate external_data.id within the company, the value is duplicate_external_data_id.

errors

object

nullable

Present when code is validation_error. Keys are field names; values are arrays of human-readable error messages for that field.

property name*

string[]

nullable

Array [

string

]

Example (from schema)

{
  "title": "string",
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "instance": "/api/catalog/goods/regular",
  "trace_id": "00-84c1fd4063c38d9f3900d06e56542d48-85d1d4-00",
  "status": 0,
  "code": "validation_error",
  "detail": "string",
  "reason": "duplicate_external_data_id",
  "errors": {
    "uom_id": [
      "'uom_id' must not be empty."
    ],
    "vat": [
      "'vat' must not be empty."
    ],
    "variations": [
      "'variations' must contain between 1 and 150 items."
    ]
  }
}

unexpected

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.6.1",
  "trace_id": "00-00000000000000000000000000000000-00000000-00",
  "status": 500,
  "code": "internal_server_error"
}

503

Service temporarily unavailable.

application/problem+json

Schema

Schema

title stringrequired

Short human-readable summary

type stringrequired

URI reference identifying the problem category

instance stringnullable

URI reference identifying the specific request that caused this error (e.g. the request path).

trace_id stringrequired

Correlation id for support (report when contacting support)

status int32required

HTTP status code

code stringrequired

Machine-readable code for client branching

detail stringnullable

Human-readable explanation (optional)

reason string

Stable extension when code is existing_entity_conflict. For a duplicate external_data.id within the company, the value is duplicate_external_data_id.

errors

object

nullable

Present when code is validation_error. Keys are field names; values are arrays of human-readable error messages for that field.

property name*

string[]

nullable

Array [

string

]

Example (from schema)

{
  "title": "string",
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "instance": "/api/catalog/goods/regular",
  "trace_id": "00-84c1fd4063c38d9f3900d06e56542d48-85d1d4-00",
  "status": 0,
  "code": "validation_error",
  "detail": "string",
  "reason": "duplicate_external_data_id",
  "errors": {
    "uom_id": [
      "'uom_id' must not be empty."
    ],
    "vat": [
      "'vat' must not be empty."
    ],
    "variations": [
      "'variations' must contain between 1 and 150 items."
    ]
  }
}

unavailable

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.6.4",
  "trace_id": "00-00000000000000000000000000000000-00000000-00",
  "status": 503
}

Loading...