Skip to main content
PUT
/
stores
/
{storeId}
/
return-tags
/
{name}
Upsert Return Tag
curl --request PUT \
  --url https://api.getredo.com/v2.2/stores/{storeId}/return-tags/{name} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pillTheme": "NORMAL",
  "newName": "<string>"
}
'
{
  "tag": {
    "name": "<string>",
    "kind": "<string>",
    "pillTheme": "NORMAL",
    "source": "merchant",
    "numericId": 123
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
storeId
string
required

Store ID

Example:

"64e5a8a1af49a89df37e4ee7"

​
name
string
required

Return tag name. Case-sensitive and URL-encoded.

Example:

"Damaged"

Body

application/json

Request body for creating, recoloring, or renaming a return tag.

​
pillTheme
enum<string>
required

Color theme used to render a tag pill in the UI.

Available options:
NORMAL,
PRIMARY_LIGHT,
LIGHT_PINK,
DANGER,
NEUTRAL_YELLOW,
SUCCESS,
NEUTRAL_BLUE,
PRIMARY,
SOLID_WHITE,
SOLID_PINK,
SOLID_RED,
SOLID_ORANGE,
SOLID_YELLOW,
SOLID_GREEN,
SOLID_LIGHT_BLUE,
SOLID_NAVY,
SOLID_BLACK,
BRAND,
GRAY_BLUE,
WHITE_SUCCESS,
GRAY_ALTERNATE,
BRAND_ALTERNATE,
ERROR_ALTERNATE,
WARNING_ALTERNATE,
SUCCESS_ALTERNATE,
GRAY_BLUE_ALTERNATE,
BLUE_LIGHT_ALTERNATE,
BLUE_ALTERNATE,
INDIGO_ALTERNATE,
PURPLE_ALTERNATE,
PINK_ALTERNATE,
ORANGE_ALTERNATE,
BLACK_ALTERNATE,
WHITE_ALTERNATE,
WHITE_SUCCESS_ALTERNATE
​
newName
string

New name for the tag. When set and different from the path name, the tag is renamed and the change cascades to returns and saved view filters.

Response

Success

​
tag
Return tag · object
required

A return tag defined for a store.