Batch - Get

Retrieve batch details by ID, including orders and fulfillment progress.

GET /batch/get

Batch - Get

cURL

curl --request GET \
  --url https://api.skulabs.com/batch/get \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.skulabs.com/batch/get"

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

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

print(response.text)

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

fetch('https://api.skulabs.com/batch/get', 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/batch/get",
  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://api.skulabs.com/batch/get"

	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://api.skulabs.com/batch/get")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.skulabs.com/batch/get")

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

{
  "batch": {
    "_id": "507f1f77bcf86cd799439011",
    "number": 123,
    "orders": [
      {
        "store_id": "507f1f77bcf86cd799439011",
        "order_number": "<string>",
        "bin": "<string>",
        "status": "<string>",
        "items": [
          {}
        ],
        "scans": [
          {}
        ],
        "misscans": [
          {}
        ],
        "shipments": [
          {}
        ],
        "purchase_orders": [
          {}
        ],
        "log": [
          {}
        ],
        "inventory": [
          {}
        ],
        "combined_order_numbers": [
          "<string>"
        ],
        "stash": {},
        "barcodes": [
          {}
        ],
        "tags": [
          "507f1f77bcf86cd799439011",
          "507f1f77bcf86cd799439012"
        ],
        "notes": "<string>",
        "batch_number": 123
      }
    ],
    "log": [
      {
        "user_id": "507f1f77bcf86cd799439011",
        "action": "<string>",
        "time": "2025-01-15T12:00:00.000Z"
      }
    ],
    "ship_end": "2025-01-15T12:00:00.000Z",
    "batch_settings": {
      "name": "<string>",
      "type": "<string>",
      "warehouse_filters": [
        "<string>"
      ],
      "include_out_of_stock": true,
      "include_partially_fulfillable": true,
      "ship_mode": "<string>",
      "n_sku_batch": true,
      "same": true
    },
    "inventory": [
      {}
    ],
    "inventory_map": {}
  }
}

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

batch_id · string

Batch ID to retrieve

Example:

"507f1f77bcf86cd799439011"

batch_number · number

Batch number to retrieve

Response

200

application/json

Full batch detail with orders, inventory, and scan data

batch · object · required

Show child attributes