The Pick List 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.

status string

Default: draft

company string required

parent_warehouse string

customer string

work_order string

for_qty number

purpose string

Default: Material Transfer for Manufacture

material_request string

group_same_items boolean

Default: false

scan_barcode string

scan_mode boolean

Default: false

prompt_qty boolean

Default: false

customer_name string

consider_rejected_warehouses boolean

Default: false

pick_manually boolean

Default: false

ignore_pricing_rule boolean

Default: false

delivery_status string

per_delivered number

The Pick List object

{
  "id": "pick-list_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "parent_warehouse": "parent_warehouse_example",
  "customer": "customer_example",
  "work_order": "work_order_example",
  "for_qty": 0,
  "purpose": "Material Transfer for Manufacture",
  "material_request": "material_request_example",
  "group_same_items": false,
  "scan_barcode": "scan_barcode_example",
  "scan_mode": false,
  "prompt_qty": false,
  "customer_name": "customer_name_example",
  "consider_rejected_warehouses": false,
  "pick_manually": false,
  "ignore_pricing_rule": false,
  "delivery_status": "delivery_status_example",
  "per_delivered": 0
}

GET /api/stock/pick-list/{id}

Retrieve a pick list

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

Path parameters

id string required

The identifier of the pick list to retrieve.

Returns

Returns the pick list object if a valid identifier was provided.

GET /api/stock/pick-list/{id}

curl https://api.overplane.dev/api/stock/pick-list/pick-list_abc123 \
  -H "Authorization: Bearer sk_test_..."

Response

{
  "id": "pick-list_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "parent_warehouse": "parent_warehouse_example",
  "customer": "customer_example",
  "work_order": "work_order_example",
  "for_qty": 0,
  "purpose": "Material Transfer for Manufacture",
  "material_request": "material_request_example",
  "group_same_items": false,
  "scan_barcode": "scan_barcode_example",
  "scan_mode": false,
  "prompt_qty": false,
  "customer_name": "customer_name_example",
  "consider_rejected_warehouses": false,
  "pick_manually": false,
  "ignore_pricing_rule": false,
  "delivery_status": "delivery_status_example",
  "per_delivered": 0
}

GET /api/stock/pick-list

List all pick lists

Returns a list of pick lists. 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 pick list objects.

GET /api/stock/pick-list

curl https://api.overplane.dev/api/stock/pick-list \
  -H "Authorization: Bearer sk_test_..."

Response

{
  "data": [
    {
      "id": "pick-list_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "company": "Example Corp",
      "parent_warehouse": "parent_warehouse_example",
      "customer": "customer_example",
      "work_order": "work_order_example",
      "for_qty": 0,
      "purpose": "Material Transfer for Manufacture",
      "material_request": "material_request_example",
      "group_same_items": false,
      "scan_barcode": "scan_barcode_example",
      "scan_mode": false,
      "prompt_qty": false,
      "customer_name": "customer_name_example",
      "consider_rejected_warehouses": false,
      "pick_manually": false,
      "ignore_pricing_rule": false,
      "delivery_status": "delivery_status_example",
      "per_delivered": 0
    }
  ],
  "has_more": false,
  "total": 1
}

POST /api/stock/pick-list

Create a pick list

Creates a new pick list object.

Body parameters

status string

Default: draft

company string required

parent_warehouse string

customer string

work_order string

for_qty number

purpose string

Default: Material Transfer for Manufacture

material_request string

group_same_items boolean

Default: false

scan_barcode string

scan_mode boolean

Default: false

prompt_qty boolean

Default: false

customer_name string

consider_rejected_warehouses boolean

Default: false

pick_manually boolean

Default: false

ignore_pricing_rule boolean

Default: false

delivery_status string

per_delivered number

Returns

Returns the newly created pick list object if the call succeeded.

POST /api/stock/pick-list

curl https://api.overplane.dev/api/stock/pick-list \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"company":"Example Corp"}'

Response

{
  "id": "pick-list_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "parent_warehouse": "parent_warehouse_example",
  "customer": "customer_example",
  "work_order": "work_order_example",
  "for_qty": 0,
  "purpose": "Material Transfer for Manufacture",
  "material_request": "material_request_example",
  "group_same_items": false,
  "scan_barcode": "scan_barcode_example",
  "scan_mode": false,
  "prompt_qty": false,
  "customer_name": "customer_name_example",
  "consider_rejected_warehouses": false,
  "pick_manually": false,
  "ignore_pricing_rule": false,
  "delivery_status": "delivery_status_example",
  "per_delivered": 0
}

PATCH /api/stock/pick-list/{id}

Update a pick list

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

Body parameters

status string

Default: draft

company string

parent_warehouse string

customer string

work_order string

for_qty number

purpose string

Default: Material Transfer for Manufacture

material_request string

group_same_items boolean

Default: false

scan_barcode string

scan_mode boolean

Default: false

prompt_qty boolean

Default: false

customer_name string

consider_rejected_warehouses boolean

Default: false

pick_manually boolean

Default: false

ignore_pricing_rule boolean

Default: false

delivery_status string

per_delivered number

Returns

Returns the updated pick list object.

PATCH /api/stock/pick-list/{id}

curl https://api.overplane.dev/api/stock/pick-list/pick-list_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","company":"Example Corp"}'

