Skip to main content
GET
/
transactions
/
{id}
cURL
curl --request GET \
  --url https://development.knotapi.com/transactions/{id} \
  --header 'Authorization: Basic <encoded-value>'
{ "id": "13da3c28-a068-4642-9ce2-b730cfda5f5f", "external_id": "a9x7bq2lmw5p", "datetime": "2024-11-10T00:00:00+00:00", "url": "https://www.example.com/orders/123123123", "order_status": "COMPLETED", "shipping": { "location": { "address": { "line1": "123 Main St", "line2": "Floor 4", "city": "Los Angeles", "region": "CA", "postal_code": "94105", "country": "US" }, "first_name": "Ada", "last_name": "Lovelace" } }, "payment_methods": [ { "external_id": "x7q9m2lbw5pazc", "type": "CARD", "brand": "VISA", "last_four": "5690", "name": "Ada's credit card", "transaction_amount": "23.20" }, { "external_id": "x7q9m2lbw5pazc", "type": "GIFT_CARD", "brand": "VISA", "last_four": "1802", "name": "", "transaction_amount": "20.00" } ], "price": { "sub_total": "43.69", "adjustments": [ { "type": "TAX", "label": "NYC local sales tax", "amount": "3.88" }, { "type": "DISCOUNT", "label": "Summer promo", "amount": "-4.37" } ], "total": "43.20", "currency": "USD" }, "products": [ { "external_id": "10315643", "gtin": "00381370044536", "name": "Band-Aid Adhesive Bandages Variety Pack", "description": "A convenient assortment of durable adhesive bandages designed to protect minor cuts and scrapes. Featuring a range of sizes for everyday first-aid needs, each bandage cushions the wound while helping keep out dirt and germs. Made to stay securely in place with a gentle adhesive, this variety pack is ideal for home, travel, school, or on-the-go care.", "category": "CATEGORY1", "url": "https://www.example.com/ip/10315643", "image_url": "https://storage.googleapis.com/txn-product-images/doordash/33972462636.jpg", "quantity": 1, "price": { "sub_total": "12.56", "total": "12.56", "unit_price": "12.56" }, "seller": null, "eligibility": [ "FSA/HSA" ] }, { "external_id": "1031891", "gtin": "00078731878120", "name": "Dixie Ultra 8-12 Paper Plate, 240-count", "description": "", "category": "CATEGORY2", "url": "https://www.example.com/ip/1031891", "image_url": "https://storage.googleapis.com/txn-product-images/doordash/33972462636.jpg", "quantity": 1, "price": { "sub_total": "8.14", "total": "8.14", "unit_price": "8.14" }, "seller": null, "eligibility": [] }, { "external_id": "1038973", "gtin": "00651277430015", "name": "4Pairs Men's Elite Sports Socks Athletic Crew Socks Mid-calf Boys for Football, Basketball, Running Soccer", "description": "High-performance athletic crew socks designed for comfort, support, and durability during intense activity. Made with breathable, moisture-wicking fabric to help keep feet dry, with reinforced heels and toes for added strength.", "category": "CATEGORY3", "url": "https://www.example.com/ip/1038973", "image_url": "https://storage.googleapis.com/txn-product-images/doordash/33972462636.jpg", "quantity": 1, "price": { "sub_total": "22.99", "total": "22.99", "unit_price": "22.99" }, "seller": { "name": "KingCamp Outdoor Products Co., Ltd.", "url": "https://www.example.com/browse/kingcamp/YnJhbmQ6S2luZ0NhbXAie" }, "eligibility": [] } ], "loyalty_membership": { "tier": "Walmart+ Assist" } }

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

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

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.