Python
import os, sodacards
config = sodacards.Configuration(host="https://api.sodacards.com")
config.api_key["ApiKeyAuth"] = os.environ["SODACARDS_API_KEY"]
client = sodacards.DefaultApi(sodacards.ApiClient(config))
codes = client.reveal_order_codes("ord_123")import { Sodacards } from "@sodacards/sdk";
const sodacards = new Sodacards({ apiKeyAuth: process.env.SODACARDS_API_KEY });
const codes = await sodacards.revealOrderCodes({ orderId: "ord_123" });client := sodacards.NewAPIClient(sodacards.NewConfiguration())
auth := context.WithValue(context.Background(), sodacards.ContextAPIKeys,
map[string]sodacards.APIKey{"ApiKeyAuth": {Key: os.Getenv("SODACARDS_API_KEY")}})
codes, _, err := client.DefaultAPI.RevealOrderCodes(auth, "ord_123").Execute()$config = Sodacards\Configuration::getDefaultConfiguration()
->setApiKey('X-API-Key', getenv('SODACARDS_API_KEY'));
$client = new Sodacards\Api\DefaultApi(new GuzzleHttp\Client(), $config);
$codes = $client->revealOrderCodes("ord_123");curl --request GET \
--url https://api.sodacards.com/v1/orders/{order_id}/codes \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.sodacards.com/v1/orders/{order_id}/codes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://api.sodacards.com/v1/orders/{order_id}/codes")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sodacards.com/v1/orders/{order_id}/codes")
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{
"codes": [
{
"label": "<string>",
"code": "<string>"
}
]
}API Reference
RevealOrderCodes
RevealOrderCodes returns the delivered codes of a completed order. Codes are available once the order is completed; a still-processing order reports that it is not ready. Reveals are rate-limited per order.
GET
/
v1
/
orders
/
{order_id}
/
codes
Python
import os, sodacards
config = sodacards.Configuration(host="https://api.sodacards.com")
config.api_key["ApiKeyAuth"] = os.environ["SODACARDS_API_KEY"]
client = sodacards.DefaultApi(sodacards.ApiClient(config))
codes = client.reveal_order_codes("ord_123")import { Sodacards } from "@sodacards/sdk";
const sodacards = new Sodacards({ apiKeyAuth: process.env.SODACARDS_API_KEY });
const codes = await sodacards.revealOrderCodes({ orderId: "ord_123" });client := sodacards.NewAPIClient(sodacards.NewConfiguration())
auth := context.WithValue(context.Background(), sodacards.ContextAPIKeys,
map[string]sodacards.APIKey{"ApiKeyAuth": {Key: os.Getenv("SODACARDS_API_KEY")}})
codes, _, err := client.DefaultAPI.RevealOrderCodes(auth, "ord_123").Execute()$config = Sodacards\Configuration::getDefaultConfiguration()
->setApiKey('X-API-Key', getenv('SODACARDS_API_KEY'));
$client = new Sodacards\Api\DefaultApi(new GuzzleHttp\Client(), $config);
$codes = $client->revealOrderCodes("ord_123");curl --request GET \
--url https://api.sodacards.com/v1/orders/{order_id}/codes \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.sodacards.com/v1/orders/{order_id}/codes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://api.sodacards.com/v1/orders/{order_id}/codes")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sodacards.com/v1/orders/{order_id}/codes")
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{
"codes": [
{
"label": "<string>",
"code": "<string>"
}
]
}Authorizations
Your API key, prefixed sc_live_ or sc_test_.
Path Parameters
order_id is the order whose codes to reveal.
Response
200 - application/json
Success
codes are the delivered codes of the order.
Show child attributes
Show child attributes
⌘I