Short order lines - ClarusWMS

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"
}
'

import requests

url = "https://clarus-api.com/api/goods_out_processes/short_order_lines"

payload = {
    "ids": [1, 2, 3],
    "description": "Stock unavailable - shipping partial order"
}
headers = {
    "Authorization": "Bearer <token>",
    "X-Clarus-Subdomain": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'X-Clarus-Subdomain': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ids: [1, 2, 3], description: 'Stock unavailable - shipping partial order'})
};

fetch('https://clarus-api.com/api/goods_out_processes/short_order_lines', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "error": "<string>"
}

{
  "errors": [
    {
      "code": 123,
      "symbol": "<string>",
      "details": "<string>",
      "source": "<string>",
      "context": {}
    }
  ]
}

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"
}
'

import requests

url = "https://clarus-api.com/api/goods_out_processes/short_order_lines"

payload = {
    "ids": [1, 2, 3],
    "description": "Stock unavailable - shipping partial order"
}
headers = {
    "Authorization": "Bearer <token>",
    "X-Clarus-Subdomain": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'X-Clarus-Subdomain': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ids: [1, 2, 3], description: 'Stock unavailable - shipping partial order'})
};

fetch('https://clarus-api.com/api/goods_out_processes/short_order_lines', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "error": "<string>"
}

{
  "errors": [
    {
      "code": 123,
      "symbol": "<string>",
      "details": "<string>",
      "source": "<string>",
      "context": {}
    }
  ]
}

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.

FlowAuthorization Code

Authorization URL: https://clarus-api.com/oauth/authorize
Token URL: https://clarus-api.com/oauth/token

FlowClient Credentials

Token URL: https://clarus-api.com/oauth/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