const response = await fetch("https://api.sudomock.com/api/v1/studio/actions/consume", {
method: "POST",
headers: {
"x-api-key": "sm_your_api_key",
"Content-Type": "application/json",
},
body: JSON.stringify({
"message_session_id": "7d1b4a90-2e63-4f18-bb27-1c9a0e4d7f52",
"payload": {
"mockup_uuid": "c315f78f-d2c7-4541-b240-a9372842de94",
"render_uuid": "9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354"
},
"request_id": "0f9c2d1e-7b44-4a2f-9a0d-6c1f2b8e5d33",
"type": "studio.mockup-saved",
"version": 1
}),
});
const data = await response.json();
console.log(data);
<?php
$payload = <<<'JSON'
{
"message_session_id": "7d1b4a90-2e63-4f18-bb27-1c9a0e4d7f52",
"payload": {
"mockup_uuid": "c315f78f-d2c7-4541-b240-a9372842de94",
"render_uuid": "9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354"
},
"request_id": "0f9c2d1e-7b44-4a2f-9a0d-6c1f2b8e5d33",
"type": "studio.mockup-saved",
"version": 1
}
JSON;
$ch = curl_init("https://api.sudomock.com/api/v1/studio/actions/consume");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"x-api-key: sm_your_api_key",
"Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
import requests
payload = {
"message_session_id": "7d1b4a90-2e63-4f18-bb27-1c9a0e4d7f52",
"payload": {
"mockup_uuid": "c315f78f-d2c7-4541-b240-a9372842de94",
"render_uuid": "9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354"
},
"request_id": "0f9c2d1e-7b44-4a2f-9a0d-6c1f2b8e5d33",
"type": "studio.mockup-saved",
"version": 1
}
response = requests.post(
"https://api.sudomock.com/api/v1/studio/actions/consume",
headers={"x-api-key": "sm_your_api_key"},
json=payload,
)
response.raise_for_status()
print(response.json())
require "net/http"
require "uri"
uri = URI("https://api.sudomock.com/api/v1/studio/actions/consume")
request = Net::HTTP::Post.new(uri)
request["x-api-key"] = "sm_your_api_key"
request["Content-Type"] = "application/json"
request.body = <<~JSON
{
"message_session_id": "7d1b4a90-2e63-4f18-bb27-1c9a0e4d7f52",
"payload": {
"mockup_uuid": "c315f78f-d2c7-4541-b240-a9372842de94",
"render_uuid": "9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354"
},
"request_id": "0f9c2d1e-7b44-4a2f-9a0d-6c1f2b8e5d33",
"type": "studio.mockup-saved",
"version": 1
}
JSON
response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
http.request(request)
end
puts response.body
package main
import (
"bytes"
"fmt"
"io"
"net/http"
)
func main() {
payload := []byte(`{
"message_session_id": "7d1b4a90-2e63-4f18-bb27-1c9a0e4d7f52",
"payload": {
"mockup_uuid": "c315f78f-d2c7-4541-b240-a9372842de94",
"render_uuid": "9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354"
},
"request_id": "0f9c2d1e-7b44-4a2f-9a0d-6c1f2b8e5d33",
"type": "studio.mockup-saved",
"version": 1
}`)
req, err := http.NewRequest("POST", "https://api.sudomock.com/api/v1/studio/actions/consume", bytes.NewBuffer(payload))
if err != nil {
panic(err)
}
req.Header.Set("x-api-key", "sm_your_api_key")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
String payload = """
{
"message_session_id": "7d1b4a90-2e63-4f18-bb27-1c9a0e4d7f52",
"payload": {
"mockup_uuid": "c315f78f-d2c7-4541-b240-a9372842de94",
"render_uuid": "9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354"
},
"request_id": "0f9c2d1e-7b44-4a2f-9a0d-6c1f2b8e5d33",
"type": "studio.mockup-saved",
"version": 1
}
""";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.sudomock.com/api/v1/studio/actions/consume"))
.header("x-api-key", "sm_your_api_key")
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(payload))
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
using System.Net.Http;
using System.Text;
var payload = """
{
"message_session_id": "7d1b4a90-2e63-4f18-bb27-1c9a0e4d7f52",
"payload": {
"mockup_uuid": "c315f78f-d2c7-4541-b240-a9372842de94",
"render_uuid": "9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354"
},
"request_id": "0f9c2d1e-7b44-4a2f-9a0d-6c1f2b8e5d33",
"type": "studio.mockup-saved",
"version": 1
}
""";
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.sudomock.com/api/v1/studio/actions/consume");
request.Headers.Add("x-api-key", "sm_your_api_key");
request.Content = new StringContent(payload, Encoding.UTF8, "application/json");
var client = new HttpClient();
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());
curl -X POST "https://api.sudomock.com/api/v1/studio/actions/consume" \
-H "x-api-key: sm_your_api_key" \
-H "Content-Type: application/json" \
-d '{
"message_session_id": "7d1b4a90-2e63-4f18-bb27-1c9a0e4d7f52",
"payload": {
"mockup_uuid": "c315f78f-d2c7-4541-b240-a9372842de94",
"render_uuid": "9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354"
},
"request_id": "0f9c2d1e-7b44-4a2f-9a0d-6c1f2b8e5d33",
"type": "studio.mockup-saved",
"version": 1
}'
{
"success": true,
"replayed": false,
"receipt": {
"version": 1,
"request_id": "0f9c2d1e-7b44-4a2f-9a0d-6c1f2b8e5d33",
"message_session_id": "7d1b4a90-2e63-4f18-bb27-1c9a0e4d7f52",
"type": "studio.mockup-saved",
"mockup_type": "psd",
"session_kind": "setup",
"action_id": "add-to-cart",
"action_context": {
"shop": "your-store.myshopify.com",
"product_id": "8342019283",
"variant_id": "44912837465"
},
"mockup_uuid": "c315f78f-d2c7-4541-b240-a9372842de94",
"render_uuid": "9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354",
"render_parameters": {
"export_options": {
"image_format": "webp",
"image_size": 1920,
"quality": 95
},
"print_areas": [
{
"adjustments": {
"blend_mode": "multiply",
"opacity": 90
},
"artwork_url": "https://example.com/design.png",
"placement": {
"fit": "fit",
"position": "center"
},
"uuid": "223e4567-e89b-12d3-a456-426614174001"
}
]
},
"artwork_sources": [
{
"uuid": "6f1c8d42-0b57-4e39-a6d8-3c95b1e740af",
"surface_uuid": "2b7e4f19-8c3d-4a60-9e15-7d0c6b3a58e2",
"smart_object_uuid": "a3d95c07-61e2-4f8b-b204-5e9c1f7d3a86",
"url": "https://cdn.example.com/design-cutout.png"
}
]
},
"order_assets": {
"preview_url": "https://cdn.sudomock.com/mockup-assets/order-assets/c315f78f-d2c7-4541-b240-a9372842de94/9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354/preview/render_9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354.webp",
"artwork_urls": [
"https://cdn.sudomock.com/mockup-assets/order-assets/c315f78f-d2c7-4541-b240-a9372842de94/9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354/a3d95c07-61e2-4f8b-b204-5e9c1f7d3a86/5f1c0b2a7d434e9a.png"
],
"print_file_urls": [
"https://cdn.sudomock.com/mockup-assets/order-assets/c315f78f-d2c7-4541-b240-a9372842de94/9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354/print/3f9c2a7e5b1d4c8a9e6f0b2d7a4c1e8f5b3d9a6c2e7f1b4d8a0c5e9f3b7d2a6c.png"
]
}
}
Consume a Studio action
Server-only exactly-once confirmation of a Studio action against its bound successful render.
POST
/
api
/
v1
/
studio
/
actions
/
consume
const response = await fetch("https://api.sudomock.com/api/v1/studio/actions/consume", {
method: "POST",
headers: {
"x-api-key": "sm_your_api_key",
"Content-Type": "application/json",
},
body: JSON.stringify({
"message_session_id": "7d1b4a90-2e63-4f18-bb27-1c9a0e4d7f52",
"payload": {
"mockup_uuid": "c315f78f-d2c7-4541-b240-a9372842de94",
"render_uuid": "9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354"
},
"request_id": "0f9c2d1e-7b44-4a2f-9a0d-6c1f2b8e5d33",
"type": "studio.mockup-saved",
"version": 1
}),
});
const data = await response.json();
console.log(data);
<?php
$payload = <<<'JSON'
{
"message_session_id": "7d1b4a90-2e63-4f18-bb27-1c9a0e4d7f52",
"payload": {
"mockup_uuid": "c315f78f-d2c7-4541-b240-a9372842de94",
"render_uuid": "9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354"
},
"request_id": "0f9c2d1e-7b44-4a2f-9a0d-6c1f2b8e5d33",
"type": "studio.mockup-saved",
"version": 1
}
JSON;
$ch = curl_init("https://api.sudomock.com/api/v1/studio/actions/consume");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"x-api-key: sm_your_api_key",
"Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
import requests
payload = {
"message_session_id": "7d1b4a90-2e63-4f18-bb27-1c9a0e4d7f52",
"payload": {
"mockup_uuid": "c315f78f-d2c7-4541-b240-a9372842de94",
"render_uuid": "9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354"
},
"request_id": "0f9c2d1e-7b44-4a2f-9a0d-6c1f2b8e5d33",
"type": "studio.mockup-saved",
"version": 1
}
response = requests.post(
"https://api.sudomock.com/api/v1/studio/actions/consume",
headers={"x-api-key": "sm_your_api_key"},
json=payload,
)
response.raise_for_status()
print(response.json())
require "net/http"
require "uri"
uri = URI("https://api.sudomock.com/api/v1/studio/actions/consume")
request = Net::HTTP::Post.new(uri)
request["x-api-key"] = "sm_your_api_key"
request["Content-Type"] = "application/json"
request.body = <<~JSON
{
"message_session_id": "7d1b4a90-2e63-4f18-bb27-1c9a0e4d7f52",
"payload": {
"mockup_uuid": "c315f78f-d2c7-4541-b240-a9372842de94",
"render_uuid": "9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354"
},
"request_id": "0f9c2d1e-7b44-4a2f-9a0d-6c1f2b8e5d33",
"type": "studio.mockup-saved",
"version": 1
}
JSON
response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
http.request(request)
end
puts response.body
package main
import (
"bytes"
"fmt"
"io"
"net/http"
)
func main() {
payload := []byte(`{
"message_session_id": "7d1b4a90-2e63-4f18-bb27-1c9a0e4d7f52",
"payload": {
"mockup_uuid": "c315f78f-d2c7-4541-b240-a9372842de94",
"render_uuid": "9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354"
},
"request_id": "0f9c2d1e-7b44-4a2f-9a0d-6c1f2b8e5d33",
"type": "studio.mockup-saved",
"version": 1
}`)
req, err := http.NewRequest("POST", "https://api.sudomock.com/api/v1/studio/actions/consume", bytes.NewBuffer(payload))
if err != nil {
panic(err)
}
req.Header.Set("x-api-key", "sm_your_api_key")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
String payload = """
{
"message_session_id": "7d1b4a90-2e63-4f18-bb27-1c9a0e4d7f52",
"payload": {
"mockup_uuid": "c315f78f-d2c7-4541-b240-a9372842de94",
"render_uuid": "9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354"
},
"request_id": "0f9c2d1e-7b44-4a2f-9a0d-6c1f2b8e5d33",
"type": "studio.mockup-saved",
"version": 1
}
""";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.sudomock.com/api/v1/studio/actions/consume"))
.header("x-api-key", "sm_your_api_key")
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(payload))
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
using System.Net.Http;
using System.Text;
var payload = """
{
"message_session_id": "7d1b4a90-2e63-4f18-bb27-1c9a0e4d7f52",
"payload": {
"mockup_uuid": "c315f78f-d2c7-4541-b240-a9372842de94",
"render_uuid": "9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354"
},
"request_id": "0f9c2d1e-7b44-4a2f-9a0d-6c1f2b8e5d33",
"type": "studio.mockup-saved",
"version": 1
}
""";
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.sudomock.com/api/v1/studio/actions/consume");
request.Headers.Add("x-api-key", "sm_your_api_key");
request.Content = new StringContent(payload, Encoding.UTF8, "application/json");
var client = new HttpClient();
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());
curl -X POST "https://api.sudomock.com/api/v1/studio/actions/consume" \
-H "x-api-key: sm_your_api_key" \
-H "Content-Type: application/json" \
-d '{
"message_session_id": "7d1b4a90-2e63-4f18-bb27-1c9a0e4d7f52",
"payload": {
"mockup_uuid": "c315f78f-d2c7-4541-b240-a9372842de94",
"render_uuid": "9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354"
},
"request_id": "0f9c2d1e-7b44-4a2f-9a0d-6c1f2b8e5d33",
"type": "studio.mockup-saved",
"version": 1
}'
{
"success": true,
"replayed": false,
"receipt": {
"version": 1,
"request_id": "0f9c2d1e-7b44-4a2f-9a0d-6c1f2b8e5d33",
"message_session_id": "7d1b4a90-2e63-4f18-bb27-1c9a0e4d7f52",
"type": "studio.mockup-saved",
"mockup_type": "psd",
"session_kind": "setup",
"action_id": "add-to-cart",
"action_context": {
"shop": "your-store.myshopify.com",
"product_id": "8342019283",
"variant_id": "44912837465"
},
"mockup_uuid": "c315f78f-d2c7-4541-b240-a9372842de94",
"render_uuid": "9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354",
"render_parameters": {
"export_options": {
"image_format": "webp",
"image_size": 1920,
"quality": 95
},
"print_areas": [
{
"adjustments": {
"blend_mode": "multiply",
"opacity": 90
},
"artwork_url": "https://example.com/design.png",
"placement": {
"fit": "fit",
"position": "center"
},
"uuid": "223e4567-e89b-12d3-a456-426614174001"
}
]
},
"artwork_sources": [
{
"uuid": "6f1c8d42-0b57-4e39-a6d8-3c95b1e740af",
"surface_uuid": "2b7e4f19-8c3d-4a60-9e15-7d0c6b3a58e2",
"smart_object_uuid": "a3d95c07-61e2-4f8b-b204-5e9c1f7d3a86",
"url": "https://cdn.example.com/design-cutout.png"
}
]
},
"order_assets": {
"preview_url": "https://cdn.sudomock.com/mockup-assets/order-assets/c315f78f-d2c7-4541-b240-a9372842de94/9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354/preview/render_9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354.webp",
"artwork_urls": [
"https://cdn.sudomock.com/mockup-assets/order-assets/c315f78f-d2c7-4541-b240-a9372842de94/9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354/a3d95c07-61e2-4f8b-b204-5e9c1f7d3a86/5f1c0b2a7d434e9a.png"
],
"print_file_urls": [
"https://cdn.sudomock.com/mockup-assets/order-assets/c315f78f-d2c7-4541-b240-a9372842de94/9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354/print/3f9c2a7e5b1d4c8a9e6f0b2d7a4c1e8f5b3d9a6c2e7f1b4d8a0c5e9f3b7d2a6c.png"
]
}
}
const response = await fetch("https://api.sudomock.com/api/v1/studio/actions/consume", {
method: "POST",
headers: {
"x-api-key": "sm_your_api_key",
"Content-Type": "application/json",
},
body: JSON.stringify({
"message_session_id": "7d1b4a90-2e63-4f18-bb27-1c9a0e4d7f52",
"payload": {
"mockup_uuid": "c315f78f-d2c7-4541-b240-a9372842de94",
"render_uuid": "9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354"
},
"request_id": "0f9c2d1e-7b44-4a2f-9a0d-6c1f2b8e5d33",
"type": "studio.mockup-saved",
"version": 1
}),
});
const data = await response.json();
console.log(data);
<?php
$payload = <<<'JSON'
{
"message_session_id": "7d1b4a90-2e63-4f18-bb27-1c9a0e4d7f52",
"payload": {
"mockup_uuid": "c315f78f-d2c7-4541-b240-a9372842de94",
"render_uuid": "9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354"
},
"request_id": "0f9c2d1e-7b44-4a2f-9a0d-6c1f2b8e5d33",
"type": "studio.mockup-saved",
"version": 1
}
JSON;
$ch = curl_init("https://api.sudomock.com/api/v1/studio/actions/consume");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"x-api-key: sm_your_api_key",
"Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
import requests
payload = {
"message_session_id": "7d1b4a90-2e63-4f18-bb27-1c9a0e4d7f52",
"payload": {
"mockup_uuid": "c315f78f-d2c7-4541-b240-a9372842de94",
"render_uuid": "9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354"
},
"request_id": "0f9c2d1e-7b44-4a2f-9a0d-6c1f2b8e5d33",
"type": "studio.mockup-saved",
"version": 1
}
response = requests.post(
"https://api.sudomock.com/api/v1/studio/actions/consume",
headers={"x-api-key": "sm_your_api_key"},
json=payload,
)
response.raise_for_status()
print(response.json())
require "net/http"
require "uri"
uri = URI("https://api.sudomock.com/api/v1/studio/actions/consume")
request = Net::HTTP::Post.new(uri)
request["x-api-key"] = "sm_your_api_key"
request["Content-Type"] = "application/json"
request.body = <<~JSON
{
"message_session_id": "7d1b4a90-2e63-4f18-bb27-1c9a0e4d7f52",
"payload": {
"mockup_uuid": "c315f78f-d2c7-4541-b240-a9372842de94",
"render_uuid": "9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354"
},
"request_id": "0f9c2d1e-7b44-4a2f-9a0d-6c1f2b8e5d33",
"type": "studio.mockup-saved",
"version": 1
}
JSON
response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
http.request(request)
end
puts response.body
package main
import (
"bytes"
"fmt"
"io"
"net/http"
)
func main() {
payload := []byte(`{
"message_session_id": "7d1b4a90-2e63-4f18-bb27-1c9a0e4d7f52",
"payload": {
"mockup_uuid": "c315f78f-d2c7-4541-b240-a9372842de94",
"render_uuid": "9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354"
},
"request_id": "0f9c2d1e-7b44-4a2f-9a0d-6c1f2b8e5d33",
"type": "studio.mockup-saved",
"version": 1
}`)
req, err := http.NewRequest("POST", "https://api.sudomock.com/api/v1/studio/actions/consume", bytes.NewBuffer(payload))
if err != nil {
panic(err)
}
req.Header.Set("x-api-key", "sm_your_api_key")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
String payload = """
{
"message_session_id": "7d1b4a90-2e63-4f18-bb27-1c9a0e4d7f52",
"payload": {
"mockup_uuid": "c315f78f-d2c7-4541-b240-a9372842de94",
"render_uuid": "9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354"
},
"request_id": "0f9c2d1e-7b44-4a2f-9a0d-6c1f2b8e5d33",
"type": "studio.mockup-saved",
"version": 1
}
""";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.sudomock.com/api/v1/studio/actions/consume"))
.header("x-api-key", "sm_your_api_key")
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(payload))
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
using System.Net.Http;
using System.Text;
var payload = """
{
"message_session_id": "7d1b4a90-2e63-4f18-bb27-1c9a0e4d7f52",
"payload": {
"mockup_uuid": "c315f78f-d2c7-4541-b240-a9372842de94",
"render_uuid": "9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354"
},
"request_id": "0f9c2d1e-7b44-4a2f-9a0d-6c1f2b8e5d33",
"type": "studio.mockup-saved",
"version": 1
}
""";
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.sudomock.com/api/v1/studio/actions/consume");
request.Headers.Add("x-api-key", "sm_your_api_key");
request.Content = new StringContent(payload, Encoding.UTF8, "application/json");
var client = new HttpClient();
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());
curl -X POST "https://api.sudomock.com/api/v1/studio/actions/consume" \
-H "x-api-key: sm_your_api_key" \
-H "Content-Type: application/json" \
-d '{
"message_session_id": "7d1b4a90-2e63-4f18-bb27-1c9a0e4d7f52",
"payload": {
"mockup_uuid": "c315f78f-d2c7-4541-b240-a9372842de94",
"render_uuid": "9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354"
},
"request_id": "0f9c2d1e-7b44-4a2f-9a0d-6c1f2b8e5d33",
"type": "studio.mockup-saved",
"version": 1
}'
{
"success": true,
"replayed": false,
"receipt": {
"version": 1,
"request_id": "0f9c2d1e-7b44-4a2f-9a0d-6c1f2b8e5d33",
"message_session_id": "7d1b4a90-2e63-4f18-bb27-1c9a0e4d7f52",
"type": "studio.mockup-saved",
"mockup_type": "psd",
"session_kind": "setup",
"action_id": "add-to-cart",
"action_context": {
"shop": "your-store.myshopify.com",
"product_id": "8342019283",
"variant_id": "44912837465"
},
"mockup_uuid": "c315f78f-d2c7-4541-b240-a9372842de94",
"render_uuid": "9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354",
"render_parameters": {
"export_options": {
"image_format": "webp",
"image_size": 1920,
"quality": 95
},
"print_areas": [
{
"adjustments": {
"blend_mode": "multiply",
"opacity": 90
},
"artwork_url": "https://example.com/design.png",
"placement": {
"fit": "fit",
"position": "center"
},
"uuid": "223e4567-e89b-12d3-a456-426614174001"
}
]
},
"artwork_sources": [
{
"uuid": "6f1c8d42-0b57-4e39-a6d8-3c95b1e740af",
"surface_uuid": "2b7e4f19-8c3d-4a60-9e15-7d0c6b3a58e2",
"smart_object_uuid": "a3d95c07-61e2-4f8b-b204-5e9c1f7d3a86",
"url": "https://cdn.example.com/design-cutout.png"
}
]
},
"order_assets": {
"preview_url": "https://cdn.sudomock.com/mockup-assets/order-assets/c315f78f-d2c7-4541-b240-a9372842de94/9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354/preview/render_9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354.webp",
"artwork_urls": [
"https://cdn.sudomock.com/mockup-assets/order-assets/c315f78f-d2c7-4541-b240-a9372842de94/9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354/a3d95c07-61e2-4f8b-b204-5e9c1f7d3a86/5f1c0b2a7d434e9a.png"
],
"print_file_urls": [
"https://cdn.sudomock.com/mockup-assets/order-assets/c315f78f-d2c7-4541-b240-a9372842de94/9b2e5f31-4c8d-4a76-8f0b-2d7e6c1a9354/print/3f9c2a7e5b1d4c8a9e6f0b2d7a4c1e8f5b3d9a6c2e7f1b4d8a0c5e9f3b7d2a6c.png"
]
}
}
Authorizations
API key with sm_ prefix. Get your key at https://sudomock.com/dashboard/api-keys
Body
application/json
Version of the Studio action message format.
Identifier of the action message, so a repeated call returns the same receipt.
Example:
"0f9c2d1e-7b44-4a2f-9a0d-6c1f2b8e5d33"
Identifier of the Studio session that emitted the action.
Example:
"7d1b4a90-2e63-4f18-bb27-1c9a0e4d7f52"
Studio result this request confirms.
Available options:
studio.mockup-saved, studio.design-submitted Identifiers and parameters of the Studio action to confirm.
Show child attributes
Show child attributes
Response
200 - application/json
Successful Response
True when this action was already confirmed and its receipt is returned again.
Example:
false
Confirmed record of the Studio action.
Show child attributes
Show child attributes
Always true when the action was confirmed.
Preview, artwork and print file links to keep on the order line. Returned for a submitted design of an add-to-cart session when files were kept for it. A repeat returns the links the order has at that time. Left out otherwise.
Show child attributes
Show child attributes
Was this page helpful?
⌘I