Create a Data Refresh Order
curl --request POST \
--url https://api.example.com/v1/orders/{id}/import requests
url = "https://api.example.com/v1/orders/{id}/"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/v1/orders/{id}/', 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.example.com/v1/orders/{id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$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.example.com/v1/orders/{id}/"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/orders/{id}/")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/orders/{id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyOrders
Create a Data Refresh Order
Create a new order with data populated from an existing order
POST
/
v1
/
orders
/
{id}
/
Create a Data Refresh Order
curl --request POST \
--url https://api.example.com/v1/orders/{id}/import requests
url = "https://api.example.com/v1/orders/{id}/"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/v1/orders/{id}/', 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.example.com/v1/orders/{id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$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.example.com/v1/orders/{id}/"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/orders/{id}/")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/orders/{id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyEndpoint Overview
POSThttps://prod.transcrypts.com/v1/orders/{id}/
The endpoint creates a new order with data populated from the existing order, eliminating the need to re-enter all details manually.
Authentication
The endpoint requires API credentials passed via headers:- ClientID (Header)
- AccessKey (Header)
Parameters
Path Parameters
| Parameter | Type | Description |
|---|---|---|
id | string | Required. The ID of the existing order to refresh from |
Request Body
The endpoint accepts an order ID in the URL path. The request body schema follows the standard order creation parameters, with data pre-populated from the source order.Response
Status Code: 201 (Created) Upon successful execution, the API returns the newly created refresh order with populated data fields carried over from the source order.Error Handling
| Status Code | Description |
|---|---|
201 | Resource created successfully |
400 | Invalid request parameters provided |
401 | Authentication credentials missing or invalid |
403 | Insufficient permissions for the action |