{"_id":"56a9924c257fbc0d00d4763a","githubsync":"","__v":56,"user":"567f0baca74a1c0d003e1fba","parentDoc":null,"project":"567f0c06143cc60d00c1fdbe","version":{"_id":"567f0c06143cc60d00c1fdc1","__v":9,"project":"567f0c06143cc60d00c1fdbe","createdAt":"2015-12-26T21:52:06.734Z","releaseDate":"2015-12-26T21:52:06.734Z","categories":["567f0c07143cc60d00c1fdc2","56a9783109cb9c0d00f0c7d3","56a97837f834950d0037b363","56a9783b2d8fd90d0036eed6","56a979912d8fd90d0036eed8","5834b5691a80690f00d31faf","5834b5e4f775120f00c45f9d","5bf1a1473031e4005075ae14","5c64c200244bda003204b97f"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"category":{"_id":"56a9783b2d8fd90d0036eed6","version":"567f0c06143cc60d00c1fdc1","__v":10,"pages":["56a99246318e6c1700a19d06","56a9924c257fbc0d00d4763a","56a9926bf834950d0037b381","56a99273257fbc0d00d4763c","56a992863b04f20d00ecca87","56a9928df834950d0037b383","56a992aff834950d0037b385","56a992d413a69a0d00a778de","56a9f82aca491e0d00eb8b12","56a9f959257fbc0d00d476c2"],"project":"567f0c06143cc60d00c1fdbe","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-01-28T02:08:59.138Z","from_sync":false,"order":3,"slug":"orders","title":"Orders"},"updates":["5a2f9fb3a0213c003e8ebe14"],"next":{"pages":[],"description":""},"createdAt":"2016-01-28T04:00:12.893Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"curl -X GET https://tophatter.com/merchant_api/v1/orders.json \\\n-d 'access_token=YOUR_ACCESS_TOKEN' \\\n-d 'filter=unfulfilled'","language":"curl"}]},"method":"get","results":{"codes":[{"name":"","code":"[  \n   {  \n      \"order_id\": 59010920,\n      \"status\": \"paid\",\n      \"carrier\": null,\n      \"tracking_number\": null,\n      \"product_name\": \"Nintendo Switch - Neon Blue and Red Joy-Con\",\n      \"product_identifier\": \"B01MUAGZ49\",\n      \"variation_identifier\": \"B01MUAGZ49\",\n      \"customer_id\": 19724374,\n      \"customer_name\": \"John Doe\",\n      \"address1\": \"123 Main Street\",\n      \"address2\": \"Apartment 42\",\n      \"city\": \"Denver\",\n      \"state\": \"CO\",\n      \"postal_code\": \"80219\",\n      \"country\": \"USA\",\n      \"available_refunds\": {  \n         \"buyer_fee\": 275.0\n      },\n      \"refund_amount\": 0.0,\n      \"disbursement_amount\": \"239.22\",\n      \"seller_fees_amount\": 35.78,\n      \"seller_fees\": [  \n         {  \n            \"type\": \"commission_fee\",\n            \"amount\": fake-commission-fee (27.5)\n         },\n         {  \n            \"type\": \"processing_fee\",\n            \"amount\": fake-processing-fee (8.28)\n         }\n      ],\n      \"upsells\": [\n        {\n           \"type_description\": \"buy_one_get_one\",\n           \"amount\": \"fake-upsell-amount (9.0)\",\n           \"description\": null\n        },\n        {\n           \"type_description\": \"accessory\",\n           \"amount\": \"fake-upsell-amount (2.0)\",\n           \"description\": null\n        }\n      ],\n      \"refunded_at\": null,\n      \"paid_at\": \"2018-03-29T17:04:20-07:00\",\n      \"created_at\": \"2018-03-29T17:04:17-07:00\",\n      \"updated_at\": \"2018-09-26T11:05:09-07:00\",\n      \"canceled_at\": null\n   }\n]","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"5835102b61b4300f0032e6b8","ref":"","in":"query","required":false,"desc":"An optional filter. The following values are accepted: `fulfilled`, `unfulfilled`, and `refunded`.","default":"","type":"string","name":"filter"},{"_id":"5835102b61b4300f0032e6b7","ref":"","in":"query","required":false,"desc":"An optional date filter. Only orders created after this date will be returned.","default":"","type":"yyyy-mm-dd","name":"start"},{"_id":"5835102b61b4300f0032e6b6","ref":"","in":"query","required":false,"desc":"When paginating, the page of orders to return. Example: Assuming a per_page value of 50, page 1 would return orders 1 to 50 and page 2 would return products 51 to 100.","default":"1","type":"int","name":"page"},{"_id":"5835102b61b4300f0032e6b5","ref":"","in":"query","required":false,"desc":"The number of orders to return per page. 1000 is the maximum value.","default":"50","type":"int","name":"per_page"}],"url":"/orders.json"},"isReference":false,"order":1,"body":"[block:api-header]\n{\n  \"title\": \"Order Statuses:\"\n}\n[/block]\nOrders will have one of the following statuses:\n\n- `refunded`: The order has been refunded.\n- `shipped`: The order has been fulfilled.\n- `paid`: The order is waiting to be fulfilled.","excerpt":"","slug":"order-list","type":"endpoint","title":"List Orders"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

filter:
string
An optional filter. The following values are accepted: `fulfilled`, `unfulfilled`, and `refunded`.
start:
yyyy-mm-dd
An optional date filter. Only orders created after this date will be returned.
page:
integer1
When paginating, the page of orders to return. Example: Assuming a per_page value of 50, page 1 would return orders 1 to 50 and page 2 would return products 51 to 100.
per_page:
integer50
The number of orders to return per page. 1000 is the maximum value.

Examples


Result Format


Documentation

[block:api-header] { "title": "Order Statuses:" } [/block] Orders will have one of the following statuses: - `refunded`: The order has been refunded. - `shipped`: The order has been fulfilled. - `paid`: The order is waiting to be fulfilled.