/
Requests & Calls

Requests & Calls

Dec 07, 2020

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

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

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

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

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:

  1. out_of_stock - the product is out of stock and thus cannot be delivered

  2. product_discontinued - product is no longer available and thus cannot be delivered

  3. invalid_delivery_address - customer has given a delivery address that appears invalid

  4. customer_cancellation - customer has has asked for the order to be cancelled

  5. legislation_restriction - law or contract restriction prevents delivery to customer's address

  6. other - other reason

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

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

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:

  1. unsatisfied_with_item -  customer was not satisfied with the item

  2. item_did_not_match_description - item didn't match the product description

  3. damaged_item - item was damaged

  4. wrong_item - wrong item was shipped to the customer

  5. other - other reason

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

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.