Fruugo Order API example

Note: This page is set up to access real production API and will display and manipulate real, live orders.

Download orders

URLhttps://www.fruugo.com/orders/download
MethodGET
ReturnsOrder XML for the orders released between given time boundaries, MIME type "application/xml"
from Start date for the order listing.
to End date for the order listing (optional)

Confirm order

URLhttps://www.fruugo.com/orders/confirm
MethodPOST
ReturnsOrder XML for the confirmed order, MIME type "application/xml"
orderId The id of the order to confirm, taken from orderID -element in the XML
item




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 Estimate of the date when the order is likely to ship (optional)
messageToCustomer A message relayed to the customer (optional)
messageToFruugo A message relayed to Fruugo (optional)

Cancel order

URLhttps://www.fruugo.com/orders/cancel
MethodPOST
ReturnsOrder XML for the cancelled order, MIME type "application/xml"
orderId The id of the order whose items to cancel, taken from orderID -element in the XML
item




fruugoProductId, fruugoSkuId and quantity of the item to cancel, separated with commas. The parameter can be repeated multiple times in one request to cancel multiple items at a time. If parameter is not given, all items on the order will be cancelled.
cancellationReason Reason for the cancellation. Valid values are
  • out_of_stock, the product is out of stock and thus cannot be delivered
  • product_discontinued, product is no longer available and thus cannot be delivered
  • invalid_delivery_address, customer has given a delivery address that appears invalid
  • customer_cancellation, customer has has asked for the order to be cancelled"
  • legislation_restriction, law or contract restriction prevents delivery to customer's address
  • other, other reason
messageToCustomer A message relayed to the customer (optional)
messageToFruugo A message relayed to Fruugo (optional)

Ship order

URLhttps://www.fruugo.com/orders/ship
MethodPOST
ReturnsOrder XML for the shipped order, MIME type "application/xml"
orderId The id of the order whose items to ship, taken from orderID -element in the XML
item




fruugoProductId, fruugoSkuId and quantity of the item to ship, separated with commas. The parameter can be repeated multiple times in one request to ship multiple items at a time. If parameter is not given, all items on the order will be shipped.
trackingCode Tracking code of the package, sent to the customer in the shipment notification email
messageToCustomer A message relayed to the customer (optional)
messageToFruugo A message relayed to Fruugo (optional)

Return order

URLhttps://www.fruugo.com/orders/return
MethodPOST
ReturnsOrder XML for the returned order, MIME type "application/xml"
orderId The id of the order whose items are to be marked returned, taken from orderID -element in the XML
item




fruugoProductId, fruugoSkuId and quantity of the item to mark returned, separated with commas. The parameter can be repeated multiple times in one request to ship multiple items at a time. If parameter is not given, all items on the order will be returned.
returnReason Reason for the cancellation (optional). Valid values are
  • unsatisfied_with_item, customer was not satisfied with the item
  • item_did_not_match_description, item didn't match the product description
  • damaged_item, item was damaged
  • wrong_item, wrong item was shipped to the customer
  • other, other reason
messageToCustomer A message relayed to the customer (optional)
messageToFruugo A message relayed to Fruugo (optional)

Download packing list PDF

URLhttps://www.fruugo.com/orders/packinglist
MethodPOST
ReturnsPacking list PDF, MIME type "application/xml"
orderId The id of the order whose packing list to download, taken from orderID -element in the XML
shipmentId The id of the shipment whose packing list to download, taken from shipmentId -element in the XML