API Endpoints

AddressValidation
(added 9.0.6)

  • GET    /Address  Validate an address provided

Branch
(added 9.0.5)

  • GET    /Branches/{id}   Read a single Branch
  • PUT    /Branches/{id}  Update the Branch with the passed ID using the object passed.
  • DELETE    /Branches/{id}  Delete the Branch with the passed ID.
  • GET    /Branches  Search for branches using query parameters
  • POST    /Branches  Create the Branch with the passed ID using the object passed.

BuyLine
(added 9.0.5)

  • GET    /BuyLines/{id}   Read a single BuyLine
  • PUT    /BuyLines/{id}    Update the BuyLine with the passed ID using the object passed.
  • DELETE   /BuyLines/{id}   Delete the BuyLine with the passed ID
  • GET    /BuyLines    Search for buyLines using query parameters
  • POST   /BuyLines   Create the BuyLine with the passed ID using the object passed.

BuyLineBranch
(added 9.0.6)

  • GET    /BuyLineBranch/{id}   Read a single BuyLineBranch
  • PUT    /BuyLineBranch/{id}    Update the BuyLineBranch with the passed ID using the object passed.
  • DELETE   /BuyLineBranch/{id}   Delete the BuyLineBranch with the passed ID
  • GET    /BuyLineBranch    Search for buyLineBranchList using query parameters
  • POST   /BuyLineBranch  Create the BuyLineBranch with the passed ID using the object passed.

Contact
(added 9.0.5)

  • GET    /Contacts/{id}    Read a single Contact
  • PUT    /Contacts/{id}    Update the Contact with the passed ID using the object passed.
  • DELETE    /Contacts/{id}    Delete the Contact with the passed ID
  • GET    /Contacts    Search for contacts using query parameters
  • POST    /Contacts    Create the Contact with the passed ID using the object passed.
  • GET    /Contacts/WebSettings    Search for contactWebs using query parameters
  • POST    /Contacts/WebSettings    Create the ContactWeb with the passed ID using the object passed.
  • GET    /Contacts/{id}/WebSettings    Read a single ContactWeb
  • PUT    /Contacts/{id}/WebSettings    Update the ContactWeb with the passed ID using the object passed.
  • DELETE    /Contacts/{id}/WebSettings    Delete the ContactWeb with the passed ID

Customer
(added 9.0.5)

  • GET    /Customers/{id}    Read a single Customer
  • PUT    /Customers/{id}    Update the Customer with the passed ID using the object passed.
  • DELETE    /Customers/{id}    Delete the Customer with the passed ID
  • GET    /Customers    Search for customers using query parameters
  • POST    /Customers    Create the Customer with the passed ID using the object passed.

CustomerBranchAuth
(added 9.0.6)

  • GET    /CustomerBranchAuths/{id}    Read a single CustomerBranchAuth
  • PUT     /CustomerBranchAuths/{id}   Update the CustomerBranchAuth with the passed ID using the object passed.
  • DELETE    /CustomerBranchAuths/{id}    Delete the CustomerBranchAuth with the passed ID
  • GET    /CustomerBranchAuths    Search for customerBranchAuths using query parameters
  • POST    /CustomerBranchAuths   Create the CustomerBranchAuth with the passed ID using the object passed.

CustomerPartNumber
(added 9.0.5)

  • GET   /CustomerPartNumbers/{id}   Read a single CustomerPartNumber
  • PUT    /CustomerPartNumbers/{id}   Update the CustomerPartNumber with the passed ID using the object passed.
  • DELETE   /CustomerPartNumbers/{id}   Delete the CustomerPartNumber with the passed ID
  • GET   /CustomerPartNumbers   Search for customerPartNumbers using query parameters
  • POST   /CustomerPartNumbers   Create the CustomerPartNumber with the passed ID using the object passed.

DocumentImagingFile
(added 9.0.5)

  • GET    /DocumentImagingFiles/{id}   Read the full binary attachment plus attachment information
  • PUT   /DocumentImagingFiles/{id}   Update the DocumentImagingFile with the passed ID using the object passed.
  • DELETE   /DocumentImagingFiles/{id}   Delete the DocumentImagingFile with the passed ID
  • GET   /DocumentImagingFiles   Search for documentImagingFileInfomrmations using query parameters
  • POST   /DocumentImagingFiles   Create the DocumentImagingFile with the passed ID using the object passed.

