Get a bulk shipping group

curl --request GET \
  --url https://api-dev.rain.xyz/v1/issuing/shipping-groups/{shippingGroupId} \
  --header 'Api-Key: <api-key>'

const options = {method: 'GET', headers: {'Api-Key': '<api-key>'}};

fetch('https://api-dev.rain.xyz/v1/issuing/shipping-groups/{shippingGroupId}', 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/{shippingGroupId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-dev.rain.xyz/v1/issuing/shipping-groups/{shippingGroupId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-dev.rain.xyz/v1/issuing/shipping-groups/{shippingGroupId}")

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

request = Net::HTTP::Get.new(url)
request["Api-Key"] = '<api-key>'

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"
}

GET

issuing

shipping-groups

{shippingGroupId}

Get a bulk shipping group

curl --request GET \
  --url https://api-dev.rain.xyz/v1/issuing/shipping-groups/{shippingGroupId} \
  --header 'Api-Key: <api-key>'

const options = {method: 'GET', headers: {'Api-Key': '<api-key>'}};

fetch('https://api-dev.rain.xyz/v1/issuing/shipping-groups/{shippingGroupId}', 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/{shippingGroupId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-dev.rain.xyz/v1/issuing/shipping-groups/{shippingGroupId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-dev.rain.xyz/v1/issuing/shipping-groups/{shippingGroupId}")

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

request = Net::HTTP::Get.new(url)
request["Api-Key"] = '<api-key>'

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

Api-Key

string

header

required

Path Parameters

shippingGroupId

string<uuid>

required

Id of the bulk shipping group to get

Response

Successful operation

string<uuid>

required

recipientFirstName

string

required

The recipient's first name

Maximum string length: 50

address

object

required

The bulk shipment's destination address

Show child attributes

recipientLastName

string

The recipient's last name

Maximum string length: 50

recipientPhoneCountryCode

string

The receiving party's phone country code

Required string length: 1 - 3

Pattern: ^[0-9]+$

Example:

"1"

recipientPhoneNumber

string

The receiving party's phone number

Required string length: 1 - 15

Pattern: ^[0-9]+$

Example:

"5555555555"

Overview

Compliance

Cards

Payments

Webhooks

Webhook Events

Get a bulk shipping group

Authorizations

Path Parameters

Response