Create Order
curl --request POST \
--url https://api.getredo.com/v2.2/stores/{storeId}/orders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"orderId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"lineItems": [
{
"id": "<string>",
"productId": "<string>",
"title": "<string>",
"quantity": 500,
"variantId": "<string>",
"sku": "<string>",
"barcode": "<string>",
"manufacturerPartNumber": "<string>",
"hsCode": "<string>",
"countryOfOrigin": "<string>",
"price": 1,
"imageUrl": "<string>",
"discount": 1
}
],
"customer": {
"id": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"name": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"shipping": {
"method": "<string>",
"cost": 1,
"address": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"province": "<string>",
"country": "<string>",
"postalCode": "<string>"
}
},
"totalPrice": 1,
"subtotalPrice": 1,
"totalTax": 1,
"totalDiscount": 1,
"billingAddress": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"province": "<string>",
"country": "<string>",
"postalCode": "<string>"
},
"tags": [
"<string>"
],
"currencyCode": "<string>",
"locationId": "loc_4d8e1a2b3c"
}
'import requests
url = "https://api.getredo.com/v2.2/stores/{storeId}/orders"
payload = {
"orderId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"lineItems": [
{
"id": "<string>",
"productId": "<string>",
"title": "<string>",
"quantity": 500,
"variantId": "<string>",
"sku": "<string>",
"barcode": "<string>",
"manufacturerPartNumber": "<string>",
"hsCode": "<string>",
"countryOfOrigin": "<string>",
"price": 1,
"imageUrl": "<string>",
"discount": 1
}
],
"customer": {
"id": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"name": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"shipping": {
"method": "<string>",
"cost": 1,
"address": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"province": "<string>",
"country": "<string>",
"postalCode": "<string>"
}
},
"totalPrice": 1,
"subtotalPrice": 1,
"totalTax": 1,
"totalDiscount": 1,
"billingAddress": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"province": "<string>",
"country": "<string>",
"postalCode": "<string>"
},
"tags": ["<string>"],
"currencyCode": "<string>",
"locationId": "loc_4d8e1a2b3c"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
orderId: '<string>',
createdAt: '2023-11-07T05:31:56Z',
lineItems: [
{
id: '<string>',
productId: '<string>',
title: '<string>',
quantity: 500,
variantId: '<string>',
sku: '<string>',
barcode: '<string>',
manufacturerPartNumber: '<string>',
hsCode: '<string>',
countryOfOrigin: '<string>',
price: 1,
imageUrl: '<string>',
discount: 1
}
],
customer: {
id: '<string>',
email: '<string>',
phoneNumber: '<string>',
name: '<string>',
firstName: '<string>',
lastName: '<string>'
},
shipping: {
method: '<string>',
cost: 1,
address: {
address1: '<string>',
address2: '<string>',
city: '<string>',
province: '<string>',
country: '<string>',
postalCode: '<string>'
}
},
totalPrice: 1,
subtotalPrice: 1,
totalTax: 1,
totalDiscount: 1,
billingAddress: {
address1: '<string>',
address2: '<string>',
city: '<string>',
province: '<string>',
country: '<string>',
postalCode: '<string>'
},
tags: ['<string>'],
currencyCode: '<string>',
locationId: 'loc_4d8e1a2b3c'
})
};
fetch('https://api.getredo.com/v2.2/stores/{storeId}/orders', 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.getredo.com/v2.2/stores/{storeId}/orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'orderId' => '<string>',
'createdAt' => '2023-11-07T05:31:56Z',
'lineItems' => [
[
'id' => '<string>',
'productId' => '<string>',
'title' => '<string>',
'quantity' => 500,
'variantId' => '<string>',
'sku' => '<string>',
'barcode' => '<string>',
'manufacturerPartNumber' => '<string>',
'hsCode' => '<string>',
'countryOfOrigin' => '<string>',
'price' => 1,
'imageUrl' => '<string>',
'discount' => 1
]
],
'customer' => [
'id' => '<string>',
'email' => '<string>',
'phoneNumber' => '<string>',
'name' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>'
],
'shipping' => [
'method' => '<string>',
'cost' => 1,
'address' => [
'address1' => '<string>',
'address2' => '<string>',
'city' => '<string>',
'province' => '<string>',
'country' => '<string>',
'postalCode' => '<string>'
]
],
'totalPrice' => 1,
'subtotalPrice' => 1,
'totalTax' => 1,
'totalDiscount' => 1,
'billingAddress' => [
'address1' => '<string>',
'address2' => '<string>',
'city' => '<string>',
'province' => '<string>',
'country' => '<string>',
'postalCode' => '<string>'
],
'tags' => [
'<string>'
],
'currencyCode' => '<string>',
'locationId' => 'loc_4d8e1a2b3c'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://api.getredo.com/v2.2/stores/{storeId}/orders"
payload := strings.NewReader("{\n \"orderId\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"lineItems\": [\n {\n \"id\": \"<string>\",\n \"productId\": \"<string>\",\n \"title\": \"<string>\",\n \"quantity\": 500,\n \"variantId\": \"<string>\",\n \"sku\": \"<string>\",\n \"barcode\": \"<string>\",\n \"manufacturerPartNumber\": \"<string>\",\n \"hsCode\": \"<string>\",\n \"countryOfOrigin\": \"<string>\",\n \"price\": 1,\n \"imageUrl\": \"<string>\",\n \"discount\": 1\n }\n ],\n \"customer\": {\n \"id\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"name\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\"\n },\n \"shipping\": {\n \"method\": \"<string>\",\n \"cost\": 1,\n \"address\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"province\": \"<string>\",\n \"country\": \"<string>\",\n \"postalCode\": \"<string>\"\n }\n },\n \"totalPrice\": 1,\n \"subtotalPrice\": 1,\n \"totalTax\": 1,\n \"totalDiscount\": 1,\n \"billingAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"province\": \"<string>\",\n \"country\": \"<string>\",\n \"postalCode\": \"<string>\"\n },\n \"tags\": [\n \"<string>\"\n ],\n \"currencyCode\": \"<string>\",\n \"locationId\": \"loc_4d8e1a2b3c\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.post("https://api.getredo.com/v2.2/stores/{storeId}/orders")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"orderId\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"lineItems\": [\n {\n \"id\": \"<string>\",\n \"productId\": \"<string>\",\n \"title\": \"<string>\",\n \"quantity\": 500,\n \"variantId\": \"<string>\",\n \"sku\": \"<string>\",\n \"barcode\": \"<string>\",\n \"manufacturerPartNumber\": \"<string>\",\n \"hsCode\": \"<string>\",\n \"countryOfOrigin\": \"<string>\",\n \"price\": 1,\n \"imageUrl\": \"<string>\",\n \"discount\": 1\n }\n ],\n \"customer\": {\n \"id\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"name\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\"\n },\n \"shipping\": {\n \"method\": \"<string>\",\n \"cost\": 1,\n \"address\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"province\": \"<string>\",\n \"country\": \"<string>\",\n \"postalCode\": \"<string>\"\n }\n },\n \"totalPrice\": 1,\n \"subtotalPrice\": 1,\n \"totalTax\": 1,\n \"totalDiscount\": 1,\n \"billingAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"province\": \"<string>\",\n \"country\": \"<string>\",\n \"postalCode\": \"<string>\"\n },\n \"tags\": [\n \"<string>\"\n ],\n \"currencyCode\": \"<string>\",\n \"locationId\": \"loc_4d8e1a2b3c\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getredo.com/v2.2/stores/{storeId}/orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"orderId\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"lineItems\": [\n {\n \"id\": \"<string>\",\n \"productId\": \"<string>\",\n \"title\": \"<string>\",\n \"quantity\": 500,\n \"variantId\": \"<string>\",\n \"sku\": \"<string>\",\n \"barcode\": \"<string>\",\n \"manufacturerPartNumber\": \"<string>\",\n \"hsCode\": \"<string>\",\n \"countryOfOrigin\": \"<string>\",\n \"price\": 1,\n \"imageUrl\": \"<string>\",\n \"discount\": 1\n }\n ],\n \"customer\": {\n \"id\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"name\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\"\n },\n \"shipping\": {\n \"method\": \"<string>\",\n \"cost\": 1,\n \"address\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"province\": \"<string>\",\n \"country\": \"<string>\",\n \"postalCode\": \"<string>\"\n }\n },\n \"totalPrice\": 1,\n \"subtotalPrice\": 1,\n \"totalTax\": 1,\n \"totalDiscount\": 1,\n \"billingAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"province\": \"<string>\",\n \"country\": \"<string>\",\n \"postalCode\": \"<string>\"\n },\n \"tags\": [\n \"<string>\"\n ],\n \"currencyCode\": \"<string>\",\n \"locationId\": \"loc_4d8e1a2b3c\"\n}"
response = http.request(request)
puts response.read_body{
"orderId": "<string>",
"externalOrderId": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"detail": "<string>",
"instance": "<string>",
"title": "<string>",
"type": "about:blank"
}Orders
Create Order
Create a new order in the system with line items, customer information, and shipping details. Requires the orders_write scope.
POST
/
stores
/
{storeId}
/
orders
Create Order
curl --request POST \
--url https://api.getredo.com/v2.2/stores/{storeId}/orders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"orderId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"lineItems": [
{
"id": "<string>",
"productId": "<string>",
"title": "<string>",
"quantity": 500,
"variantId": "<string>",
"sku": "<string>",
"barcode": "<string>",
"manufacturerPartNumber": "<string>",
"hsCode": "<string>",
"countryOfOrigin": "<string>",
"price": 1,
"imageUrl": "<string>",
"discount": 1
}
],
"customer": {
"id": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"name": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"shipping": {
"method": "<string>",
"cost": 1,
"address": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"province": "<string>",
"country": "<string>",
"postalCode": "<string>"
}
},
"totalPrice": 1,
"subtotalPrice": 1,
"totalTax": 1,
"totalDiscount": 1,
"billingAddress": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"province": "<string>",
"country": "<string>",
"postalCode": "<string>"
},
"tags": [
"<string>"
],
"currencyCode": "<string>",
"locationId": "loc_4d8e1a2b3c"
}
'import requests
url = "https://api.getredo.com/v2.2/stores/{storeId}/orders"
payload = {
"orderId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"lineItems": [
{
"id": "<string>",
"productId": "<string>",
"title": "<string>",
"quantity": 500,
"variantId": "<string>",
"sku": "<string>",
"barcode": "<string>",
"manufacturerPartNumber": "<string>",
"hsCode": "<string>",
"countryOfOrigin": "<string>",
"price": 1,
"imageUrl": "<string>",
"discount": 1
}
],
"customer": {
"id": "<string>",
"email": "<string>",
"phoneNumber": "<string>",
"name": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"shipping": {
"method": "<string>",
"cost": 1,
"address": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"province": "<string>",
"country": "<string>",
"postalCode": "<string>"
}
},
"totalPrice": 1,
"subtotalPrice": 1,
"totalTax": 1,
"totalDiscount": 1,
"billingAddress": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"province": "<string>",
"country": "<string>",
"postalCode": "<string>"
},
"tags": ["<string>"],
"currencyCode": "<string>",
"locationId": "loc_4d8e1a2b3c"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
orderId: '<string>',
createdAt: '2023-11-07T05:31:56Z',
lineItems: [
{
id: '<string>',
productId: '<string>',
title: '<string>',
quantity: 500,
variantId: '<string>',
sku: '<string>',
barcode: '<string>',
manufacturerPartNumber: '<string>',
hsCode: '<string>',
countryOfOrigin: '<string>',
price: 1,
imageUrl: '<string>',
discount: 1
}
],
customer: {
id: '<string>',
email: '<string>',
phoneNumber: '<string>',
name: '<string>',
firstName: '<string>',
lastName: '<string>'
},
shipping: {
method: '<string>',
cost: 1,
address: {
address1: '<string>',
address2: '<string>',
city: '<string>',
province: '<string>',
country: '<string>',
postalCode: '<string>'
}
},
totalPrice: 1,
subtotalPrice: 1,
totalTax: 1,
totalDiscount: 1,
billingAddress: {
address1: '<string>',
address2: '<string>',
city: '<string>',
province: '<string>',
country: '<string>',
postalCode: '<string>'
},
tags: ['<string>'],
currencyCode: '<string>',
locationId: 'loc_4d8e1a2b3c'
})
};
fetch('https://api.getredo.com/v2.2/stores/{storeId}/orders', 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.getredo.com/v2.2/stores/{storeId}/orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'orderId' => '<string>',
'createdAt' => '2023-11-07T05:31:56Z',
'lineItems' => [
[
'id' => '<string>',
'productId' => '<string>',
'title' => '<string>',
'quantity' => 500,
'variantId' => '<string>',
'sku' => '<string>',
'barcode' => '<string>',
'manufacturerPartNumber' => '<string>',
'hsCode' => '<string>',
'countryOfOrigin' => '<string>',
'price' => 1,
'imageUrl' => '<string>',
'discount' => 1
]
],
'customer' => [
'id' => '<string>',
'email' => '<string>',
'phoneNumber' => '<string>',
'name' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>'
],
'shipping' => [
'method' => '<string>',
'cost' => 1,
'address' => [
'address1' => '<string>',
'address2' => '<string>',
'city' => '<string>',
'province' => '<string>',
'country' => '<string>',
'postalCode' => '<string>'
]
],
'totalPrice' => 1,
'subtotalPrice' => 1,
'totalTax' => 1,
'totalDiscount' => 1,
'billingAddress' => [
'address1' => '<string>',
'address2' => '<string>',
'city' => '<string>',
'province' => '<string>',
'country' => '<string>',
'postalCode' => '<string>'
],
'tags' => [
'<string>'
],
'currencyCode' => '<string>',
'locationId' => 'loc_4d8e1a2b3c'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://api.getredo.com/v2.2/stores/{storeId}/orders"
payload := strings.NewReader("{\n \"orderId\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"lineItems\": [\n {\n \"id\": \"<string>\",\n \"productId\": \"<string>\",\n \"title\": \"<string>\",\n \"quantity\": 500,\n \"variantId\": \"<string>\",\n \"sku\": \"<string>\",\n \"barcode\": \"<string>\",\n \"manufacturerPartNumber\": \"<string>\",\n \"hsCode\": \"<string>\",\n \"countryOfOrigin\": \"<string>\",\n \"price\": 1,\n \"imageUrl\": \"<string>\",\n \"discount\": 1\n }\n ],\n \"customer\": {\n \"id\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"name\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\"\n },\n \"shipping\": {\n \"method\": \"<string>\",\n \"cost\": 1,\n \"address\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"province\": \"<string>\",\n \"country\": \"<string>\",\n \"postalCode\": \"<string>\"\n }\n },\n \"totalPrice\": 1,\n \"subtotalPrice\": 1,\n \"totalTax\": 1,\n \"totalDiscount\": 1,\n \"billingAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"province\": \"<string>\",\n \"country\": \"<string>\",\n \"postalCode\": \"<string>\"\n },\n \"tags\": [\n \"<string>\"\n ],\n \"currencyCode\": \"<string>\",\n \"locationId\": \"loc_4d8e1a2b3c\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.post("https://api.getredo.com/v2.2/stores/{storeId}/orders")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"orderId\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"lineItems\": [\n {\n \"id\": \"<string>\",\n \"productId\": \"<string>\",\n \"title\": \"<string>\",\n \"quantity\": 500,\n \"variantId\": \"<string>\",\n \"sku\": \"<string>\",\n \"barcode\": \"<string>\",\n \"manufacturerPartNumber\": \"<string>\",\n \"hsCode\": \"<string>\",\n \"countryOfOrigin\": \"<string>\",\n \"price\": 1,\n \"imageUrl\": \"<string>\",\n \"discount\": 1\n }\n ],\n \"customer\": {\n \"id\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"name\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\"\n },\n \"shipping\": {\n \"method\": \"<string>\",\n \"cost\": 1,\n \"address\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"province\": \"<string>\",\n \"country\": \"<string>\",\n \"postalCode\": \"<string>\"\n }\n },\n \"totalPrice\": 1,\n \"subtotalPrice\": 1,\n \"totalTax\": 1,\n \"totalDiscount\": 1,\n \"billingAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"province\": \"<string>\",\n \"country\": \"<string>\",\n \"postalCode\": \"<string>\"\n },\n \"tags\": [\n \"<string>\"\n ],\n \"currencyCode\": \"<string>\",\n \"locationId\": \"loc_4d8e1a2b3c\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getredo.com/v2.2/stores/{storeId}/orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"orderId\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"lineItems\": [\n {\n \"id\": \"<string>\",\n \"productId\": \"<string>\",\n \"title\": \"<string>\",\n \"quantity\": 500,\n \"variantId\": \"<string>\",\n \"sku\": \"<string>\",\n \"barcode\": \"<string>\",\n \"manufacturerPartNumber\": \"<string>\",\n \"hsCode\": \"<string>\",\n \"countryOfOrigin\": \"<string>\",\n \"price\": 1,\n \"imageUrl\": \"<string>\",\n \"discount\": 1\n }\n ],\n \"customer\": {\n \"id\": \"<string>\",\n \"email\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"name\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\"\n },\n \"shipping\": {\n \"method\": \"<string>\",\n \"cost\": 1,\n \"address\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"province\": \"<string>\",\n \"country\": \"<string>\",\n \"postalCode\": \"<string>\"\n }\n },\n \"totalPrice\": 1,\n \"subtotalPrice\": 1,\n \"totalTax\": 1,\n \"totalDiscount\": 1,\n \"billingAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"province\": \"<string>\",\n \"country\": \"<string>\",\n \"postalCode\": \"<string>\"\n },\n \"tags\": [\n \"<string>\"\n ],\n \"currencyCode\": \"<string>\",\n \"locationId\": \"loc_4d8e1a2b3c\"\n}"
response = http.request(request)
puts response.read_body{
"orderId": "<string>",
"externalOrderId": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"detail": "<string>",
"instance": "<string>",
"title": "<string>",
"type": "about:blank"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Store ID
Example:
"64e5a8a1af49a89df37e4ee7"
Body
application/json
Request body for creating an order.
Unique identifier for the order.
ISO 8601 date string for when the order was created.
List of line items in the order.
Minimum array length:
1Show child attributes
Show child attributes
Customer information.
Show child attributes
Show child attributes
Shipping information.
Show child attributes
Show child attributes
Total order price including tax and shipping, as a decimal amount in the order's currency (e.g. $79.99, not 7999 cents).
Required range:
x >= 0Subtotal price excluding tax and shipping, as a decimal amount in the order's currency (e.g. $79.99, not 7999 cents).
Required range:
x >= 0Total tax amount, as a decimal amount in the order's currency (e.g. $79.99, not 7999 cents).
Required range:
x >= 0Total discount amount applied to the order (e.g. coupon codes, promotions), as a decimal amount in the order's currency (e.g. $79.99, not 7999 cents).
Required range:
x >= 0Billing address.
Show child attributes
Show child attributes
Optional tags associated with the order.
Currency code from the ISO 4217 standard (e.g., USD, EUR, GBP).
Optional. Pin this order to a specific fulfillment location. Must be a location id (loc_...) returned by GET /inventory-levels — either one of your own warehouses or a location at a linked 3PL fulfillment service. When provided, the fulfillment group's origin address is sourced from the location row. Omit to use your team's default origin address.
Example:
"loc_4d8e1a2b3c"
Was this page helpful?