Shipments - Csv Export

Export shipments data as a CSV file within a specified date range.

GET /s/job/shipments/csv_export

Shipments - Csv Export

cURL

curl --request GET \
  --url https://app.skulabs.com/s/job/shipments/csv_export \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.skulabs.com/s/job/shipments/csv_export"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.skulabs.com/s/job/shipments/csv_export', 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/shipments/csv_export",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://app.skulabs.com/s/job/shipments/csv_export"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.skulabs.com/s/job/shipments/csv_export")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.skulabs.com/s/job/shipments/csv_export")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "shipment": "<string>",
  "shipment_items": "<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.

Query Parameters

store_ids · string[] · required

Store IDs to export shipments from

Example:

["507f1f77bcf86cd799439011"]

start · string · required

Start date (ISO 8601)

Example:

"2025-01-01T00:00:00.000Z"

end · string · required

End date (ISO 8601)

Example:

"2025-01-31T23:59:59.000Z"

warehouse_ids · string[]

Filter by warehouse IDs

options · object

CSV export options

Show child attributes

Response

200

application/json

Presigned S3 URLs for the generated CSV files

shipment · string

S3 URL for shipments CSV export

shipment_items · string

S3 URL for shipment items CSV export