Cancel an unpaid payment group
curl --request POST \
--url https://itemshop.dev/api/v2/orders/{shopId}/groups/{groupId}/cancel \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"reason": "<string>"
}
'import requests
url = "https://itemshop.dev/api/v2/orders/{shopId}/groups/{groupId}/cancel"
payload = { "reason": "<string>" }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({reason: '<string>'})
};
fetch('https://itemshop.dev/api/v2/orders/{shopId}/groups/{groupId}/cancel', 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/orders/{shopId}/groups/{groupId}/cancel",
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([
'reason' => '<string>'
]),
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://itemshop.dev/api/v2/orders/{shopId}/groups/{groupId}/cancel"
payload := strings.NewReader("{\n \"reason\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://itemshop.dev/api/v2/orders/{shopId}/groups/{groupId}/cancel")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://itemshop.dev/api/v2/orders/{shopId}/groups/{groupId}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"_id": "664f1a2b3c4d5e6f7a8b9c0d",
"groupNumber": "7K2M9QX4R8T1V6W3Y5Z0",
"shopId": "664f1a2b3c4d5e6f7a8b9c0d",
"orderIds": [
"664f1a2b3c4d5e6f7a8b9c0d"
],
"status": "paid",
"subtotal": 59.97,
"total": 53.97,
"currency": "PLN",
"refundedAmount": 0,
"lines": [
{
"orderId": "664f1a2b3c4d5e6f7a8b9c0d",
"productId": "664f1a2b3c4d5e6f7a8b9c0d",
"name": "Ranga VIP",
"variant": "30 dni",
"quantity": 1,
"subtotal": 19.99,
"discountShare": 2,
"amount": 17.99
}
],
"discount": {
"code": "LATO10",
"amount": 6
},
"payment": {
"amount": 123,
"provider": "<string>",
"transactionId": "<string>",
"completedAt": "2023-11-07T05:31:56Z"
},
"orders": [
{
"_id": "664f1a2b3c4d5e6f7a8b9c0d",
"orderNumber": "3a7b9c2d",
"status": "paid",
"groupId": "664f1a2b3c4d5e6f7a8b9c0d",
"product": {
"id": "664f1a2b3c4d5e6f7a8b9c0d",
"name": "<string>",
"price": 123
},
"customer": {
"nickname": "Steve",
"email": "<string>"
},
"payment": {
"amount": 19.99,
"currency": "PLN",
"fee": {
"percentage": 123,
"amount": 123,
"netAmount": 123
}
},
"vat": {
"enabled": true,
"rate": 23,
"amount": 123,
"netAmount": 123
},
"quantity": 1,
"createdAt": "2023-11-07T05:31:56Z"
}
],
"createdAt": "2023-11-07T05:31:56Z"
},
"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/..."
}Orders
Cancel an unpaid payment group
POST
/
api
/
v2
/
orders
/
{shopId}
/
groups
/
{groupId}
/
cancel
Cancel an unpaid payment group
curl --request POST \
--url https://itemshop.dev/api/v2/orders/{shopId}/groups/{groupId}/cancel \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"reason": "<string>"
}
'import requests
url = "https://itemshop.dev/api/v2/orders/{shopId}/groups/{groupId}/cancel"
payload = { "reason": "<string>" }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({reason: '<string>'})
};
fetch('https://itemshop.dev/api/v2/orders/{shopId}/groups/{groupId}/cancel', 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/orders/{shopId}/groups/{groupId}/cancel",
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([
'reason' => '<string>'
]),
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://itemshop.dev/api/v2/orders/{shopId}/groups/{groupId}/cancel"
payload := strings.NewReader("{\n \"reason\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://itemshop.dev/api/v2/orders/{shopId}/groups/{groupId}/cancel")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://itemshop.dev/api/v2/orders/{shopId}/groups/{groupId}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"_id": "664f1a2b3c4d5e6f7a8b9c0d",
"groupNumber": "7K2M9QX4R8T1V6W3Y5Z0",
"shopId": "664f1a2b3c4d5e6f7a8b9c0d",
"orderIds": [
"664f1a2b3c4d5e6f7a8b9c0d"
],
"status": "paid",
"subtotal": 59.97,
"total": 53.97,
"currency": "PLN",
"refundedAmount": 0,
"lines": [
{
"orderId": "664f1a2b3c4d5e6f7a8b9c0d",
"productId": "664f1a2b3c4d5e6f7a8b9c0d",
"name": "Ranga VIP",
"variant": "30 dni",
"quantity": 1,
"subtotal": 19.99,
"discountShare": 2,
"amount": 17.99
}
],
"discount": {
"code": "LATO10",
"amount": 6
},
"payment": {
"amount": 123,
"provider": "<string>",
"transactionId": "<string>",
"completedAt": "2023-11-07T05:31:56Z"
},
"orders": [
{
"_id": "664f1a2b3c4d5e6f7a8b9c0d",
"orderNumber": "3a7b9c2d",
"status": "paid",
"groupId": "664f1a2b3c4d5e6f7a8b9c0d",
"product": {
"id": "664f1a2b3c4d5e6f7a8b9c0d",
"name": "<string>",
"price": 123
},
"customer": {
"nickname": "Steve",
"email": "<string>"
},
"payment": {
"amount": 19.99,
"currency": "PLN",
"fee": {
"percentage": 123,
"amount": 123,
"netAmount": 123
}
},
"vat": {
"enabled": true,
"rate": 23,
"amount": 123,
"netAmount": 123
},
"quantity": 1,
"createdAt": "2023-11-07T05:31:56Z"
}
],
"createdAt": "2023-11-07T05:31:56Z"
},
"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
apiKeyAuthbearerAuth
Body
application/json
Reason (status history)
Maximum string length:
500Was this page helpful?
⌘I