URL

https:///www.retailorbit.com/api/skudata/upload

Method

POST

Format

Text file with pipe | delimiter (can be zipped)

Restricted Characters

No pipes “|”

File Headers

First row should be a header row with the corresponding names from the field summary. Case insensitive.

FileName

{Retail Orbit Client Code}_{Transaction Date}.{txt|zip}

TransactionDate format YYYYMMDD. 

For a full month upload transaction date = last day in month.

Upload Headers(required)

X-CLIENTCODE - Supplied by Retail Orbit. 

X-CLIENTGUID - Supplied by Retail Orbit.

X-FILETYPE - zip or gz

X-PERIOD - YYYYMM format.

X-PERIODDAY - 1-35 value.

X-OVERWRITE - True = Delete all data for the period

                            False= Update data without deletion.

Success Response

200

Error Response

500

Best Practices

Have separate records for retail data and on order.

You may compress your upload file into a zip or gz file prior to sending the data.

Notes

You must have a valid column header for each column. 

It is strongly recommended that you upload each day in a separate file. This is to eliminate a file being too large to process in a timely manner.

Name

Type

Req.

Description

Client

string

Y

4+ character code from Retail Orbit. 

Period

string

Y

{YYYYMM} 6 digit Year Month. Period of the transaction for retail transactions. Period the goods are expected to be received for On Order data. Period must >= period of retail transactions.

Location

string

Y

Unique location identifier used to map to Retail Orbit

TransactionDate

Date

Y

Date the transaction happened.

ISO date format 8601 YYYY -MM -DD. 

DateStart

Date

N

Starting date of the query.

ISO date format 8601 YYYY -MM -DD

DateThrough

Date

Y

Ending date of the query.

ISO date format 8601 YYYY -MM -DD.

Cannot be greater than period end date or current date.

Class

string

Y

Classification code used for mapping to Retail Orbit classes. If there is no class assigned for a sku, use a default such as {UNCLS}

If there are multiple levels of classifications in the POS, we will need to know how many and what they are and discuss which is best to be used in this class field. 

Department

string

N

Classification description

PosId

string

Y

Unique POS identifier for this Item. System level Identifier that cannot be changed.

Ie 12348A8323938

Sku

string

Y

POS Identifier for this Item that can be understood by the client. Same detail level as PosId. 

Ie 0012-91099-025

UPC

string

N

Primary UPC code for this item. 

01123374748329

StyleId

string

Y

Item identifier before assortment, ignoring size, color

Name

string

Y

Common transaction description for this Item.

Description

string

N

Full description of the Item.  

Vendor

string

Y

Primary vendor code for this Item. Supplier of the item. 

Color

string

Y

Color of the item

ColorGroup

string

N

Color code for aggregating items (e.g. “red” for “scarlet”, “crimson”, “wine”)

Size

string

Y

Actual size of item

SizeGroup

string

N

Shared size code (e.g. “small” for “childs”,”petite”, “kids” 

Sales

decimal

N

Retail sales

SalesCost

decimal

N

Cost of sold items

SalesUnits

decimal

N

Unit Sales. Supports negative numbers.

MarkdownsPointOfSale

decimal

N

Original Price subtract discounted price for item from Sales Transactions. Markdown returned as a positive value. 

MarkdownsInventory

decimal

N

Retail valuation adjustment for this item in inventory due to adjustments to inventory price.  Permanent mark down. Markdown returned as a positive value. 

MarkdownsUnits

decimal

N

Number of units marked down.

Inventory

decimal

N

On hand retail value for this sku.  Units * retail price. 

InventoryCost

decimal

N

On hand cost total for this sku.  Units * cost of sku.  

InventoryUnits

decimal

N

Total units of inventory for sku at end of day for transaction date.

InventoryAdjustment

decimal

N

Retail total of inventory adjustments to this sku when quantities are adjusted, such as an inventory count.  Supports negative numbers.

InventoryAdjustmentCost

decimal

N

Cost total of inventory adjustments to this item when quantities are adjusted, such as an inventory count.  Supports negative numbers.

InventoryAdjustmentUnits

decimal

N

Number of units adjusted.

ReceivingRetail

decimal

N

Retail total of the sku in receiving transactions.

ReceivingCost

decimal

N

Cost total of the sku in receiving transactions.

ReceivingUnits

decimal

N

Number of units of the sku in receiving transactions.

TransfersOut

decimal

N

Retail total of this item for transfers leaving this location.

TransfersOutCost

decimal

N

Cost total of this item for transfers leaving this location.

TransfersOutUnits

decimal

N

Number of units for transfers leaving this location.

TransfersIn

decimal

N

Retail total of this item for transfers arriving at this location.

TransfersInCost

decimal

N

Cost total of this item for transfers arriving at this location.

TransfersInUnits

decimal

N

Number of units for transfers arriving at this location.

InTransitRetail

decimal

N

Retail value of units currently being transferred to a location

InTransitCost

decimal

N

Cost value of units currently being transferred to a location

InTransitUnits

decimal

N

Number of units currently being transferred to a location

ReturnsRetail

decimal

N

Retail total for return to vendor transactions.

ReturnsCost

decimal

N

Cost total for return to vendor transactions.

ReturnsUnits

decimal

N

Number of units returned to vendor.

OnOrderRetail

decimal

N

Retail total for purchase orders for the period.

OnOrderCost

decimal

N

Cost total for purchase orders for the period.

OnOrderUnits

decimal

N

Number of units for purchase orders for the period.