...
The access key will be provided by OmniRPS on request.
The retailer name is also required
Please ensure that the key is not hardcoded into the system.
Parameters of API
Parameter | Mandatory | Type | Description |
|---|---|---|---|
OrderNumber | Y | Varchar | Order number |
SKU | Y | Varchar | Item Sku code |
Quantity | Y | Integer | Quantity |
StyleNumber | Y | Varchar | Item Style number/ code |
Category | Optional | Varchar | Item category |
SubCategory | Optional | Varchar | Item sub category |
EAN | Y | Varchar | Item number |
ProductName | Y | Varchar | Product name |
ItemValue | Y | Varchar | Product price |
Currency | Y | Varchar | Currency code |
ItemWeight |
Y | Varchar |
If order weight is empty then item weight required. Weight should be in Kg.
OrderWeight
-
Varchar
We need a positive value for either Itemweight or OrderWeight. Weight must be in KGs If you do not have ItemWeight, please use 0 | |||
OrderWeight | Y | Varchar | We need a positive value for either Itemweight or OrderWeight. Weight must be in KGs If you do not have OrderWeight, please use 0 |
CommodityCode | Y - if international return | Varchar | HS code used customs clearance |
ProductCountryOfOrigin | Y | Varchar | manufacturer country |
CommodityName | Optional | Varchar | |
CommodityShortName | Optional | Varchar | |
CustomerName | Y | Varchar | Customer’s first and last name |
CustomerEmail | Y | Varchar | Email address |
Building | Y | Varchar | Customer Building name |
Street | Y | Varchar | Customer Street address |
Suburb | Y | Varchar | Customer suburb / City. No short code. For Example add NEW YORK and not NY. |
Town | Optional | Varchar | Town address |
State | Y | Varchar | Customer state. No short code. For Example add NEW YORK and not NY. |
DeliveryPostcode | Y | Varchar | Order delivery date. Five digits for USA. For other country it is flexible. |
DeliveryCountry | Y | Varchar | Customer country. |
DateDespatched | Y | Datetime | This is the date when the return timeframe (window customers have to create the return) begins. You can either send date dispatched or Order date depending on your returns policy or what you have available |
Returnable | Optional | Varchar | Flag “Y” / “N” which provide information about the item is returnable or not and to stop the user to send unreturnable items. Default value is “Y” if not provided. |
SKUImage | Optional | Text | https:// Live URL of the product image. For example https://cdn.xl.thumbs.canstockphoto.com/sample- rubber-stamp-with-word-sample-inside-vector- illustration-image_csp27057271.jpg |
SupplierName | Optional | Varchar | Product Supplier name |
API Request
One request needs to be sent per SKU/line item
...