DocumentImagingProfile
(added 9.0.5)

  • GET   /DocumentImagingProfiles/{id}   Read a single DocumentImagingProfile
  • PUT   /DocumentImagingProfiles/{id}   Update the DocumentImagingProfile with the passed ID using the object passed.
  • DELETE   /DocumentImagingProfiles/{id}   Delete the DocumentImagingProfile with the passed ID
  • GET   /DocumentImagingProfiles   Search for documentImagingProfiles using query parameters
  • POST   /DocumentImagingProfiles   Create the DocumentImagingProfile with the passed ID using the object passed.

DocumentImagingStorageLocation
(added 9.0.5)

  • GET   /DocumentImagingStorageLocations/{id}   Read a single DocumentImagingStorageLocation
  • PUT   /DocumentImagingStorageLocations/{id}   Update the DocumentImagingStorageLocation with the passed ID using the object passed.
  • DELETE   /DocumentImagingStorageLocations/{id}   Delete the DocumentImagingStorageLocation with the passed ID
  • GET   /DocumentImagingStorageLocations   Search for documentImagingStorageLocations using query parameters
  • POST   /DocumentImagingStorageLocations   Create the DocumentImagingStorageLocation with the passed ID using the object passed.

LabelFormats
(added 9.0.7)

  • GET   /LabelFormat   Read a list of label formats

PostalCode
(added 9.0.5)

  • GET   /PostalCodes/{id}   Read a single PostalCode
  • PUT   /PostalCodes/{id}   Update the PostalCode with the passed ID using the object passed.
  • DELETE   /PostalCodes/{id}   Delete the PostalCode with the passed ID
  • GET   /PostalCodes    Search for PostalCodes using query parameters
  • POST   /PostalCodes    Create the PostalCode with the passed ID using the object passed.

PriceLine
(added 9.0.5)

  • GET    /PriceLines/{id}    Read a single PriceLine
  • PUT    /PriceLines/{id}    Update the PriceLine with the passed ID using the object passed.
  • DELETE    /PriceLines/{id}    Delete the PriceLine with the passed ID.
  • GET    /PriceLines    Search for priceLines using query parameters.
  • POST    /PriceLines    Create the PriceLine with the passed ID using the object passed.

PriceLineBranch
(added 9.0.6)

  • GET    /PriceLineBranch/{id}    Read a single PriceLineBranch
  • PUT    /PriceLineBranch/{id}    Update the PriceLineBranch with the passed ID using the object passed.
  • DELETE    /PriceLineBranch/{id}    Delete the PriceLineBranch with the passed ID.
  • GET    /PriceLineBranch    Search for PriceLineBranch using query parameters.

PriceMatrix
(added 9.0.5)

  • GET    /PriceMatrices/{matrixType}/{id}    Read a single PriceMatrix
  • PUT    /PriceMatrices/{matrixType}/{id}    Update the PriceMatrix with the passed ID using the object passed.
  • DELETE    /PriceMatrices/{matrixType}/{id}    Delete the PriceMatrix with the passed ID
  • POST    /PriceMatrices/{matrixType}    Create the PriceMatrix with the passed ID using the object passed.

PriceMatrixInformation
(added 9.0.6)

  • GET    /PriceMatrixInformation/{matrixType}    Consult Matrix effective dates.

Product
(added 9.0.5)

  • GET   /Products/{id}   Read a single Product
  • PUT   /Products/{id}   Update the Product with the passed ID using the object passed.
  • DELETE   /Products/{id}   Delete the Product with the passed ID
  • GET   /Products   Search for products using query parameters
  • POST   /Products   Create the Product with the passed ID using the object passed.

ProductFamily
(added 9.0.5)

  • GET    /ProductFamilies/{id}   Read a single ProductFamily
  • PUT    /ProductFamilies/{id}   Update the ProductFamily with the passed ID using the object passed.
  • DELETE    /ProductFamilies/{id}   Delete the ProductFamily with the passed ID
  • GET    /ProductFamilies/{id}/ProductFamilyBranches/{branchid}   Read a single ProductFamily and Branch
  • PUT    /ProductFamilies/{id}/ProductFamilyBranches/{branchid}   Update the ProductFamily with the passed branch ID using the object passed.
  • DELETE     /ProductFamilies/{id}/ProductFamilyBranches/{branchid}
  • GET    /ProductFamilies   Search for productFamilies using query parameters
  • POST    /ProductFamilies   Create the ProductFamily with the passed ID using the object passed.
  • POST    /ProductFamilies/{id}/ProductFamilyBranches   Create the ProductFamily with the passed branch ID using the object passed.

ProductInventory
(added 9.0.6)

  • GET   /ProductInventoryList/{id}   Read a single ProductInventory
  • PUT   /ProductInventoryList/{id}   Update the ProductInventory with the passed ID using the object passed.
  • GET   /ProductInventoryList/{id}/{branch}   Read a single ProductInventory
  • GET   /ProductInventoryList   Search for productInventoryList using query parameters
  • POST   /ProductInventoryList   Create the ProductInventory with the passed ID using the object passed.

