Bin Worksheet API

Plan and prepare bin operations before execution, providing a staging area for warehouse activities.

Endpoints

Method	Endpoint	Description
GET	`/record/v1/binWorksheet`	Retrieve list of bin worksheets
GET	`/record/v1/binWorksheet/{id}`	Retrieve a specific bin worksheet
POST	`/record/v1/binWorksheet`	Create a new bin worksheet
PATCH	`/record/v1/binWorksheet/{id}`	Update an existing bin worksheet
DELETE	`/record/v1/binWorksheet/{id}`	Delete a bin worksheet

Key Fields

Header Fields

Field	Type	Description	Required
`tranDate`	Date	Transaction date	Yes
`location`	Object	Location reference `{"id": "1"}`	Yes
`subsidiary`	Object	Subsidiary reference	No
`memo`	String	Transaction memo/description	No
`tranId`	String	Transaction number (auto-generated if not provided)	No

Line Item Fields (item.items)

Field	Type	Description	Required
`item`	Object	Item reference `{"id": "789"}`	Yes
`quantity`	Number	Planned quantity	No
`description`	String	Line item description	No
`fromBins`	Object	Planned source bin assignments	No
`toBins`	Object	Planned destination bin assignments	No

Example: Create Bin Worksheet

Request

POST /record/v1/binWorksheet
Content-Type: application/json

{
  "tranDate": "2025-12-25",
  "location": {"id": "1"},
  "memo": "Monthly warehouse reorganization plan - Q4 2025",
  "item": {
    "items": [
      {
        "item": {"id": "789"},
        "quantity": 100,
        "description": "Move Widget A from bulk to pick location"
      },
      {
        "item": {"id": "790"},
        "quantity": 50,
        "description": "Consolidate Widget B inventory"
      }
    ]
  }
}

Response

{
  "id": "78901",
  "tranDate": "2025-12-25",
  "tranId": "BINWS-2025-001",
  "location": {
    "id": "1",
    "refName": "Main Warehouse"
  },
  "memo": "Monthly warehouse reorganization plan - Q4 2025",
  "item": {
    "items": [
      {
        "item": {
          "id": "789",
          "refName": "Widget A"
        },
        "quantity": 100,
        "description": "Move Widget A from bulk to pick location"
      },
      {
        "item": {
          "id": "790",
          "refName": "Widget B"
        },
        "quantity": 50,
        "description": "Consolidate Widget B inventory"
      }
    ]
  },
  "links": [
    {
      "rel": "self",
      "href": "https://{{account}}.suitetalk.api.netsuite.com/services/rest/record/v1/binWorksheet/78901"
    }
  ]
}

Example: Create Detailed Bin Worksheet

With specific bin planning:

Request

POST /record/v1/binWorksheet
Content-Type: application/json

{
  "tranDate": "2025-12-25",
  "location": {"id": "1"},
  "memo": "Cycle count preparation - Aisle A reorganization",
  "item": {
    "items": [
      {
        "item": {"id": "789"},
        "quantity": 75,
        "description": "Reorganize Widget A bins",
        "fromBins": {
          "items": [
            {
              "binNumber": {"id": "10"},
              "quantity": 50
            },
            {
              "binNumber": {"id": "12"},
              "quantity": 25
            }
          ]
        },
        "toBins": {
          "items": [
            {
              "binNumber": {"id": "11"},
              "quantity": 75
            }
          ]
        }
      }
    ]
  }
}

Response

{
  "id": "78902",
  "tranDate": "2025-12-25",
  "tranId": "BINWS-2025-002",
  "location": {
    "id": "1",
    "refName": "Main Warehouse"
  },
  "memo": "Cycle count preparation - Aisle A reorganization",
  "item": {
    "items": [
      {
        "item": {
          "id": "789",
          "refName": "Widget A"
        },
        "quantity": 75,
        "description": "Reorganize Widget A bins",
        "fromBins": {
          "items": [
            {
              "binNumber": {
                "id": "10",
                "refName": "BULK-A-001"
              },
              "quantity": 50
            },
            {
              "binNumber": {
                "id": "12",
                "refName": "BULK-A-003"
              },
              "quantity": 25
            }
          ]
        },
        "toBins": {
          "items": [
            {
              "binNumber": {
                "id": "11",
                "refName": "PICK-A-001"
              },
              "quantity": 75
            }
          ]
        }
      }
    ]
  },
  "links": [
    {
      "rel": "self",
      "href": "https://{{account}}.suitetalk.api.netsuite.com/services/rest/record/v1/binWorksheet/78902"
    }
  ]
}

Example: Update Bin Worksheet

Request

PATCH /record/v1/binWorksheet/78901
Content-Type: application/json

