Requests & Calls
The API works over HTTPS and follows REST semantics. Authentication is handled with HTTP Basic - method. The credentials used are those which are set-up for the account to access the Fruugo Retailer Portal.
Download Orders
| URL | https://www.fruugo.com/orders/download |
|---|---|
| HTTP Method | GET |
| Returns | Order XML for the orders released between given time boundaries, MIME type "application/XML" |
Parameters
| Name | Format | Mandatory | Description |
|---|---|---|---|
| from | ISO 8601 date or datetime | Yes | Start date for the order listing |
| to | ISO 8601 date or datetime | No | End date for the order listing |
Download Orders - v2 - includes customer currency information and Fruugo tax IDs for customers declarations
| URL | https://www.fruugo.com/orders/download/v2 |
|---|---|
| HTTP Method | GET |
| Returns | Order XML for the orders released between given time boundaries, MIME type "application/XML" |
Parameters
| Name | Format | Mandatory | Description |
|---|---|---|---|
| from | ISO 8601 date or datetime | Yes | Start date for the order listing |
| to | ISO 8601 date or datetime | No | End date for the order listing |
Confirm Order
| URL | https://www.fruugo.com/orders/confirm |
|---|---|
| HTTP Method | POST |
| Returns | Order XML for the confirmed order, MIME type "application/xml" |
Parameters
| Name | Format | Mandatory | Description |
|---|---|---|---|
| orderId | Integer | Yes | The id of the order to confirm, taken from orderId - element in the XML. |
| item | Item Identifiers | No | fruugoProductId, fruugoSkuId and quantity of the item to confirm, separated with commas. The parameter can be repeated multiple times in one request to confirm multiple items at a time. If parameter is not given, all items on the order will be confirmed. |
| estimatedShippingDate | ISO 8601 date | No | Estimate of the date when the order is likely to ship. |
| messageToCustomer | Text | No | A message relayed to the customer. |
| messageToFruugo | Text | No | A message relayed to Fruugo. |
Cancel Order
| URL | https://www.fruugo.com/orders/cancel |
|---|---|
| HTTP Method | POST |
| Returns | Order XML for the cancelled order, MIME type "application/xml" |
Parameters
| Name | Format | Mandatory | Description |
|---|---|---|---|
| orderId | Integer | Yes | The id of the order to confirm, taken from orderId - element in the XML. |
| item | Item Identifiers | No | fruugoProductId, fruugoSkuId and quantity of the item to cancel, separated with commas. The parameter can be repeated multiple times in one request to confirm multiple items at a time. If parameter is not given, all items on the order will be cancelled. |
| cancellationReason | Text | Yes | Reason for the cancellation. Valid values are:
|
| messageToCustomer | Text | No | A message relayed to the customer. |
| messageToFruugo | Text | No | A message relayed to Fruugo. |
Ship Order
| URL | https://www.fruugo.com/orders/ship |
|---|---|
| HTTP Method | POST |
| Returns | Order XML for the shipped order, MIME type "application/xml" |
Parameters
| Name | Format | Mandatory | Description |
|---|---|---|---|
| orderId | Integer | Yes | The id of the order to confirm, taken from orderId - element in the XML. |
| item | Item Identifiers | No | fruugoProductId, fruugoSkuId and quantity of the item to ship, separated with commas. The parameter can be repeated multiple times in one request to confirm multiple items at a time. If parameter is not given, all items on the order will be shipped. |
| trackingUrl | Text | No | A URL of the courier company where the package can be tracked or at a minimum the courier name. |
| trackingCode | Text | No | Tracking code of the package, relayed to the customer. |
| messageToCustomer | Text | No | A message relayed to the customer. |
| messageToFruugo | Text | No | A message relayed to Fruugo. |
Return Order
| URL | https://www.fruugo.com/orders/return |
|---|---|
| HTTP Method | POST |
| Returns | Order XML for the returned order, MIME type "application/xml" |
Parameters
| Name | Format | Mandatory | Description |
|---|---|---|---|
| orderId | Integer | Yes | The id of the order to confirm, taken from orderId - element in the XML |
| item | Item Identifiers | No | fruugoProductId, fruugoSkuId and quantity of the item to mark returned, separated with commas. The parameter can be repeated multiple times in one request to confirm multiple items at a time. If parameter is not given, all items on the order will be returned. |
| returnReason | Text | No | Reason for the cancellation. Valid values are:
|
| messageToCustomer | Text | No | A message relayed to the customer. |
| messageToFruugo | Text | No | A message relayed to Fruugo. |
Download Packing List
| URL | https://www.fruugo.com/orders/packinglist |
|---|---|
| HTTP Method | GET |
| Returns | Packing list PDF, MIME type "application/pdf" |
Parameters
| Name | Format | Mandatory | Description |
|---|---|---|---|
| orderId | Integer | Yes | The id of the order to mark returned, taken from orderID - element in the XML. |
| shipmentId | Integer | Yes | The id of the shipment whose packing list to download, taken from shipmentId - element in the XML. Use 0 as the shipmentId if the consignment has yet to be shipped. |
, multiple selections available, Use left or right arrow keys to navigate selected items
