The Putaway Rule object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

item_code string required
item_name string
warehouse string required
capacity number

Default: 0

stock_uom string
priority integer

Default: 1

company string required
disable boolean

Default: false

uom string
stock_capacity number
conversion_factor number

Default: 1

The Putaway Rule object 
{
  "id": "putaway-rule_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "warehouse": "warehouse_example",
  "capacity": 0,
  "stock_uom": "stock_uom_example",
  "priority": 1,
  "company": "Example Corp",
  "disable": false,
  "uom": "uom_example",
  "stock_capacity": 0,
  "conversion_factor": 1
}
GET /api/stock/putaway-rule/{id}

Retrieve a putaway rule

Retrieves the details of an existing putaway rule. Supply the unique putaway rule ID that was returned from a previous request.

Path parameters

id string required

The identifier of the putaway rule to retrieve.

Returns

Returns the putaway rule object if a valid identifier was provided.

GET /api/stock/putaway-rule/{id} 
curl https://api.overplane.dev/api/stock/putaway-rule/putaway-rule_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "putaway-rule_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "warehouse": "warehouse_example",
  "capacity": 0,
  "stock_uom": "stock_uom_example",
  "priority": 1,
  "company": "Example Corp",
  "disable": false,
  "uom": "uom_example",
  "stock_capacity": 0,
  "conversion_factor": 1
}
GET /api/stock/putaway-rule

List all putaway rules

Returns a list of putaway rules. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of putaway rule objects.

GET /api/stock/putaway-rule 
curl https://api.overplane.dev/api/stock/putaway-rule \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "putaway-rule_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "item_code": "item_code_example",
      "item_name": "item_name_example",
      "warehouse": "warehouse_example",
      "capacity": 0,
      "stock_uom": "stock_uom_example",
      "priority": 1,
      "company": "Example Corp",
      "disable": false,
      "uom": "uom_example",
      "stock_capacity": 0,
      "conversion_factor": 1
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/stock/putaway-rule

Create a putaway rule

Creates a new putaway rule object.

Body parameters

item_code string required
item_name string
warehouse string required
capacity number

Default: 0

stock_uom string
priority integer

Default: 1

company string required
disable boolean

Default: false

uom string
stock_capacity number
conversion_factor number

Default: 1

Returns

Returns the newly created putaway rule object if the call succeeded.

POST /api/stock/putaway-rule 
curl https://api.overplane.dev/api/stock/putaway-rule \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"item_code":"item_code_example","warehouse":"warehouse_example","company":"Example Corp"}'
Response 
{
  "id": "putaway-rule_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "warehouse": "warehouse_example",
  "capacity": 0,
  "stock_uom": "stock_uom_example",
  "priority": 1,
  "company": "Example Corp",
  "disable": false,
  "uom": "uom_example",
  "stock_capacity": 0,
  "conversion_factor": 1
}
PATCH /api/stock/putaway-rule/{id}

Update a putaway rule

Updates the specified putaway rule by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the putaway rule to update.

Body parameters

item_code string
item_name string
warehouse string
capacity number

Default: 0

stock_uom string
priority integer

Default: 1

company string
disable boolean

Default: false

uom string
stock_capacity number
conversion_factor number

Default: 1

Returns

Returns the updated putaway rule object.

PATCH /api/stock/putaway-rule/{id} 
curl https://api.overplane.dev/api/stock/putaway-rule/putaway-rule_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"item_code":"item_code_example","item_name":"item_name_example"}'
Response 
{
  "id": "putaway-rule_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "warehouse": "warehouse_example",
  "capacity": 0,
  "stock_uom": "stock_uom_example",
  "priority": 1,
  "company": "Example Corp",
  "disable": false,
  "uom": "uom_example",
  "stock_capacity": 0,
  "conversion_factor": 1
}
DELETE /api/stock/putaway-rule/{id}

Delete a putaway rule

Permanently deletes a putaway rule. This cannot be undone.

Path parameters

id string required

The identifier of the putaway rule to delete.

Returns

Returns a confirmation that the putaway rule has been deleted.

DELETE /api/stock/putaway-rule/{id} 
curl https://api.overplane.dev/api/stock/putaway-rule/putaway-rule_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "putaway-rule_abc123",
  "deleted": true
}