Returns
Update Return
Get the request body shape by calling the meta endpoint.
PUT
/
wms
/
returns
/
{return_id}
Header
Path
Body
curl --request PUT \
--url https://production.trackstarhq.com/wms/returns/{return_id} \
--header 'Content-Type: application/json' \
--header 'x-trackstar-access-token: <x-trackstar-access-token>' \
--header 'x-trackstar-api-key: <x-trackstar-api-key>' \
--data '{
"field1": "some_value",
"field2": {
"key": "value"
}
}'
{
"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": "open",
"line_items": []
}
}
Headers
x-trackstar-api-key
string
requiredYour organization-level Trackstar API key.
x-trackstar-access-token
string
requiredYour user's access token for a specific integration (ShipHero, Extensiv, etc).
Path Parameters
return_id
string
requiredBody
application/json
field1
string
Placeholder - variable based on integration. Read about the meta endpoint for more information.
field2
object
Placeholder - variable based on integration. Read about the meta endpoint for more information.
Response
200 - application/json
data
object
curl --request PUT \
--url https://production.trackstarhq.com/wms/returns/{return_id} \
--header 'Content-Type: application/json' \
--header 'x-trackstar-access-token: <x-trackstar-access-token>' \
--header 'x-trackstar-api-key: <x-trackstar-api-key>' \
--data '{
"field1": "some_value",
"field2": {
"key": "value"
}
}'
{
"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": "open",
"line_items": []
}
}