Inventory Table - Export Velocity

Export inventory velocity data (sales speed analysis) as a downloadable report.

POST /s/job/inventory_table/export_velocity

Inventory Table - Export Velocity

cURL

curl --request POST \
  --url https://app.skulabs.com/s/job/inventory_table/export_velocity \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "columns": [
      {
        "name": "<string>",
        "data": "<string>",
        "visible": true
      }
    ],
    "order": [
      {
        "column": 123
      }
    ],
    "start": 0,
    "length": 50,
    "filters": {
      "warehouses": [
        "<string>"
      ],
      "stores": [
        "<string>"
      ],
      "movers": [],
      "show_unsold_items": true,
      "show_inactive_items": true,
      "show_stocked_items": true,
      "show_unstocked_items": true,
      "distributors": [
        "<string>"
      ],
      "order_tags": [
        "507f1f77bcf86cd799439011"
      ]
    },
    "search": {
      "value": "<string>",
      "regex": true
    },
    "draw": 123,
    "num_days": 123,
    "statuses": "<string>",
    "source": "<string>"
  }
}
'

import requests

url = "https://app.skulabs.com/s/job/inventory_table/export_velocity"

payload = { "data": {
        "columns": [
            {
                "name": "<string>",
                "data": "<string>",
                "visible": True
            }
        ],
        "order": [{ "column": 123 }],
        "start": 0,
        "length": 50,
        "filters": {
            "warehouses": ["<string>"],
            "stores": ["<string>"],
            "movers": [],
            "show_unsold_items": True,
            "show_inactive_items": True,
            "show_stocked_items": True,
            "show_unstocked_items": True,
            "distributors": ["<string>"],
            "order_tags": ["507f1f77bcf86cd799439011"]
        },
        "search": {
            "value": "<string>",
            "regex": True
        },
        "draw": 123,
        "num_days": 123,
        "statuses": "<string>",
        "source": "<string>"
    } }
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({
    data: {
      columns: [{name: '<string>', data: '<string>', visible: true}],
      order: [{column: 123}],
      start: 0,
      length: 50,
      filters: {
        warehouses: ['<string>'],
        stores: ['<string>'],
        movers: [],
        show_unsold_items: true,
        show_inactive_items: true,
        show_stocked_items: true,
        show_unstocked_items: true,
        distributors: ['<string>'],
        order_tags: ['507f1f77bcf86cd799439011']
      },
      search: {value: '<string>', regex: true},
      draw: 123,
      num_days: 123,
      statuses: '<string>',
      source: '<string>'
    }
  })
};

fetch('https://app.skulabs.com/s/job/inventory_table/export_velocity', 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://app.skulabs.com/s/job/inventory_table/export_velocity",
  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([
    'data' => [
        'columns' => [
                [
                                'name' => '<string>',
                                'data' => '<string>',
                                'visible' => true
                ]
        ],
        'order' => [
                [
                                'column' => 123
                ]
        ],
        'start' => 0,
        'length' => 50,
        'filters' => [
                'warehouses' => [
                                '<string>'
                ],
                'stores' => [
                                '<string>'
                ],
                'movers' => [
                                
                ],
                'show_unsold_items' => true,
                'show_inactive_items' => true,
                'show_stocked_items' => true,
                'show_unstocked_items' => true,
                'distributors' => [
                                '<string>'
                ],
                'order_tags' => [
                                '507f1f77bcf86cd799439011'
                ]
        ],
        'search' => [
                'value' => '<string>',
                'regex' => true
        ],
        'draw' => 123,
        'num_days' => 123,
        'statuses' => '<string>',
        'source' => '<string>'
    ]
  ]),
  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://app.skulabs.com/s/job/inventory_table/export_velocity"

	payload := strings.NewReader("{\n  \"data\": {\n    \"columns\": [\n      {\n        \"name\": \"<string>\",\n        \"data\": \"<string>\",\n        \"visible\": true\n      }\n    ],\n    \"order\": [\n      {\n        \"column\": 123\n      }\n    ],\n    \"start\": 0,\n    \"length\": 50,\n    \"filters\": {\n      \"warehouses\": [\n        \"<string>\"\n      ],\n      \"stores\": [\n        \"<string>\"\n      ],\n      \"movers\": [],\n      \"show_unsold_items\": true,\n      \"show_inactive_items\": true,\n      \"show_stocked_items\": true,\n      \"show_unstocked_items\": true,\n      \"distributors\": [\n        \"<string>\"\n      ],\n      \"order_tags\": [\n        \"507f1f77bcf86cd799439011\"\n      ]\n    },\n    \"search\": {\n      \"value\": \"<string>\",\n      \"regex\": true\n    },\n    \"draw\": 123,\n    \"num_days\": 123,\n    \"statuses\": \"<string>\",\n    \"source\": \"<string>\"\n  }\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://app.skulabs.com/s/job/inventory_table/export_velocity")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {\n    \"columns\": [\n      {\n        \"name\": \"<string>\",\n        \"data\": \"<string>\",\n        \"visible\": true\n      }\n    ],\n    \"order\": [\n      {\n        \"column\": 123\n      }\n    ],\n    \"start\": 0,\n    \"length\": 50,\n    \"filters\": {\n      \"warehouses\": [\n        \"<string>\"\n      ],\n      \"stores\": [\n        \"<string>\"\n      ],\n      \"movers\": [],\n      \"show_unsold_items\": true,\n      \"show_inactive_items\": true,\n      \"show_stocked_items\": true,\n      \"show_unstocked_items\": true,\n      \"distributors\": [\n        \"<string>\"\n      ],\n      \"order_tags\": [\n        \"507f1f77bcf86cd799439011\"\n      ]\n    },\n    \"search\": {\n      \"value\": \"<string>\",\n      \"regex\": true\n    },\n    \"draw\": 123,\n    \"num_days\": 123,\n    \"statuses\": \"<string>\",\n    \"source\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.skulabs.com/s/job/inventory_table/export_velocity")

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  \"data\": {\n    \"columns\": [\n      {\n        \"name\": \"<string>\",\n        \"data\": \"<string>\",\n        \"visible\": true\n      }\n    ],\n    \"order\": [\n      {\n        \"column\": 123\n      }\n    ],\n    \"start\": 0,\n    \"length\": 50,\n    \"filters\": {\n      \"warehouses\": [\n        \"<string>\"\n      ],\n      \"stores\": [\n        \"<string>\"\n      ],\n      \"movers\": [],\n      \"show_unsold_items\": true,\n      \"show_inactive_items\": true,\n      \"show_stocked_items\": true,\n      \"show_unstocked_items\": true,\n      \"distributors\": [\n        \"<string>\"\n      ],\n      \"order_tags\": [\n        \"507f1f77bcf86cd799439011\"\n      ]\n    },\n    \"search\": {\n      \"value\": \"<string>\",\n      \"regex\": true\n    },\n    \"draw\": 123,\n    \"num_days\": 123,\n    \"statuses\": \"<string>\",\n    \"source\": \"<string>\"\n  }\n}"

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

200

{
  "path": "<string>",
  "count": 123
}

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

data · object · required

Table configuration for the velocity export (same as build_rows with type=velocity)

Show child attributes

Response

200

application/json

S3 signed URL for the exported velocity CSV file

path · string | null · required

S3 signed URL for the exported CSV file, or null if no data

count · number · required

Number of rows exported