The Bin 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.

warehouse string required
item_code string required
reserved_qty number

Default: 0

actual_qty number

Default: 0

ordered_qty number

Default: 0

indented_qty number

Default: 0

planned_qty number
projected_qty number
reserved_qty_for_production number
reserved_qty_for_sub_contract number
stock_uom string
company string
valuation_rate number
stock_value number
reserved_qty_for_production_plan number
reserved_stock number

Default: 0

The Bin object 
{
  "id": "bin_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "warehouse": "warehouse_example",
  "item_code": "item_code_example",
  "reserved_qty": 0,
  "actual_qty": 0,
  "ordered_qty": 0,
  "indented_qty": 0,
  "planned_qty": 0,
  "projected_qty": 0,
  "reserved_qty_for_production": 0,
  "reserved_qty_for_sub_contract": 0,
  "stock_uom": "stock_uom_example",
  "company": "Example Corp",
  "valuation_rate": 0,
  "stock_value": 0,
  "reserved_qty_for_production_plan": 0,
  "reserved_stock": 0
}
GET /api/stock/bin/{id}

Retrieve a bin

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

Path parameters

id string required

The identifier of the bin to retrieve.

Returns

Returns the bin object if a valid identifier was provided.

GET /api/stock/bin/{id} 
curl https://api.overplane.dev/api/stock/bin/bin_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "bin_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "warehouse": "warehouse_example",
  "item_code": "item_code_example",
  "reserved_qty": 0,
  "actual_qty": 0,
  "ordered_qty": 0,
  "indented_qty": 0,
  "planned_qty": 0,
  "projected_qty": 0,
  "reserved_qty_for_production": 0,
  "reserved_qty_for_sub_contract": 0,
  "stock_uom": "stock_uom_example",
  "company": "Example Corp",
  "valuation_rate": 0,
  "stock_value": 0,
  "reserved_qty_for_production_plan": 0,
  "reserved_stock": 0
}
GET /api/stock/bin

List all bins

Returns a list of bins. 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 bin objects.

GET /api/stock/bin 
curl https://api.overplane.dev/api/stock/bin \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "bin_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "warehouse": "warehouse_example",
      "item_code": "item_code_example",
      "reserved_qty": 0,
      "actual_qty": 0,
      "ordered_qty": 0,
      "indented_qty": 0,
      "planned_qty": 0,
      "projected_qty": 0,
      "reserved_qty_for_production": 0,
      "reserved_qty_for_sub_contract": 0,
      "stock_uom": "stock_uom_example",
      "company": "Example Corp",
      "valuation_rate": 0,
      "stock_value": 0,
      "reserved_qty_for_production_plan": 0,
      "reserved_stock": 0
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/stock/bin

Create a bin

Creates a new bin object.

Body parameters

warehouse string required
item_code string required
reserved_qty number

Default: 0

actual_qty number

Default: 0

ordered_qty number

Default: 0

indented_qty number

Default: 0

planned_qty number
projected_qty number
reserved_qty_for_production number
reserved_qty_for_sub_contract number
stock_uom string
company string
valuation_rate number
stock_value number
reserved_qty_for_production_plan number
reserved_stock number

Default: 0

Returns

Returns the newly created bin object if the call succeeded.

POST /api/stock/bin 
curl https://api.overplane.dev/api/stock/bin \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"warehouse":"warehouse_example","item_code":"item_code_example"}'
Response 
{
  "id": "bin_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "warehouse": "warehouse_example",
  "item_code": "item_code_example",
  "reserved_qty": 0,
  "actual_qty": 0,
  "ordered_qty": 0,
  "indented_qty": 0,
  "planned_qty": 0,
  "projected_qty": 0,
  "reserved_qty_for_production": 0,
  "reserved_qty_for_sub_contract": 0,
  "stock_uom": "stock_uom_example",
  "company": "Example Corp",
  "valuation_rate": 0,
  "stock_value": 0,
  "reserved_qty_for_production_plan": 0,
  "reserved_stock": 0
}
PATCH /api/stock/bin/{id}

Update a bin

Updates the specified bin 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 bin to update.

Body parameters

warehouse string
item_code string
reserved_qty number

Default: 0

actual_qty number

Default: 0

ordered_qty number

Default: 0

indented_qty number

Default: 0

planned_qty number
projected_qty number
reserved_qty_for_production number
reserved_qty_for_sub_contract number
stock_uom string
company string
valuation_rate number
stock_value number
reserved_qty_for_production_plan number
reserved_stock number

Default: 0

Returns

Returns the updated bin object.

PATCH /api/stock/bin/{id} 
curl https://api.overplane.dev/api/stock/bin/bin_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"warehouse":"warehouse_example","item_code":"item_code_example"}'
Response 
{
  "id": "bin_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "warehouse": "warehouse_example",
  "item_code": "item_code_example",
  "reserved_qty": 0,
  "actual_qty": 0,
  "ordered_qty": 0,
  "indented_qty": 0,
  "planned_qty": 0,
  "projected_qty": 0,
  "reserved_qty_for_production": 0,
  "reserved_qty_for_sub_contract": 0,
  "stock_uom": "stock_uom_example",
  "company": "Example Corp",
  "valuation_rate": 0,
  "stock_value": 0,
  "reserved_qty_for_production_plan": 0,
  "reserved_stock": 0
}
DELETE /api/stock/bin/{id}

Delete a bin

Permanently deletes a bin. This cannot be undone.

Path parameters

id string required

The identifier of the bin to delete.

Returns

Returns a confirmation that the bin has been deleted.

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