This REST based API makes possible the upload of item based information into our servers.
\nThe upload file must either be in a zip , gz or txt format. The delimiter used in the file is the pipe delimiter.\nThe upload format specification document can be downloaded here.
\nYou will require a client code and password to authenticate. This can be requested by emailing support@management-one.com
\n200 - Successful upload.
\n500 - Error with upload. Check response for detailed error messages.
\nNo.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"},{"content":"Authentication","slug":"authentication"},{"content":"Error Codes","slug":"error-codes"},{"content":"Rate limit","slug":"rate-limit"}],"owner":"1049045","collectionId":"fd3993f0-e1b4-4131-ddc2-b3ebc88466b4","publishedId":"6fbSMs9","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-06-23T23:13:22.000Z"},"item":[{"name":"Upload a class based file","id":"12002c08-99ce-4478-ae4d-20fcc619c00f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"f","description":"This is the file you are uploading for processing.
\n","type":"file","value":null},{"key":"u","value":"{{clientCode}}","description":"This is the Orbit client code which will be provided for you.
\n","type":"text"},{"key":"p","value":"{{clientGuid}}","description":"This is the Orbit auth key , which will be provided for you.
\n","type":"text"}]},"url":"https://www.retailorbit.com/api/shuttle/upload","description":"This endpoint is used to upload a non-sku based file. \nSupported extensions are .txt, .csv, .xls, .xlsx\nThis file is space delimited.
\nYou are required to send an Orbit client code and auth key\nwhich will be provided for you.
\nThe beta domain (https://beta.retailorbit.com) is used for testing purposes only.
\n#Result Codes\n200 - Successful send of data.
\n500 - Failure. Contact support@retailorbit.com for assistance once you have exhausted your internal troubleshooting processes.
\n#Response
\nUpon a successful upload , you will be sent a Guid indicating the jobId. This is an internal reference for support , so you may log it on your end , if you would like us to reference it in a support call or audit process.
\nFile Format
\nHere are the columns listed in the order that they must appear in the export file.
\nClient Code - Required. This is the client code that will be supplied to you. It is a constant in the file. An example is \"ORBIT123\"
\nClass Code - Required. This is the Management One class code for your data. This is organized by Management One. An example is \"TOYS\"
\nLocation Code - Required. This is the location identifier for this data. This is an agreed upon code in your client profile. An example is \"MAIN\"
\nYearMonth - Required. This is a 4 digit value of the year and month of the data. For example, if the row represented the data for March 2021, the YearMonth value would be 2103.
\nMarkdown Amount. Required. This is the retail amount of permanent and POS markdowns. The value is a decimal and should show a positive amount for the markdown. For example, if you sold an item that had a five dollar markdown, the amount you would pass in would be 5 NOT negative 5.
\n6)Inventory Adjustments - Required. The retail amount of inventory adjustments for this location/class. For example, if you had 5 widgets in stock, and reduced the amount of the widgets unit price from 10.00 to 8.00, you would pass in 10.00, which is (5 units x (10.00 -8.00)) = 10.
\nInventory OnHand - Required. The retail amount of goods on hand for this class/location.
\nOn Order Cost - Required. The amount still due at cost.
\nOn Order Retail - Required. The amount still due at retail.
\nReceived Cost - Required. The amount received at cost for the period that you are reporting.
\nReceived Retail - Required. The amount received at retail for the period that you are reporting.
\nSales - Required. The amount sold at retail for the period you are reporting.
\nTransfer Out- Required. The retail amount transferred out from this class/location.
\nTransfer In- Required. The retail amount transferred in from this class/location.
\nVendor Return Retail - Required. The retail amount of goods returned to the vendor for this class/location.
\nVendor Return Cost - Required. The cost amount of goods returns to the vendor for this class/location.
\nUser - Required. A string that represents the POS system name.
\nDate - Required. Date of the upload. MM/DD/YYYY format.
\nTerminal - Required. Legacy field that is the POS system name. Same as field 17
\nSecondaryUser - Required. Same value as field 17.
\nDateOfExtract- Required. Same value as field 18.
\nDateEffective - Required. Same as Field 21.
\nDepartment- Required. Static value of 100.
\nRecord Type - Required. This is a value of 1 if the line contains data that is not on order, and a value of 2 if the line contains data that is on order.
\nExample:\nClientCode = TEST123\nLocationCode = 1\nPeriod= March 2021\nIf you had a single store, with three classes: TOYS, PANTS, ACC , the file could look like this. (Line numbers and comments are for documentation and not part of the export.
\nLine1\nTEST123 TOY 1 2103 10 0 550 0 0 10 20 600 0 0 5 10 POS 03/31/2021 POS POS 03/31/2021 03/31/2021 100 1
\nLine2\nTEST123 PANTS 1 2103 18 0 400 0 0 5 10 700 0 0 8 15 POS 03/31/2021 POS POS 03/31/2021 03/31/2021 100 1
\nLine3\nTEST123 PANTS 1 2105 0 0 0 100 200 0 0 0 0 0 0 0 POS 03/31/2021 POS POS 03/31/2021 03/31/2021 100 2
\nLine 1 represents the following data:
\nLine 2 represents the same data format, but shows a different class and amounts.\nLine 3 represents an ON ORDER line ( see last value of 2).
\n