{
  "memo": "Monthly warehouse reorganization plan - Q4 2025 - Revised",
  "item": {
    "items": [
      {
        "item": {"id": "791"},
        "quantity": 30,
        "description": "Add Widget C to reorganization plan"
      }
    ]
  }
}

Response

{
  "id": "78901",
  "memo": "Monthly warehouse reorganization plan - Q4 2025 - Revised",
  "links": [
    {
      "rel": "self",
      "href": "https://{{account}}.suitetalk.api.netsuite.com/services/rest/record/v1/binWorksheet/78901"
    }
  ]
}

Sublists/Line Items

Item Sublist Structure

The item.items array contains planned bin operations. Each line represents a planned activity.

{
  "item": {
    "items": [
      {
        "item": {"id": "789"},
        "quantity": 100,
        "description": "Planned operation description"
      }
    ]
  }
}

With Bin Planning

Include detailed bin-to-bin movement plans:

{
  "item": {
    "items": [
      {
        "item": {"id": "789"},
        "quantity": 100,
        "description": "Consolidate from multiple bins",
        "fromBins": {
          "items": [
            {"binNumber": {"id": "10"}, "quantity": 60},
            {"binNumber": {"id": "12"}, "quantity": 40}
          ]
        },
        "toBins": {
          "items": [
            {"binNumber": {"id": "11"}, "quantity": 100}
          ]
        }
      }
    ]
  }
}

Multiple Item Planning

Plan operations for multiple items:

{
  "item": {
    "items": [
      {
        "item": {"id": "789"},
        "quantity": 100,
        "description": "Widget A - Replenishment"
      },
      {
        "item": {"id": "790"},
        "quantity": 50,
        "description": "Widget B - Consolidation"
      },
      {
        "item": {"id": "791"},
        "quantity": 75,
        "description": "Widget C - Reorganization"
      }
    ]
  }
}

Query Filters

Filter by Date Range

GET /record/v1/binWorksheet?q=tranDate BETWEEN '2025-01-01' AND '2025-12-31'

Filter by Location

GET /record/v1/binWorksheet?q=location.id = 1

Filter by Transaction ID

GET /record/v1/binWorksheet?q=tranId = 'BINWS-2025-001'

Filter by Date and Location

GET /record/v1/binWorksheet?q=tranDate >= '2025-01-01' AND location.id = 1

Search by Memo

GET /record/v1/binWorksheet?q=memo LIKE '%reorganization%'

Complex Query with Sorting

GET /record/v1/binWorksheet?q=tranDate >= '2025-01-01' AND location.id = 1&orderby=tranDate DESC&limit=50

Important Notes

Purpose of Bin Worksheet

Planning Tool:

Plan warehouse activities before execution
Document proposed bin movements
Coordinate team activities
Review and approve before implementing

Not an Execution Record:

Bin worksheets do NOT move inventory
They are planning documents only
Actual movements require Bin Transfer transactions
Think of it as a "blueprint" for warehouse work

Workflow Integration

Typical Workflow:

Create bin worksheet to plan reorganization
Review and approve the plan
Execute planned movements using Bin Transfer
Close or delete the worksheet once complete

Bin Management Requirements

Prerequisites:

Advanced Bin / Numbered Bin Management must be enabled
Location must have bin management enabled
Items should be bin-enabled (not strictly required for planning)

Permissions Required

Create: Transactions > Bin Worksheet > Create
Edit: Transactions > Bin Worksheet > Edit
Delete: Transactions > Bin Worksheet > Delete
View: Transactions > Bin Worksheet > View

Best Practices

Detailed documentation: Use memo to explain the purpose and scope
Plan comprehensively: Include all items and bins affected
Review before execution: Have warehouse manager approve plans
Schedule execution: Plan timing for minimal disruption
Clean up: Delete or archive worksheets after execution
Track progress: Update worksheet as work is completed
Team coordination: Share worksheets with warehouse staff

Limitations

Does not move actual inventory
Does not validate bin capacity
Does not check inventory availability
No accounting impact
May not enforce all business rules of actual transactions

Common Use Cases

Warehouse Reorganization: Plan major layout changes
Cycle Count Preparation: Document expected bin contents
Seasonal Planning: Prepare for seasonal inventory shifts
Replenishment Planning: Plan bulk-to-pick movements
Project Planning: Coordinate large-scale warehouse projects
Training: Use as training tool for warehouse procedures
Analysis: Evaluate different organization strategies

Bin Worksheet vs Bin Transfer

Bin Worksheet (this API):

Planning document only
No inventory movement
Can be edited/deleted freely
No GL impact
Used for preparation

Bin Transfer:

Execution transaction
Actually moves inventory
Creates audit trail
Limited editability after posting
Used for implementation

Data Validation

Transaction date should be valid
Location must exist
Items should exist (though not strictly required for planning)
Bins should exist (though not strictly required for planning)
Quantities should be reasonable for planning purposes

