Retrieve commerce schema
curl --request GET \
--url https://api.mercemur.com/api/v1/commerce-schema \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.mercemur.com/api/v1/commerce-schema', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.mercemur.com/api/v1/commerce-schema"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.mercemur.com/api/v1/commerce-schema"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mercemur.com/api/v1/commerce-schema",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {
"filters": [
"<string>"
],
"kinds": {
"404": [
"<string>"
],
"cart": [
"<string>"
],
"collection": [
"<string>"
],
"footer": [
"<string>"
],
"header": [
"<string>"
],
"home": [
"<string>"
],
"product": [
"<string>"
],
"search": [
"<string>"
]
},
"loop_vars": {
"cart.items": "<string>",
"collection.products": "<string>",
"line_item.properties": "<string>",
"order.line_items": "<string>",
"product.options_with_values": "<string>",
"product.variants": "<string>",
"product_option.values": "<string>",
"search.results": "<string>"
},
"objects": {
"cart": {
"properties": {
"currency": {
"type": "<string>"
},
"item_count": {
"type": "<string>"
},
"items": {
"list": true,
"object": "<string>",
"type": "<string>"
},
"items_subtotal_price": {
"money": true,
"type": "<string>"
},
"total_discount": {
"type": "<string>"
},
"total_price": {
"money": true,
"type": "<string>"
}
}
},
"collection": {
"properties": {
"description": {
"type": "<string>"
},
"featured_image": {
"type": "<string>"
},
"handle": {
"type": "<string>"
},
"id": {
"type": "<string>"
},
"image": {
"type": "<string>"
},
"products": {
"list": true,
"object": "<string>",
"type": "<string>"
},
"products_count": {
"type": "<string>"
},
"title": {
"type": "<string>"
},
"url": {
"type": "<string>"
}
}
},
"customer": {
"properties": {
"email": {
"type": "<string>"
},
"first_name": {
"type": "<string>"
},
"id": {
"type": "<string>"
},
"last_name": {
"type": "<string>"
},
"name": {
"type": "<string>"
}
}
},
"line_item": {
"properties": {
"final_line_price": {
"money": true,
"type": "<string>"
},
"final_price": {
"money": true,
"type": "<string>"
},
"id": {
"type": "<string>"
},
"image": {
"type": "<string>"
},
"key": {
"type": "<string>"
},
"original_line_price": {
"money": true,
"type": "<string>"
},
"original_price": {
"money": true,
"type": "<string>"
},
"product_title": {
"type": "<string>"
},
"properties": {
"list": true,
"object": "<string>",
"type": "<string>"
},
"quantity": {
"type": "<string>"
},
"title": {
"type": "<string>"
},
"url": {
"type": "<string>"
},
"variant_id": {
"type": "<string>"
},
"variant_title": {
"type": "<string>"
},
"vendor": {
"type": "<string>"
}
}
},
"line_property": {
"properties": {
"name": {
"type": "<string>"
},
"value": {
"type": "<string>"
}
}
},
"order": {
"properties": {
"created_at": {
"type": "<string>"
},
"currency": {
"type": "<string>"
},
"email": {
"type": "<string>"
},
"id": {
"type": "<string>"
},
"item_count": {
"type": "<string>"
},
"line_items": {
"list": true,
"object": "<string>",
"type": "<string>"
},
"name": {
"type": "<string>"
},
"order_number": {
"type": "<string>"
},
"shipping_price": {
"money": true,
"type": "<string>"
},
"status": {
"type": "<string>"
},
"subtotal_price": {
"money": true,
"type": "<string>"
},
"tax_price": {
"money": true,
"type": "<string>"
}
}
},
"product": {
"properties": {
"available": {
"type": "<string>"
},
"compare_at_price": {
"money": true,
"type": "<string>"
},
"compare_at_price_varies": {
"type": "<string>"
},
"currency": {
"type": "<string>"
},
"description": {
"type": "<string>"
},
"featured_image": {
"type": "<string>"
},
"gift_card": {
"type": "<string>"
},
"handle": {
"type": "<string>"
},
"has_only_default_variant": {
"type": "<string>"
},
"id": {
"type": "<string>"
},
"images": {
"list": true,
"type": "<string>"
},
"metafields": {
"type": "<string>"
},
"options_with_values": {
"list": true,
"object": "<string>",
"type": "<string>"
},
"price": {
"money": true,
"type": "<string>"
},
"price_max": {
"money": true,
"type": "<string>"
},
"price_min": {
"money": true,
"type": "<string>"
},
"price_varies": {
"type": "<string>"
},
"quantity_price_breaks_configured": {
"type": "<string>"
},
"selected_or_first_available_variant": {
"object": "<string>",
"type": "<string>"
},
"title": {
"type": "<string>"
},
"url": {
"type": "<string>"
},
"variants": {
"list": true,
"object": "<string>",
"type": "<string>"
},
"variants_count": {
"type": "<string>"
},
"vendor": {
"type": "<string>"
}
}
},
"product_option": {
"properties": {
"name": {
"type": "<string>"
},
"position": {
"type": "<string>"
},
"selected_value": {
"type": "<string>"
},
"values": {
"list": true,
"object": "<string>",
"type": "<string>"
}
}
},
"product_option_value": {
"properties": {
"available": {
"type": "<string>"
},
"name": {
"type": "<string>"
},
"selected": {
"type": "<string>"
}
}
},
"search": {
"properties": {
"performed": {
"type": "<string>"
},
"results": {
"list": true,
"object": "<string>",
"type": "<string>"
},
"results_count": {
"type": "<string>"
},
"terms": {
"type": "<string>"
}
}
},
"shop": {
"properties": {
"currency": {
"type": "<string>"
},
"domain": {
"type": "<string>"
},
"id": {
"type": "<string>"
},
"name": {
"type": "<string>"
},
"secure_url": {
"type": "<string>"
},
"url": {
"type": "<string>"
}
}
},
"variant": {
"properties": {
"available": {
"type": "<string>"
},
"compare_at_price": {
"money": true,
"type": "<string>"
},
"id": {
"type": "<string>"
},
"image": {
"type": "<string>"
},
"inventory_quantity": {
"type": "<string>"
},
"options": {
"list": true,
"type": "<string>"
},
"price": {
"money": true,
"type": "<string>"
},
"sku": {
"type": "<string>"
},
"title": {
"type": "<string>"
}
}
}
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"resource": "<string>",
"field": "<string>",
"reason": "malformed_json"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"resource": "<string>",
"field": "<string>",
"reason": "malformed_json"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"resource": "<string>",
"field": "<string>",
"reason": "malformed_json"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"resource": "<string>",
"field": "<string>",
"reason": "malformed_json"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"resource": "<string>",
"field": "<string>",
"reason": "malformed_json"
}
}Retrieve commerce schema
GET
/
api
/
v1
/
commerce-schema
Retrieve commerce schema
curl --request GET \
--url https://api.mercemur.com/api/v1/commerce-schema \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.mercemur.com/api/v1/commerce-schema', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.mercemur.com/api/v1/commerce-schema"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.mercemur.com/api/v1/commerce-schema"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mercemur.com/api/v1/commerce-schema",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {
"filters": [
"<string>"
],
"kinds": {
"404": [
"<string>"
],
"cart": [
"<string>"
],
"collection": [
"<string>"
],
"footer": [
"<string>"
],
"header": [
"<string>"
],
"home": [
"<string>"
],
"product": [
"<string>"
],
"search": [
"<string>"
]
},
"loop_vars": {
"cart.items": "<string>",
"collection.products": "<string>",
"line_item.properties": "<string>",
"order.line_items": "<string>",
"product.options_with_values": "<string>",
"product.variants": "<string>",
"product_option.values": "<string>",
"search.results": "<string>"
},
"objects": {
"cart": {
"properties": {
"currency": {
"type": "<string>"
},
"item_count": {
"type": "<string>"
},
"items": {
"list": true,
"object": "<string>",
"type": "<string>"
},
"items_subtotal_price": {
"money": true,
"type": "<string>"
},
"total_discount": {
"type": "<string>"
},
"total_price": {
"money": true,
"type": "<string>"
}
}
},
"collection": {
"properties": {
"description": {
"type": "<string>"
},
"featured_image": {
"type": "<string>"
},
"handle": {
"type": "<string>"
},
"id": {
"type": "<string>"
},
"image": {
"type": "<string>"
},
"products": {
"list": true,
"object": "<string>",
"type": "<string>"
},
"products_count": {
"type": "<string>"
},
"title": {
"type": "<string>"
},
"url": {
"type": "<string>"
}
}
},
"customer": {
"properties": {
"email": {
"type": "<string>"
},
"first_name": {
"type": "<string>"
},
"id": {
"type": "<string>"
},
"last_name": {
"type": "<string>"
},
"name": {
"type": "<string>"
}
}
},
"line_item": {
"properties": {
"final_line_price": {
"money": true,
"type": "<string>"
},
"final_price": {
"money": true,
"type": "<string>"
},
"id": {
"type": "<string>"
},
"image": {
"type": "<string>"
},
"key": {
"type": "<string>"
},
"original_line_price": {
"money": true,
"type": "<string>"
},
"original_price": {
"money": true,
"type": "<string>"
},
"product_title": {
"type": "<string>"
},
"properties": {
"list": true,
"object": "<string>",
"type": "<string>"
},
"quantity": {
"type": "<string>"
},
"title": {
"type": "<string>"
},
"url": {
"type": "<string>"
},
"variant_id": {
"type": "<string>"
},
"variant_title": {
"type": "<string>"
},
"vendor": {
"type": "<string>"
}
}
},
"line_property": {
"properties": {
"name": {
"type": "<string>"
},
"value": {
"type": "<string>"
}
}
},
"order": {
"properties": {
"created_at": {
"type": "<string>"
},
"currency": {
"type": "<string>"
},
"email": {
"type": "<string>"
},
"id": {
"type": "<string>"
},
"item_count": {
"type": "<string>"
},
"line_items": {
"list": true,
"object": "<string>",
"type": "<string>"
},
"name": {
"type": "<string>"
},
"order_number": {
"type": "<string>"
},
"shipping_price": {
"money": true,
"type": "<string>"
},
"status": {
"type": "<string>"
},
"subtotal_price": {
"money": true,
"type": "<string>"
},
"tax_price": {
"money": true,
"type": "<string>"
}
}
},
"product": {
"properties": {
"available": {
"type": "<string>"
},
"compare_at_price": {
"money": true,
"type": "<string>"
},
"compare_at_price_varies": {
"type": "<string>"
},
"currency": {
"type": "<string>"
},
"description": {
"type": "<string>"
},
"featured_image": {
"type": "<string>"
},
"gift_card": {
"type": "<string>"
},
"handle": {
"type": "<string>"
},
"has_only_default_variant": {
"type": "<string>"
},
"id": {
"type": "<string>"
},
"images": {
"list": true,
"type": "<string>"
},
"metafields": {
"type": "<string>"
},
"options_with_values": {
"list": true,
"object": "<string>",
"type": "<string>"
},
"price": {
"money": true,
"type": "<string>"
},
"price_max": {
"money": true,
"type": "<string>"
},
"price_min": {
"money": true,
"type": "<string>"
},
"price_varies": {
"type": "<string>"
},
"quantity_price_breaks_configured": {
"type": "<string>"
},
"selected_or_first_available_variant": {
"object": "<string>",
"type": "<string>"
},
"title": {
"type": "<string>"
},
"url": {
"type": "<string>"
},
"variants": {
"list": true,
"object": "<string>",
"type": "<string>"
},
"variants_count": {
"type": "<string>"
},
"vendor": {
"type": "<string>"
}
}
},
"product_option": {
"properties": {
"name": {
"type": "<string>"
},
"position": {
"type": "<string>"
},
"selected_value": {
"type": "<string>"
},
"values": {
"list": true,
"object": "<string>",
"type": "<string>"
}
}
},
"product_option_value": {
"properties": {
"available": {
"type": "<string>"
},
"name": {
"type": "<string>"
},
"selected": {
"type": "<string>"
}
}
},
"search": {
"properties": {
"performed": {
"type": "<string>"
},
"results": {
"list": true,
"object": "<string>",
"type": "<string>"
},
"results_count": {
"type": "<string>"
},
"terms": {
"type": "<string>"
}
}
},
"shop": {
"properties": {
"currency": {
"type": "<string>"
},
"domain": {
"type": "<string>"
},
"id": {
"type": "<string>"
},
"name": {
"type": "<string>"
},
"secure_url": {
"type": "<string>"
},
"url": {
"type": "<string>"
}
}
},
"variant": {
"properties": {
"available": {
"type": "<string>"
},
"compare_at_price": {
"money": true,
"type": "<string>"
},
"id": {
"type": "<string>"
},
"image": {
"type": "<string>"
},
"inventory_quantity": {
"type": "<string>"
},
"options": {
"list": true,
"type": "<string>"
},
"price": {
"money": true,
"type": "<string>"
},
"sku": {
"type": "<string>"
},
"title": {
"type": "<string>"
}
}
}
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"resource": "<string>",
"field": "<string>",
"reason": "malformed_json"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"resource": "<string>",
"field": "<string>",
"reason": "malformed_json"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"resource": "<string>",
"field": "<string>",
"reason": "malformed_json"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"resource": "<string>",
"field": "<string>",
"reason": "malformed_json"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"resource": "<string>",
"field": "<string>",
"reason": "malformed_json"
}
}Authorizations
apiKeyapiKeyHeader
A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.
Response
Success
Show child attributes
Show child attributes
⌘I