Create Order Tag - Salla Public APIs Docs

This endpoint allows you to assign a specific order with a tag by using the tag name, by passing the order_id as a path parameter.

You can get a list of available tags from List Tags endpoint.

Moreover, you can get a list of orders assigned to a tag from the List Orders endpoint using the tag query parameter on the List Orders endpoint.

Scopes

orders.read_write - Orders Read & Write

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Path Params

order_id

integer

required

The Order ID. List of Order ID can be found here

Body Params application/json

tag_name

string

required

the label or textual identifier assigned to a specific tag or label associated with the order.

Example

{
    "tag_name": "test"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

status

number

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

object (OrderTag)

optional

Detailed structure of the orders tag model object showing its fields and data types.

number

required

A unique identifier assigned to a tag associated with an order.

name

string

required

A textual identifier used to describe a tag associated with an order.

Example

{
    "status": 200,
    "success": true,
    "data": {
        "id": 665151403,
        "name": "test"
    }
}

🟠404Not Found

🟠422Error Validation

🟠401Uauthorized