Skip to main content
POST
/
collections
Create Collection
curl --request POST \
  --url https://api.loopreturns.com/api/v1/collections \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization: <api-key>' \
  --data '
{
  "sales_channel": "<string>",
  "name": "<string>",
  "external_id": "<string>",
  "products": [
    123
  ]
}
'
import requests

url = "https://api.loopreturns.com/api/v1/collections"

payload = {
"sales_channel": "<string>",
"name": "<string>",
"external_id": "<string>",
"products": [123]
}
headers = {
"X-Authorization": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {'X-Authorization': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
sales_channel: '<string>',
name: '<string>',
external_id: '<string>',
products: [123]
})
};

fetch('https://api.loopreturns.com/api/v1/collections', 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.loopreturns.com/api/v1/collections",
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([
'sales_channel' => '<string>',
'name' => '<string>',
'external_id' => '<string>',
'products' => [
123
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Authorization: <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"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.loopreturns.com/api/v1/collections"

payload := strings.NewReader("{\n \"sales_channel\": \"<string>\",\n \"name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"products\": [\n 123\n ]\n}")

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

req.Header.Add("X-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.loopreturns.com/api/v1/collections")
.header("X-Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sales_channel\": \"<string>\",\n \"name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"products\": [\n 123\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.loopreturns.com/api/v1/collections")

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

request = Net::HTTP::Post.new(url)
request["X-Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sales_channel\": \"<string>\",\n \"name\": \"<string>\",\n \"external_id\": \"<string>\",\n \"products\": [\n 123\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "collection": {
    "id": 123,
    "external_id": "<string>",
    "sales_channel": "<string>",
    "name": "<string>",
    "products": [
      {
        "id": 2,
        "external_id": "<string>",
        "sku": "<string>",
        "name": "<string>"
      }
    ]
  }
}
{
"errors": "<string>"
}
{
"message": "<string>",
"errors": {}
}

Authorizations

X-Authorization
string
header
required

API Scope: "Collections (write)"

Body

application/json
sales_channel
string
required

If a channel with this name is not already associated with the shop, it will be used to create a new channel.

Maximum string length: 255
Example:

"shopify"

name
string
required

The name of the collection.

Maximum string length: 255
Example:

"Footwear"

external_id
string | null

The provided external_id must be unique. If a non-unique external_id is provided, the API will respond with an error.

Maximum string length: 64
Example:

"71263csss-12uhsdfh-2138dja"

products
(integer | object)[] | null

An array of products to add to the collection.

A product to add to the collection, provided either as a plain integer global identifier or as an object with a global_id.

Response

Success

collection
object
required