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"
    }
  ]
}
'

import requests

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

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

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

print(response.text)

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

fetch('https://api.skulabs.com/order/set_tags', 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/set_tags",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'tags' => [
        '507f1f77bcf86cd799439011',
        '507f1f77bcf86cd799439012'
    ],
    'store_id' => '507f1f77bcf86cd799439011',
    'order_number' => '<string>',
    'reason' => '<string>',
    'orders' => [
        [
                'order_number' => '<string>',
                'store_id' => '507f1f77bcf86cd799439011'
        ]
    ]
  ]),
  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/set_tags"

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

	req, _ := http.NewRequest("PUT", 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.put("https://api.skulabs.com/order/set_tags")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tags\": [\n    \"507f1f77bcf86cd799439011\",\n    \"507f1f77bcf86cd799439012\"\n  ],\n  \"store_id\": \"507f1f77bcf86cd799439011\",\n  \"order_number\": \"<string>\",\n  \"reason\": \"<string>\",\n  \"orders\": [\n    {\n      \"order_number\": \"<string>\",\n      \"store_id\": \"507f1f77bcf86cd799439011\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

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

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

200

{
  "success": 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
  }
}

{
  "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

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