Create Order
curl --request POST \
--url https://api.satsuma.ai/order \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"customer": {
"id": "<string>",
"name": "<string>",
"address": {
"city": "<string>",
"region": "NY",
"country": "US",
"street_address": "<string>",
"postal_code": "<string>",
"street_address_detail": "<string>"
},
"phone_number": "+12345678901",
"email": "<string>"
},
"items": [
{
"product_id": "<string>",
"quantity": 2
}
],
"location_id": "<string>",
"tip": 123,
"dropoff_instructions": "<string>"
}
'import requests
url = "https://api.satsuma.ai/order"
payload = {
"customer": {
"id": "<string>",
"name": "<string>",
"address": {
"city": "<string>",
"region": "NY",
"country": "US",
"street_address": "<string>",
"postal_code": "<string>",
"street_address_detail": "<string>"
},
"phone_number": "+12345678901",
"email": "<string>"
},
"items": [
{
"product_id": "<string>",
"quantity": 2
}
],
"location_id": "<string>",
"tip": 123,
"dropoff_instructions": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
customer: {
id: '<string>',
name: '<string>',
address: {
city: '<string>',
region: 'NY',
country: 'US',
street_address: '<string>',
postal_code: '<string>',
street_address_detail: '<string>'
},
phone_number: '+12345678901',
email: '<string>'
},
items: [{product_id: '<string>', quantity: 2}],
location_id: '<string>',
tip: 123,
dropoff_instructions: '<string>'
})
};
fetch('https://api.satsuma.ai/order', 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.satsuma.ai/order",
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([
'customer' => [
'id' => '<string>',
'name' => '<string>',
'address' => [
'city' => '<string>',
'region' => 'NY',
'country' => 'US',
'street_address' => '<string>',
'postal_code' => '<string>',
'street_address_detail' => '<string>'
],
'phone_number' => '+12345678901',
'email' => '<string>'
],
'items' => [
[
'product_id' => '<string>',
'quantity' => 2
]
],
'location_id' => '<string>',
'tip' => 123,
'dropoff_instructions' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.satsuma.ai/order"
payload := strings.NewReader("{\n \"customer\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": {\n \"city\": \"<string>\",\n \"region\": \"NY\",\n \"country\": \"US\",\n \"street_address\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"street_address_detail\": \"<string>\"\n },\n \"phone_number\": \"+12345678901\",\n \"email\": \"<string>\"\n },\n \"items\": [\n {\n \"product_id\": \"<string>\",\n \"quantity\": 2\n }\n ],\n \"location_id\": \"<string>\",\n \"tip\": 123,\n \"dropoff_instructions\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.satsuma.ai/order")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customer\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": {\n \"city\": \"<string>\",\n \"region\": \"NY\",\n \"country\": \"US\",\n \"street_address\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"street_address_detail\": \"<string>\"\n },\n \"phone_number\": \"+12345678901\",\n \"email\": \"<string>\"\n },\n \"items\": [\n {\n \"product_id\": \"<string>\",\n \"quantity\": 2\n }\n ],\n \"location_id\": \"<string>\",\n \"tip\": 123,\n \"dropoff_instructions\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.satsuma.ai/order")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": {\n \"city\": \"<string>\",\n \"region\": \"NY\",\n \"country\": \"US\",\n \"street_address\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"street_address_detail\": \"<string>\"\n },\n \"phone_number\": \"+12345678901\",\n \"email\": \"<string>\"\n },\n \"items\": [\n {\n \"product_id\": \"<string>\",\n \"quantity\": 2\n }\n ],\n \"location_id\": \"<string>\",\n \"tip\": 123,\n \"dropoff_instructions\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"tip": 123,
"subtotal": 123,
"tax": 123,
"total": 123,
"customer": {
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"address": {
"street_number": "<string>",
"street_name": "<string>",
"street_address": "<string>",
"street_address_detail": "<string>",
"city": "<string>",
"region": "<string>",
"postal_code": "<string>",
"country": "<string>"
}
},
"fees": [
{
"amount": 123
}
],
"items": [
{
"quantity": 123,
"price": 123,
"product_id": "<string>",
"product_name": "<string>"
}
],
"merchant_id": "<string>",
"location_id": "<string>",
"fee_total": 123,
"dropoff_instructions": "<string>"
},
"messages": [
{
"context": "<string>",
"text": "<string>",
"data": {}
}
]
}Order
Create Order
Create a new order
POST
/
order
Create Order
curl --request POST \
--url https://api.satsuma.ai/order \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"customer": {
"id": "<string>",
"name": "<string>",
"address": {
"city": "<string>",
"region": "NY",
"country": "US",
"street_address": "<string>",
"postal_code": "<string>",
"street_address_detail": "<string>"
},
"phone_number": "+12345678901",
"email": "<string>"
},
"items": [
{
"product_id": "<string>",
"quantity": 2
}
],
"location_id": "<string>",
"tip": 123,
"dropoff_instructions": "<string>"
}
'import requests
url = "https://api.satsuma.ai/order"
payload = {
"customer": {
"id": "<string>",
"name": "<string>",
"address": {
"city": "<string>",
"region": "NY",
"country": "US",
"street_address": "<string>",
"postal_code": "<string>",
"street_address_detail": "<string>"
},
"phone_number": "+12345678901",
"email": "<string>"
},
"items": [
{
"product_id": "<string>",
"quantity": 2
}
],
"location_id": "<string>",
"tip": 123,
"dropoff_instructions": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
customer: {
id: '<string>',
name: '<string>',
address: {
city: '<string>',
region: 'NY',
country: 'US',
street_address: '<string>',
postal_code: '<string>',
street_address_detail: '<string>'
},
phone_number: '+12345678901',
email: '<string>'
},
items: [{product_id: '<string>', quantity: 2}],
location_id: '<string>',
tip: 123,
dropoff_instructions: '<string>'
})
};
fetch('https://api.satsuma.ai/order', 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.satsuma.ai/order",
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([
'customer' => [
'id' => '<string>',
'name' => '<string>',
'address' => [
'city' => '<string>',
'region' => 'NY',
'country' => 'US',
'street_address' => '<string>',
'postal_code' => '<string>',
'street_address_detail' => '<string>'
],
'phone_number' => '+12345678901',
'email' => '<string>'
],
'items' => [
[
'product_id' => '<string>',
'quantity' => 2
]
],
'location_id' => '<string>',
'tip' => 123,
'dropoff_instructions' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.satsuma.ai/order"
payload := strings.NewReader("{\n \"customer\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": {\n \"city\": \"<string>\",\n \"region\": \"NY\",\n \"country\": \"US\",\n \"street_address\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"street_address_detail\": \"<string>\"\n },\n \"phone_number\": \"+12345678901\",\n \"email\": \"<string>\"\n },\n \"items\": [\n {\n \"product_id\": \"<string>\",\n \"quantity\": 2\n }\n ],\n \"location_id\": \"<string>\",\n \"tip\": 123,\n \"dropoff_instructions\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.satsuma.ai/order")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customer\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": {\n \"city\": \"<string>\",\n \"region\": \"NY\",\n \"country\": \"US\",\n \"street_address\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"street_address_detail\": \"<string>\"\n },\n \"phone_number\": \"+12345678901\",\n \"email\": \"<string>\"\n },\n \"items\": [\n {\n \"product_id\": \"<string>\",\n \"quantity\": 2\n }\n ],\n \"location_id\": \"<string>\",\n \"tip\": 123,\n \"dropoff_instructions\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.satsuma.ai/order")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": {\n \"city\": \"<string>\",\n \"region\": \"NY\",\n \"country\": \"US\",\n \"street_address\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"street_address_detail\": \"<string>\"\n },\n \"phone_number\": \"+12345678901\",\n \"email\": \"<string>\"\n },\n \"items\": [\n {\n \"product_id\": \"<string>\",\n \"quantity\": 2\n }\n ],\n \"location_id\": \"<string>\",\n \"tip\": 123,\n \"dropoff_instructions\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"tip": 123,
"subtotal": 123,
"tax": 123,
"total": 123,
"customer": {
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"address": {
"street_number": "<string>",
"street_name": "<string>",
"street_address": "<string>",
"street_address_detail": "<string>",
"city": "<string>",
"region": "<string>",
"postal_code": "<string>",
"country": "<string>"
}
},
"fees": [
{
"amount": 123
}
],
"items": [
{
"quantity": 123,
"price": 123,
"product_id": "<string>",
"product_name": "<string>"
}
],
"merchant_id": "<string>",
"location_id": "<string>",
"fee_total": 123,
"dropoff_instructions": "<string>"
},
"messages": [
{
"context": "<string>",
"text": "<string>",
"data": {}
}
]
}Authorizations
API Key authentication
Body
application/json
Create order request
Customer information
Show child attributes
Show child attributes
List of items
Show child attributes
Show child attributes
Location ID
Fulfillment method
Available options:
Delivery, Pickup, Shipping Tip amount
Dropoff instructions
⌘I