These requests where implemented into RESTfulFish to match the syntax of Fishbowl's legacy API which can be found on Fishbowl's Wiki. Refer to this page for further details.
All objects are to be passed through the body in raw format and must be within
depending on the query path used (i.e. http(s)://restfulfish:1234/(xml/json)/).
Refer to this page for further information regarding Fishbowl objects.
Fishbowl Inventory Wiki
Any occurrences of the letters DB refer to a value used as a variable within the database. For instance <OrderTypeID>DB int</OrderTypeID> expects one of following numbers: 1, 10, 20, 30 or 40. Each number specifies an order type. 1 being none, 10 a purchase order and so on. The values and their significance can be found by accessing your database tables. Other indicators within the syntax include int, string, boolean, double, and date/time. These are all typical coding data types aside from date/time. Below is the format and an example for inputting date/time.
This generates a shipping order that is completely fictitious. You would use this request to calculate the cost etc. If you want to actually process this order you need to use the Save.
SalesOrder
This object is required and contains multiple sub-objects. All sub-objects (CustomFields, Memos, & SalesOrderItem) may contain multiple instances of the sub-object. Refer to Sales Order object API for further details.
This returns a Customer object from your database with all the data associated with that customer. Note: When currency rate is 0 then customer is using the default currency rate.
Returns results of SQL query in csv format. Two options are available. A query that has been saved in the Fishbowl Client data module can be executed using or a query can be placed directly in the call using.
Request a list of Shipments. This includes all those that have been shipped. Be sure to include more specifics on what you want to see. Note You cannot use Order Number in conjunction with Order Type and Carrier. Order Number returns the history of the use of that number, see Example 2. Also, to merit a response you must include the RecordCount field.
This request allows you to import data. Data columns can be blank, but each data column must be represented in the request. It is best practice to always include the header rows when importing data. Refer to the following page for instructions to import and export data from each module: https://www.fishbowlinventory.com/wiki/Imports_and_Exports#List_of_imports_and_exports
This request will return all the picks that you specify. You can refine your results by its place in the index (StartIndex in conjunction with RecordCount), pick number, order number, pick type, status, priority, the first date to include, last date to include, whether or not it's fulfillable, or by its location group. The starting index defines at what point the records you want returned will start, default is 0. Record count is how may records you want returned.
Requests detailed information about the product. This includes the product's underlying part, the product's base UOM and its tracking information. GetImage is a flag indicating if the image should be included.
Will do an automatic pick, pack, and ship on a Sales Order that has already been issued (Work Orders tied to the SO must be fulfilled also). Fishbowl automatically picks the best tracking available. FulfillServiceItems indicates if the service items on the SO should be fulfilled during ship.
Returns information about orders in the receiving module. You can narrow your search by filling in as many of the controls as you wish. It will return all orders that contain the specified details. Note To get a response the order number specified must be a receiving order!
Enables you to change the default location of a part. Use the database to find all the details for the Location object that you want to use as the default location.
{
"FishbowlLegacyObjects": {
"Rows": {
"Row": [
"Name,AddressName,AddressContact,AddressType,IsDefault,Address,City,State,Zip,Country,Main,Home,Work,Mobile,Fax,Email,Pager,Web,Other,CurrencyName,CurrencyRate,DefaultTerms,DefaultCarrier,DefaultShippingTerms,Status,AccountNumber,Active,MinOrderAmount,AlertNotes,URL,DefaultCarrier,CF-",
"\"Monroe Bike Company\",\"Williams Bike Company - 210\",\"Williams Bike Company\",\"50\",\"true\",\"Wall st.\",\"New York\",\"NY\",\"21004\",\"UNITED STATES\",\"212-321-5643\",,,,,,,,,,,,,,,,,,,,,,"
]
}
}
}
<FishbowlLegacyObjects>
<Rows>
<Row>Name,AddressName,AddressContact,AddressType,IsDefault,Address,City,State,Zip,Country,Main,Home,Work,Mobile,Fax,Email,Pager,Web,Other,CurrencyName,CurrencyRate,DefaultTerms,DefaultCarrier,DefaultShippingTerms,Status,AccountNumber,Active,MinOrderAmount,AlertNotes,URL,DefaultCarrier,CF-</Row>
<Row>"Monroe Bike Company","Williams Bike Company - 210","Williams Bike Company","50","true","Wall st.","New York","NY","21004","UNITED STATES","212-321-5643",,,,,,,,,,,,,,,,,,,,,,</Row>
</Rows>
</FishbowlLegacyObjects>
