Short order lines

curl --request POST \
  --url https://clarus-api.com/api/goods_out_processes/short_order_lines \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "ids": [
    1,
    2,
    3
  ],
  "description": "Stock unavailable - shipping partial order"
}
'

{
  "error": "<string>"
}

POST

api

goods_out_processes

short_order_lines

Short order lines

curl --request POST \
  --url https://clarus-api.com/api/goods_out_processes/short_order_lines \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "ids": [
    1,
    2,
    3
  ],
  "description": "Stock unavailable - shipping partial order"
}
'

{
  "error": "<string>"
}

Request Structure

{
  "ids": [101, 102, 103],
  "description": "Stock unavailable - shipping partial order",
  "reason_code_id": 5
}

Key Fields

Field	Required	Description
`ids`	Yes	Array of goods out order IDs to short
`description`	Yes	Free text reason for shorting (audit trail)
`reason_code_id`	No	Reference to configurable ReasonCode lookup table

Prerequisites

Account must have is_short_pickable: true
Orders should be in PART_ALLOCATED status

Behavior

Marks unallocated order line quantities as short
Allows orders to proceed with partial fulfillment
Records reason in audit trail for compliance
Can use reason_code_id for standardized reasons (configurable per tenant)

Error Codes

Code	Symbol	Description
36	empty_ids_provided	No order IDs provided
37	invalid_ids_provided	Some IDs do not exist

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 shorting partially allocated order lines

ids

integer[]

required

Array of goods out order IDs to short

Minimum array length: 1

description

string

required

Free text reason for shorting the order lines. Used for audit trail - content is determined by the user.

reason_code_id

integer | null

Optional reference to a configurable ReasonCode lookup table for standardized reasons

Response

Order lines shorted successfully

⌘I

​Request Structure

​Key Fields

​Prerequisites

​Behavior

​Error Codes

Authorizations

Body

Response

Request Structure

Key Fields

Prerequisites

Behavior

Error Codes