Transactions

Retrieve a transaction

Base for every public v1 endpoint (products, and customers/transactions later) — named for the surface, not any one resource.

get/transactions/{external_id}

Request

  • Base URL: https://api.getsphere.com/v1
  • URL: https://api.getsphere.com/v1/transactions/{external_id}
  • Auth: API key in header X-API-KEY

Path parameters

external_idstring required

The external_id you assigned to the record.

Response

external_idstring required
typestring required
statusstring required
currencystring required
external_reference_numberstring nullable
descriptionstring nullable
customer_idstring nullable
finalized_onstring date-time nullable
original_transaction_idstring nullable
subtotalstring nullable
taxstring nullable
totalstring nullable
invoice_urlstring uri nullable
created_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.