...
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 | - | Varchar | If order weight is empty then item weight required. Weight should be in Kg. | ||||
OrderWeight | - | Varchar | If item weight empty then order weight required. Weight should be in Kg. | ||||
CommodityCodeOptional | Y - if international return | Varchar | Commodity code | ||||
ProductCountryOfOrigin | Y | Varchar | Town | Optional | Varchar | ||
Town address | CommodityName | Optional | Varchar | ||||
CommodityShortName | Optional | Varchar | |||||
CommodityShortName | Optional | Varchar | |||||
CustomerName | Y | Varchar | Customer 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. | Town | Optional | Varchar | Town address |
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
...
Example Request
Test: https://www.test.omnirps.com/app/ftp_return/add_ftp_order_details
...