{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/orders/retrieve.json","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X GET https://tophatter.com/merchant_api/v1/orders/retrieve.json \\\n-d 'access_token=YOUR_ACCESS_TOKEN' \\\n-d 'order_id=1035509247'"}]},"method":"get","params":[{"name":"order_id","type":"int","default":"","desc":"The order_id of the order you wish to retrieve.","required":false,"in":"query","ref":"","_id":"58351d35b85f2f0f00463925"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n \"order_id\": 82664093,\n \"status\": \"paid\",\n \"carrier\": null,\n \"tracking_number\": null,\n \"fulfillment_partner\": null,\n \"product_name\": \"E. Headset Earbuds Ture Wireless Bluetooth Double Earphone Twins Earpieces Stereo Binaural Earphones For All mobile phones\",\n \"product_identifier\": “RH00001”,\n \"product_internal_id\": fake-id (1111111),\n \"variation_identifier\": \"RH00001-Gold\",\n \"variation_internal_id\": fake-id (11111116),\n \"annotation\": null,\n \"customer_id\": 1034347337,\n \"customer_name\": “John Doe”,\n \"address1\": \"123 Main Street\",\n \"address2\": \"\",\n \"city\": “Los Altos”,\n \"state\": “CA”,\n \"postal_code\": “94022\",\n \"country\": \"USA\",\n \"available_refunds\": {\n \"buyer_fee\": fake-buyer-fee (12.0),\n \"buy_one_get_one_upsell_fee\": fake-buy-one-get-one-upsell-fee (12.0),\n\t\t\t\t\"accessory_upsell_fee\": fake-accessory-upsell-fee (11.0)\n },\n \"refund_amount\": 0,\n \"disbursement_amount\": \"fake-disbursement-amount (28.88)”,\n \"seller_fees_amount\": fake-seller-fee-amount (6.12),\n \"seller_fees\": [\n {\n \"type\": \"scheduling_fee\",\n \"amount\": fake-scheduling-fee (1.3)\n },\n {\n \"type\": \"commission_fee\",\n \"amount\": fake-commission-fee (3.5)\n },\n {\n \"type\": \"processing_fee\",\n \"amount\": fake-processing-fee (1.32)\n }\n ],\n \"upsells\": [\n {\n \"type_description\": \"buy_one_get_one\",\n \"amount\": \"19.0\", //soon-to-be-deprecated\n \"description\": null\n },\n {\n \"type_description\": \"accessory\",\n \"amount\": \"4.0\",\n \"description\": \"1*color box\",\n \"identifier\": null,\n \"image\": null\n }\n ],\n \"product_quantity\": 2,\n \"refunded_at\": null,\n \"paid_at\": \"2019-03-18T17:23:01-07:00\",\n \"created_at\": \"2019-03-18T17:17:29-07:00\",\n \"updated_at\": \"2019-03-19T03:40:40-07:00\",\n \"canceled_at\": null\n}","name":""}]},"settings":""},"next":{"description":"","pages":[]},"title":"Retrieve an Order","type":"endpoint","slug":"order-retrieve","excerpt":"","body":"","updates":["5e26ccc393b0ac01d1d0c6bc"],"order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56a992aff834950d0037b385","editedParams2":true,"githubsync":"","parentDoc":null,"__v":16,"createdAt":"2016-01-28T04:01:51.880Z","project":"567f0c06143cc60d00c1fdbe","user":"567f0baca74a1c0d003e1fba","category":{"sync":{"isSync":false,"url":""},"pages":["56a99246318e6c1700a19d06","56a9924c257fbc0d00d4763a","56a9926bf834950d0037b381","56a99273257fbc0d00d4763c","56a992863b04f20d00ecca87","56a9928df834950d0037b383","56a992aff834950d0037b385","56a992d413a69a0d00a778de","56a9f82aca491e0d00eb8b12","56a9f959257fbc0d00d476c2"],"title":"Orders","slug":"orders","order":3,"from_sync":false,"reference":false,"_id":"56a9783b2d8fd90d0036eed6","version":"567f0c06143cc60d00c1fdc1","__v":10,"createdAt":"2016-01-28T02:08:59.138Z","project":"567f0c06143cc60d00c1fdbe"},"editedParams":true,"version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["567f0c07143cc60d00c1fdc2","56a9783109cb9c0d00f0c7d3","56a97837f834950d0037b363","56a9783b2d8fd90d0036eed6","56a979912d8fd90d0036eed8","5834b5691a80690f00d31faf","5834b5e4f775120f00c45f9d","5bf1a1473031e4005075ae14","5c64c200244bda003204b97f"],"_id":"567f0c06143cc60d00c1fdc1","__v":9,"createdAt":"2015-12-26T21:52:06.734Z","releaseDate":"2015-12-26T21:52:06.734Z","project":"567f0c06143cc60d00c1fdbe"}}
getRetrieve an Order
Definition
{{ api_url }}{{ page_api_url }}
Parameters
Query Params
order_id:
integer
The order_id of the order you wish to retrieve.