Archive article
curl --request PUT \
--url https://server.twicecommerce.com/v1/admin/articles/{id}/archive \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '{
"force": true
}'import requests
url = "https://server.twicecommerce.com/v1/admin/articles/{id}/archive"
payload = { "force": True }
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({force: true})
};
fetch('https://server.twicecommerce.com/v1/admin/articles/{id}/archive', 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://server.twicecommerce.com/v1/admin/articles/{id}/archive",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'force' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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://server.twicecommerce.com/v1/admin/articles/{id}/archive"
payload := strings.NewReader("{\n \"force\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-KEY", "<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.put("https://server.twicecommerce.com/v1/admin/articles/{id}/archive")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"force\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://server.twicecommerce.com/v1/admin/articles/{id}/archive")
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/json'
request.body = "{\n \"force\": true\n}"
response = http.request(request)
puts response.read_bodytrue{
"items": {
"kind": "upcomingOrderBookings",
"severity": "warning",
"count": 0,
"samples": {
"id": "<string>",
"label": "<string>",
"date": "<string>"
}
}
}Archive article
Archives article — removes it from active use while keeping its history, and it can be brought back with unarchive. If archiving would affect live data (e.g. bookings that haven’t ended, listings that would be left unpriced) the request is refused with 409 and the impact; pass force: true to archive anyway.
API key scope: one of inventory.stock_items.write.
PUT
/
v1
/
admin
/
articles
/
{id}
/
archive
Archive article
curl --request PUT \
--url https://server.twicecommerce.com/v1/admin/articles/{id}/archive \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '{
"force": true
}'import requests
url = "https://server.twicecommerce.com/v1/admin/articles/{id}/archive"
payload = { "force": True }
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({force: true})
};
fetch('https://server.twicecommerce.com/v1/admin/articles/{id}/archive', 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://server.twicecommerce.com/v1/admin/articles/{id}/archive",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'force' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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://server.twicecommerce.com/v1/admin/articles/{id}/archive"
payload := strings.NewReader("{\n \"force\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-KEY", "<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.put("https://server.twicecommerce.com/v1/admin/articles/{id}/archive")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"force\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://server.twicecommerce.com/v1/admin/articles/{id}/archive")
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/json'
request.body = "{\n \"force\": true\n}"
response = http.request(request)
puts response.read_bodytrue{
"items": {
"kind": "upcomingOrderBookings",
"severity": "warning",
"count": 0,
"samples": {
"id": "<string>",
"label": "<string>",
"date": "<string>"
}
}
}Was this page helpful?