Get order by ID
curl --request GET \
--url https://api.opencals.com/storefront/orders/{orderId}import requests
url = "https://api.opencals.com/storefront/orders/{orderId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.opencals.com/storefront/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://api.opencals.com/storefront/orders/{orderId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.opencals.com/storefront/orders/{orderId}"
req, _ := http.NewRequest("GET", url, nil)
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.opencals.com/storefront/orders/{orderId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.opencals.com/storefront/orders/{orderId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": "<string>",
"paymentCurrencyCode": "123e4567-e89b-12d3-a456-426614174000",
"taxesIncluded": "123e4567-e89b-12d3-a456-426614174000",
"externalId": "shop123_order_456",
"externalName": "#1001",
"name": "1001",
"customerId": "123e4567-e89b-12d3-a456-426614174000",
"storeId": "store-uuid",
"cartId": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2023-06-01T10:30:00Z",
"updatedAt": "2023-06-02T14:15:00Z",
"deletedAt": "2023-06-03T09:45:00Z",
"subtotal": 249.99,
"total": 249.99,
"totalTax": 249.99,
"dueToPay": 249.99,
"paidTotal": 249.99,
"refundedTotal": 249.99,
"balance": 249.99,
"dueToRefund": 249.99,
"isFullyPaid": false,
"isFullyRefunded": false,
"paymentStatus": "paid",
"refundStatus": "partially-refunded",
"fulfillmentStatus": "partially-fulfilled",
"customer": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalId": "1234567890",
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"phone": "+12135550123",
"password": "<string>",
"storeId": "store-uuid",
"language": "en",
"createdAt": "2023-01-15T10:30:00Z",
"updatedAt": "2023-02-20T14:15:00Z",
"emailVerifiedAt": "2023-01-02T00:00:00Z",
"deletedAt": "2023-06-03T09:45:00Z",
"isEmailVerified": true,
"isPasswordSet": true
},
"lineItems": [
{
"orderId": "550e8400-e29b-41d4-a716-446655440000",
"appointmentId": "550e8400-e29b-41d4-a716-446655440000",
"externalId": "12345678",
"originalUnitPrice": 249.99,
"discountedUnitPrice": 249.99,
"unitTaxAmount": 0,
"quantity": 1,
"createdAt": "2023-06-01T10:30:00Z",
"updatedAt": "2023-06-02T14:15:00Z",
"deletedAt": "2023-06-03T09:45:00Z",
"addOnSubtotal": 123,
"addOnTotalTax": 123,
"subtotal": 249.99,
"total": 249.99,
"totalTax": 249.99,
"refundedQuantity": 249.99,
"refundableQuantity": 249.99,
"appointment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "1001",
"productId": "123e4567-e89b-12d3-a456-426614174001",
"staffMemberId": "123e4567-e89b-12d3-a456-426614174002",
"locationId": "123e4567-e89b-12d3-a456-426614174003",
"storeId": "123e4567-e89b-12d3-a456-426614174004",
"customerId": "123e4567-e89b-12d3-a456-426614174005",
"externalOrderId": "12345678",
"externalOrderName": "#1001",
"from": "2023-06-15T09:00:00Z",
"to": "2023-06-15T10:00:00Z",
"addressLine1": "123 Main Street",
"addressLine2": "Suite 456",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "USA",
"status": "scheduled",
"internalNote": "Customer requested extra attention for specific needs",
"createdBy": "customer",
"reminderSentAt": "2023-06-14T09:00:00Z",
"numberOfAttendees": 1,
"createdAt": "2023-06-01T10:30:00Z",
"updatedAt": "2023-06-02T14:15:00Z",
"deletedAt": "2023-06-03T09:45:00Z",
"product": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"productId": "123e4567-e89b-12d3-a456-426614174000",
"externalId": "1234567890",
"externalVariantId": "9876543210",
"storeId": "123e4567-e89b-12d3-a456-426614174001",
"slug": "haircut-basic",
"scheduleId": "<string>",
"productPoolId": "<string>",
"title": "Haircut Service",
"variantTitle": "Short Hair",
"description": "<string>",
"imageId": "<string>",
"color": "BLUE",
"price": 250,
"taxable": false,
"duration": 3600,
"allowCustomDuration": false,
"maxDuration": -1,
"maxAttendees": 1,
"maxGuests": 123,
"allowGuests": false,
"allowCustomerReschedule": false,
"allowCustomerCancel": false,
"rescheduleGap": 123,
"cancelGap": 123,
"beforeGap": 123,
"afterGap": 123,
"fixedTimes": false,
"fixedStartTime": "09:00:00",
"fixedEndTime": "17:00:00",
"advanceScheduleThreshold": 0,
"sendConfirmationEmail": true,
"sendReminderEmail": false,
"sendFeedbackEmail": false,
"skipCheckout": false,
"status": "ACTIVE",
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"image": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalId": "img_123456",
"url": "https://storage.example.com/images/product-image.jpg",
"filename": "product-image.jpg",
"mime": "image/jpeg",
"createdAt": "2023-01-01T12:00:00Z",
"updatedAt": "2023-01-02T12:00:00Z",
"deletedAt": "2023-01-03T12:00:00Z",
"storeId": "store-uuid"
}
},
"staffMember": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"storeId": "123e4567-e89b-12d3-a456-426614174111",
"userId": "user-uuid",
"scheduleId": "123e4567-e89b-12d3-a456-426614174000",
"imageId": "123e4567-e89b-12d3-a456-426614174000",
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@example.com",
"slug": "mike",
"refreshToken": "abc123xyz456",
"createdAt": "2025-05-01T12:00:00Z",
"updatedAt": "2025-05-15T14:30:00Z",
"deletedAt": "2025-06-01T09:15:00Z",
"image": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalId": "img_123456",
"url": "https://storage.example.com/images/product-image.jpg",
"filename": "product-image.jpg",
"mime": "image/jpeg",
"createdAt": "2023-01-01T12:00:00Z",
"updatedAt": "2023-01-02T12:00:00Z",
"deletedAt": "2023-01-03T12:00:00Z",
"storeId": "store-uuid"
}
},
"location": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"storeId": "123e4567-e89b-12d3-a456-426614174001",
"scheduleId": "123e4567-e89b-12d3-a456-426614174002",
"title": "Main Office",
"description": "Our main downtown office location with 3 treatment rooms",
"slug": "new-york",
"type": "physical",
"link": "https://zoom.us/j/123456789",
"addressLine1": "123 Main Street",
"addressLine2": "Suite 200",
"city": "San Francisco",
"state": "CA",
"postalCode": "94105",
"country": "United States",
"addressPlaceId": "ChIJIQBpAG2ahYAR_6128GcTUEo",
"latitude": 37.4224764,
"longitude": -122.0842499,
"createdAt": "2023-01-20T08:30:00Z",
"updatedAt": "2023-02-15T14:20:00Z",
"deletedAt": "2023-03-10T11:45:00Z",
"address": "<string>"
}
},
"addOnLineItems": [
{
"id": "<string>",
"orderId": "<string>",
"lineItemId": "<string>",
"addOnId": "<string>",
"externalId": "<string>",
"originalUnitPrice": 123,
"discountedUnitPrice": 123,
"unitTaxAmount": 123,
"quantity": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"subtotal": 123,
"total": 123,
"totalTax": 123,
"refundedQuantity": 123,
"refundableQuantity": 123,
"addOn": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalId": "1234567890",
"externalVariantId": "9876543210",
"storeId": "123e4567-e89b-12d3-a456-426614174001",
"slug": "child-seat",
"title": "Child Seat",
"description": "<string>",
"imageId": "<string>",
"color": "slate",
"price": 15,
"taxable": true,
"durationMultiplied": false,
"maxQuantity": 4,
"status": "active",
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"image": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalId": "img_123456",
"url": "https://storage.example.com/images/product-image.jpg",
"filename": "product-image.jpg",
"mime": "image/jpeg",
"createdAt": "2023-01-01T12:00:00Z",
"updatedAt": "2023-01-02T12:00:00Z",
"deletedAt": "2023-01-03T12:00:00Z",
"storeId": "store-uuid"
}
},
"refundLineItems": [
{
"id": "<string>",
"refundId": "<string>",
"externalId": "<string>",
"addOnLineItemId": "<string>",
"quantity": 2,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
],
"refundLineItems": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"refundId": "550e8400-e29b-41d4-a716-446655440000",
"externalId": "123456789",
"lineItemId": "550e8400-e29b-41d4-a716-446655440000",
"quantity": 2,
"createdAt": "2023-06-10T15:30:00Z",
"updatedAt": "2023-06-10T16:15:00Z"
}
]
}
],
"transactions": [
{
"orderId": "550e8400-e29b-41d4-a716-446655440000",
"externalId": "12345678",
"parentId": "12345678",
"refundId": "550e8400-e29b-41d4-a716-446655440000",
"type": "sale",
"amount": 249.99,
"currencyCode": "USD",
"gateway": "shopify",
"provider": "stripe",
"status": "success",
"createdAt": "2023-06-01T10:30:00Z",
"updatedAt": "2023-06-02T14:15:00Z",
"deletedAt": "2023-06-03T09:45:00Z",
"refundableAmount": 249.99,
"refundedAmount": 249.99,
"isRefundable": true,
"parentTransaction": {
"orderId": "550e8400-e29b-41d4-a716-446655440000",
"externalId": "12345678",
"parentId": "12345678",
"refundId": "550e8400-e29b-41d4-a716-446655440000",
"type": "sale",
"amount": 249.99,
"currencyCode": "USD",
"gateway": "shopify",
"provider": "stripe",
"status": "success",
"createdAt": "2023-06-01T10:30:00Z",
"updatedAt": "2023-06-02T14:15:00Z",
"deletedAt": "2023-06-03T09:45:00Z",
"refundableAmount": 249.99,
"refundedAmount": 249.99,
"isRefundable": true
},
"childTransactions": [
{
"orderId": "550e8400-e29b-41d4-a716-446655440000",
"externalId": "12345678",
"parentId": "12345678",
"refundId": "550e8400-e29b-41d4-a716-446655440000",
"type": "sale",
"amount": 249.99,
"currencyCode": "USD",
"gateway": "shopify",
"provider": "stripe",
"status": "success",
"createdAt": "2023-06-01T10:30:00Z",
"updatedAt": "2023-06-02T14:15:00Z",
"deletedAt": "2023-06-03T09:45:00Z",
"refundableAmount": 249.99,
"refundedAmount": 249.99,
"isRefundable": true
}
],
"refund": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"orderId": "550e8400-e29b-41d4-a716-446655440000",
"externalId": "123456789",
"createdAt": "2023-06-10T15:30:00Z",
"updatedAt": "2023-06-10T16:15:00Z",
"total": 100,
"transactions": [
{
"orderId": "550e8400-e29b-41d4-a716-446655440000",
"externalId": "12345678",
"parentId": "12345678",
"refundId": "550e8400-e29b-41d4-a716-446655440000",
"type": "sale",
"amount": 249.99,
"currencyCode": "USD",
"gateway": "shopify",
"provider": "stripe",
"status": "success",
"createdAt": "2023-06-01T10:30:00Z",
"updatedAt": "2023-06-02T14:15:00Z",
"deletedAt": "2023-06-03T09:45:00Z",
"refundableAmount": 249.99,
"refundedAmount": 249.99,
"isRefundable": true
}
]
}
}
],
"refunds": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"orderId": "550e8400-e29b-41d4-a716-446655440000",
"externalId": "123456789",
"createdAt": "2023-06-10T15:30:00Z",
"updatedAt": "2023-06-10T16:15:00Z",
"total": 100,
"lineItems": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"refundId": "550e8400-e29b-41d4-a716-446655440000",
"externalId": "123456789",
"lineItemId": "550e8400-e29b-41d4-a716-446655440000",
"quantity": 2,
"createdAt": "2023-06-10T15:30:00Z",
"updatedAt": "2023-06-10T16:15:00Z"
}
],
"transactions": [
{
"orderId": "550e8400-e29b-41d4-a716-446655440000",
"externalId": "12345678",
"parentId": "12345678",
"refundId": "550e8400-e29b-41d4-a716-446655440000",
"type": "sale",
"amount": 249.99,
"currencyCode": "USD",
"gateway": "shopify",
"provider": "stripe",
"status": "success",
"createdAt": "2023-06-01T10:30:00Z",
"updatedAt": "2023-06-02T14:15:00Z",
"deletedAt": "2023-06-03T09:45:00Z",
"refundableAmount": 249.99,
"refundedAmount": 249.99,
"isRefundable": true
}
]
}
],
"logs": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174001",
"title": "Order rescheduled",
"description": "Customer requested to reschedule from June 15 to June 20",
"level": "info",
"createdAt": "2023-06-10T15:30:00Z",
"updatedAt": "2023-06-10T16:15:00Z"
}
],
"gclid": "EAIaIQobChMI..."
}Orders
Get order by ID
Returns a single order by ID for the authenticated customer
GET
/
storefront
/
orders
/
{orderId}
Get order by ID
curl --request GET \
--url https://api.opencals.com/storefront/orders/{orderId}import requests
url = "https://api.opencals.com/storefront/orders/{orderId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.opencals.com/storefront/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://api.opencals.com/storefront/orders/{orderId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.opencals.com/storefront/orders/{orderId}"
req, _ := http.NewRequest("GET", url, nil)
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.opencals.com/storefront/orders/{orderId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.opencals.com/storefront/orders/{orderId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": "<string>",
"paymentCurrencyCode": "123e4567-e89b-12d3-a456-426614174000",
"taxesIncluded": "123e4567-e89b-12d3-a456-426614174000",
"externalId": "shop123_order_456",
"externalName": "#1001",
"name": "1001",
"customerId": "123e4567-e89b-12d3-a456-426614174000",
"storeId": "store-uuid",
"cartId": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2023-06-01T10:30:00Z",
"updatedAt": "2023-06-02T14:15:00Z",
"deletedAt": "2023-06-03T09:45:00Z",
"subtotal": 249.99,
"total": 249.99,
"totalTax": 249.99,
"dueToPay": 249.99,
"paidTotal": 249.99,
"refundedTotal": 249.99,
"balance": 249.99,
"dueToRefund": 249.99,
"isFullyPaid": false,
"isFullyRefunded": false,
"paymentStatus": "paid",
"refundStatus": "partially-refunded",
"fulfillmentStatus": "partially-fulfilled",
"customer": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalId": "1234567890",
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com",
"phone": "+12135550123",
"password": "<string>",
"storeId": "store-uuid",
"language": "en",
"createdAt": "2023-01-15T10:30:00Z",
"updatedAt": "2023-02-20T14:15:00Z",
"emailVerifiedAt": "2023-01-02T00:00:00Z",
"deletedAt": "2023-06-03T09:45:00Z",
"isEmailVerified": true,
"isPasswordSet": true
},
"lineItems": [
{
"orderId": "550e8400-e29b-41d4-a716-446655440000",
"appointmentId": "550e8400-e29b-41d4-a716-446655440000",
"externalId": "12345678",
"originalUnitPrice": 249.99,
"discountedUnitPrice": 249.99,
"unitTaxAmount": 0,
"quantity": 1,
"createdAt": "2023-06-01T10:30:00Z",
"updatedAt": "2023-06-02T14:15:00Z",
"deletedAt": "2023-06-03T09:45:00Z",
"addOnSubtotal": 123,
"addOnTotalTax": 123,
"subtotal": 249.99,
"total": 249.99,
"totalTax": 249.99,
"refundedQuantity": 249.99,
"refundableQuantity": 249.99,
"appointment": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "1001",
"productId": "123e4567-e89b-12d3-a456-426614174001",
"staffMemberId": "123e4567-e89b-12d3-a456-426614174002",
"locationId": "123e4567-e89b-12d3-a456-426614174003",
"storeId": "123e4567-e89b-12d3-a456-426614174004",
"customerId": "123e4567-e89b-12d3-a456-426614174005",
"externalOrderId": "12345678",
"externalOrderName": "#1001",
"from": "2023-06-15T09:00:00Z",
"to": "2023-06-15T10:00:00Z",
"addressLine1": "123 Main Street",
"addressLine2": "Suite 456",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "USA",
"status": "scheduled",
"internalNote": "Customer requested extra attention for specific needs",
"createdBy": "customer",
"reminderSentAt": "2023-06-14T09:00:00Z",
"numberOfAttendees": 1,
"createdAt": "2023-06-01T10:30:00Z",
"updatedAt": "2023-06-02T14:15:00Z",
"deletedAt": "2023-06-03T09:45:00Z",
"product": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"productId": "123e4567-e89b-12d3-a456-426614174000",
"externalId": "1234567890",
"externalVariantId": "9876543210",
"storeId": "123e4567-e89b-12d3-a456-426614174001",
"slug": "haircut-basic",
"scheduleId": "<string>",
"productPoolId": "<string>",
"title": "Haircut Service",
"variantTitle": "Short Hair",
"description": "<string>",
"imageId": "<string>",
"color": "BLUE",
"price": 250,
"taxable": false,
"duration": 3600,
"allowCustomDuration": false,
"maxDuration": -1,
"maxAttendees": 1,
"maxGuests": 123,
"allowGuests": false,
"allowCustomerReschedule": false,
"allowCustomerCancel": false,
"rescheduleGap": 123,
"cancelGap": 123,
"beforeGap": 123,
"afterGap": 123,
"fixedTimes": false,
"fixedStartTime": "09:00:00",
"fixedEndTime": "17:00:00",
"advanceScheduleThreshold": 0,
"sendConfirmationEmail": true,
"sendReminderEmail": false,
"sendFeedbackEmail": false,
"skipCheckout": false,
"status": "ACTIVE",
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"image": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalId": "img_123456",
"url": "https://storage.example.com/images/product-image.jpg",
"filename": "product-image.jpg",
"mime": "image/jpeg",
"createdAt": "2023-01-01T12:00:00Z",
"updatedAt": "2023-01-02T12:00:00Z",
"deletedAt": "2023-01-03T12:00:00Z",
"storeId": "store-uuid"
}
},
"staffMember": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"storeId": "123e4567-e89b-12d3-a456-426614174111",
"userId": "user-uuid",
"scheduleId": "123e4567-e89b-12d3-a456-426614174000",
"imageId": "123e4567-e89b-12d3-a456-426614174000",
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@example.com",
"slug": "mike",
"refreshToken": "abc123xyz456",
"createdAt": "2025-05-01T12:00:00Z",
"updatedAt": "2025-05-15T14:30:00Z",
"deletedAt": "2025-06-01T09:15:00Z",
"image": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalId": "img_123456",
"url": "https://storage.example.com/images/product-image.jpg",
"filename": "product-image.jpg",
"mime": "image/jpeg",
"createdAt": "2023-01-01T12:00:00Z",
"updatedAt": "2023-01-02T12:00:00Z",
"deletedAt": "2023-01-03T12:00:00Z",
"storeId": "store-uuid"
}
},
"location": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"storeId": "123e4567-e89b-12d3-a456-426614174001",
"scheduleId": "123e4567-e89b-12d3-a456-426614174002",
"title": "Main Office",
"description": "Our main downtown office location with 3 treatment rooms",
"slug": "new-york",
"type": "physical",
"link": "https://zoom.us/j/123456789",
"addressLine1": "123 Main Street",
"addressLine2": "Suite 200",
"city": "San Francisco",
"state": "CA",
"postalCode": "94105",
"country": "United States",
"addressPlaceId": "ChIJIQBpAG2ahYAR_6128GcTUEo",
"latitude": 37.4224764,
"longitude": -122.0842499,
"createdAt": "2023-01-20T08:30:00Z",
"updatedAt": "2023-02-15T14:20:00Z",
"deletedAt": "2023-03-10T11:45:00Z",
"address": "<string>"
}
},
"addOnLineItems": [
{
"id": "<string>",
"orderId": "<string>",
"lineItemId": "<string>",
"addOnId": "<string>",
"externalId": "<string>",
"originalUnitPrice": 123,
"discountedUnitPrice": 123,
"unitTaxAmount": 123,
"quantity": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"subtotal": 123,
"total": 123,
"totalTax": 123,
"refundedQuantity": 123,
"refundableQuantity": 123,
"addOn": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalId": "1234567890",
"externalVariantId": "9876543210",
"storeId": "123e4567-e89b-12d3-a456-426614174001",
"slug": "child-seat",
"title": "Child Seat",
"description": "<string>",
"imageId": "<string>",
"color": "slate",
"price": 15,
"taxable": true,
"durationMultiplied": false,
"maxQuantity": 4,
"status": "active",
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"image": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalId": "img_123456",
"url": "https://storage.example.com/images/product-image.jpg",
"filename": "product-image.jpg",
"mime": "image/jpeg",
"createdAt": "2023-01-01T12:00:00Z",
"updatedAt": "2023-01-02T12:00:00Z",
"deletedAt": "2023-01-03T12:00:00Z",
"storeId": "store-uuid"
}
},
"refundLineItems": [
{
"id": "<string>",
"refundId": "<string>",
"externalId": "<string>",
"addOnLineItemId": "<string>",
"quantity": 2,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
],
"refundLineItems": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"refundId": "550e8400-e29b-41d4-a716-446655440000",
"externalId": "123456789",
"lineItemId": "550e8400-e29b-41d4-a716-446655440000",
"quantity": 2,
"createdAt": "2023-06-10T15:30:00Z",
"updatedAt": "2023-06-10T16:15:00Z"
}
]
}
],
"transactions": [
{
"orderId": "550e8400-e29b-41d4-a716-446655440000",
"externalId": "12345678",
"parentId": "12345678",
"refundId": "550e8400-e29b-41d4-a716-446655440000",
"type": "sale",
"amount": 249.99,
"currencyCode": "USD",
"gateway": "shopify",
"provider": "stripe",
"status": "success",
"createdAt": "2023-06-01T10:30:00Z",
"updatedAt": "2023-06-02T14:15:00Z",
"deletedAt": "2023-06-03T09:45:00Z",
"refundableAmount": 249.99,
"refundedAmount": 249.99,
"isRefundable": true,
"parentTransaction": {
"orderId": "550e8400-e29b-41d4-a716-446655440000",
"externalId": "12345678",
"parentId": "12345678",
"refundId": "550e8400-e29b-41d4-a716-446655440000",
"type": "sale",
"amount": 249.99,
"currencyCode": "USD",
"gateway": "shopify",
"provider": "stripe",
"status": "success",
"createdAt": "2023-06-01T10:30:00Z",
"updatedAt": "2023-06-02T14:15:00Z",
"deletedAt": "2023-06-03T09:45:00Z",
"refundableAmount": 249.99,
"refundedAmount": 249.99,
"isRefundable": true
},
"childTransactions": [
{
"orderId": "550e8400-e29b-41d4-a716-446655440000",
"externalId": "12345678",
"parentId": "12345678",
"refundId": "550e8400-e29b-41d4-a716-446655440000",
"type": "sale",
"amount": 249.99,
"currencyCode": "USD",
"gateway": "shopify",
"provider": "stripe",
"status": "success",
"createdAt": "2023-06-01T10:30:00Z",
"updatedAt": "2023-06-02T14:15:00Z",
"deletedAt": "2023-06-03T09:45:00Z",
"refundableAmount": 249.99,
"refundedAmount": 249.99,
"isRefundable": true
}
],
"refund": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"orderId": "550e8400-e29b-41d4-a716-446655440000",
"externalId": "123456789",
"createdAt": "2023-06-10T15:30:00Z",
"updatedAt": "2023-06-10T16:15:00Z",
"total": 100,
"transactions": [
{
"orderId": "550e8400-e29b-41d4-a716-446655440000",
"externalId": "12345678",
"parentId": "12345678",
"refundId": "550e8400-e29b-41d4-a716-446655440000",
"type": "sale",
"amount": 249.99,
"currencyCode": "USD",
"gateway": "shopify",
"provider": "stripe",
"status": "success",
"createdAt": "2023-06-01T10:30:00Z",
"updatedAt": "2023-06-02T14:15:00Z",
"deletedAt": "2023-06-03T09:45:00Z",
"refundableAmount": 249.99,
"refundedAmount": 249.99,
"isRefundable": true
}
]
}
}
],
"refunds": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"orderId": "550e8400-e29b-41d4-a716-446655440000",
"externalId": "123456789",
"createdAt": "2023-06-10T15:30:00Z",
"updatedAt": "2023-06-10T16:15:00Z",
"total": 100,
"lineItems": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"refundId": "550e8400-e29b-41d4-a716-446655440000",
"externalId": "123456789",
"lineItemId": "550e8400-e29b-41d4-a716-446655440000",
"quantity": 2,
"createdAt": "2023-06-10T15:30:00Z",
"updatedAt": "2023-06-10T16:15:00Z"
}
],
"transactions": [
{
"orderId": "550e8400-e29b-41d4-a716-446655440000",
"externalId": "12345678",
"parentId": "12345678",
"refundId": "550e8400-e29b-41d4-a716-446655440000",
"type": "sale",
"amount": 249.99,
"currencyCode": "USD",
"gateway": "shopify",
"provider": "stripe",
"status": "success",
"createdAt": "2023-06-01T10:30:00Z",
"updatedAt": "2023-06-02T14:15:00Z",
"deletedAt": "2023-06-03T09:45:00Z",
"refundableAmount": 249.99,
"refundedAmount": 249.99,
"isRefundable": true
}
]
}
],
"logs": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174001",
"title": "Order rescheduled",
"description": "Customer requested to reschedule from June 15 to June 20",
"level": "info",
"createdAt": "2023-06-10T15:30:00Z",
"updatedAt": "2023-06-10T16:15:00Z"
}
],
"gclid": "EAIaIQobChMI..."
}Path Parameters
Order unique identifier
Example:
"123e4567-e89b-12d3-a456-426614174000"
Response
200 - application/json
The order details
Unique identifier of the order
The currency used by the customer when placing the order.
Example:
"123e4567-e89b-12d3-a456-426614174000"
Whether the taxes are included in the order subtotal.
Example:
"123e4567-e89b-12d3-a456-426614174000"
External order ID from user's platform (if any)
Example:
"shop123_order_456"
External order name/reference from user's platform
Example:
"#1001"
Generated order name for the user (starts at 1001 and increments)
Example:
"1001"
ID of the customer who placed the order
Example:
"123e4567-e89b-12d3-a456-426614174000"
ID of the store that owns the order
Example:
"store-uuid"
ID of the cart from which the order was created
Example:
"123e4567-e89b-12d3-a456-426614174000"
Date and time when the order was created
Example:
"2023-06-01T10:30:00Z"
Date and time when the order was last updated
Example:
"2023-06-02T14:15:00Z"
Date and time when the order was soft-deleted
Example:
"2023-06-03T09:45:00Z"
Subtotal amount of the order, excluding canceled appointments
Example:
249.99
Total amount of the order, including canceled appointments and taxes
Example:
249.99
Total tax amount of the order, excluding canceled appointments
Example:
249.99
Total amount still due to be paid for the order. Derived from the current total (which excludes canceled appointments and reflects current add-ons and discounts) minus the net amount already held (paid minus refunded). Never negative — when the customer has overpaid the current total, the surplus surfaces via dueToRefund instead.
Example:
249.99
Total amount paid for the order
Example:
249.99
Total amount refunded for the order
Example:
249.99
Balance of the order; based on paid and refunded amounts
Example:
249.99
Total amount owed back to the customer. Derived from the net amount held (paid minus refunded) minus the current total. Any change that lowers the current total below what the customer has already paid — a canceled appointment, a removed or reduced add-on, or a discount that is restored on reevaluation — surfaces the surplus here. Never negative.
Example:
249.99
Whether the order is fully paid
Example:
false
Whether everything the customer paid has been refunded (paid something, nothing held).
Example:
false
Payment status of the order
Available options:
unpaid, paid, partially-paid Example:
"paid"
Refund status of the order
Available options:
refund-owed, partially-refunded, fully-refunded, unrefunded Example:
"partially-refunded"
Fulfillment status of the order
Available options:
partially-fulfilled, fulfilled, unfulfilled Example:
"partially-fulfilled"
Customer who placed the order
Show child attributes
Show child attributes
Line items in the order
Show child attributes
Show child attributes
Transactions associated with this order
Show child attributes
Show child attributes
Refunds associated with this order
Show child attributes
Show child attributes
Order activity logs
Show child attributes
Show child attributes
Google Ads click ID captured at the time of booking
Example:
"EAIaIQobChMI..."
Last modified on July 26, 2026
Was this page helpful?
⌘I