> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getruba.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Read Order Receipt
> ### Intent
Reads the order receipt without changing it.
### When to call it
Call this after your application has received or stored the identifier for the order receipt.
### Access boundary
Authorize the request with a token that carries `customer_portal:read` or `customer_portal:write`.
### Successful result
A successful request returns `200`, `202`. The response schema below defines the body your integration receives.
export const RubaSocials = () => {
if (typeof document === "undefined") {
return null;
}
const inject = () => {
const footer = document.getElementById("footer");
if (!footer || document.getElementById("ruba-socials")) {
return false;
}
const isDark = document.querySelector("html.dark") || document.querySelector('html[class*="dark"]');
const lineColor = isDark ? "#383838" : "#e8e8ed";
const iconColor = isDark ? "#8e8e93" : "#86868b";
const markColor = isDark ? "#ffffff" : "#08080c";
const hoverColor = "#0071e3";
const div = document.createElement("div");
div.id = "ruba-socials";
div.style.cssText = `display:flex;align-items:center;gap:20px;padding-top:20px;margin-top:20px;border-top:1px solid ${lineColor};width:100%`;
const logo = `Ruba`;
const spacer = ``;
const ig = ``;
const li = ``;
const x = ``;
const github = ``;
div.innerHTML = logo + spacer + ig + li + x + github;
footer.appendChild(div);
return true;
};
if (!document.documentElement.dataset.rubaSocialsObserver) {
document.documentElement.dataset.rubaSocialsObserver = "true";
const observer = new MutationObserver(() => {
if (!document.getElementById("ruba-socials")) {
inject();
}
});
observer.observe(document.body, {
childList: true,
subtree: true
});
}
setTimeout(() => {
if (!inject()) {
const interval = setInterval(() => {
if (inject()) {
clearInterval(interval);
}
}, 500);
setTimeout(() => clearInterval(interval), 10000);
}
}, 300);
return null;
};
## OpenAPI
````yaml get /v1/customer-portal/orders/{id}/receipt
openapi: 3.1.0
info:
title: Ruba API
summary: Ruba HTTP and Webhooks API
description: '**Details:** Read the docs at https://docs.getruba.com/api-reference.'
version: 2026-04
servers:
- url: https://api.getruba.com
description: '**Details:** Production environment.'
x-speakeasy-server-id: production
- url: https://sandbox-api.getruba.com
description: '**Details:** Sandbox environment.'
x-speakeasy-server-id: sandbox
security: []
tags:
- name: public
description: >-
**Details:** Endpoints shown and documented in the Ruba API documentation
and available in our SDKs.
- name: private
description: >-
**Details:** Endpoints that should appear in the schema only in
development to generate our internal JS SDK.
paths:
/v1/customer-portal/orders/{id}/receipt:
get:
tags:
- customer_portal
- orders
- public
summary: Read Order Receipt
description: >-
### Intent
Reads the order receipt without changing it.
### When to call it
Call this after your application has received or stored the identifier
for the order receipt.
### Access boundary
Authorize the request with a token that carries `customer_portal:read`
or `customer_portal:write`.
### Successful result
A successful request returns `200`, `202`. The response schema below
defines the body your integration receives.
operationId: customer_portal:orders:receipt
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid4
description: Identifier of the order.
title: Id
description: Identifier of the order.
responses:
'200':
description: Request completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerOrderReceipt'
'202':
description: '**Response:** Receipt generation in progress.'
'404':
description: '**Response:** Order could not be found.'
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFound'
'422':
description: Request validation failed
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- customer_session:
- customer_portal:read
- customer_portal:write
- member_session:
- customer_portal:read
- customer_portal:write
components:
schemas:
CustomerOrderReceipt:
properties:
url:
type: string
title: Url
description: '**Url:** URL to the receipt PDF.'
type: object
required:
- url
title: CustomerOrderReceipt
description: Order's receipt data.
ResourceNotFound:
properties:
error:
type: string
const: ResourceNotFound
title: Error
examples:
- ResourceNotFound
detail:
type: string
title: Detail
type: object
required:
- error
- detail
title: ResourceNotFound
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
securitySchemes:
customer_session:
type: http
description: >-
**Authentication:** Customer session tokens authenticate buyers within
your organization. Generate one through the [customer session
operation](/api-reference/customer-portal/sessions/create).
scheme: bearer
member_session:
type: http
description: >-
**Authentication:** Member session tokens authenticate team members
within a customer account. Generate one through the [member session
operation](/api-reference/member-portal/sessions/create).
scheme: bearer
````