Response

{
  "id": "pick-list_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "parent_warehouse": "parent_warehouse_example",
  "customer": "customer_example",
  "work_order": "work_order_example",
  "for_qty": 0,
  "purpose": "Material Transfer for Manufacture",
  "material_request": "material_request_example",
  "group_same_items": false,
  "scan_barcode": "scan_barcode_example",
  "scan_mode": false,
  "prompt_qty": false,
  "customer_name": "customer_name_example",
  "consider_rejected_warehouses": false,
  "pick_manually": false,
  "ignore_pricing_rule": false,
  "delivery_status": "delivery_status_example",
  "per_delivered": 0
}

DELETE /api/stock/pick-list/{id}

Delete a pick list

Permanently deletes a pick list. This cannot be undone.

Path parameters

id string required

The identifier of the pick list to delete.

Returns

Returns a confirmation that the pick list has been deleted.

DELETE /api/stock/pick-list/{id}

curl https://api.overplane.dev/api/stock/pick-list/pick-list_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE

Response

{
  "id": "pick-list_abc123",
  "deleted": true
}

POST /api/stock/pick-list/{id}/submit

Submit a pick list

Submits a draft pick list, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the pick list to act on.

Returns

Returns the pick list object with updated status.

POST /api/stock/pick-list/{id}/submit

curl https://api.overplane.dev/api/stock/pick-list/pick-list_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST

Response

{
  "id": "pick-list_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "parent_warehouse": "parent_warehouse_example",
  "customer": "customer_example",
  "work_order": "work_order_example",
  "for_qty": 0,
  "purpose": "Material Transfer for Manufacture",
  "material_request": "material_request_example",
  "group_same_items": false,
  "scan_barcode": "scan_barcode_example",
  "scan_mode": false,
  "prompt_qty": false,
  "customer_name": "customer_name_example",
  "consider_rejected_warehouses": false,
  "pick_manually": false,
  "ignore_pricing_rule": false,
  "delivery_status": "delivery_status_example",
  "per_delivered": 0
}

POST /api/stock/pick-list/{id}/cancel

Cancel a pick list

Cancels a submitted pick list, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the pick list to act on.

Returns

Returns the pick list object with updated status.

POST /api/stock/pick-list/{id}/cancel

curl https://api.overplane.dev/api/stock/pick-list/pick-list_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST

Response

{
  "id": "pick-list_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "parent_warehouse": "parent_warehouse_example",
  "customer": "customer_example",
  "work_order": "work_order_example",
  "for_qty": 0,
  "purpose": "Material Transfer for Manufacture",
  "material_request": "material_request_example",
  "group_same_items": false,
  "scan_barcode": "scan_barcode_example",
  "scan_mode": false,
  "prompt_qty": false,
  "customer_name": "customer_name_example",
  "consider_rejected_warehouses": false,
  "pick_manually": false,
  "ignore_pricing_rule": false,
  "delivery_status": "delivery_status_example",
  "per_delivered": 0
}

Line items

Child objects that belong to this pick list. These are accessed via the parent's ID.

Pick List Item

Attributes

idx integer

pick_list_id string required

qty number

picked_qty number

warehouse string

item_name string

description string

serial_no string

batch_no string

stock_uom string

uom string

conversion_factor number

stock_qty number

item_code string required

sales_order string

sales_order_item string

material_request string

material_request_item string

item_group string

product_bundle_item string

serial_and_batch_bundle string

stock_reserved_qty number

use_serial_batch_fields boolean

delivered_qty number

actual_qty number

company_total_stock number

Endpoints

GET /api/stock/pick-list-item?parent_id={id}

POST /api/stock/pick-list-item

PATCH /api/stock/pick-list-item/{id}

DELETE /api/stock/pick-list-item/{id}

POST /api/stock/pick-list-item/reorder

Pick List Item object

{
  "id": "pick-list-item_abc123",
  "idx": 1,
  "pick_list_id": "pick_list_id_example",
  "qty": 1,
  "picked_qty": 0,
  "warehouse": "warehouse_example",
  "item_name": "item_name_example",
  "description": "description_example",
  "serial_no": "serial_no_example",
  "batch_no": "batch_no_example",
  "stock_uom": "stock_uom_example",
  "uom": "uom_example",
  "conversion_factor": 0,
  "stock_qty": 0,
  "item_code": "item_code_example",
  "sales_order": "sales_order_example",
  "sales_order_item": "sales_order_item_example",
  "material_request": "material_request_example",
  "material_request_item": "material_request_item_example",
  "item_group": "item_group_example",
  "product_bundle_item": "product_bundle_item_example",
  "serial_and_batch_bundle": "serial_and_batch_bundle_example",
  "stock_reserved_qty": 0,
  "use_serial_batch_fields": false,
  "delivered_qty": 0,
  "actual_qty": 0,
  "company_total_stock": 0
}

The Pick List object

Attributes

Retrieve a pick list

Path parameters

Returns

List all pick lists

Query parameters

Returns

Create a pick list

Body parameters

Returns

Update a pick list

Path parameters

Body parameters

Returns

Delete a pick list

Path parameters

Returns

Submit a pick list

Path parameters

Returns

Cancel a pick list

Path parameters

Returns

Line items

Pick List Item

Attributes

Endpoints

Coming Soon