Issue a presigned S3 upload URL for a new attachment

Returns a presigned S3 PUT URL valid for 15 minutes plus the canonical attachment row pre-allocated with status=pending_upload. The client PUTs the file bytes to the returned URL, then calls POST /attachments (with the issued attachment_id) to finalise the row. Requires attachments:write scope.

POST /attachments/upload-url

Issue a presigned S3 upload URL for a new attachment

cURL

curl --request POST \
  --url https://api.arcuserp.com/v1/attachments/upload-url \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filename": "<string>",
  "content_type": "<string>",
  "parent_type": "<string>",
  "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "size_bytes": 123
}
'

import requests

url = "https://api.arcuserp.com/v1/attachments/upload-url"

payload = {
    "filename": "<string>",
    "content_type": "<string>",
    "parent_type": "<string>",
    "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "size_bytes": 123
}
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({
    filename: '<string>',
    content_type: '<string>',
    parent_type: '<string>',
    parent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    size_bytes: 123
  })
};

fetch('https://api.arcuserp.com/v1/attachments/upload-url', 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.arcuserp.com/v1/attachments/upload-url",
  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([
    'filename' => '<string>',
    'content_type' => '<string>',
    'parent_type' => '<string>',
    'parent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'size_bytes' => 123
  ]),
  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.arcuserp.com/v1/attachments/upload-url"

	payload := strings.NewReader("{\n  \"filename\": \"<string>\",\n  \"content_type\": \"<string>\",\n  \"parent_type\": \"<string>\",\n  \"parent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"size_bytes\": 123\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.arcuserp.com/v1/attachments/upload-url")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filename\": \"<string>\",\n  \"content_type\": \"<string>\",\n  \"parent_type\": \"<string>\",\n  \"parent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"size_bytes\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/attachments/upload-url")

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  \"filename\": \"<string>\",\n  \"content_type\": \"<string>\",\n  \"parent_type\": \"<string>\",\n  \"parent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"size_bytes\": 123\n}"

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

200

{
  "upload_url": "<string>",
  "attachment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expires_at": "2023-11-07T05:31:56Z"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

Authorizations

Authorization · string · header · required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Body

application/json

filename · string · required

content_type · string · required

parent_type · string · required

parent_id · string<uuid> · required

size_bytes · integer

Response

200

application/json

Presigned upload URL + pending attachment row

upload_url · string

attachment_id · string<uuid>

expires_at · string<date-time>