Goods Out - ClarusWMS

{
  "account_id": 1,
  "expected_date_of_dispatch": "2024-01-20T10:00:00Z",
  "goods_out_type": "sales_order",
  "reference": "ORD-001",
  "actual_date_of_dispatch": "2024-01-20T14:30:00Z",
  "boolean1": true,
  "boolean2": true,
  "boolean3": true,
  "boolean4": true,
  "boolean5": true,
  "carrier_id": 5,
  "carrier_service_id": 12,
  "customer_id": 42,
  "datetime1": "2024-01-20T10:00:00Z",
  "datetime2": "2023-11-07T05:31:56Z",
  "datetime3": "2023-11-07T05:31:56Z",
  "datetime4": "2023-11-07T05:31:56Z",
  "datetime5": "2023-11-07T05:31:56Z",
  "delivery_notes": "Leave at reception if no answer",
  "dispatch_strategy": "auto",
  "drop_sequence": 3,
  "external_system_reference1": "EXT-001",
  "external_system_reference2": "<string>",
  "external_system_reference3": "<string>",
  "goods_out_status_id": 2,
  "integer1": 123,
  "integer2": 123,
  "integer3": 123,
  "integer4": 123,
  "integer5": 123,
  "integration_id": 7,
  "lines_changes": [
    {
      "attributes": {
        "alt_line_note": "<string>",
        "alt_line_number": "<string>",
        "alt_line_reference": "<string>",
        "alt_product_code": "<string>",
        "boolean1": true,
        "boolean2": true,
        "boolean3": true,
        "boolean4": true,
        "boolean5": true,
        "carrier_id": 5,
        "carrier_service_id": 12,
        "datetime1": "2023-11-07T05:31:56Z",
        "datetime1_from": "2023-11-07T05:31:56Z",
        "datetime1_to": "2023-11-07T05:31:56Z",
        "datetime2": "2023-11-07T05:31:56Z",
        "datetime2_from": "2023-11-07T05:31:56Z",
        "datetime2_to": "2023-11-07T05:31:56Z",
        "datetime3": "2023-11-07T05:31:56Z",
        "datetime3_from": "2023-11-07T05:31:56Z",
        "datetime3_to": "2023-11-07T05:31:56Z",
        "datetime4": "2023-11-07T05:31:56Z",
        "datetime4_from": "2023-11-07T05:31:56Z",
        "datetime4_to": "2023-11-07T05:31:56Z",
        "datetime5": "2023-11-07T05:31:56Z",
        "datetime5_from": "2023-11-07T05:31:56Z",
        "datetime5_to": "2023-11-07T05:31:56Z",
        "external_system_reference1": "<string>",
        "external_system_reference2": "<string>",
        "external_system_reference3": "<string>",
        "goods_in_receipt_line_id": 123,
        "integer1": 123,
        "integer2": 123,
        "integer3": 123,
        "integer4": 123,
        "integer5": 123,
        "order_quantity": 1,
        "ordered_configurations_quantity": 1,
        "product_id": 123,
        "stock_description": "<string>",
        "stock_to_pick_id": 123,
        "storage_unit_reference": "<string>",
        "string1": "<string>",
        "string2": "<string>",
        "string3": "<string>",
        "string4": "<string>",
        "string5": "<string>"
      },
      "id": 123
    }
  ],
  "load_reference": "LOAD-2024-001",
  "location_id": 100,
  "order_notes": "Priority customer - handle with care",
  "order_type_id": 1,
  "original_delivery_address_id": 123,
  "pack_strategy": "pack_by_line",
  "packing_notes": "Use fragile stickers",
  "pick_notes": "Check expiry dates",
  "pick_reference": "PICK-BATCH-001",
  "pick_type": "standard",
  "priority": 1,
  "short_order_lines_description": "<string>",
  "short_order_lines_reason_code_id": 123,
  "string1": "<string>",
  "string2": "<string>",
  "string3": "<string>",
  "string4": "<string>",
  "string5": "<string>",
  "warehouse_id": 1
}

Goods out order header attributes

account_id

integer

required

Stock account ID - the owner of the stock. Accounts represent 3PL clients or stock owners, not end customers.

Example:

1

expected_date_of_dispatch

string<date-time>

required

Target dispatch date and time in ISO 8601 format

Example:

"2024-01-20T10:00:00Z"

