Get Sales Data by SalesId

This endpoint is for fetching the details of a sale.

Request

Security:

JWT

path Parameters

saleId

required

string

header Parameters

Authorization

required

string

Default: Bearer {$$.env.access_token}

Responses

200

The sales response

404

When the provided saleId does not match a Sale stored in the system.

get/sales/{saleId}

Request samples

curl
C#
Node.js

curl -i -X GET \
  'https://api.tyro.com/connect/sales/{saleId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Response samples

application/json

{"version": 69,
"locationId": "luna-park",
"origin": {"saleId": "SaleId"
},
"source": {"type": "MEANDU"
},
"type": "SALE",
"status": "CLOSED",
"openedZonedDateTime": "2018-05-02T08:28:13+10:00",
"closedZonedDateTime": "2018-05-02T08:28:13+10:00",
"staff": {"id": "8675309"
},
"bookingId": "6dca53a9-04c7-46aa-991c-cfdf51a8f652",
"items": [{"id": "DRINK-123",
"name": "Diet Soda",
"sku": "1123581321",
"unitPrice": {"amount": 123,
"currency": "AUD"
},
"unitPriceTax": {"amount": 123,
"currency": "AUD"
},
"quantity": 3,
"tax": {"amount": 369,
"currency": "AUD"
},
"total": {"amount": 369,
"currency": "AUD"
}
}
],
"payments": [{"acquirer": {"name": "TYRO",
"transactionReference": "88888888-4444-4444-4444-121212121212",
"terminalId": "57"
},
"method": "EFTPOS",
"type": "SALE",
"goodsAndServicesAmount": {"amount": 123,
"currency": "AUD"
}
}
],
"tax": {"amount": 123,
"currency": "AUD"
},
"total": {"amount": 369,
"currency": "AUD"
},
"table": {"seats": 1,
"number": "11"
},
"subtotal": {"amount": 369,
"currency": "AUD"
}
}