Skip to main content
POST
Short order lines

Request Structure

Key Fields

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

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