Skip to main content
GET
/
purchases
/
{purchase_id}
Get Purchase
curl --request GET \
  --url https://api.example.com/purchases/{purchase_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-key: <x-api-key>'
import requests

url = "https://api.example.com/purchases/{purchase_id}"

headers = {
"x-api-key": "<x-api-key>",
"Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {
method: 'GET',
headers: {'x-api-key': '<x-api-key>', Authorization: 'Bearer <token>'}
};

fetch('https://api.example.com/purchases/{purchase_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/purchases/{purchase_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"x-api-key: <x-api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/purchases/{purchase_id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-api-key", "<x-api-key>")
req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/purchases/{purchase_id}")
.header("x-api-key", "<x-api-key>")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/purchases/{purchase_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "purchase_id": "<string>",
  "date": "<string>",
  "total": "<string>",
  "tax": "<string>",
  "subtotal": "<string>",
  "item_count": 123,
  "items": [
    {
      "item_id": "<string>",
      "price": "<string>",
      "quantity": "<string>",
      "product": {
        "description": "<string>",
        "name": "<string>",
        "upc": "049000028911",
        "product_id": "01J51S0JYV6N7K1030CV1ZKSCA",
        "brand": "diet-coke"
      }
    }
  ]
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Authorizations

Authorization
string
header
required

A connection-specific token with access scope

Headers

x-api-key
string
required

The client's API key secret value

Path Parameters

purchase_id
string
required

Response

Successful Response

purchase_id
string
required

The unique identifier for the purchase

Example:

"01J51S0JYV6N7K1030CV1ZKSCF"

date
string
required

The date and time of the purchase

Example:

"2024-01-01T00:00:00Z"

total
string
required

The total amount of the purchase

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Example:

"9.34"

tax
string
required

The tax amount of the purchase

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Example:

"0.85"

subtotal
string
required

The subtotal amount of the purchase

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Example:

"8.49"

item_count
integer
required

The number of items in the purchase

Example:

1

items
ItemResponse · object[]
required

The list of items in the purchase

Example:
[
{
"item_id": "01J51S0JYV6N7K1030CV1ZKSCA",
"price": "8.49",
"product": {
"brand": "diet-coke",
"description": "Diet Coke - 12pk/12oz cans",
"name": "Diet Coke 12pk",
"product_id": "01J51S0JYV6N7K1030CV1ZKSCB",
"upc": "049000028911"
},
"quantity": 1
}
]