Skip to content

AppSetOrderTags

PUT
/apps/orders/{id}/tags
curl --request PUT \
--url https://your-store.myciqra.com/apps/orders/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/tags \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "tags": [ "example" ] }'

Required scope: write_orders — an installation token without it receives 403.

id
required
string format: uuid
Media typeapplication/json
One of:
null
Examplegenerated
{
"tags": [
"example"
]
}

OK

Media typeapplication/json
object
archivedAt
required
null | string format: date-time
id
required
string format: uuid
orderNumber
required
string
status
required
Allowed values: PendingPayment AwaitingCollection Paid PaymentFailed Processing Shipped Delivered Completed Cancelled Refunded Returned AwaitingApproval Procurement ReadyForShipment PartiallyRefunded PartiallyCancelled PartiallyFulfilled
tags
required
Array<string>
Example
{
"status": "PendingPayment"
}