...
The access key will be provided by OmniRPS on request.
Please ensure that the key is not hardcoded into the system.
| Info |
|---|
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 | - | 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. |
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 |
...
One request needs to be sent per SKU/line item
| Info |
|---|
Requires Authentication A valid access token must be provided in token request header. Token will be provided by RPS on request to use the API. |
Example Request
Test: https://test.omnirps.com/app/ftp_return/add_ftp_order_details
Headers
| Code Block |
|---|
Token: [access_key_for_site_account] Content-Type:application/json charset:utf-8 |
...
| Code Block |
|---|
[
{
"OrderNumber": "1212234",
"CustomerEmail": "customer1@gmail.com",
"CustomerName": "customer1Joe Blogs",
"DeliveryCountry": "New Zealand",
"Building": "StoreCool Company",
"Street": "63 TEST STREET",
"Suburb": "PORIRUA",
"State": "WELLINGTON",
"DeliveryPostcode": "6011",
"SKU": "S000450-mocha-10(M)",
"EAN": "123EAN",
"ProductName": "Make A Move Tights in Mocha",
"Quantity": "1",
"StyleNumber": "S000450-mocha-10(M)",
"Category": "Clothes",
"SubCategory": "Pants & Leggings",
"ItemWeight": "0.5",
"ItemValue": "45",
"OrderWeight": "0.5",
"Currency": "AUD",
"CommodityCode": "AAAA123123",
"ProductCountryOfOrigin": "USChina",
"CommodityName": "APPAREL",
"CommodityShortName": "NOT APPLICABLE",
"Town": "6 Purser",
"DeliveryPostcode": "6011",
"DateDespatched": "2018-06-02 16:04:32",
"Returnable": "Y",
"SKUImage": "https://cdn.xl.thumbs.canstockphoto.com/sample-rubber-stamp-with-word-sample-inside-vector-illustration-image_csp27057271.jpg",
"SupplierName": "XYZ"
},
{
"OrderNumber": "1312234",
"CustomerEmail": "customer2@gmail.com",
"CustomerName": "customer2Joe Blogs",
"DeliveryCountry": "New Zealand",
"Building": "Store",
"Street": "63 TEST STREET",
"Suburb": "PORIRUA",
"State": "WELLINGTON",
"DeliveryPostcode": "6011",
"SKU": "S000450-mocha-1012(ML)",
"EAN": "123EAN",
"ProductName": "Make A Move Tights in Mocha",
"Quantity": "1",
"StyleNumber": "S000450-mocha-10(M)",
"Category": "Clothes",
"SubCategory": "Pants & Leggings",
"ItemWeight": "0.5",
"ItemValue": "45",
"OrderWeight": "0.5",
"Currency": "AUD",
"CommodityCode": "AA",
"ProductCountryOfOrigin": "USChina",
"CommodityName": "APPAREL",
"CommodityShortName": "NOT APPLICABLE",
"DateDespatched": "2018-06-02 16:04:32",
"Returnable": "N",
"SKUImage": "https://cdn.xl.thumbs.canstockphoto.com/sample-rubber-stamp-with-word-sample-inside-vector-illustration-image_csp27057271.jpg",
"SupplierName": "ABC"
}
] |
...
| Code Block |
|---|
{
"SUCCESS": "TRUE",
"MESSAGE": "Updated Successfully.",
"RESPONSE":
{
"OrderNumber - 12": "Inserted successfully",
"OrderNumber - 13": "Inserted successfully"
}
} |
...