goods_out_type

enum<string>

required

Type of outbound order

Available options:

sales_order,

work_order,

crossdock

Example:

"sales_order"

reference

string

required

Reference number (e.g., order reference, receipt reference). Used for external system identification.

Maximum string length: 50

Example:

"ORD-001"

actual_date_of_dispatch

string<date-time> | null

Actual dispatch date and time

Example:

"2024-01-20T14:30:00Z"

boolean1

boolean | null

Custom boolean field 1

boolean2

boolean | null

Custom boolean field 2

boolean3

boolean | null

Custom boolean field 3

boolean4

boolean | null

Custom boolean field 4

boolean5

boolean | null

Custom boolean field 5

carrier_id

integer | null

Carrier ID - reference to a shipping carrier (e.g., DHL, DPD, Royal Mail)

Example:

5

carrier_service_id

integer | null

Carrier service ID - reference to a specific carrier service level (e.g., Next Day, Express)

Example:

12

customer_id

integer | null

End customer ID - the recipient of the goods (distinct from account/stock owner)

Example:

42

datetime1

string<date-time> | null

Custom datetime field 1

Example:

"2024-01-20T10:00:00Z"

datetime2

string<date-time> | null

Custom datetime field 2

datetime3

string<date-time> | null

Custom datetime field 3

datetime4

string<date-time> | null

Custom datetime field 4

datetime5

string<date-time> | null

Custom datetime field 5

delivery_notes

string | null

Delivery instructions for carrier

Example:

"Leave at reception if no answer"

dispatch_strategy

enum<string> | null

How order should be dispatched

Available options:

manual,

auto,

load,

shipment,

auto_shipment

Example:

"auto"

drop_sequence

integer | null

Delivery sequence on route

Required range: x >= 0

Example:

3

external_system_reference1

string | null

External system reference 1

Example:

"EXT-001"

external_system_reference2

string | null

External system reference 2

external_system_reference3

string | null

External system reference 3

goods_out_status_id

integer | null

Goods out status ID. Default statuses: 1=DRAFT (order created but not ready), 2=PENDING (awaiting stock allocation), 3=PICK (picking in progress), 4=PART (legacy), 5=ALLOCATED (fully allocated), 6=COMPLETED (dispatched), 7=PART_ALLOCATED, 8=CANCELLED

Example:

2

integer1

integer | null

Custom integer field 1

integer2

integer | null

Custom integer field 2

integer3

integer | null

Custom integer field 3

integer4

integer | null

Custom integer field 4

integer5

integer | null

Custom integer field 5

integration_id

integer | null

Integration ID - reference to an external system integration (e.g., Shopify, Brightpearl)

Example:

7

lines_changes

object[]

Array of line item changes (ADD, UPDATE, DESTROY)

Show child attributes

load_reference

string | null

Reference for grouping into loads

Example:

"LOAD-2024-001"

location_id

integer | null

Location ID - reference to a storage location within a warehouse

Example:

100

order_notes

string | null

General order notes

Example:

"Priority customer - handle with care"

order_type_id

integer | null

Order type ID - configurable per tenant, used to categorize orders (e.g., for duty/tax purposes via duty_payable flag)

Example:

1

original_delivery_address_id

integer | null

Original delivery address ID

pack_strategy

enum<string> | null

Packing strategy

Available options:

disabled,

pack_by_line,

pack_by_unit

Example:

"pack_by_line"

packing_notes

string | null

Instructions for packers

Maximum string length: 255

Example:

"Use fragile stickers"

pick_notes

string | null

Instructions for pickers

Example:

"Check expiry dates"

pick_reference

string | null

Reference for grouping picks

Example:

"PICK-BATCH-001"

pick_type

enum<string> | null

Picking method

Available options:

standard,

tote

Example:

"standard"

priority

integer | null

Priority level where lower numbers indicate higher priority (1 = highest)

Required range: 1 <= x <= 99

Example:

1

short_order_lines_description

string | null

Description for short orders

short_order_lines_reason_code_id

integer | null

Reason code for short orders

string1

string | null

Custom string field 1

string2

string | null

Custom string field 2

string3

string | null

Custom string field 3

string4

string | null

Custom string field 4

string5

string | null

Custom string field 5

warehouse_id

integer | null

Warehouse ID - the physical warehouse location for operations

Example:

1