HomeGuidesAPI ReferenceChangelogDiscussions
HomeLog In
Guides

Get Return Order By id

GET <<api_domain>>/v1/return_orders/:id

Request Example

curl --location --request GET 'https://<<api_domain>>/v1/return_orders/61723f3f8f7b520049d9b064' \
--header 'Authorization: Bearer 19399a2efff20ab275bf354f09cdf11a8afe0eed5a647f2a01f0506dc68d38d0' \
--header 'Cookie: _stg_shopline_admin_session_id_v2=c712d5c748438b4df48f966a7588c6c2'

Request Params

id Required string Return Order ID e.g. 62299f6d30f5390014329c0a

Response Example

{
    "id": "60ca0cb9876b2300384b7eb4",
    "return_order_number": "2021061614374566",
    "created_at": "2021-06-16T14:37:46.406+00:00",
    "updated_at": "2021-06-16T14:52:45.115+00:00",
    "status": "confirmed",
    "total": {
        "cents": 426,
        "currency_symbol": "NT$",
        "currency_iso": "TWD",
        "label": "NT$426",
        "dollars": 426
    },
    "order_id": "60ca0b31c9c724001dc7193c",
    "delivery_address": {
        "country_code": "TW",
        "country": "台灣",
        "city": "台北市",
        "state": null,
        "district": null,
        "postcode": 100,
        "address_1": "123",
        "address_2": "100 中正區",
        "key": null,
        "layer1": null,
        "layer2": null,
        "layer3": null,
        "logistic_codes": null,
        "recipient_name": "Tony Fang",
        "recipient_phone": "0905370555",
        "recipient_phone_country_code": null,
        "remarks": null
    },
    "inspect_status": "inspected",
    "customer_id": "5f9fe24505b1390013f5dc0e",
    "customer_name": "Tony Fang",
    "customer_email": "[email protected]",
    "order_delivery": {
        "id": "60ca0cb9876b2300384b7eb5",
        "platform": "custom_return",
        "status": "return_collected",
        "delivery_status": "returning"
    },
    "delivery_data": {
        "hk_sfplus_home_region": null,
        "location_code": null,
        "location_name": null,
        "name_translations": {},
        "store_address": null,
        "url": null,
        "tracking_number": null,
        "scheduled_delivery_date": null,
        "time_slot_key": null
    },
    "order_payment": {
        "id": "60ca0cb9876b2300384b7eb6",
        "payment_method_id": "5e9d5e3c7011c4003c497ffb",
        "payment_type": "custom",
        "status": "pending",
        "updated_at": "2021-06-16T14:37:46.473+00:00",
        "created_at": "2021-06-16T14:37:46.473+00:00",
        "refund_amount": {
            "cents": 0,
            "currency_symbol": "NT$",
            "currency_iso": "TWD",
            "label": "NT$0",
            "dollars": 0
        },
        "update_refund_amount_at": null,
        "payment_data": {
            "bank_account": ""
        }
    },
    "order_payment_status": "pending",
    "order_delivery_status": "return_collected",
    "items": [
        {
            "id": "60ca0cba876b2300384b7eb8",
            "item_type": "Product",
            "item_data": {
                "cart_item_id": "60ca0af050bb5f0011bc0a5f",
                "promotion_id": null,
                "parent_item_ids": [],
                "triggering_item_id": "",
                "order_promotion_items": {
                    "order_discounted_price": "60ca0b31c9c724001dc71939"
                },
                "order_discounted_price": {
                    "cents": 18,
                    "currency_iso": "TWD"
                },
                "has_exclude_promotion_tag": false
            },
            "object_data": {
                "_id": "60a26d7496727b001d820273",
                "tags_array": [],
                "quantity": 30,
                "weight": 0,
                "barcode_type": "Code 128",
                "title_translations": {
                    "zh-hant": "測試無成本1",
                    "en": "測試無成本1"
                },
                "type": "product",
                "status": "active",
                "subscription_period_type": "day",
                "subscription_period_duration": 30,
                "seo_title_translations": {
                    "zh-hant": "測試無成本",
                    "en": "測試無成本"
                },
                "seo_description_translations": {
                    "en": "",
                    "zh-hant": "",
                    "zh-cn": ""
                },
                "amount_sold": 726,
                "quantity_sold": 22,
                "page_views": 0,
                "added_to_cart": 0,
                "field_titles": [],
                "preorder_note_translations": {},
                "created_by": "admin",
                "retail_status": "active",
                "out_of_stock_orderable": false,
                "hide_price": false,
                "subscription_enabled": false,
                "taxable": false,
                "same_price": false,
                "is_preorder": false,
                "is_excluded_promotion": false,
                "owner_id": "5e9807e1f58d5300425e48ff",
                "price": {
                    "cents": 55,
                    "currency_symbol": "NT$",
                    "currency_iso": "TWD",
                    "label": "NT$55",
                    "dollars": 55
                },
                "unlimited_quantity": false,
                "description_translations": {
                    "en": "",
                    "zh-hant": "",
                    "zh-cn": ""
                },
                "summary_translations": {
                    "en": "",
                    "zh-hant": "",
                    "zh-cn": ""
                },
                "show_custom_related_products": false,
                "blacklisted_feed_channels": [],
                "max_order_quantity": -1,
                "gender": "unisex",
                "age_group": "all_ages",
                "adult": "no",
                "condition": "new",
                "available_start_time": null,
                "available_end_time": null,
                "updated_at": "2021-05-30T08:58:31.432Z",
                "created_at": "2021-05-17T13:19:48.629Z",
                "gtin": "94803988",
                "root_product_id": "60a26d7496727b001d820275",
                "stock_ids": [
                    "60a26d7496727b001d820276",
                    "60a26d7496727b001d820277",
                    "60a26d7496727b001d820278",
                    "60a26d7496727b001d820279"
                ],
                "wapos_id": "944f56fa-5d67-4702-b296-222cd332f839",
                "related_product_ids": [
                    "60576da8a5a4fe001ab2ce3a",
                    "600ed6548aab960023361607",
                    "600ed5c507ec3119ed6b43cb",
                    "5f3cfbb607ec3174289b6300"
                ],
                "cost": {
                    "cents": 11,
                    "currency_iso": "TWD"
                },
                "price_sale": {
                    "cents": 44,
                    "currency_symbol": "NT$",
                    "currency_iso": "TWD",
                    "label": "NT$44",
                    "dollars": 44
                },
                "promotion_ids": [
                    "60b328959fdc3f7bb11ebda5"
                ],
                "promotion_condition_ids": [
                    "60b328959fdc3f7bb11ebda6"
                ],
                "media": [
                    {
                        "images": {
                            "favicon_small": {
                                "width": 200,
                                "height": 200,
                                "url": "https://img.shoplineapp.com/media/image_clips/5e981b45eda5a50016bf3d29/thumb.jpeg?1587026756"
                            },
                            "favicon": {
                                "width": 200,
                                "height": 200,
                                "url": "https://img.shoplineapp.com/media/image_clips/5e981b45eda5a50016bf3d29/thumb.jpeg?1587026756"
                            },
                            "favicon_large": {
                                "width": 200,
                                "height": 200,
                                "url": "https://img.shoplineapp.com/media/image_clips/5e981b45eda5a50016bf3d29/thumb.jpeg?1587026756"
                            },
                            "transparent_thumb": {
                                "width": 200,
                                "height": 200,
                                "url": "https://img.shoplineapp.com/media/image_clips/5e981b45eda5a50016bf3d29/thumb.jpeg?1587026756"
                            },
                            "transparent_large": {
                                "width": 400,
                                "height": 400,
                                "url": "https://img.shoplineapp.com/media/image_clips/5e981b45eda5a50016bf3d29/large.jpeg?1587026756"
                            },
                            "transparent_xlarge": {
                                "width": 400,
                                "height": 400,
                                "url": "https://img.shoplineapp.com/media/image_clips/5e981b45eda5a50016bf3d29/xlarge.jpeg?1587026756"
                            },
                            "original": {
                                "width": 400,
                                "height": 400,
                                "url": "https://img.shoplineapp.com/media/image_clips/5e981b45eda5a50016bf3d29/original.jpeg?1587026756"
                            },
                            "source": {
                                "width": 400,
                                "height": 400,
                                "url": "https://img.shoplineapp.com/media/image_clips/5e981b45eda5a50016bf3d29/source.jpeg?1587026756"
                            },
                            "thumb": {
                                "width": 200,
                                "height": 200,
                                "url": "https://img.shoplineapp.com/media/image_clips/5e981b45eda5a50016bf3d29/thumb.jpeg?1587026756"
                            },
                            "large": {
                                "width": 400,
                                "height": 400,
                                "url": "https://img.shoplineapp.com/media/image_clips/5e981b45eda5a50016bf3d29/large.jpeg?1587026756"
                            },
                            "xlarge": {
                                "width": 400,
                                "height": 400,
                                "url": "https://img.shoplineapp.com/media/image_clips/5e981b45eda5a50016bf3d29/xlarge.jpeg?1587026756"
                            }
                        },
                        "_id": "5e981b45eda5a50016bf3d29",
                        "alt_translations": {}
                    }
                ],
                "member_price": {},
                "lowest_price": {
                    "cents": 44,
                    "currency_symbol": "NT$",
                    "currency_iso": "TWD",
                    "label": "NT$44",
                    "dollars": 44
                },
                "lowest_member_price": {
                    "cents": 44,
                    "currency_symbol": "NT$",
                    "currency_iso": "TWD",
                    "label": "NT$44",
                    "dollars": 44
                },
                "variations": [],
                "detail_media": []
            },
            "item_variation_id": null,
            "item_id": "60a26d7496727b001d820273",
            "item_price": {
                "cents": 44,
                "currency_symbol": "NT$",
                "currency_iso": "TWD",
                "label": "NT$44",
                "dollars": 44
            },
            "item_points": null,
            "quantity": 1,
            "total": {
                "cents": 44,
                "currency_symbol": "NT$",
                "currency_iso": "TWD",
                "label": "NT$44",
                "dollars": 44
            },
            "total_points": null
        },
        {
            "id": "60ca0cba876b2300384b7eba",
            "item_type": "Product",
            "item_data": {
                "cart_item_id": "60ca0afb561fd0003288535a",
                "promotion_id": null,
                "parent_item_ids": [],
                "triggering_item_id": "",
                "order_promotion_items": {
                    "order_discounted_price": "60ca0b31c9c724001dc71939"
                },
                "order_discounted_price": {
                    "cents": 266,
                    "currency_iso": "TWD"
                },
                "has_exclude_promotion_tag": false
            },
            "object_data": {
                "_id": "600ed5c507ec3119ed6b43cb",
                "tags_array": [],
                "quantity": 86,
                "weight": 0,
                "barcode_type": "Code 128",
                "title_translations": {
                    "zh-hant": "大量上傳大圖80",
                    "en": "大量上傳大圖80"
                },
                "type": "product",
                "status": "active",
                "subscription_period_type": "day",
                "subscription_period_duration": 30,
                "seo_title_translations": {
                    "zh-hant": "大量上傳大圖80",
                    "en": "大量上傳大圖80"
                },
                "seo_description_translations": {
                    "zh-hant": "大量上傳大圖80",
                    "en": "大量上傳大圖80"
                },
                "amount_sold": 1998,
                "quantity_sold": 3,
                "page_views": 0,
                "added_to_cart": 0,
                "field_titles": [],
                "preorder_note_translations": {},
                "created_by": "admin",
                "owner_id": "5e9807e1f58d5300425e48ff",
                "description_translations": {
                    "zh-hant": "大量上傳大圖80",
                    "en": "大量上傳大圖80"
                },
                "seo_keywords": "",
                "price": {
                    "cents": 666,
                    "currency_symbol": "NT$",
                    "currency_iso": "TWD",
                    "label": "NT$666",
                    "dollars": 666
                },
                "same_price": true,
                "hide_price": false,
                "unlimited_quantity": false,
                "sku": "",
                "gender": "unisex",
                "age_group": "adult",
                "adult": "no",
                "condition": "new",
                "gtin": "89461046",
                "out_of_stock_orderable": false,
                "subscription_enabled": false,
                "taxable": false,
                "is_preorder": false,
                "is_excluded_promotion": false,
                "bulkupload_log_id": "600ed59009fe2e003502059c",
                "updated_at": "2021-06-16T14:30:16.503Z",
                "created_at": "2021-01-25T14:29:25.726Z",
                "root_product_id": "600ed5c507ec3119ed6b43cd",
                "stock_ids": [
                    "600ed5c507ec3119ed6b43ce",
                    "600ed5c507ec3119ed6b43cf",
                    "600ed5c507ec3119ed6b43d0",
                    "600ed5c507ec3119ed6b43d1"
                ],
                "wapos_id": "a152c899-272a-4c5f-8b37-9d107c91d404",
                "related_product_ids": [
                    "60a26d7496727b001d820273",
                    "60576da8a5a4fe001ab2ce3a",
                    "600ed6548aab960023361607",
                    "5f3cfbb607ec3174289b6300"
                ],
                "promotion_ids": [
                    "6012654b88463c003e35bacb"
                ],
                "promotion_condition_ids": [
                    "6012654b88463c003e35bacc"
                ],
                "retail_status": "active",
                "media": [
                    {
                        "images": {
                            "favicon_small": {
                                "width": 4320,
                                "height": 2708,
                                "url": "https://img.shoplineapp.com/media/image_clips/600ed5c507ec3119ed6b43ca/original.jpg?1611584964"
                            },
                            "favicon": {
                                "width": 4320,
                                "height": 2708,
                                "url": "https://img.shoplineapp.com/media/image_clips/600ed5c507ec3119ed6b43ca/original.jpg?1611584964"
                            },
                            "favicon_large": {
                                "width": 4320,
                                "height": 2708,
                                "url": "https://img.shoplineapp.com/media/image_clips/600ed5c507ec3119ed6b43ca/original.jpg?1611584964"
                            },
                            "transparent_thumb": {
                                "width": 4320,
                                "height": 2708,
                                "url": "https://img.shoplineapp.com/media/image_clips/600ed5c507ec3119ed6b43ca/original.jpg?1611584964"
                            },
                            "transparent_large": {
                                "width": 4320,
                                "height": 2708,
                                "url": "https://img.shoplineapp.com/media/image_clips/600ed5c507ec3119ed6b43ca/original.jpg?1611584964"
                            },
                            "transparent_xlarge": {
                                "width": 4320,
                                "height": 2708,
                                "url": "https://img.shoplineapp.com/media/image_clips/600ed5c507ec3119ed6b43ca/original.jpg?1611584964"
                            },
                            "original": {
                                "width": 4320,
                                "height": 2708,
                                "url": "https://img.shoplineapp.com/media/image_clips/600ed5c507ec3119ed6b43ca/original.jpg?1611584964"
                            },
                            "thumb": {
                                "width": 4320,
                                "height": 2708,
                                "url": "https://img.shoplineapp.com/media/image_clips/600ed5c507ec3119ed6b43ca/original.jpg?1611584964"
                            },
                            "source": {
                                "width": 4320,
                                "height": 2708,
                                "url": "https://img.shoplineapp.com/media/image_clips/600ed5c507ec3119ed6b43ca/original.jpg?1611584964"
                            }
                        },
                        "_id": "600ed5c507ec3119ed6b43ca",
                        "alt_translations": {}
                    }
                ],
                "price_sale": {},
                "member_price": {},
                "lowest_price": {
                    "cents": 666,
                    "currency_symbol": "NT$",
                    "currency_iso": "TWD",
                    "label": "NT$666",
                    "dollars": 666
                },
                "lowest_member_price": {
                    "cents": 666,
                    "currency_symbol": "NT$",
                    "currency_iso": "TWD",
                    "label": "NT$666",
                    "dollars": 666
                },
                "variations": [],
                "cost": null,
                "detail_media": []
            },
            "item_variation_id": null,
            "item_id": "600ed5c507ec3119ed6b43cb",
            "item_price": {
                "cents": 666,
                "currency_symbol": "NT$",
                "currency_iso": "TWD",
                "label": "NT$666",
                "dollars": 666
            },
            "item_points": null,
            "quantity": 1,
            "total": {
                "cents": 666,
                "currency_symbol": "NT$",
                "currency_iso": "TWD",
                "label": "NT$666",
                "dollars": 666
            },
            "total_points": null
        }
    ],
    "promotion_items": [
        {
            "id": "60ca0b31c9c724001dc71938",
            "coupon_code": null,
            "discounted_amount": {
                "cents": 0,
                "currency_symbol": "US$",
                "currency_iso": "USD",
                "label": "",
                "dollars": 0
            },
            "subtotal_after": {
                "cents": 710,
                "currency_symbol": "NT$",
                "currency_iso": "TWD",
                "label": "NT$710",
                "dollars": 710
            },
            "updated_at": "2021-06-16T14:31:13.887+00:00",
            "created_at": "2021-06-16T14:31:13.869+00:00",
            "promotion_data": {
                "_id": "602dcbc6da1914003ba1130a",
                "addon_product_id": null,
                "available_platforms": [
                    "ec"
                ],
                "banner_media_ids": [],
                "codes": [],
                "created_at": "2021-02-18T02:07:02.814Z",
                "description_translations": {},
                "discount_amount": null,
                "discount_on": "order",
                "discount_percentage": null,
                "discount_type": "gift",
                "discountable_category_ids": [],
                "discountable_product_ids": [
                    "5ea99a52062d82001547f801"
                ],
                "discountable_quantity": 1,
                "discounted_point": null,
                "discounted_price": null,
                "end_at": null,
                "extended_promotion_id": null,
                "for_affiliate_campaign": false,
                "is_accumulated": false,
                "max_use_count": null,
                "membership_tier_id": null,
                "merchant_id": "5e9807e1f58d5300425e48ff",
                "min_price_type": "after_discount",
                "multiple_code": false,
                "requires_membership": false,
                "seo_description_translations": {},
                "seo_keywords": "",
                "seo_title_translations": {},
                "show_coupon": false,
                "start_at": "2021-02-18T02:00:00.000Z",
                "status": "active",
                "term_translations": {},
                "title_translations": {
                    "en": "贈品優惠",
                    "zh-hant": "贈品優惠",
                    "zh-cn": "贈品優惠"
                },
                "updated_at": "2021-02-18T02:10:59.548Z",
                "use_count": 0,
                "user_max_use_count": 0,
                "whitelisted_delivery_option_ids": [
                    "5ea6a794895d3700367ab11a",
                    "5ea6a70a2c7c35003c224917",
                    "5ea6a6f42c7c3565ec221270",
                    "5ea6a43de5ead8002ddc22ce",
                    "5e980b3fb7ed86000f8e5da4"
                ],
                "whitelisted_membership_tier_ids": [],
                "whitelisted_payment_ids": [
                    "5ea6ada2dc48c1001249bc52",
                    "5e9d5e3c7011c4003c497ffb",
                    "5e980b6edbba8a0039a9aae8",
                    "5ea6adc259267200330b4df0"
                ],
                "whitelisted_tag_contents": [],
                "is_extend_promotion": false
            }
        },
        {
            "id": "60ca0b31c9c724001dc71939",
            "coupon_code": null,
            "discounted_amount": {
                "cents": 284,
                "currency_symbol": "NT$",
                "currency_iso": "TWD",
                "label": "NT$284",
                "dollars": 284
            },
            "subtotal_after": {
                "cents": 426,
                "currency_symbol": "NT$",
                "currency_iso": "TWD",
                "label": "NT$426",
                "dollars": 426
            },
            "updated_at": "2021-06-16T14:31:13.892+00:00",
            "created_at": "2021-06-16T14:31:13.876+00:00",
            "promotion_data": {
                "_id": "5ea98ebb209026001eb45aa6",
                "addon_product_id": null,
                "available_platforms": [
                    "ec"
                ],
                "banner_media_ids": [],
                "codes": [],
                "created_at": "2020-04-29T14:27:07.242Z",
                "description_translations": {},
                "discount_amount": null,
                "discount_on": "order",
                "discount_percentage": 40,
                "discount_type": "percentage",
                "discountable_category_ids": [],
                "discountable_product_ids": [],
                "discountable_quantity": null,
                "discounted_point": null,
                "discounted_price": null,
                "end_at": null,
                "extended_promotion_id": null,
                "for_affiliate_campaign": false,
                "is_accumulated": false,
                "max_use_count": 0,
                "membership_tier_id": "5ea98ebbc7cb740019471933",
                "merchant_id": "5e9807e1f58d5300425e48ff",
                "min_price_type": "subtotal",
                "multiple_code": false,
                "requires_membership": false,
                "seo_description_translations": {},
                "seo_keywords": "",
                "seo_title_translations": {},
                "show_coupon": false,
                "start_at": null,
                "status": "hidden",
                "term_translations": {},
                "title_translations": {},
                "updated_at": "2021-05-30T05:15:10.991Z",
                "use_count": 1,
                "user_max_use_count": 0,
                "whitelisted_delivery_option_ids": [],
                "whitelisted_membership_tier_ids": [
                    "5ea98ebbc7cb740019471933"
                ],
                "whitelisted_payment_ids": [],
                "whitelisted_tag_contents": [],
                "is_extend_promotion": false
            }
        }
    ],
    "order": {
        "_id": "60ca0b31c9c724001dc7193c",
        "order_number": "20210616143113792",
        "merchant_order_number": null
    },
    "returned_by": "admin",
    "max_return_total": {
        "cents": 710,
        "currency_symbol": "NT$",
        "currency_iso": "TWD",
        "label": "NT$710",
        "dollars": 710
    }
}