Skip to main content
PUT
/
v1
/
orders
/
metadata
/
{id}
/
{key}
update metadata on order
curl --request PUT \
  --url https://api.production.orderprotection.com/v1/orders/metadata/{id}/{key} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "badge",
  "badgeType": "success",
  "label": "Order Risk: Low",
  "icon": "AddBook",
  "iconPosition": "left",
  "lowContrast": true
}'

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required
​
key
string
required

Body

application/json
​
type
string
required
Example:

"badge"

​
badgeType
enum<string>
required
Available options:
success,
warning,
danger,
neutral,
secondary
Example:

"success"

​
label
string
required
Example:

"Order Risk: Low"

​
icon
enum<string>
required

The icon to use

Available options:
AddBook,
ApiLogo,
ArmraLogo,
ArrowsRightLeft,
BigCommerce,
CheckCircle,
CircleLogo,
ClaimInfoSubscribedRightArrows,
ClaimTodoApprovedDeniedSolidArrow,
ClaimTodoClosedSolidArrow,
ClaimTodoDashedArrow,
ClaimTodoOnholdDashedArrow,
ClaimTodoPendingDashedArrow,
ClaimTodoSolidLine,
DatePicker,
EarthGlobeTimezone,
FolderCheck,
FollowUp,
IconApprove,
IconArmra,
IconAvatar,
IconBuilding,
IconCheck,
IconClose,
IconCreditCard,
IconCustom,
IconDanger,
IconDollar,
IconEdit,
IconGoogle,
IconInfo,
IconLock,
IconLogo,
IconRefund,
IconSend,
IconShipment,
IconShopify,
IconWarning,
ImageCancel,
LineAlign,
LineAngleDoubleLeft,
LineAngleDoubleRight,
LineAngleDown,
LineAngleLeft,
LineAngleRight,
LineAngleUp,
LineAppleAlt,
LineArchive,
LineArrow,
LineArrowDownRight,
LineArrowLeft,
LineArrowRight,
LineBars,
LineBold,
LineBolt,
LineBookMedical,
LineBox,
LineBuilding,
LineCameraQuestion,
LineChart,
LineChatBubbleUser,
LineCheckCircle,
LineClipboardAlt,
LineCodeBranch,
LineCoins,
LineCommentAlt,
LineCommentAltBlock,
LineCommentDots,
LineCommentMessage,
LineCommentQuestion,
LineComparison,
LineCopy,
LineCornerUpLeftAlt,
LineCornerUpRightAlt,
LineCreditCard,
LineDashboard,
LineDownloadAlt,
LineDraggabledots,
LineEllipsisH,
LineExclamationCircle,
LineExclamationOctagon,
LineExport,
LineExternalLinkAlt,
LineEye,
LineEyeSlash,
LineFileCopyAlt,
LineFileLandscape,
LineFilter,
LineFire,
LineFolder,
LineFolderOpen,
LineFont,
LineGithubAlt,
LineGlobe,
LineImport,
LineInfoCircle,
LineItalic,
LineLeftIndent,
LineLinkAlt,
LineListOl,
LineListUl,
LineLock,
LineMessage,
LineMinusCircle,
LineMoney,
LineMoneyWithdraw,
LineMoon,
LinePalette,
LinePaperclip,
LinePen,
LinePhone,
LinePlus,
LinePlusCircle,
LinePlusSquare,
LineRefresh,
LineRightIndentAlt,
LineRocket,
LineSearch,
LineSetting,
LineShield,
LineSlack,
LineSort,
LineStar,
LineSun,
LineSwatchbook,
LineSync,
LineTable,
LineTag,
LineTimes,
LineTimesCircle,
LineToggleOff,
LineToggleOn,
LineTransaction,
LineTrashAlt,
LineUnderline,
LineUsdCircle,
LineUsersAlt,
MagentoLogo,
NoResponse,
OutsideOp,
Package,
PackageArrived,
PlayCircle,
PlusCircle,
QueueList,
RefreshResentMail,
ShieldCheck,
Shipstation,
ShopifyAvatar,
ShopifyBag,
SolidStar,
TableDeleteColumn,
TableDeleteRow,
TableInsertColumnAfter,
TableInsertColumnBefore,
TableInsertRowAbove,
TableInsertRowAfter,
TipaltiLogo,
XCircle,
XMark
​
lowContrast
boolean
required
​
iconPosition
enum<string>
Available options:
left,
right
Example:

"left"

⌘I