Sales

Receipt of a Sales Transaction

Request

Reads one sale document at the specified Location. For a membership with a nonzero goods_transaction_id, first retrieve that goods transaction to get its document_id. The caller needs Location access and, for a sale document, Inventory access. The sale state contains items and payment transactions; it is not a single membership purchase amount. Match document and item IDs before attributing any payment to a membership.

Security

BearerPartnerUser

Path

document_idintegerrequired

Sales Document ID

location_idnumberrequired

Location ID

Query

includeArray of strings

Optional list of extra blocks to include in the response. Repeat as include[]=<value>. Supported values include state, state.items, state.loyalty_transactions, state.payment_transactions, state.deposit_holds, kkm_state, and payment_methods. Request state.deposit_holds to receive the prepaid holds associated with the sale, including active and completed holds.

Acceptstringrequired

e.g. application/vnd.api.v2+json

Example:application/vnd.api.v2+json

Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

curl -i -X GET \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/locations/{location_id}/sale/{document_id}?include=string' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: string'

Responses

OK

Bodyapplication/json

successboolean

Execution success status (true)

Example:true

dataobject

Object with data

Example:

{
  "state": {
    "items": [ … ],
    "deposit_holds": [ … ],
    "loyalty_transactions": [ … ],
    "payment_transactions": [ … ]
  },
  "kkm_state": {
    "last_operation_type": 1,
    "transactions": [ … ]
  },
  "payment_methods": [
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}

metaArray of objects

Metadata (empty array)