Write a file to the draft

curl --request PUT \
  --url https://itemshop.dev/api/v2/shops/{shopId}/site/files/{path} \
  --header 'Content-Type: application/octet-stream' \
  --header 'X-API-Key: <api-key>' \
  --data '<string>'

import requests

url = "https://itemshop.dev/api/v2/shops/{shopId}/site/files/{path}"

payload = "<string>"
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/octet-stream"
}

response = requests.put(url, data=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/octet-stream'},
  body: '<string>'
};

fetch('https://itemshop.dev/api/v2/shops/{shopId}/site/files/{path}', 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://itemshop.dev/api/v2/shops/{shopId}/site/files/{path}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "<string>",
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/octet-stream",
    "X-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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://itemshop.dev/api/v2/shops/{shopId}/site/files/{path}"

	payload := strings.NewReader("<string>")

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

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/octet-stream")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://itemshop.dev/api/v2/shops/{shopId}/site/files/{path}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/octet-stream")
  .body("<string>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://itemshop.dev/api/v2/shops/{shopId}/site/files/{path}")

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

request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/octet-stream'
request.body = "<string>"

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

{
  "success": true,
  "data": {},
  "message": "<string>"
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

PUT

api

shops

{shopId}

site

files

{path}

Write a file to the draft

curl --request PUT \
  --url https://itemshop.dev/api/v2/shops/{shopId}/site/files/{path} \
  --header 'Content-Type: application/octet-stream' \
  --header 'X-API-Key: <api-key>' \
  --data '<string>'

import requests

url = "https://itemshop.dev/api/v2/shops/{shopId}/site/files/{path}"

payload = "<string>"
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/octet-stream"
}

response = requests.put(url, data=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/octet-stream'},
  body: '<string>'
};

fetch('https://itemshop.dev/api/v2/shops/{shopId}/site/files/{path}', 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://itemshop.dev/api/v2/shops/{shopId}/site/files/{path}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "<string>",
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/octet-stream",
    "X-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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://itemshop.dev/api/v2/shops/{shopId}/site/files/{path}"

	payload := strings.NewReader("<string>")

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

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/octet-stream")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://itemshop.dev/api/v2/shops/{shopId}/site/files/{path}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/octet-stream")
  .body("<string>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://itemshop.dev/api/v2/shops/{shopId}/site/files/{path}")

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

request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/octet-stream'
request.body = "<string>"

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

{
  "success": true,
  "data": {},
  "message": "<string>"
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

Authorizations

X-API-Key

string

header

required

Path Parameters

shopId

string

required

Shop ID (ObjectId)

Body

Raw bytes or JSON { content, encoding }

The body is of type file.

Response

success

boolean

Example:

true

data

object

message

string

Overview

Storefront API v1

Shop API

Write a file to the draft

Authorizations

Path Parameters

Body

Response