Documentation of the shops data exchange protocol - baselinker.com
Function list
Tests
ChangeLog
Remap Builder


OrderReturnsGet
The method allows you to download order returns from the store.


Input parameters
Incoming as $_POST fields.
time_fromint(optional) Date from which the orders are to be picked up. Unix time stamp format.
pageint(optional) Page number when pagination occurs.



Outgoing data
Array fields that the method should return.
list of order returnsarrayAn array where the return ID is the key and the values are arrays with the following fields:
shop_order_idstringOrder ID from store database
return_status_idstringReturn status ID (status list to be downloaded by OrderReturnStatusesList method)
reason_idstringReturn reason ID (reason list to be downloaded by OrderReturnReasonsList method)
reference_numberstringReturn reference number
date_addintReturn date in UNIX_TIMESTAMP format
refund_account_numberstringAccount number for refund
refund_ibanstringIBAN for refund
refund_swiftstringSWIFT for refund
phonestringCustomer phone
emailstringCustomer email
currencychar(3)Return currency symbol
admin_commentsstringshort note from the operator to the return
refundedboolflag determining whether the return is refunded (0/1)
delivery_tracking_numberstringDelivery tracking number
delivery_fullnamestringDelivery address - full name
delivery_companystringDelivery address - company
delivery_addressstringDelivery address - street and home/local number
delivery_postcodestringDelivery address - postcode
delivery_citystringDelivery address - city
delivery_state_codestringDelivery address - State, region or province code
delivery_countrystringDelivery address - Country
delivery_country_codestringDelivery address - ISO country code (2 letters)
delivery_methodstringDelivery name
delivery_method_idstringDelivery ID
delivery_pricefloatDelivery price
productsarraya list of ordered products, where each element is an array with the following fields:
| - idstringproduct ID
| - variant_idstringvariant ID (0 when main product)
| - namestringfull product or variant name
| - quantityintnumber of items purchased
| - pricefloatgross price of one item
| - weightfloatWeight expressed in kilograms
| - taxfloattax amount expressed as a percentage, as a number from 0-100. Without % character.
| - eanstringEAN - 13 digit barcode
| - skustring Stock Keeping Unit
| - locationstringLocation in the warehouse
| - attributesarrayan optional array with selectable product attributes describing the purchased variant, in which each element contains the following fields:
      |- namestringattribute name (e.g. 'color')
      |- valuestringattribute value (e.g. 'red')
      |- pricefloatprice difference to the basic price
extra_field_1stringadditional field (any data)
extra_field_2stringadditional field (any data)
pagesint(optional) number of pages. We recommend 1000 results on 1 page. The limit is 1000 pages.



Example:
Input data:
Array
(
    [time_from] => 1529505396
)

POST request:
time_from=1529505396


returned data JSON:

Dane wyjściowe: