Contents

• Title and Copyright Information
• Get Help

1 Overview

• Change History
• End User License Agreement
• Restful Web Services
• HTTP Requests
  • HTTP Methods
  • URI Format
  • Login and Authentication
  • Application Permissions
• Data Input Methodology
  • GET/HEAD
  • POST

2 HTTP Response

• Status Codes
• Response Formats
• Response Data Encoding
• Response Data Formats
  • Error Response
  • Resource Representations

3 Entity Module

• Supported Entities
• Entity Metadata
• Input Data Types
• Resource Result Set Filtering
  • Supported Lookup Functions
• Resource Representations (GET)
  • List
  • Retrieve
  • Resource Representation Data Conventions
  • Hyperlink-Related Resource Representations
  • Related Data Sets
  • Field Selection
  • Ordering
  • Querying Multiple Entities in one GET Request using “values_list”
  • Filter Entity Data using NOT Operator
• Resource Existence and Modification (HEAD)
  • “If-Modified-Since” HTTP Request Header
  • Response Statuses
• Creating a Resource (POST)
  • Input Data
  • Data Structure
  • Related Resources
  • Response Statuses
  • Validations
  • Nested Related Objects
  • Supported Entities
• Updating a Resource (PATCH)
  • Input Data
  • Response Statuses
  • IB Shipment
  • IB Shipment Detail
  • Item Characteristics
  • Load
  • Location
  • Order Header
  • Order Detail
  • Purchase Order Header
  • Purchase Order Detail
  • Work Order Header
  • Work Order Kit
  • Pallet
  • Container, IBLPN, and OBLPN
  • Movement Request Header
• Entity Operations (GET/POST)
  • Response Status
  • Bulk Operations

4 Supported Entity Operations

• Batch Number
• Company Parameter
• Container
  • Get Sales Orders
  • Lock Container
  • Bulk Lock Container
  • Unlock Container
  • Bulk Unlock Container
  • Palletize Container
  • Depalletize Inbound/Outbound LPN
  • Quality Check Approve
  • Quality Check Reject
• Cycle Count
  • Confirm LPN Count
  • Confirm Count LPN Scan
  • Confirm Active Count
• Describe Entity
• Facility Parameter
• IBLPN
  • Direct Consume
  • Modify Item Quantity
  • Composite Create
  • Receive
  • Split LPN for Replenishment
  • Deallocate
  • Vendor Performance Code
  • Quality Check Approve/Reject
• Item
  • Image Upload
  • Item Image
• Inventory
  • Link Serial Numbers
  • Bulk Update Inventory Attributes
  • Delink Serial Numbers
  • GET Inventory History
  • GET Next Number
• Load
  • Check_In
  • Check_Out
  • Ship Load
• Location
  • Update Active Inventory
  • Locate LPN or Pallet
  • Location Size Type
• OBLPN
  • Mark Delivered
  • Create from IBLPN
  • Link OBLPN with Asset
  • Ship OBLPN
  • Bulk Ship OBLPN
• Pallet
  • Sort LPN
  • Sort LPN Close Pallet
  • Ship Pallet
• Pick-Pack
  • Pick Confirm
  • Close LPN
  • Wave Complete
  • GET Next Pick
  • Pack Full LPN
• Print
  • Print Shipping Label
  • Print LPN Label
  • Print Pallet Label
• Putaway
  • Putaway Priority
  • Directed Putaway Location
  • Putaway Type
  • Putaway Type Calculation Rule
• Repack
  • Pack Inventory
  • Close LPN
• Replenishment
  • Replenish to Active
  • Replenishment Zone
• Report
  • Custom Inventory Summary
  • WMS Activity and Activity Detail
• Sales Order Header
  • GET IBLPN(s)
  • GET OBLPN(s)
  • Bulk Lock
  • Bulk Unlock
  • Remove Personal Info
  • Update Parcel Shipment Info
• SQL Selection (Rule Tree)
• Task
  • Next Task
  • Hold Task
  • Release Task
  • Assign Task
  • Change Priority
  • Cancel Task
• Trailer
  • First Available
  • Locate to Yard
  • Remove from Yard
• Waves
  • Run Manual Wave
  • Run Template
  • Undo Wave
• Workforce Management (WFM)
  • Clock In-Out