Order - Add Tag

Add a tag to one or more orders by tag ID.

POST /order/add_tag

Order - Add Tag

cURL

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

import requests

url = "https://api.skulabs.com/order/add_tag"

payload = {
    "orders": [
        {
            "order_number": "<string>",
            "store_id": "507f1f77bcf86cd799439011"
        }
    ],
    "tag_id": "<string>",
    "no_refresh": True,
    "reason": "<string>",
    "is_system": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    orders: [{order_number: '<string>', store_id: '507f1f77bcf86cd799439011'}],
    tag_id: '<string>',
    no_refresh: true,
    reason: '<string>',
    is_system: true
  })
};

fetch('https://api.skulabs.com/order/add_tag', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.skulabs.com/order/add_tag",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'orders' => [
        [
                'order_number' => '<string>',
                'store_id' => '507f1f77bcf86cd799439011'
        ]
    ],
    'tag_id' => '<string>',
    'no_refresh' => true,
    'reason' => '<string>',
    'is_system' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.skulabs.com/order/add_tag"

	payload := strings.NewReader("{\n  \"orders\": [\n    {\n      \"order_number\": \"<string>\",\n      \"store_id\": \"507f1f77bcf86cd799439011\"\n    }\n  ],\n  \"tag_id\": \"<string>\",\n  \"no_refresh\": true,\n  \"reason\": \"<string>\",\n  \"is_system\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.skulabs.com/order/add_tag")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"orders\": [\n    {\n      \"order_number\": \"<string>\",\n      \"store_id\": \"507f1f77bcf86cd799439011\"\n    }\n  ],\n  \"tag_id\": \"<string>\",\n  \"no_refresh\": true,\n  \"reason\": \"<string>\",\n  \"is_system\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.skulabs.com/order/add_tag")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"orders\": [\n    {\n      \"order_number\": \"<string>\",\n      \"store_id\": \"507f1f77bcf86cd799439011\"\n    }\n  ],\n  \"tag_id\": \"<string>\",\n  \"no_refresh\": true,\n  \"reason\": \"<string>\",\n  \"is_system\": true\n}"

response = http.request(request)
puts response.read_body

200

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

{
  "error": {
    "message": "<string>",
    "statusCode": 123,
    "code": "<string>",
    "overview": "<string>",
    "origin": "<string>",
    "skulabsTraceId": "<string>",
    "user_error": true
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123,
    "code": "<string>",
    "overview": "<string>",
    "origin": "<string>",
    "skulabsTraceId": "<string>",
    "user_error": true
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123,
    "code": "<string>",
    "overview": "<string>",
    "origin": "<string>",
    "skulabsTraceId": "<string>",
    "user_error": true
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123,
    "code": "<string>",
    "overview": "<string>",
    "origin": "<string>",
    "skulabsTraceId": "<string>",
    "user_error": true
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123,
    "code": "<string>",
    "overview": "<string>",
    "origin": "<string>",
    "skulabsTraceId": "<string>",
    "user_error": true
  }
}

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_id · string · required

Tag ID to add

no_refresh · boolean

Skip cache refresh

reason · string

Reason for adding the tag

is_system · boolean

Whether this is a system tag operation

Response

200

application/json

Tag added to orders

success · boolean · required

Whether the operation succeeded

errors · object[]

Errors for individual orders that failed

Show child attributes