Order - Set Tags

Replace all tags on one or more orders with a new set of tags.

PUT /order/set_tags

Order - Set Tags

cURL

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

200

{
  "success": true
}

Authorizations

Authorization · string · header · required

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

Body

application/json

tags · string[] · required

Array of tag IDs to set (ObjectId strings referencing the tag collection)

Example:

[
  "507f1f77bcf86cd799439011",
  "507f1f77bcf86cd799439012"
]

store_id · string

Store ID (use with order_number)

Example:

"507f1f77bcf86cd799439011"

order_number · string

Order number (use with store_id)

reason · string

Reason for setting tags

orders · object[]

Array of order references (alternative to store_id + order_number)

Show child attributes

Response

200

application/json

Tags set on orders

success · boolean · required

Whether the operation succeeded