Modify order
curl --request PUT \
--url https://dev.sbx.imprint.co/v2/orders/{order_id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"payment_method_id": "0144ea84-3c39-4382-a37a-03c699b77646",
"partner_order_id": "o-c8a1fe46bbff4a18ba1d",
"total_order_amount": 274999,
"id": "77f60af4-185e-4867-b113-34e3cf7c6acd",
"customer_id": "1bb0ab64-ed57-4f2f-bd8d-ab04d1a365c5",
"merchant_id": "m-123456789",
"merchant_name": "Rest Assured",
"merchant_address": [
{
"street_line1": "123 Main St",
"street_line2": "Apt 4B",
"city": "San Francisco",
"state": "CA",
"postal_code": "94105",
"country": "USA"
}
],
"order_lines": [
{
"name": "Couch Supreme",
"product_url": "www.restassured.com/couch-supreme",
"image_url": "https://cdn.restassured.com/couch-supreme.jpg",
"quantity": 1,
"rate": 274999,
"rewards_rate": 2500
}
],
"total_rewards_amount": 2500,
"currency": "USD",
"created_at": "2025-02-13T19:08:07Z",
"updated_at": "2025-02-13T19:08:07Z"
}
'import requests
url = "https://dev.sbx.imprint.co/v2/orders/{order_id}"
payload = {
"payment_method_id": "0144ea84-3c39-4382-a37a-03c699b77646",
"partner_order_id": "o-c8a1fe46bbff4a18ba1d",
"total_order_amount": 274999,
"id": "77f60af4-185e-4867-b113-34e3cf7c6acd",
"customer_id": "1bb0ab64-ed57-4f2f-bd8d-ab04d1a365c5",
"merchant_id": "m-123456789",
"merchant_name": "Rest Assured",
"merchant_address": [
{
"street_line1": "123 Main St",
"street_line2": "Apt 4B",
"city": "San Francisco",
"state": "CA",
"postal_code": "94105",
"country": "USA"
}
],
"order_lines": [
{
"name": "Couch Supreme",
"product_url": "www.restassured.com/couch-supreme",
"image_url": "https://cdn.restassured.com/couch-supreme.jpg",
"quantity": 1,
"rate": 274999,
"rewards_rate": 2500
}
],
"total_rewards_amount": 2500,
"currency": "USD",
"created_at": "2025-02-13T19:08:07Z",
"updated_at": "2025-02-13T19:08:07Z"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
payment_method_id: '0144ea84-3c39-4382-a37a-03c699b77646',
partner_order_id: 'o-c8a1fe46bbff4a18ba1d',
total_order_amount: 274999,
id: '77f60af4-185e-4867-b113-34e3cf7c6acd',
customer_id: '1bb0ab64-ed57-4f2f-bd8d-ab04d1a365c5',
merchant_id: 'm-123456789',
merchant_name: 'Rest Assured',
merchant_address: [
{
street_line1: '123 Main St',
street_line2: 'Apt 4B',
city: 'San Francisco',
state: 'CA',
postal_code: '94105',
country: 'USA'
}
],
order_lines: [
{
name: 'Couch Supreme',
product_url: 'www.restassured.com/couch-supreme',
image_url: 'https://cdn.restassured.com/couch-supreme.jpg',
quantity: 1,
rate: 274999,
rewards_rate: 2500
}
],
total_rewards_amount: 2500,
currency: 'USD',
created_at: '2025-02-13T19:08:07Z',
updated_at: '2025-02-13T19:08:07Z'
})
};
fetch('https://dev.sbx.imprint.co/v2/orders/{order_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://dev.sbx.imprint.co/v2/orders/{order_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'payment_method_id' => '0144ea84-3c39-4382-a37a-03c699b77646',
'partner_order_id' => 'o-c8a1fe46bbff4a18ba1d',
'total_order_amount' => 274999,
'id' => '77f60af4-185e-4867-b113-34e3cf7c6acd',
'customer_id' => '1bb0ab64-ed57-4f2f-bd8d-ab04d1a365c5',
'merchant_id' => 'm-123456789',
'merchant_name' => 'Rest Assured',
'merchant_address' => [
[
'street_line1' => '123 Main St',
'street_line2' => 'Apt 4B',
'city' => 'San Francisco',
'state' => 'CA',
'postal_code' => '94105',
'country' => 'USA'
]
],
'order_lines' => [
[
'name' => 'Couch Supreme',
'product_url' => 'www.restassured.com/couch-supreme',
'image_url' => 'https://cdn.restassured.com/couch-supreme.jpg',
'quantity' => 1,
'rate' => 274999,
'rewards_rate' => 2500
]
],
'total_rewards_amount' => 2500,
'currency' => 'USD',
'created_at' => '2025-02-13T19:08:07Z',
'updated_at' => '2025-02-13T19:08:07Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://dev.sbx.imprint.co/v2/orders/{order_id}"
payload := strings.NewReader("{\n \"payment_method_id\": \"0144ea84-3c39-4382-a37a-03c699b77646\",\n \"partner_order_id\": \"o-c8a1fe46bbff4a18ba1d\",\n \"total_order_amount\": 274999,\n \"id\": \"77f60af4-185e-4867-b113-34e3cf7c6acd\",\n \"customer_id\": \"1bb0ab64-ed57-4f2f-bd8d-ab04d1a365c5\",\n \"merchant_id\": \"m-123456789\",\n \"merchant_name\": \"Rest Assured\",\n \"merchant_address\": [\n {\n \"street_line1\": \"123 Main St\",\n \"street_line2\": \"Apt 4B\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postal_code\": \"94105\",\n \"country\": \"USA\"\n }\n ],\n \"order_lines\": [\n {\n \"name\": \"Couch Supreme\",\n \"product_url\": \"www.restassured.com/couch-supreme\",\n \"image_url\": \"https://cdn.restassured.com/couch-supreme.jpg\",\n \"quantity\": 1,\n \"rate\": 274999,\n \"rewards_rate\": 2500\n }\n ],\n \"total_rewards_amount\": 2500,\n \"currency\": \"USD\",\n \"created_at\": \"2025-02-13T19:08:07Z\",\n \"updated_at\": \"2025-02-13T19:08:07Z\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://dev.sbx.imprint.co/v2/orders/{order_id}")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"payment_method_id\": \"0144ea84-3c39-4382-a37a-03c699b77646\",\n \"partner_order_id\": \"o-c8a1fe46bbff4a18ba1d\",\n \"total_order_amount\": 274999,\n \"id\": \"77f60af4-185e-4867-b113-34e3cf7c6acd\",\n \"customer_id\": \"1bb0ab64-ed57-4f2f-bd8d-ab04d1a365c5\",\n \"merchant_id\": \"m-123456789\",\n \"merchant_name\": \"Rest Assured\",\n \"merchant_address\": [\n {\n \"street_line1\": \"123 Main St\",\n \"street_line2\": \"Apt 4B\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postal_code\": \"94105\",\n \"country\": \"USA\"\n }\n ],\n \"order_lines\": [\n {\n \"name\": \"Couch Supreme\",\n \"product_url\": \"www.restassured.com/couch-supreme\",\n \"image_url\": \"https://cdn.restassured.com/couch-supreme.jpg\",\n \"quantity\": 1,\n \"rate\": 274999,\n \"rewards_rate\": 2500\n }\n ],\n \"total_rewards_amount\": 2500,\n \"currency\": \"USD\",\n \"created_at\": \"2025-02-13T19:08:07Z\",\n \"updated_at\": \"2025-02-13T19:08:07Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev.sbx.imprint.co/v2/orders/{order_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"payment_method_id\": \"0144ea84-3c39-4382-a37a-03c699b77646\",\n \"partner_order_id\": \"o-c8a1fe46bbff4a18ba1d\",\n \"total_order_amount\": 274999,\n \"id\": \"77f60af4-185e-4867-b113-34e3cf7c6acd\",\n \"customer_id\": \"1bb0ab64-ed57-4f2f-bd8d-ab04d1a365c5\",\n \"merchant_id\": \"m-123456789\",\n \"merchant_name\": \"Rest Assured\",\n \"merchant_address\": [\n {\n \"street_line1\": \"123 Main St\",\n \"street_line2\": \"Apt 4B\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postal_code\": \"94105\",\n \"country\": \"USA\"\n }\n ],\n \"order_lines\": [\n {\n \"name\": \"Couch Supreme\",\n \"product_url\": \"www.restassured.com/couch-supreme\",\n \"image_url\": \"https://cdn.restassured.com/couch-supreme.jpg\",\n \"quantity\": 1,\n \"rate\": 274999,\n \"rewards_rate\": 2500\n }\n ],\n \"total_rewards_amount\": 2500,\n \"currency\": \"USD\",\n \"created_at\": \"2025-02-13T19:08:07Z\",\n \"updated_at\": \"2025-02-13T19:08:07Z\"\n}"
response = http.request(request)
puts response.read_body{
"payment_method_id": "0144ea84-3c39-4382-a37a-03c699b77646",
"partner_order_id": "o-c8a1fe46bbff4a18ba1d",
"total_order_amount": 274999,
"id": "77f60af4-185e-4867-b113-34e3cf7c6acd",
"customer_id": "1bb0ab64-ed57-4f2f-bd8d-ab04d1a365c5",
"merchant_id": "m-123456789",
"merchant_name": "Rest Assured",
"merchant_address": [
{
"street_line1": "123 Main St",
"street_line2": "Apt 4B",
"city": "San Francisco",
"state": "CA",
"postal_code": "94105",
"country": "USA"
}
],
"order_lines": [
{
"name": "Couch Supreme",
"product_url": "www.restassured.com/couch-supreme",
"image_url": "https://cdn.restassured.com/couch-supreme.jpg",
"quantity": 1,
"rate": 274999,
"rewards_rate": 2500
}
],
"total_rewards_amount": 2500,
"currency": "USD",
"created_at": "2025-02-13T19:08:07Z",
"updated_at": "2025-02-13T19:08:07Z"
}{
"error": {
"type": "BAD_REQUEST_ERROR",
"message": "unsupported reward_type: INVALID, must be STATEMENT or DELAYED"
}
}Orders
Modify order
Modify an existing order.
Required scope: ORDER_WRITE
PUT
/
v2
/
orders
/
{order_id}
Modify order
curl --request PUT \
--url https://dev.sbx.imprint.co/v2/orders/{order_id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"payment_method_id": "0144ea84-3c39-4382-a37a-03c699b77646",
"partner_order_id": "o-c8a1fe46bbff4a18ba1d",
"total_order_amount": 274999,
"id": "77f60af4-185e-4867-b113-34e3cf7c6acd",
"customer_id": "1bb0ab64-ed57-4f2f-bd8d-ab04d1a365c5",
"merchant_id": "m-123456789",
"merchant_name": "Rest Assured",
"merchant_address": [
{
"street_line1": "123 Main St",
"street_line2": "Apt 4B",
"city": "San Francisco",
"state": "CA",
"postal_code": "94105",
"country": "USA"
}
],
"order_lines": [
{
"name": "Couch Supreme",
"product_url": "www.restassured.com/couch-supreme",
"image_url": "https://cdn.restassured.com/couch-supreme.jpg",
"quantity": 1,
"rate": 274999,
"rewards_rate": 2500
}
],
"total_rewards_amount": 2500,
"currency": "USD",
"created_at": "2025-02-13T19:08:07Z",
"updated_at": "2025-02-13T19:08:07Z"
}
'import requests
url = "https://dev.sbx.imprint.co/v2/orders/{order_id}"
payload = {
"payment_method_id": "0144ea84-3c39-4382-a37a-03c699b77646",
"partner_order_id": "o-c8a1fe46bbff4a18ba1d",
"total_order_amount": 274999,
"id": "77f60af4-185e-4867-b113-34e3cf7c6acd",
"customer_id": "1bb0ab64-ed57-4f2f-bd8d-ab04d1a365c5",
"merchant_id": "m-123456789",
"merchant_name": "Rest Assured",
"merchant_address": [
{
"street_line1": "123 Main St",
"street_line2": "Apt 4B",
"city": "San Francisco",
"state": "CA",
"postal_code": "94105",
"country": "USA"
}
],
"order_lines": [
{
"name": "Couch Supreme",
"product_url": "www.restassured.com/couch-supreme",
"image_url": "https://cdn.restassured.com/couch-supreme.jpg",
"quantity": 1,
"rate": 274999,
"rewards_rate": 2500
}
],
"total_rewards_amount": 2500,
"currency": "USD",
"created_at": "2025-02-13T19:08:07Z",
"updated_at": "2025-02-13T19:08:07Z"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
payment_method_id: '0144ea84-3c39-4382-a37a-03c699b77646',
partner_order_id: 'o-c8a1fe46bbff4a18ba1d',
total_order_amount: 274999,
id: '77f60af4-185e-4867-b113-34e3cf7c6acd',
customer_id: '1bb0ab64-ed57-4f2f-bd8d-ab04d1a365c5',
merchant_id: 'm-123456789',
merchant_name: 'Rest Assured',
merchant_address: [
{
street_line1: '123 Main St',
street_line2: 'Apt 4B',
city: 'San Francisco',
state: 'CA',
postal_code: '94105',
country: 'USA'
}
],
order_lines: [
{
name: 'Couch Supreme',
product_url: 'www.restassured.com/couch-supreme',
image_url: 'https://cdn.restassured.com/couch-supreme.jpg',
quantity: 1,
rate: 274999,
rewards_rate: 2500
}
],
total_rewards_amount: 2500,
currency: 'USD',
created_at: '2025-02-13T19:08:07Z',
updated_at: '2025-02-13T19:08:07Z'
})
};
fetch('https://dev.sbx.imprint.co/v2/orders/{order_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://dev.sbx.imprint.co/v2/orders/{order_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'payment_method_id' => '0144ea84-3c39-4382-a37a-03c699b77646',
'partner_order_id' => 'o-c8a1fe46bbff4a18ba1d',
'total_order_amount' => 274999,
'id' => '77f60af4-185e-4867-b113-34e3cf7c6acd',
'customer_id' => '1bb0ab64-ed57-4f2f-bd8d-ab04d1a365c5',
'merchant_id' => 'm-123456789',
'merchant_name' => 'Rest Assured',
'merchant_address' => [
[
'street_line1' => '123 Main St',
'street_line2' => 'Apt 4B',
'city' => 'San Francisco',
'state' => 'CA',
'postal_code' => '94105',
'country' => 'USA'
]
],
'order_lines' => [
[
'name' => 'Couch Supreme',
'product_url' => 'www.restassured.com/couch-supreme',
'image_url' => 'https://cdn.restassured.com/couch-supreme.jpg',
'quantity' => 1,
'rate' => 274999,
'rewards_rate' => 2500
]
],
'total_rewards_amount' => 2500,
'currency' => 'USD',
'created_at' => '2025-02-13T19:08:07Z',
'updated_at' => '2025-02-13T19:08:07Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://dev.sbx.imprint.co/v2/orders/{order_id}"
payload := strings.NewReader("{\n \"payment_method_id\": \"0144ea84-3c39-4382-a37a-03c699b77646\",\n \"partner_order_id\": \"o-c8a1fe46bbff4a18ba1d\",\n \"total_order_amount\": 274999,\n \"id\": \"77f60af4-185e-4867-b113-34e3cf7c6acd\",\n \"customer_id\": \"1bb0ab64-ed57-4f2f-bd8d-ab04d1a365c5\",\n \"merchant_id\": \"m-123456789\",\n \"merchant_name\": \"Rest Assured\",\n \"merchant_address\": [\n {\n \"street_line1\": \"123 Main St\",\n \"street_line2\": \"Apt 4B\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postal_code\": \"94105\",\n \"country\": \"USA\"\n }\n ],\n \"order_lines\": [\n {\n \"name\": \"Couch Supreme\",\n \"product_url\": \"www.restassured.com/couch-supreme\",\n \"image_url\": \"https://cdn.restassured.com/couch-supreme.jpg\",\n \"quantity\": 1,\n \"rate\": 274999,\n \"rewards_rate\": 2500\n }\n ],\n \"total_rewards_amount\": 2500,\n \"currency\": \"USD\",\n \"created_at\": \"2025-02-13T19:08:07Z\",\n \"updated_at\": \"2025-02-13T19:08:07Z\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://dev.sbx.imprint.co/v2/orders/{order_id}")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"payment_method_id\": \"0144ea84-3c39-4382-a37a-03c699b77646\",\n \"partner_order_id\": \"o-c8a1fe46bbff4a18ba1d\",\n \"total_order_amount\": 274999,\n \"id\": \"77f60af4-185e-4867-b113-34e3cf7c6acd\",\n \"customer_id\": \"1bb0ab64-ed57-4f2f-bd8d-ab04d1a365c5\",\n \"merchant_id\": \"m-123456789\",\n \"merchant_name\": \"Rest Assured\",\n \"merchant_address\": [\n {\n \"street_line1\": \"123 Main St\",\n \"street_line2\": \"Apt 4B\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postal_code\": \"94105\",\n \"country\": \"USA\"\n }\n ],\n \"order_lines\": [\n {\n \"name\": \"Couch Supreme\",\n \"product_url\": \"www.restassured.com/couch-supreme\",\n \"image_url\": \"https://cdn.restassured.com/couch-supreme.jpg\",\n \"quantity\": 1,\n \"rate\": 274999,\n \"rewards_rate\": 2500\n }\n ],\n \"total_rewards_amount\": 2500,\n \"currency\": \"USD\",\n \"created_at\": \"2025-02-13T19:08:07Z\",\n \"updated_at\": \"2025-02-13T19:08:07Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev.sbx.imprint.co/v2/orders/{order_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"payment_method_id\": \"0144ea84-3c39-4382-a37a-03c699b77646\",\n \"partner_order_id\": \"o-c8a1fe46bbff4a18ba1d\",\n \"total_order_amount\": 274999,\n \"id\": \"77f60af4-185e-4867-b113-34e3cf7c6acd\",\n \"customer_id\": \"1bb0ab64-ed57-4f2f-bd8d-ab04d1a365c5\",\n \"merchant_id\": \"m-123456789\",\n \"merchant_name\": \"Rest Assured\",\n \"merchant_address\": [\n {\n \"street_line1\": \"123 Main St\",\n \"street_line2\": \"Apt 4B\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postal_code\": \"94105\",\n \"country\": \"USA\"\n }\n ],\n \"order_lines\": [\n {\n \"name\": \"Couch Supreme\",\n \"product_url\": \"www.restassured.com/couch-supreme\",\n \"image_url\": \"https://cdn.restassured.com/couch-supreme.jpg\",\n \"quantity\": 1,\n \"rate\": 274999,\n \"rewards_rate\": 2500\n }\n ],\n \"total_rewards_amount\": 2500,\n \"currency\": \"USD\",\n \"created_at\": \"2025-02-13T19:08:07Z\",\n \"updated_at\": \"2025-02-13T19:08:07Z\"\n}"
response = http.request(request)
puts response.read_body{
"payment_method_id": "0144ea84-3c39-4382-a37a-03c699b77646",
"partner_order_id": "o-c8a1fe46bbff4a18ba1d",
"total_order_amount": 274999,
"id": "77f60af4-185e-4867-b113-34e3cf7c6acd",
"customer_id": "1bb0ab64-ed57-4f2f-bd8d-ab04d1a365c5",
"merchant_id": "m-123456789",
"merchant_name": "Rest Assured",
"merchant_address": [
{
"street_line1": "123 Main St",
"street_line2": "Apt 4B",
"city": "San Francisco",
"state": "CA",
"postal_code": "94105",
"country": "USA"
}
],
"order_lines": [
{
"name": "Couch Supreme",
"product_url": "www.restassured.com/couch-supreme",
"image_url": "https://cdn.restassured.com/couch-supreme.jpg",
"quantity": 1,
"rate": 274999,
"rewards_rate": 2500
}
],
"total_rewards_amount": 2500,
"currency": "USD",
"created_at": "2025-02-13T19:08:07Z",
"updated_at": "2025-02-13T19:08:07Z"
}{
"error": {
"type": "BAD_REQUEST_ERROR",
"message": "unsupported reward_type: INVALID, must be STATEMENT or DELAYED"
}
}Authorizations
basicAuthbearerAuth
Basic HTTP authentication. Allowed headers-- Authorization: Basic <base64(api_key_id:api_key_secret)>
Path Parameters
Unique identifier for the order
Body
application/json
Payment method identifier
Example:
"0144ea84-3c39-4382-a37a-03c699b77646"
Partner's order identifier
Example:
"o-c8a1fe46bbff4a18ba1d"
Total order amount ($2,699.99 + $50.00)
Example:
274999
Unique identifier for the order
Example:
"77f60af4-185e-4867-b113-34e3cf7c6acd"
Customer identifier
Example:
"1bb0ab64-ed57-4f2f-bd8d-ab04d1a365c5"
Merchant identifier
Example:
"m-123456789"
Merchant name
Example:
"Rest Assured"
List of merchant addresses
Show child attributes
Show child attributes
An array of items that make up the order, used for the purpose of establishing the items, amounts, and rewards that are expected to be included in events sent to Imprint following order creation.
Changes made to orders after the order is created can be implicitly communicated to Imprint through the event creation process following the creation of the order; modifying the order itself is not necessary. The set of events sent to Imprint after order creation serve as the final source of truth for transaction amounts, rewards, order lines, etc.
When provided, the API will require that the calculated sum of all the rates and rewards rates within (taking quantities into account) are equal to the total_order_amount and total_rewards_amount, respectively.
Show child attributes
Show child attributes
Example:
[
{
"name": "Couch Supreme",
"product_url": "www.restassured.com/couch-supreme",
"image_url": "https://cdn.restassured.com/couch-supreme.jpg",
"quantity": 1,
"rate": 274999,
"rewards_rate": 2500
}
]
Total rewards amount ($25 + $0)
Example:
2500
The 3-character currency code of the amount in ISO 4217 format (e.g., "USD")
Example:
"USD"
The RFC-3339 timestamp when the order was created
Example:
"2025-02-13T19:08:07Z"
The RFC-3339 timestamp when the order was last updated
Example:
"2025-02-13T19:08:07Z"
Response
Order modified successfully
Payment method identifier
Example:
"0144ea84-3c39-4382-a37a-03c699b77646"
Partner's order identifier
Example:
"o-c8a1fe46bbff4a18ba1d"
Total order amount ($2,699.99 + $50.00)
Example:
274999
Unique identifier for the order
Example:
"77f60af4-185e-4867-b113-34e3cf7c6acd"
Customer identifier
Example:
"1bb0ab64-ed57-4f2f-bd8d-ab04d1a365c5"
Merchant identifier
Example:
"m-123456789"
Merchant name
Example:
"Rest Assured"
List of merchant addresses
Show child attributes
Show child attributes
An array of items that make up the order, used for the purpose of establishing the items, amounts, and rewards that are expected to be included in events sent to Imprint following order creation.
Changes made to orders after the order is created can be implicitly communicated to Imprint through the event creation process following the creation of the order; modifying the order itself is not necessary. The set of events sent to Imprint after order creation serve as the final source of truth for transaction amounts, rewards, order lines, etc.
When provided, the API will require that the calculated sum of all the rates and rewards rates within (taking quantities into account) are equal to the total_order_amount and total_rewards_amount, respectively.
Show child attributes
Show child attributes
Example:
[
{
"name": "Couch Supreme",
"product_url": "www.restassured.com/couch-supreme",
"image_url": "https://cdn.restassured.com/couch-supreme.jpg",
"quantity": 1,
"rate": 274999,
"rewards_rate": 2500
}
]
Total rewards amount ($25 + $0)
Example:
2500
The 3-character currency code of the amount in ISO 4217 format (e.g., "USD")
Example:
"USD"
The RFC-3339 timestamp when the order was created
Example:
"2025-02-13T19:08:07Z"
The RFC-3339 timestamp when the order was last updated
Example:
"2025-02-13T19:08:07Z"