Planning Scenarios

Scenario 1: Monthly Reorganization

{
  "tranDate": "2025-12-01",
  "location": {"id": "1"},
  "memo": "December warehouse optimization - move fast movers to pick zones",
  "item": {
    "items": [
      {
        "item": {"id": "789"},
        "quantity": 200,
        "description": "High velocity - move to PICK zone"
      }
    ]
  }
}

Scenario 2: Cycle Count Planning

{
  "tranDate": "2025-12-15",
  "location": {"id": "1"},
  "memo": "Aisle A cycle count preparation - expected discrepancies",
  "item": {
    "items": [
      {
        "item": {"id": "789"},
        "quantity": 100,
        "description": "Expected count in BULK-A-001"
      }
    ]
  }
}

Scenario 3: Seasonal Preparation

{
  "tranDate": "2025-11-01",
  "location": {"id": "1"},
  "memo": "Holiday season preparation - expand pick zones",
  "item": {
    "items": [
      {
        "item": {"id": "789"},
        "quantity": 500,
        "description": "Expand to additional pick bins"
      }
    ]
  }
}

Integration Tips

Use worksheets to validate plans before creating transfers
Store approved worksheets for audit purposes
Link worksheets to executed bin transfers via memo or custom fields
Generate worksheets from analytics of pick patterns
Export worksheets for warehouse management system integration

Reporting and Analytics

Use bin worksheet data for:

Planning documentation
Work order generation
Resource allocation planning
Time estimation for warehouse projects
Historical planning reference
Warehouse optimization analysis

Advanced Planning Features

Capacity Planning:

Estimate space requirements
Plan for bin capacity limits
Identify overflow scenarios

Resource Planning:

Estimate labor hours
Plan equipment needs
Schedule warehouse staff

Impact Analysis:

Assess disruption to operations
Identify dependencies
Plan phased implementation

Converting Plan to Execution

When ready to execute the planned work:

Review the worksheet for accuracy
Verify inventory levels in source bins
Create Bin Transfer transactions based on worksheet
Update worksheet memo to indicate execution status
Archive or delete worksheet after completion

Worksheet Lifecycle

Draft Phase:

Create initial worksheet
Add planned items and bins
Estimate quantities

Review Phase:

Share with stakeholders
Refine based on feedback
Approve for execution

Execution Phase:

Create bin transfers from plan
Track progress
Update as needed

Completion Phase:

Verify all planned work completed
Archive for record keeping
Delete if no longer needed

Collaboration

Use bin worksheets for:

Manager Planning: Create high-level plans
Team Review: Share for feedback
Staff Execution: Provide work instructions
Audit Trail: Document planning decisions

Performance Considerations

Worksheets have minimal performance impact
Can create many worksheets without affecting operations
Use as sandbox for planning without risk
No validation delays since no actual inventory movement

Endpoints​

Key Fields​

Header Fields​

Line Item Fields (item.items)​

Example: Create Bin Worksheet​

Request​

Response​

Example: Create Detailed Bin Worksheet​

Request​

Response​

Example: Update Bin Worksheet​

Request​

Response​

Sublists/Line Items​

Item Sublist Structure​

With Bin Planning​

Multiple Item Planning​

Query Filters​

Filter by Date Range​

Filter by Location​

Filter by Transaction ID​

Filter by Date and Location​

Search by Memo​

Complex Query with Sorting​

Important Notes​

Purpose of Bin Worksheet​

Workflow Integration​

Bin Management Requirements​

Permissions Required​

Best Practices​

Limitations​

Common Use Cases​

Bin Worksheet vs Bin Transfer​

Data Validation​

Planning Scenarios​

Integration Tips​

Reporting and Analytics​

Advanced Planning Features​

Converting Plan to Execution​

Worksheet Lifecycle​

Collaboration​

Performance Considerations​

Endpoints

Key Fields

Header Fields

Line Item Fields (item.items)

Example: Create Bin Worksheet

Request

Response

Example: Create Detailed Bin Worksheet

Request

Response

Example: Update Bin Worksheet

Request

Response

Sublists/Line Items

Item Sublist Structure

With Bin Planning

Multiple Item Planning

Query Filters

Filter by Date Range

Filter by Location

Filter by Transaction ID

Filter by Date and Location

Search by Memo

Complex Query with Sorting

Important Notes

Purpose of Bin Worksheet

Workflow Integration

Bin Management Requirements

Permissions Required

Best Practices

Limitations

Common Use Cases

Bin Worksheet vs Bin Transfer

Data Validation

Planning Scenarios

Integration Tips

Reporting and Analytics

Advanced Planning Features

Converting Plan to Execution

Worksheet Lifecycle

Collaboration

Performance Considerations