Create a bulk shipping group
curl --request POST \
--url https://api-dev.rain.xyz/v1/issuing/shipping-groups \
--header 'Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"recipientFirstName": "<string>",
"address": {
"line1": "<string>",
"city": "<string>",
"region": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"line2": "<string>",
"country": "<string>"
},
"recipientLastName": "<string>",
"recipientPhoneCountryCode": "1",
"recipientPhoneNumber": "5555555555"
}
'import requests
url = "https://api-dev.rain.xyz/v1/issuing/shipping-groups"
payload = {
"recipientFirstName": "<string>",
"address": {
"line1": "<string>",
"city": "<string>",
"region": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"line2": "<string>",
"country": "<string>"
},
"recipientLastName": "<string>",
"recipientPhoneCountryCode": "1",
"recipientPhoneNumber": "5555555555"
}
headers = {
"Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
recipientFirstName: '<string>',
address: {
line1: '<string>',
city: '<string>',
region: '<string>',
postalCode: '<string>',
countryCode: '<string>',
line2: '<string>',
country: '<string>'
},
recipientLastName: '<string>',
recipientPhoneCountryCode: '1',
recipientPhoneNumber: '5555555555'
})
};
fetch('https://api-dev.rain.xyz/v1/issuing/shipping-groups', 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-dev.rain.xyz/v1/issuing/shipping-groups",
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([
'recipientFirstName' => '<string>',
'address' => [
'line1' => '<string>',
'city' => '<string>',
'region' => '<string>',
'postalCode' => '<string>',
'countryCode' => '<string>',
'line2' => '<string>',
'country' => '<string>'
],
'recipientLastName' => '<string>',
'recipientPhoneCountryCode' => '1',
'recipientPhoneNumber' => '5555555555'
]),
CURLOPT_HTTPHEADER => [
"Api-Key: <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-dev.rain.xyz/v1/issuing/shipping-groups"
payload := strings.NewReader("{\n \"recipientFirstName\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"line2\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"recipientLastName\": \"<string>\",\n \"recipientPhoneCountryCode\": \"1\",\n \"recipientPhoneNumber\": \"5555555555\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Api-Key", "<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-dev.rain.xyz/v1/issuing/shipping-groups")
.header("Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"recipientFirstName\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"line2\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"recipientLastName\": \"<string>\",\n \"recipientPhoneCountryCode\": \"1\",\n \"recipientPhoneNumber\": \"5555555555\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-dev.rain.xyz/v1/issuing/shipping-groups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"recipientFirstName\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"line2\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"recipientLastName\": \"<string>\",\n \"recipientPhoneCountryCode\": \"1\",\n \"recipientPhoneNumber\": \"5555555555\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recipientFirstName": "<string>",
"address": {
"line1": "<string>",
"city": "<string>",
"region": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"line2": "<string>",
"country": "<string>"
},
"recipientLastName": "<string>",
"recipientPhoneCountryCode": "1",
"recipientPhoneNumber": "5555555555"
}Shipping
Create a bulk shipping group
POST
/
issuing
/
shipping-groups
Create a bulk shipping group
curl --request POST \
--url https://api-dev.rain.xyz/v1/issuing/shipping-groups \
--header 'Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"recipientFirstName": "<string>",
"address": {
"line1": "<string>",
"city": "<string>",
"region": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"line2": "<string>",
"country": "<string>"
},
"recipientLastName": "<string>",
"recipientPhoneCountryCode": "1",
"recipientPhoneNumber": "5555555555"
}
'import requests
url = "https://api-dev.rain.xyz/v1/issuing/shipping-groups"
payload = {
"recipientFirstName": "<string>",
"address": {
"line1": "<string>",
"city": "<string>",
"region": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"line2": "<string>",
"country": "<string>"
},
"recipientLastName": "<string>",
"recipientPhoneCountryCode": "1",
"recipientPhoneNumber": "5555555555"
}
headers = {
"Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
recipientFirstName: '<string>',
address: {
line1: '<string>',
city: '<string>',
region: '<string>',
postalCode: '<string>',
countryCode: '<string>',
line2: '<string>',
country: '<string>'
},
recipientLastName: '<string>',
recipientPhoneCountryCode: '1',
recipientPhoneNumber: '5555555555'
})
};
fetch('https://api-dev.rain.xyz/v1/issuing/shipping-groups', 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-dev.rain.xyz/v1/issuing/shipping-groups",
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([
'recipientFirstName' => '<string>',
'address' => [
'line1' => '<string>',
'city' => '<string>',
'region' => '<string>',
'postalCode' => '<string>',
'countryCode' => '<string>',
'line2' => '<string>',
'country' => '<string>'
],
'recipientLastName' => '<string>',
'recipientPhoneCountryCode' => '1',
'recipientPhoneNumber' => '5555555555'
]),
CURLOPT_HTTPHEADER => [
"Api-Key: <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-dev.rain.xyz/v1/issuing/shipping-groups"
payload := strings.NewReader("{\n \"recipientFirstName\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"line2\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"recipientLastName\": \"<string>\",\n \"recipientPhoneCountryCode\": \"1\",\n \"recipientPhoneNumber\": \"5555555555\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Api-Key", "<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-dev.rain.xyz/v1/issuing/shipping-groups")
.header("Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"recipientFirstName\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"line2\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"recipientLastName\": \"<string>\",\n \"recipientPhoneCountryCode\": \"1\",\n \"recipientPhoneNumber\": \"5555555555\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-dev.rain.xyz/v1/issuing/shipping-groups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"recipientFirstName\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"line2\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"recipientLastName\": \"<string>\",\n \"recipientPhoneCountryCode\": \"1\",\n \"recipientPhoneNumber\": \"5555555555\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recipientFirstName": "<string>",
"address": {
"line1": "<string>",
"city": "<string>",
"region": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"line2": "<string>",
"country": "<string>"
},
"recipientLastName": "<string>",
"recipientPhoneCountryCode": "1",
"recipientPhoneNumber": "5555555555"
}Authorizations
Body
application/json
The address of the bulk shipping group to create
The recipient's first name
Maximum string length:
50The bulk shipment's destination address
Show child attributes
Show child attributes
The recipient's last name
Maximum string length:
50The receiving party's phone country code
Required string length:
1 - 3Pattern:
^[0-9]+$Example:
"1"
The receiving party's phone number
Required string length:
1 - 15Pattern:
^[0-9]+$Example:
"5555555555"
Response
Successful operation
The recipient's first name
Maximum string length:
50The bulk shipment's destination address
Show child attributes
Show child attributes
The recipient's last name
Maximum string length:
50The receiving party's phone country code
Required string length:
1 - 3Pattern:
^[0-9]+$Example:
"1"
The receiving party's phone number
Required string length:
1 - 15Pattern:
^[0-9]+$Example:
"5555555555"