Skip to main content
POST
/
v3
/
countries
Add Country
curl --request POST \
  --url https://api.{tenant}.getomneo.com/api/v3/countries \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "iso_2": "<string>",
  "iso_3": "<string>",
  "iso_numeric": "<string>",
  "sort_order": 123,
  "currency": "<string>",
  "states": [
    {
      "name": "<string>",
      "type": "<string>",
      "iso": "<string>",
      "iso_2_country": "<string>",
      "iso_2_country_state_code": "<string>",
      "sort_order": 123
    }
  ]
}
'
import requests

url = "https://api.{tenant}.getomneo.com/api/v3/countries"

payload = {
"name": "<string>",
"iso_2": "<string>",
"iso_3": "<string>",
"iso_numeric": "<string>",
"sort_order": 123,
"currency": "<string>",
"states": [
{
"name": "<string>",
"type": "<string>",
"iso": "<string>",
"iso_2_country": "<string>",
"iso_2_country_state_code": "<string>",
"sort_order": 123
}
]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
iso_2: '<string>',
iso_3: '<string>',
iso_numeric: '<string>',
sort_order: 123,
currency: '<string>',
states: [
{
name: '<string>',
type: '<string>',
iso: '<string>',
iso_2_country: '<string>',
iso_2_country_state_code: '<string>',
sort_order: 123
}
]
})
};

fetch('https://api.{tenant}.getomneo.com/api/v3/countries', 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.{tenant}.getomneo.com/api/v3/countries",
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([
'name' => '<string>',
'iso_2' => '<string>',
'iso_3' => '<string>',
'iso_numeric' => '<string>',
'sort_order' => 123,
'currency' => '<string>',
'states' => [
[
'name' => '<string>',
'type' => '<string>',
'iso' => '<string>',
'iso_2_country' => '<string>',
'iso_2_country_state_code' => '<string>',
'sort_order' => 123
]
]
]),
CURLOPT_HTTPHEADER => [
"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.{tenant}.getomneo.com/api/v3/countries"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"iso_2\": \"<string>\",\n \"iso_3\": \"<string>\",\n \"iso_numeric\": \"<string>\",\n \"sort_order\": 123,\n \"currency\": \"<string>\",\n \"states\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"iso\": \"<string>\",\n \"iso_2_country\": \"<string>\",\n \"iso_2_country_state_code\": \"<string>\",\n \"sort_order\": 123\n }\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

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.{tenant}.getomneo.com/api/v3/countries")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"iso_2\": \"<string>\",\n \"iso_3\": \"<string>\",\n \"iso_numeric\": \"<string>\",\n \"sort_order\": 123,\n \"currency\": \"<string>\",\n \"states\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"iso\": \"<string>\",\n \"iso_2_country\": \"<string>\",\n \"iso_2_country_state_code\": \"<string>\",\n \"sort_order\": 123\n }\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.{tenant}.getomneo.com/api/v3/countries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"iso_2\": \"<string>\",\n \"iso_3\": \"<string>\",\n \"iso_numeric\": \"<string>\",\n \"sort_order\": 123,\n \"currency\": \"<string>\",\n \"states\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"iso\": \"<string>\",\n \"iso_2_country\": \"<string>\",\n \"iso_2_country_state_code\": \"<string>\",\n \"sort_order\": 123\n }\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": 123,
    "name": "<string>",
    "iso_2": "<string>",
    "iso_3": "<string>",
    "iso_numeric": "<string>",
    "sort_order": 123,
    "states": [
      {
        "id": 123,
        "name": "<string>",
        "type": "<string>",
        "iso": "<string>",
        "iso_2_country": "<string>",
        "iso_2_country_state_code": "<string>",
        "sort_order": 123,
        "created_at": "<string>",
        "updated_at": "<string>"
      }
    ],
    "currency": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "region": {
      "id": "<string>",
      "name": "<string>",
      "handle": "<string>",
      "is_default": "<string>"
    }
  }
}
{
"message": "<string>"
}
{
"message": "<string>"
}
{
"message": "<string>",
"errors": {}
}

Body

application/json
name
string
required
iso_2
string
required
iso_3
string | null
iso_numeric
string | null
sort_order
integer | null
currency
string | null
states
object[]
Minimum array length: 1

Response

Country

data
Country · object
required