ProductInventoryInquiry
(added 9.0.5)

  • GET    /ProductInventoryInquiry    Returns total availability and branch level availability of Customer Accessible Branches.

ProductInventoryPricingInquiry
(added 9.0.6)

  • GET    /ProductInventoryPricingInquiry    Returns the inventory availability and pricing for home branch/1st accessible branch.

ProductLocationActivityLog
(added 9.0.5)

  • GET    /ProductLocationActivityLogs/{id}   Read a single ProductLocationActivityLog
  • PUT    /ProductLocationActivityLogs/{id}   Update the ProductLocationActivityLog with the passed ID using the object passed.
  • GET    /ProductLocationActivityLogs   Search for productLocationActivityLogs using query parameters
  • POST    /ProductLocationActivityLogs   Create the ProductLocationActivityLog with the passed ID using the object passed.

ProductPricingInquiry
(added 9.0.6)

  • GET    /ProductPricingInquiry    Returns the product unit price for home branch/1st Accessible Branch.

SalesOrder
(added 9.0.7)

  • GET    /SalesOrders/{id}   Read a single SalesOrder
  • GET    /SalesOrder   Search for Sales Order using query parameters\
  • POST    /SalesOrder   Create the SalesOrder with the passed ID using the object passed.
  • PUT    /SalesOrders/{id}/Status   Update the Sales Order status with the passed ID using the object passed.

Sessions
(added 9.0.5)

  • GET    /Sessions/{id}   Retrieve a session
  • DELETE /Sessions/{id} Delete an existing session (essentially log out)
  • POST    /Sessions   Create a new session.
  • POST    /SessionRefresh   Refresh the session that is expired, but not deleted.
  • POST    /OneTimeUseKeySession   Allows the creation of a session using a One-Time Use key, generated by the system.

ShippingManifest
(added 9.0.5)

  • GET    /ShippingManifests/{id}   Read a single ShippingManifest
  • PUT    /ShippingManifests/{id}   Update the ShippingManifest with the passed ID using the object passed.
  • DELETE    /ShippingManifests/{id}   Delete the ShippingManifest with the passed ID
  • GET    /ShippingManifests   Search for shippingManifests using query parameters\
  • POST    /ShippingManifests   Create the ShippingManifest with the passed ID using the object passed.

ShipVia
(added 9.0.5)

  • GET    /ShipVias/{id}   Read a single ShipVia
  • PUT    /ShipVias/{id}   Update the ShipVia with the passed ID using the object passed.
  • DELETE    /ShipVias/{id}   Delete the ShipVia with the passed ID
  • GET    /ShipVias   Search for shipVias using query parameters
  • POST    /ShipVias   Create the ShipVia with the passed ID using the object passed.

Terms
(added 9.0.5)

  • GET   /TermsList/{id}   Read a single Terms
  • PUT   /TermsList/{id}   Update the Terms with the passed ID using the object passed.
  • DELETE    /TermsList/{id}    Delete the Terms with the passed ID
  • GET    /TermsList    Search for termsList using query parameters
  • POST    /TermsList    Create the Terms with the passed ID using the object passed.

Territory
(added 9.0.5)

  • GET    /Territories/{id}    Read a single Territory
  • PUT    /Territories/{id}    Update the Territory with the passed ID using the object passed.
  • DELETE    /Territories/{id}    Delete the Territory with the passed ID
  • GET    /Territories    Search for territories using query parameters
  • POST    /Territories    Create the Territory with the passed ID using the object passed.

User
(added 9.0.5)

  • GET    /Users/{id}    Read a single User
  • PUT    /Users/{id}    Update the User with the passed ID using the object passed.
  • DELETE    /Users/{id}    Delete the User with the passed ID
  • GET    /Users    Search for users using query parameters
  • POST    /Users    Create the User with the passed ID using the object passed.
  • GET    /Users/Pickers    Search for pickers using query parameters

Vendor
(added 9.0.5)

  • GET    /Vendors/{id}    Read a single Vendor
  • PUT    /Vendors/{id}    Update the Vendor with the passed ID using the object passed.
  • DELETE    /Vendors/{id}    Delete the Vendor with the passed ID
  • GET    /Vendors    Search for vendors using query parameters
  • POST    /Vendors    Create the Vendor with the passed ID using the object passed.

