Create a Meta product catalog

curl --request POST \
  --url https://api.aisa.one/apis/v1/ads/catalogs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Winter launch"
}
'

import requests

url = "https://api.aisa.one/apis/v1/ads/catalogs"

payload = { "name": "Winter launch" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Winter launch'})
};

fetch('https://api.aisa.one/apis/v1/ads/catalogs', 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.aisa.one/apis/v1/ads/catalogs",
  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' => 'Winter launch'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.aisa.one/apis/v1/ads/catalogs"

	payload := strings.NewReader("{\n  \"name\": \"Winter launch\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.aisa.one/apis/v1/ads/catalogs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Winter launch\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/ads/catalogs")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Winter launch\"\n}"

response = http.request(request)
puts response.read_body

{
  "catalog": {
    "businessId": "<string>",
    "id": "<string>",
    "name": "<string>",
    "productCount": 123,
    "vertical": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": {},
    "message": "<string>",
    "param": "<string>",
    "retryHint": "<string>",
    "retryable": true,
    "type": "<string>"
  }
}

AIsa Ads

Create a Meta product catalog

Product Catalogs. Changes the ad account without starting or raising spend; audited. Creates a Meta product catalog that can power catalog ads, Instagram and Facebook Shops, and a WhatsApp Business catalog. Creates a Meta Commerce catalog in the business portfolio (resolved like GET). Needs catalog_management on the Meta login.  A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ.

POST

https://api.aisa.one

apis

ads

catalogs

Create a Meta product catalog

curl --request POST \
  --url https://api.aisa.one/apis/v1/ads/catalogs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Winter launch"
}
'

import requests

url = "https://api.aisa.one/apis/v1/ads/catalogs"

payload = { "name": "Winter launch" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Winter launch'})
};

fetch('https://api.aisa.one/apis/v1/ads/catalogs', 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.aisa.one/apis/v1/ads/catalogs",
  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' => 'Winter launch'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.aisa.one/apis/v1/ads/catalogs"

	payload := strings.NewReader("{\n  \"name\": \"Winter launch\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.aisa.one/apis/v1/ads/catalogs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Winter launch\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/ads/catalogs")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Winter launch\"\n}"

response = http.request(request)
puts response.read_body

{
  "catalog": {
    "businessId": "<string>",
    "id": "<string>",
    "name": "<string>",
    "productCount": 123,
    "vertical": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": {},
    "message": "<string>",
    "param": "<string>",
    "retryHint": "<string>",
    "retryable": true,
    "type": "<string>"
  }
}

Request contract

Method and path: POST /apis/v1/ads/catalogs
Availability: enabled
Request URL template: https://api.aisa.one/apis/v1/ads/catalogs
connectionId: query; required
Runtime facts: fe60122939c67dc98a3a6ac6b97bd5c326b526105150c8959304dd2160d4dd09

Complete OpenAPI definition Effective request and pricing declaration (including authentication and referenced schemas):

{
  "operationId": "post_aisa_ads_apis_v1_ads_catalogs",
  "method": "POST",
  "path": "/apis/v1/ads/catalogs",
  "servers": [
    {
      "url": "https://api.aisa.one"
    }
  ],
  "parameters": [
    {
      "description": "The ads connection (adc_...) the request runs on: one of yours, from GET /apis/v1/ads/connections. On a request with a JSON body it may be sent as a top-level body member instead.",
      "in": "query",
      "name": "connectionId",
      "required": true,
      "schema": {
        "pattern": "^adc_[0-9A-Za-z]+$",
        "type": "string"
      }
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "example": {
          "connectionId": "adc_7f3k2m9q",
          "name": "Winter launch"
        },
        "schema": {
          "additionalProperties": true,
          "properties": {
            "adAccountId": {
              "description": "Ad account whose owner business creates the catalog",
              "type": "string"
            },
            "businessId": {
              "description": "Business portfolio that owns the catalog",
              "type": "string"
            },
            "catalogAccountId": {
              "description": "One of your ads connections (adc_...) whose platform login manages the catalog, when it is not this connection's.",
              "pattern": "^adc_[0-9A-Za-z]+$",
              "type": "string"
            },
            "connectionId": {
              "description": "The ads connection (adc_...), when not sent as the connectionId query parameter.",
              "pattern": "^adc_[0-9A-Za-z]+$",
              "type": "string"
            },
            "name": {
              "maxLength": 100,
              "type": "string"
            },
            "vertical": {
              "default": "commerce",
              "description": "Meta catalog vertical. Use services for a professional services catalog (for example one linked to WhatsApp). local_service_business is a deprecated alias of local_service_businesses.",
              "enum": [
                "commerce",
                "adoptable_pets",
                "apps_and_software",
                "articles_and_publications",
                "destinations",
                "flights",
                "generic",
                "home_listings",
                "hotels",
                "local_service_businesses",
                "media_titles",
                "offer_items",
                "offline_commerce",
                "services",
                "transactable_items",
                "vehicles",
                "local_service_business"
              ],
              "type": "string"
            }
          },
          "required": [
            "name"
          ],
          "type": "object"
        }
      }
    },
    "required": true
  },
  "x-aisa-status": "enabled",
  "x-aisa-pricing": {
    "description": "Ads operations are free. Ad spend is billed by the ad platform to the connected ad account, never by AIsa.",
    "kind": "no_customer_charge"
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  }
}

Cost and request rules

A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

connectionId

string

required

The ads connection (adc_...) the request runs on: one of yours, from GET /apis/v1/ads/connections. On a request with a JSON body it may be sent as a top-level body member instead.

Pattern: ^adc_[0-9A-Za-z]+$

Body

application/json

name

string

required

Maximum string length: 100

adAccountId

string

Ad account whose owner business creates the catalog

businessId

string

Business portfolio that owns the catalog

catalogAccountId

string

One of your ads connections (adc_...) whose platform login manages the catalog, when it is not this connection's.

Pattern: ^adc_[0-9A-Za-z]+$

connectionId

string

The ads connection (adc_...), when not sent as the connectionId query parameter.

Pattern: ^adc_[0-9A-Za-z]+$

vertical

enum<string>

default:commerce

Meta catalog vertical. Use services for a professional services catalog (for example one linked to WhatsApp). local_service_business is a deprecated alias of local_service_businesses.

Available options:

commerce,

adoptable_pets,

apps_and_software,

articles_and_publications,

destinations,

flights,

generic,

home_listings,

hotels,

local_service_businesses,

media_titles,

offer_items,

offline_commerce,

services,

transactable_items,

vehicles,

local_service_business

Response

Catalog created

catalog

object

Show child attributes

​Request contract

​Cost and request rules

Authorizations

Query Parameters

Body

Response

Request contract

Cost and request rules