Create picking batch

curl --request POST \
  --url https://{base_url_domain}/api/global/v1/operations/picking-batches \
  --header 'Content-Type: application/json' \
  --data '
{
  "warehouse_id": 1,
  "picking_class_id": 2,
  "asset_type_id": 5,
  "target_ship_date": "on_or_before_current",
  "merchant_ids": [
    2
  ],
  "print_packing_instructions": false
}
'

import requests

url = "https://{base_url_domain}/api/global/v1/operations/picking-batches"

payload = {
    "warehouse_id": 1,
    "picking_class_id": 2,
    "asset_type_id": 5,
    "target_ship_date": "on_or_before_current",
    "merchant_ids": [2],
    "print_packing_instructions": False
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    warehouse_id: 1,
    picking_class_id: 2,
    asset_type_id: 5,
    target_ship_date: 'on_or_before_current',
    merchant_ids: [2],
    print_packing_instructions: false
  })
};

fetch('https://{base_url_domain}/api/global/v1/operations/picking-batches', 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://{base_url_domain}/api/global/v1/operations/picking-batches",
  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([
    'warehouse_id' => 1,
    'picking_class_id' => 2,
    'asset_type_id' => 5,
    'target_ship_date' => 'on_or_before_current',
    'merchant_ids' => [
        2
    ],
    'print_packing_instructions' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "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://{base_url_domain}/api/global/v1/operations/picking-batches"

	payload := strings.NewReader("{\n  \"warehouse_id\": 1,\n  \"picking_class_id\": 2,\n  \"asset_type_id\": 5,\n  \"target_ship_date\": \"on_or_before_current\",\n  \"merchant_ids\": [\n    2\n  ],\n  \"print_packing_instructions\": false\n}")

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

	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://{base_url_domain}/api/global/v1/operations/picking-batches")
  .header("Content-Type", "application/json")
  .body("{\n  \"warehouse_id\": 1,\n  \"picking_class_id\": 2,\n  \"asset_type_id\": 5,\n  \"target_ship_date\": \"on_or_before_current\",\n  \"merchant_ids\": [\n    2\n  ],\n  \"print_packing_instructions\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{base_url_domain}/api/global/v1/operations/picking-batches")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"warehouse_id\": 1,\n  \"picking_class_id\": 2,\n  \"asset_type_id\": 5,\n  \"target_ship_date\": \"on_or_before_current\",\n  \"merchant_ids\": [\n    2\n  ],\n  \"print_packing_instructions\": false\n}"

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

{
  "resource": {
    "type": "PickingBatch",
    "id": 1024,
    "warehouse_id": 1,
    "shipment_count": 24,
    "workflow": "paper_in_bin",
    "batch_preset_id": 3,
    "picking_class_id": 2,
    "asset_type_id": 5,
    "max_shipments": 24,
    "location_accessibility": "accessible_only",
    "print_packing_instructions": false,
    "allow_partial": false
  },
  "meta": {
    "processing_time": 123
  }
}

{
  "errors": [
    {
      "type": "parameters",
      "message": "The supplied parameters are invalid."
    }
  ]
}

"<unknown>"

{
  "errors": [
    {
      "type": "not_found",
      "message": "The server could not find the requested resource."
    }
  ]
}

{
  "errors": [
    {
      "type": "unable_to_process",
      "message": "There was an error processing the request."
    }
  ]
}

Picking Batches

Create picking batch

Groups ready-to-pick shipments in a warehouse into a new picking batch.

The batch is built from either a batch preset (batch_preset_id) or a picking class (picking_class_id), and is sized by an asset type (asset_type_id) or an explicit max_shipments. The remaining properties filter which shipments are eligible and control how the batch is picked.

When a user token is used, the user must have permission to process orders and must have access to the warehouse.

A 422 response is returned when no batch could be created, for example when no eligible shipments are available or when there are not enough shipments to fill the batch and partial batches are not allowed. When some shipments could not be picked, the error details explain why.

POST

operations

picking-batches

Create picking batch

curl --request POST \
  --url https://{base_url_domain}/api/global/v1/operations/picking-batches \
  --header 'Content-Type: application/json' \
  --data '
{
  "warehouse_id": 1,
  "picking_class_id": 2,
  "asset_type_id": 5,
  "target_ship_date": "on_or_before_current",
  "merchant_ids": [
    2
  ],
  "print_packing_instructions": false
}
'

import requests

url = "https://{base_url_domain}/api/global/v1/operations/picking-batches"

payload = {
    "warehouse_id": 1,
    "picking_class_id": 2,
    "asset_type_id": 5,
    "target_ship_date": "on_or_before_current",
    "merchant_ids": [2],
    "print_packing_instructions": False
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    warehouse_id: 1,
    picking_class_id: 2,
    asset_type_id: 5,
    target_ship_date: 'on_or_before_current',
    merchant_ids: [2],
    print_packing_instructions: false
  })
};

fetch('https://{base_url_domain}/api/global/v1/operations/picking-batches', 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://{base_url_domain}/api/global/v1/operations/picking-batches",
  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([
    'warehouse_id' => 1,
    'picking_class_id' => 2,
    'asset_type_id' => 5,
    'target_ship_date' => 'on_or_before_current',
    'merchant_ids' => [
        2
    ],
    'print_packing_instructions' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "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://{base_url_domain}/api/global/v1/operations/picking-batches"

	payload := strings.NewReader("{\n  \"warehouse_id\": 1,\n  \"picking_class_id\": 2,\n  \"asset_type_id\": 5,\n  \"target_ship_date\": \"on_or_before_current\",\n  \"merchant_ids\": [\n    2\n  ],\n  \"print_packing_instructions\": false\n}")

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

	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://{base_url_domain}/api/global/v1/operations/picking-batches")
  .header("Content-Type", "application/json")
  .body("{\n  \"warehouse_id\": 1,\n  \"picking_class_id\": 2,\n  \"asset_type_id\": 5,\n  \"target_ship_date\": \"on_or_before_current\",\n  \"merchant_ids\": [\n    2\n  ],\n  \"print_packing_instructions\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{base_url_domain}/api/global/v1/operations/picking-batches")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"warehouse_id\": 1,\n  \"picking_class_id\": 2,\n  \"asset_type_id\": 5,\n  \"target_ship_date\": \"on_or_before_current\",\n  \"merchant_ids\": [\n    2\n  ],\n  \"print_packing_instructions\": false\n}"

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

{
  "resource": {
    "type": "PickingBatch",
    "id": 1024,
    "warehouse_id": 1,
    "shipment_count": 24,
    "workflow": "paper_in_bin",
    "batch_preset_id": 3,
    "picking_class_id": 2,
    "asset_type_id": 5,
    "max_shipments": 24,
    "location_accessibility": "accessible_only",
    "print_packing_instructions": false,
    "allow_partial": false
  },
  "meta": {
    "processing_time": 123
  }
}

{
  "errors": [
    {
      "type": "parameters",
      "message": "The supplied parameters are invalid."
    }
  ]
}

"<unknown>"

{
  "errors": [
    {
      "type": "not_found",
      "message": "The server could not find the requested resource."
    }
  ]
}

{
  "errors": [
    {
      "type": "unable_to_process",
      "message": "There was an error processing the request."
    }
  ]
}

Body

application/json

Selects which ready-to-pick shipments in a warehouse are grouped into a picking batch and how the batch is picked.

A batch is built from either a batch preset or a picking class, and is sized by either an asset type or an explicit maximum number of shipments. All filters are optional; omitted filters do not restrict the selection.

warehouse_id

integer<int32>

required

The warehouse whose shipments are batched. The authenticated user must have access to it.

Required range: x >= 1

Example:

1

shipment_type

enum<string> | null

Only batch shipments of this type. Omit or null to batch shipments of any type.

Available options:

parcel,

freight,

null

Example:

"parcel"

batch_preset_id

integer<int32>

Build the batch from this batch preset. The preset supplies the picking classes, sizing and defaults for location_accessibility and print_packing_instructions. Either batch_preset_id or picking_class_id is required.

Required range: x >= 1

Example:

3

picking_class_id

integer<int32>

Build the batch from shipments in this picking class. Either batch_preset_id or picking_class_id is required.

Required range: x >= 1

Example:

2

asset_type_id

integer<int32>

Size the batch for this asset type (e.g. a cart). The maximum number of shipments is derived from the asset type unless max_shipments is also given. Either asset_type_id or max_shipments is required unless the batch preset sizes the batch.

Required range: x >= 1

Example:

5

max_shipments

integer<int32>

The maximum number of shipments in the batch.

Required range: x >= 1

Example:

24

workflow

enum<string>

The picking workflow. paper_in_bin prints packing slips placed into bins; paperless prints no packing slips. Omit to use the batch preset's default workflow, or the system default when there is no preset.

Available options:

paper_in_bin,

paperless

Example:

"paper_in_bin"

batch_tag

string | null

Only batch shipments with this batch tag. An empty string selects shipments without a batch tag. Omit or null to ignore batch tags.

Maximum string length: 255

Example:

"PRIORITY"

exclude_batch_tag

boolean

default:false

When true, batch_tag excludes matching shipments instead of selecting them.

Example:

false

shipping_methods

string[]

Only batch shipments using one of these shipping methods.

Maximum array length: 1000

A shipping method code in the form {carrier}_{method}.

Example:

["ups_03"]

exclude_shipping_methods

boolean

default:false

When true, shipping_methods excludes matching shipments instead of selecting them.

Example:

false

merchant_ids

integer<int32>[]

Only batch shipments belonging to one of these merchants.

Maximum array length: 1000

A merchant id.

Example:

[2]

exclude_merchants

boolean

default:false

When true, merchant_ids excludes matching shipments instead of selecting them.

Example:

false

service_levels

string[]

Only batch shipments with one of these service levels.

Maximum array length: 1000

A service level code.

Example:

["ground"]

exclude_service_levels

boolean

default:false

When true, service_levels excludes matching shipments instead of selecting them.

Example:

false

target_ship_date

enum<string>

Selects shipments by target ship date relative to the warehouse's current target ship date. Omit to select shipments due on or before the current target ship date.

Available options:

on_or_before_current,

before_current,

current_only,

after_current,

any

Example:

"on_or_before_current"

location_accessibility

enum<string>

Which inventory locations may be picked from. accessible_only (Strict) follows the asset policies, sweep prefers accessible locations but may pick from others, and any (Disregard) ignores accessibility. Omit to use the batch preset's default, or accessible_only when there is no preset.

Available options:

accessible_only,

sweep,

any

Example:

"accessible_only"

print_packing_instructions

boolean

Whether to print packing instructions for the batch. Omit to use the batch preset's setting, or false when there is no preset.

Example:

false

allow_partial

boolean

Whether to create the batch when there are not enough shipments to fill it. Omit to use the warehouse's default. Ignored when the warehouse is configured to always or never allow partial batches.

Example:

false

Response

The picking batch was created.

resource

PickingBatch · object

required

A picking batch groups shipments so they can be picked together.

Show child attributes

Get Started

Common Features

Inventory API v1

Receiving API v1

Shipping API v1

Operations API v1

System API v1

Create picking batch

Body

Response