Returns

Apply Return Tag

Applies a tag to a return.

POST

/v1/orders/returns/{id}/tags

Apply Return Tag

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

{
  "data": {
    "created": "2019-11-25T14:52:56.000Z",
    "description": "Marked a as processed by XYZ system",
    "id": 1,
    "name": "Processed",
    "shortcode": "PROCESSED"
  },
  "meta": {
    "request_reference": "233f2gjwz-c893v86"
  }
}

Scope(s): APP::RETURNS::MANAGE

Path Parameters

idstringrequired

Path parameter: id

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

Body

shortcodestringrequired

The tag shortcode.

Response

successful operation

createdany

The date the tag was added created.

descriptionstring

The tag description.

idnumber

Tag ID.

namestring

The tag name.

shortcodestring

The tag code.

Still need help? Share an idea