VendorBranchAuth
(added 9.0.7)

  • GET    /VendorBranchAuths/{id}    Read a single VendorBranchAuth
  • PUT     /VendorBranchAuths/{id}   Update the VendorBranchAuth with the passed ID using the object passed.
  • DELETE    /VendorBranchAuths/{id}    Delete the VendorBranchAuth with the passed ID
  • GET    /VendorBranchAuths    Search for VendorBranchAuths using query parameters
  • POST    /VendorBranchAuths   Create the VendorBranchAuth with the passed ID using the object passed.

VendorPartNumber
(added 9.0.5)

  • GET    /VendorPartNumbers/{id}    Read a single VendorPartNumber
  • PUT    /VendorPartNumbers/{id}    Update the VendorPartNumber with the passed ID using the object passed.
  • DELETE    /VendorPartNumbers/{id}    Delete the VendorPartNumber with the passed ID
  • GET    /VendorPartNumbers    Search for vendorPartNumbers using query parameters
  • POST    /VendorPartNumbers    Create the VendorPartNumber with the passed ID using the object passed.

VendorProductInquiry
(added 9.0.6)

  • GET /VendorProductInquiry    Fetch the Product Stock and Pricing information.

WarehouseGeneralTasks
(added 9.0.7)

  • PUT /WarehouseTasks/AdjustmentTask/{id} Performs Quantity Adjustments for Warehouse Tasks
  • PUT /WarehouseTasks/LocationTasks/{id} Performs Location Update for Warehouse Tasks
  • GET /WarehouseScan Warehouse Scan search
  • GET /WarehouseCartonTypes Gets the list of valid Package Types
  • GET /WarehouseLocationCheck Checks if a warehouse location is valid
  • GET /WarehouseTasks/SerialNumbers Returns a list of Serial Numbers

WarehouseLabels
(added 9.0.7)

  • POST /WarehouseTasks/PrintUnverifiedReceiveLabels Prints labels for a set of Receivable items
  • POST /WarehouseTasks/PrintRFLabels Print labels for a given order

WarehouseOpenTote
(added 9.0.6, requires Eclipse Warehouse API license)

  • GET    /WarehouseOpenTotes/{id}    Read a single WarehouseOpenTote
  • GET    /WarehouseOpenTotes    Search for warehouse open totes using query parameters

WarehousePickingTasks
(added 9.0.6, requires Eclipse Warehouse API license)

  • GET /WarehouseTasks/PickTasks Search for Pick Tasks
  • PUT /WarehouseTasks/PickTasks/{id} Assigns a Pick Tasks
  • GET /WarehouseTasks/UserPick Search for Pick Tasks
  • PUT /WarehouseTasks/UserPick/{id} Completes a Pick and assigns a TOTE ID.
  • PUT /WarehouseTasks/CloseTask/{id} Completes the Pick of an Order

WarehousePutAwayTasks
(added 9.0.7)

  • GET /WarehouseTasks/PutAwayTote Search for Unassigned PutAway Totes
  • PUT /WarehouseTasks/PutAwayTote/{id} Assign a PutAway Tote
  • GET /WarehouseTasks/UserPutAway Search for Put Away Tasks assigned to the user
  • PUT /WarehouseTasks/UserPutAway/{id} Completes a Putaway
  • PUT /WarehouseTasks/ImmediatePutAway/{id} Completes an Immediate Putaway

WarehouseReceiveVerifyTasks
(added 9.0.7)

  • GET /WarehouseTasks/ReceiveTasks Search for Receive Tasks
  • GET /WarehouseTasks/ReceiveOpenOrders Search for Open Orders
  • PUT /WarehouseTasks/ReceiveOpenOrders/{id} Receives the specified generation.
  • GET /WarehouseTasks/VerifyingTask Get the data of the item to verify
  • PUT /WarehouseTasks/VerifyingTask/{id} Completes a Receive Verify

WarehouseSystemSetting
(added 9.0.7)

  • GET /WarehouseSystemSettings Retrieves the required Control Record for Warehouse applications

WarehouseTaskCount
(added 9.0.7)

  • GET /WarehouseTaskCount Fetch the counts of Warehouse tasks like Picking/ Staging/Receiving/ Pick select etc

WarehouseToteTasks
(added 9.0.7)

  • GET /WarehouseTasks/ToteTask Search for Stage Tasks
  • PUT /WarehouseTasks/ToteTask/{id} Stages a Tote and updates staging location.
  • GET /WarehouseTasks/TotePackages Gets a list of Tote’s Packages.
  • PUT /WarehouseTasks/TotePackages/{id} Updates Tote’s Packages List
  • GET /WarehouseTasks/CheckTote Search for Warehouse Check
  • GET /WarehouseTasks/CheckStagedTotes Check if an order can be closed after stage the last tote of the order.