Skip to main content
POST
/
api
/
goods_out_processes
/
process_picks_async
Process picks asynchronously
curl --request POST \
  --url https://clarus-api.com/api/goods_out_processes/process_picks_async \
  --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]
}

​
Key Fields

FieldRequiredDescription
idsYesArray of goods out order IDs to process

​
Prerequisites

  • Orders must be in PENDING or ALLOCATED status
  • Account/warehouse permissions must allow pick processing

​
Behavior

  • Returns process_references for tracking pick list generation
  • Each order gets its own pick list (use /process_and_consolidate_picks to merge)
  • Orders are grouped by warehouse
  • Crossdock orders are processed separately from sales orders
  • Pick type can be standard (traditional picking) or tote (container-based batch picking)

​
Tracking Status

Poll for completion via GraphQL: 
query {
  pickProcessingRequests(filter: { process_reference: { eq: "abc123def456" } }) {
    edges {
      node {
        id
        status
        process_reference
        message
        created_at
        updated_at
      }
    }
  }
}
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

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 asynchronous pick processing

​
ids
integer[]
required

Array of goods out order IDs to process

Minimum array length: 1

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