Skip to main content
POST
/
api
/
goods_out_processes
/
process_and_consolidate_picks
Process and consolidate picks
curl --request POST \
  --url https://clarus-api.com/api/goods_out_processes/process_and_consolidate_picks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "ids": [
    1,
    2,
    3
  ]
}
'
{
  "process_references": [
    "abc123def456"
  ]
}

​
Request Structure

{
  "ids": [101, 102, 103],
  "goods_out_pick_list_attributes": {
    "goods_out_pick_list_reference": "BATCH-2024-001",
    "expected_date_of_dispatch": "2024-01-20T14:00:00Z",
    "goods_out_bay_id": 42
  }
}

​
Key Fields

FieldRequiredDescription
idsYesArray of goods out order IDs to consolidate
goods_out_pick_list_attributesNoOptional attributes for the created pick list
goods_out_pick_list_referenceNoCustom reference for the consolidated pick list
expected_date_of_dispatchNoTarget dispatch date for the pick list
goods_out_bay_idNoStaging location ID (must be location_type: GOBAY)

​
Prerequisites

  • Orders must be in PENDING or ALLOCATED status
  • All orders must have the same pick_type (standard or tote)

​
Behavior

  • Returns process_references for tracking pick list generation
  • Merges multiple orders into a single consolidated pick list
  • Crossdock orders are always processed separately (not consolidated)
  • Sales orders and work orders can be consolidated together if same pick_type

​
Tracking Status

Poll for completion via GraphQL: 
query {
  pickProcessingRequests(filter: { process_reference: { eq: "abc123def456" } }) {
    edges {
      node {
        id
        status
        process_reference
        message
      }
    }
  }
}
Status values: pending, completed, failed

​
Error Codes

CodeSymbolDescription
36empty_ids_providedNo order IDs provided
37invalid_ids_providedSome IDs do not exist
39not_enough_stocks_for_pickingInsufficient stock available
59goods_out_already_allocatedOrder already processed
318goods_outs_with_different_pick_types_cannot_be_consolidatedMixed pick types in batch

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

​
X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Body

application/json

Request body for consolidated pick processing

​
ids
integer[]
required

Array of goods out order IDs to consolidate into a single pick list

Minimum array length: 1
​
goods_out_pick_list_attributes
object

Optional attributes for the created pick list

Response

Pick processing queued successfully

Response containing process references for tracking pick processing status

​
process_references
string[]

Array of process reference strings for tracking the queued pick processing jobs via GraphQL