Return Metadata

Set Return Metadata

Sets some metadata against a return.

PUT

/v1/orders/returns/{id}/metadata/{key}

Set Return Metadata

curl --request PUT \
  --url https://public-api.bladepro.io/v1/orders/returns/{id}/metadata/{key} \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": "<string>"
}
'

{
  "data": {
    "key": "my_key",
    "value": "some-value"
  },
  "meta": {
    "request_reference": "233f2gjwz-c893v86"
  }
}

Scope(s): APP:RETURNS::MANAGE

Path Parameters

idstringrequired

Path parameter: id

Pattern: [1-9][0-9]{0,}

keystringrequired

Path parameter: key

Pattern: [a-zA-Z_][a-zA-Z0-9_]{0,}

Body

valuestringrequired

The value.

Response

successful operation

keystring

Key the piece of stored metadata is identified with.

valuestring

Stored data metadata.

Still need help? Share an idea