Skip to main content
GET
/
2022-06-09
/
orders
/
{orderId}
Get Order
curl --request GET \
  --url https://staging.crossmint.com/api/2022-06-09/orders/{orderId} \
  --header 'X-API-KEY: <api-key>'
import requests

url = "https://staging.crossmint.com/api/2022-06-09/orders/{orderId}"

headers = {"X-API-KEY": "<api-key>"}

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

print(response.text)
const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://staging.crossmint.com/api/2022-06-09/orders/{orderId}', 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://staging.crossmint.com/api/2022-06-09/orders/{orderId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <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://staging.crossmint.com/api/2022-06-09/orders/{orderId}"

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

	req.Header.Add("X-API-KEY", "<api-key>")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://staging.crossmint.com/api/2022-06-09/orders/{orderId}")
  .header("X-API-KEY", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://staging.crossmint.com/api/2022-06-09/orders/{orderId}")

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

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "orderId": "b2959ca5-65e4-466a-bd26-1bd05cb4f837",
  "phase": "payment",
  "locale": "en-US",
  "lineItems": [
    {
      "chain": "polygon-amoy",
      "quantity": 1,
      "callData": {
        "quantity": 1,
        "ADDITIONAL_PROPERTIES": "Your other mint function arguments"
      },
      "metadata": {
        "name": "Headless Checkout Demo",
        "description": "NFT Description",
        "imageUrl": "https://cdn.io/image.png"
      },
      "quote": {
        "status": "valid",
        "charges": {
          "unit": {
            "amount": "0.0001",
            "currency": "eth"
          },
          "salesTax": {
            "amount": "0.34",
            "currency": "usdc"
          },
          "shipping": {
            "amount": "0",
            "currency": "usdc"
          }
        },
        "totalPrice": {
          "amount": "0.0001",
          "currency": "eth"
        }
      },
      "delivery": {
        "status": "awaiting-payment",
        "recipient": {
          "locator": "email:<email_address>:<chain>",
          "email": "testy@crossmint.com",
          "walletAddress": "0x1234abcd..."
        },
        "txId": "0x2e69f11dae7869b92e3d5eaf4cadd50c48b5c6803d1232815f979d744521ad4c",
        "tokens": [
          {
            "locator": "polygon:0xE04Cf294985282Ddc088E6433c064cfB85eD9EdA:3",
            "contractAddress": "0xE04Cf294985282Ddc088E6433c064cfB85eD9EdA",
            "tokenId": "3",
            "mintHash": "MintHashAbc123",
            "quantity": "1500000",
            "symbol": "USDC",
            "decimals": 6
          }
        ]
      }
    }
  ],
  "quote": {
    "status": "valid",
    "quotedAt": "2024-06-07T16:55:44.653Z",
    "expiresAt": "2024-06-07T17:55:44.653Z",
    "totalPrice": {
      "amount": "0.0001375741",
      "currency": "eth"
    }
  },
  "payment": {
    "status": "awaiting-payment",
    "method": "base-sepolia",
    "currency": "eth",
    "preparation": {
      "chain": "base-sepolia",
      "payerAddress": "0x1234abcd...",
      "serializedTransaction": "0x02f90....."
    }
  }
}
{
  "error": true,
  "message": "<string>",
  "parameters": {
    "amount": "<string>",
    "limit": "<string>",
    "hoursUntilReset": "<string>",
    "remainingAmount": "<string>"
  }
}
{
  "error": true,
  "message": "Malformed API key. / API key provided doesn't have required scopes."
}
{
  "error": true,
  "message": "Not found"
}
{
  "error": true,
  "message": "Please try again in a few minutes. If the issue still persists, contact Crossmint support."
}
{
  "error": true,
  "message": "A timeout occurred."
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
orderId
string
required

This is the identifier for the order with UUID format.

Example: 9c82ef99-617f-497d-9abb-fd355291681b

Response

Order successfully created.

​
orderId
string
Example:

"b2959ca5-65e4-466a-bd26-1bd05cb4f837"

​
phase
string
Example:

"payment"

​
locale
string
Example:

"en-US"

​
lineItems
object[]
​
quote
object
​
payment
object