{ "parameters": [ { "name": "page", "description": "Current page" }, { "name": "sort_by", "description": "Field on which to sort (see responses for possible values)" }, { "name": "sort_direction", "description": "Direction to sort (asc or desc)" }, { "name": "placed_at_greater_than", "description": "Start of a placed_at date range" }, { "name": "placed_at_less_than", "description": "End of a placed_at date range" }, { "name": "email", "description": "Email address on the order" } ], "response_fields": [ ], "requests": [ { "request_headers": { }, "request_query_parameters": { "page": "1", "sort_by": "created_at", "sort_direction": "desc", "placed_at_greater_than": "2020-08-04 13:50:39 UTC", "placed_at_less_than": "2020-08-06 13:50:39 UTC", "email": "test@workarea.com" }, "response_headers": { "X-Frame-Options": "SAMEORIGIN", "X-XSS-Protection": "1; mode=block", "X-Content-Type-Options": "nosniff", "X-Download-Options": "noopen", "X-Permitted-Cross-Domain-Policies": "none", "Referrer-Policy": "strict-origin-when-cross-origin", "Content-Type": "application/json; charset=utf-8", "X-Requested-With": "", "Vary": "X-Requested-With, X-Workarea-Segments", "Last-Modified": "Wed, 19 Aug 2020 13:50:39 GMT", "Cache-Control": "no-cache, no-store, must-revalidate", "X-Request-Id": "cd504100-86eb-408f-921e-fcdd6b0a350f", "X-Runtime": "0.009093", "X-Workarea-Segments": "", "Expires": "0", "Content-Length": "2550" }, "request_method": "GET", "request_path": "/api/admin/orders?page=1&sort_by=created_at&sort_direction=desc&placed_at_greater_than=2020-08-04+13%3A50%3A39+UTC&placed_at_less_than=2020-08-06+13%3A50%3A39+UTC&email=test%40workarea.com", "request_body": null, "request_content_type": null, "response_status": 200, "response_status_text": "OK", "response_body": "{\n \"orders\": [\n {\n \"_id\": \"10002\",\n \"canceled_at\": null,\n \"checkout_by_id\": null,\n \"checkout_started_at\": null,\n \"copied_from_id\": null,\n \"created_at\": \"2020-08-19T13:50:35.408Z\",\n \"discount_ids\": [\n\n ],\n \"email\": \"test@workarea.com\",\n \"fraud_decided_at\": \"2020-08-19T13:50:38.592Z\",\n \"fraud_decision\": {\n \"_id\": \"5f3d2e2e0218236de151f735\",\n \"analyzer\": \"Workarea::Checkout::Fraud::TestAnalyzer\",\n \"created_at\": null,\n \"decision\": \"no_decision\",\n \"message\": \"Workarea default fraud check. Automatic no decision.\",\n \"response\": null,\n \"updated_at\": null\n },\n \"fraud_suspected_at\": null,\n \"ip_address\": null,\n \"items\": [\n {\n \"_id\": \"5f3d2e2b0218236de151f697\",\n \"category_ids\": [\n\n ],\n \"created_at\": \"2020-08-19T13:50:35.408Z\",\n \"customizations\": {\n },\n \"discountable\": true,\n \"free_gift\": false,\n \"fulfillment\": \"shipping\",\n \"price_adjustments\": [\n {\n \"_id\": \"5f3d2e2d0218236de151f733\",\n \"amount\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"calculator\": \"Workarea::Pricing::Calculators::ItemCalculator\",\n \"created_at\": null,\n \"data\": {\n \"on_sale\": false,\n \"original_price\": 5.0,\n \"tax_code\": null\n },\n \"description\": \"Item Subtotal\",\n \"price\": \"item\",\n \"quantity\": 2,\n \"updated_at\": null\n }\n ],\n \"product_attributes\": {\n \"_id\": \"D863AC7057\",\n \"tags\": [\n\n ],\n \"active_segment_ids\": {\n \"en\": [\n\n ]\n },\n \"active\": {\n \"en\": true\n },\n \"subscribed_user_ids\": [\n\n ],\n \"details\": {\n \"en\": {\n \"Material\": [\n \"Cotton\"\n ],\n \"Style\": [\n \"12345\"\n ]\n }\n },\n \"filters\": {\n \"en\": {\n \"Material\": \"Cotton\",\n \"Style\": \"12345\"\n }\n },\n \"template\": \"generic\",\n \"purchasable\": true,\n \"name\": {\n \"en\": \"Test Product\"\n },\n \"digital\": false,\n \"slug\": \"test-product\",\n \"updated_at\": \"2020-08-19T13:50:34.196Z\",\n \"created_at\": \"2020-08-19T13:50:07.982Z\",\n \"variants\": [\n {\n \"_id\": \"5f3d2e0f0218236de151f464\",\n \"active_segment_ids\": {\n \"en\": [\n\n ]\n },\n \"active\": {\n \"en\": true\n },\n \"details\": {\n \"en\": {\n }\n },\n \"sku\": \"SKU\",\n \"name\": {\n \"en\": \"SKU\"\n },\n \"position\": 0\n }\n ],\n \"last_indexed_at\": \"2020-08-19T13:50:34.986Z\"\n },\n \"product_id\": \"D863AC7057\",\n \"quantity\": 2,\n \"sku\": \"SKU\",\n \"total_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"total_value\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"updated_at\": \"2020-08-19T13:50:35.408Z\",\n \"via\": null\n }\n ],\n \"lock_expires_at\": null,\n \"metrics_saved_at\": \"2020-08-19T13:50:39.456Z\",\n \"placed_at\": \"2020-08-05T13:50:34.173Z\",\n \"pricing_cache_key\": \"714834562bba627e3a0291a63d79e9e6ba368a8c\",\n \"promo_codes\": [\n\n ],\n \"reminded_at\": null,\n \"segment_ids\": [\n\n ],\n \"shipping_total\": {\n \"cents\": 100.0,\n \"currency_iso\": \"USD\"\n },\n \"source\": null,\n \"subscribed_user_ids\": [\n\n ],\n \"subtotal_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"tax_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"token\": \"nsphf9Q4yaCfKFVhJn791LZ5\",\n \"total_price\": {\n \"cents\": 1100.0,\n \"currency_iso\": \"USD\"\n },\n \"total_value\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"updated_at\": \"2020-08-19T13:50:39.687Z\",\n \"user_activity_id\": null,\n \"user_agent\": null,\n \"user_id\": null\n }\n ]\n}", "response_content_type": "application/json", "curl": "curl -g \"https://www.example.com/api/admin/orders?page=1&sort_by=created_at&sort_direction=desc&placed_at_greater_than=2020-08-04+13%3A50%3A39+UTC&placed_at_less_than=2020-08-06+13%3A50%3A39+UTC&email=test%40workarea.com\" -X GET " } ], "resource": "Orders", "description": "Viewing orders by date range", "route": "/api/admin/orders", "http_method": "GET" }