OrderReturnsGet
The method allows you to download order returns from the store.
Input parameters
Incoming as $_POST fields.
POST request:
returned data JSON:
Dane wyjściowe:
| time_from | int | (optional) Date from which the orders are to be picked up. Unix time stamp format. |
| page | int | (optional) Page number when pagination occurs. |
Outgoing data
Array fields that the method should return.
| list of order returns | array | An array where the return ID is the key and the values are arrays with the following fields: |
| shop_order_id | string | Order ID from store database |
| return_status_id | string | Return status ID (status list to be downloaded by OrderReturnStatusesList method) |
| reason_id | string | Return reason ID (reason list to be downloaded by OrderReturnReasonsList method) |
| reference_number | string | Return reference number |
| date_add | int | Return date in UNIX_TIMESTAMP format |
| refund_account_number | string | Account number for refund |
| refund_iban | string | IBAN for refund |
| refund_swift | string | SWIFT for refund |
| phone | string | Customer phone |
| string | Customer email | |
| currency | char(3) | Return currency symbol |
| admin_comments | string | short note from the operator to the return |
| refunded | bool | flag determining whether the return is refunded (0/1) |
| delivery_tracking_number | string | Delivery tracking number |
| delivery_fullname | string | Delivery address - full name |
| delivery_company | string | Delivery address - company |
| delivery_address | string | Delivery address - street and home/local number |
| delivery_postcode | string | Delivery address - postcode |
| delivery_city | string | Delivery address - city |
| delivery_state_code | string | Delivery address - State, region or province code |
| delivery_country | string | Delivery address - Country |
| delivery_country_code | string | Delivery address - ISO country code (2 letters) |
| delivery_method | string | Delivery name |
| delivery_method_id | string | Delivery ID |
| delivery_price | float | Delivery price |
| products | array | a list of ordered products, where each element is an array with the following fields: |
| | - id | string | product ID |
| | - variant_id | string | variant ID (0 when main product) |
| | - name | string | full product or variant name |
| | - quantity | int | number of items purchased |
| | - price | float | gross price of one item |
| | - weight | float | Weight expressed in kilograms |
| | - tax | float | tax amount expressed as a percentage, as a number from 0-100. Without % character. |
| | - ean | string | EAN - 13 digit barcode |
| | - sku | string | Stock Keeping Unit |
| | - location | string | Location in the warehouse |
| | - attributes | array | an optional array with selectable product attributes describing the purchased variant, in which each element contains the following fields: |
| |- name | string | attribute name (e.g. 'color') |
| |- value | string | attribute value (e.g. 'red') |
| |- price | float | price difference to the basic price |
| extra_field_1 | string | additional field (any data) |
| extra_field_2 | string | additional field (any data) |
| pages | int | (optional) number of pages. We recommend 1000 results on 1 page. The limit is 1000 pages. |
Example:
Input data:Array
(
[time_from] => 1529505396
)
(
[time_from] => 1529505396
)
POST request:
time_from=1529505396
returned data JSON:
Dane wyjściowe:
Documentation of the shops data exchange protocol - baselinker.com