Skip to main content
PUT
/
wms
/
returns
/
{return_id}
/
cancel
Cancel Return
curl --request PUT \
  --url https://production.trackstarhq.com/wms/returns/{return_id}/cancel \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>'
import requests

url = "https://production.trackstarhq.com/wms/returns/{return_id}/cancel"

headers = {
"x-trackstar-api-key": "<x-trackstar-api-key>",
"x-trackstar-access-token": "<x-trackstar-access-token>"
}

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

print(response.text)
const options = {
method: 'PUT',
headers: {
'x-trackstar-api-key': '<x-trackstar-api-key>',
'x-trackstar-access-token': '<x-trackstar-access-token>'
}
};

fetch('https://production.trackstarhq.com/wms/returns/{return_id}/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://production.trackstarhq.com/wms/returns/{return_id}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_HTTPHEADER => [
"x-trackstar-access-token: <x-trackstar-access-token>",
"x-trackstar-api-key: <x-trackstar-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"
"net/http"
"io"
)

func main() {

url := "https://production.trackstarhq.com/wms/returns/{return_id}/cancel"

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

req.Header.Add("x-trackstar-api-key", "<x-trackstar-api-key>")
req.Header.Add("x-trackstar-access-token", "<x-trackstar-access-token>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://production.trackstarhq.com/wms/returns/{return_id}/cancel")
.header("x-trackstar-api-key", "<x-trackstar-api-key>")
.header("x-trackstar-access-token", "<x-trackstar-access-token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://production.trackstarhq.com/wms/returns/{return_id}/cancel")

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

request = Net::HTTP::Put.new(url)
request["x-trackstar-api-key"] = '<x-trackstar-api-key>'
request["x-trackstar-access-token"] = '<x-trackstar-access-token>'

response = http.request(request)
puts response.read_body
{
  "id": "id",
  "unused_fields": [
    "<string>"
  ],
  "data": {
    "id": "return_id",
    "warehouse_customer_id": "warehouse_customer_id",
    "created_date": "2022-01-01T00:00:00Z",
    "updated_date": "2022-01-02T05:05:05Z",
    "status": "cancelled",
    "raw_status": "raw_status",
    "order_id": "order_id",
    "notes": [
      "This is a note"
    ],
    "line_items": [
      {
        "inventory_item_id": "item_id",
        "sku": "sku",
        "expected_quantity": 1,
        "received_quantity": 1,
        "restocked_quantity": 1,
        "return_reason": "Too Small"
      }
    ],
    "shipments": [],
    "external_system_url": "https://example.com/return/123",
    "trackstar_tags": [
      "tag1",
      "tag2",
      {
        "tag3": "value3"
      }
    ],
    "additional_fields": {
      "key": "value"
    },
    "trackstar_created_date": "2023-11-07T05:31:56Z",
    "trackstar_updated_date": "2023-11-07T05:31:56Z"
  }
}
{
"error": "<string>",
"id": "<string>"
}
{
"error": "<string>",
"detail": {
"<location>": {
"<field_name>": [
"<string>"
]
}
}
}

Headers

x-trackstar-api-key
string
required

Your organization-level Trackstar API key.

Example:

"<x-trackstar-api-key>"

x-trackstar-access-token
string
required

Your user's access token for a specific integration (ShipHero, Extensiv, etc).

Example:

"<x-trackstar-access-token>"

Path Parameters

return_id
string
required

Response

Successful response

id
string
required

The ID of the object that has been created or modified

Example:

"id"

unused_fields
string[]
required

Unused fields

data
CancelReturnResponseDataSchema · object