Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password. Use your client_id as the username and your secret as the password value.

Path Parameters

id
string
required

UUID for a transaction provided in the UPDATED_TRANSACTIONS_AVAILABLE webhook.

Example:

"13da3c28-a068-4642-9ce2-b730cfda5f5f"

Response

Successful request.

id
string

UUID for the transaction. It is best practice to deduplicate on this value.

Example:

"13da3c28-a068-4642-9ce2-b730cfda5f5f"

external_id
string | null

External identifier for the transaction provided by the merchant.

Example:

"a9x7bq2lmw5p"

datetime
string<date-time>

Timestamp of the transaction in UTC. ISO 8601 format. Note that Knot does not guarantee a specific order in which transactions are returned.

Example:

"2024-11-10T00:00:00+00:00"

url
string | null

URL associated with the transaction.

Example:

"https://www.example.com/orders/123123123"

order_status
enum<string>

Status of the order associated with the transaction.

Available options:
ORDERED,
BILLED,
SHIPPED,
DELIVERED,
RETURNED,
REFUNDED,
CANCELLED,
FAILED,
COMPLETED,
PICKED_UP,
UNRECOGNIZED
Example:

"COMPLETED"

shipping
object · null · null

Shipping information for the transaction, including the recipient's name and delivery address. null when no shipping data is available.

payment_methods
object[]

List of payment methods.

price
object
products
object[]
loyalty_membership
object · null · null

Loyalty membership information for the merchant account, not necessarily related to the specific transaction. When null, the merchant account does not have the loyalty membership.