Salla Docs
Merchant API
Partner APIs
Storefront
Salla CLI
Salla Docs

    [lightMode]

    Create Order Tag

    POST/orders/{order_id}/tags
    [updatedIn] 2 months ago

    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.

    `orders.read_write` - Orders Read & Write

    Request

    Authorization: OAuth 2.0
    Add the parameter
    Authorization
    to [header]    ，whose value is to concatenate the Token after the Bearer.
    [api.label.example]
    Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
    [message.pathParameter]
    order_id
    integer 
    required

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

    [message.bodyParameter]application/json
    tag_name
    string 
    required

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

    [api.label.example]
    {
  "tag_name": "test"
}

    Request samples

    [api.label.responses]

    Success(200)
    Not Found(404)
    Error Validation(422)
    HTTP Code: 200
    Content Type : JSONapplication/json
    [response.label.jsonSchema]
    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.

    id
    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.

    [api.label.example]
    {
  "status": 200,
  "success": true,
  "data": {
    "id": 665151403,
    "name": "test"
  }
}
    [updatedIn] 2 months ago