Order - Add Tag By Name

Add a tag to one or more orders by tag name, creating the tag if it doesn’t exist.

POST /order/add_tag_by_name

Order - Add Tag By Name

cURL

curl --request POST \
  --url https://api.skulabs.com/order/add_tag_by_name \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "orders": [
    {
      "order_number": "<string>",
      "store_id": "507f1f77bcf86cd799439011"
    }
  ],
  "tag_name": "<string>",
  "reason": "<string>"
}
'

200

{
  "success": true,
  "errors": [
    {
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Body

application/json

orders · object[] · required

Array of order references

Show child attributes

tag_name · string · required

Tag name to add (creates if not found)

reason · string

Reason for adding the tag

Response

200

application/json

Tag added to orders by name

success · boolean · required

Whether the operation succeeded

errors · object[]

Errors for individual orders that failed

Show child attributes