(window.webpackJsonp=window.webpackJsonp||[]).push([[39],{357:function(t,s,e){"use strict";e.r(s);var a=e(28),r=Object(a.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"orders"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#orders"}},[t._v("#")]),t._v(" Orders")]),t._v(" "),s("div",{staticClass:"custom-block warning"},[s("p",{staticClass:"custom-block-title"},[t._v("NOTE")]),t._v(" "),s("p",[t._v("The URI for the API endpoint is often the same for multiple endpoints, the difference being in HTTP methods.")])]),t._v(" "),s("h2",{attrs:{id:"list-orders"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#list-orders"}},[t._v("#")]),t._v(" List Orders")]),t._v(" "),s("div",{staticClass:"language- extra-class"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v("GET https://api.wolfeo.me/v1/orders\n")])])]),s("p",[t._v("Returns a paginated list of orders, ordered by most recent first.")]),t._v(" "),s("h3",{attrs:{id:"example-request"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#example-request"}},[t._v("#")]),t._v(" Example Request")]),t._v(" "),s("div",{staticClass:"language-curl extra-class"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v('curl --request GET "https://api.wolfeo.me/v1/orders?period=last30days&status=completed" \\\n  --header "Authorization: Bearer YOUR_API_KEY"\n')])])]),s("h3",{attrs:{id:"parameters"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Parameter")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("period")]),t._v(" "),s("td",[s("em",[t._v("string")])]),t._v(" "),s("td",[t._v("Time range to filter by (see possible values below)")])]),t._v(" "),s("tr",[s("td",[t._v("range")]),t._v(" "),s("td",[s("em",[t._v("string")])]),t._v(" "),s("td",[t._v("Custom date range — only used when "),s("code",[t._v("period=between")])])]),t._v(" "),s("tr",[s("td",[t._v("status")]),t._v(" "),s("td",[s("em",[t._v("string")])]),t._v(" "),s("td",[t._v("Filter by order status (see possible values below)")])]),t._v(" "),s("tr",[s("td",[t._v("page")]),t._v(" "),s("td",[s("em",[t._v("integer")])]),t._v(" "),s("td",[t._v("Page number (default: "),s("code",[t._v("1")]),t._v(")")])]),t._v(" "),s("tr",[s("td",[t._v("per_page")]),t._v(" "),s("td",[s("em",[t._v("integer")])]),t._v(" "),s("td",[t._v("Results per page — max "),s("code",[t._v("100")]),t._v(" (default: "),s("code",[t._v("50")]),t._v(")")])])])]),t._v(" "),s("h3",{attrs:{id:"possible-values-for-period"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#possible-values-for-period"}},[t._v("#")]),t._v(" Possible values for "),s("code",[t._v("period")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Value")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("all")])]),t._v(" "),s("td",[t._v("All orders ever")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("today")])]),t._v(" "),s("td",[t._v("Orders placed today")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("yesterday")])]),t._v(" "),s("td",[t._v("Orders placed yesterday")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("last7days")])]),t._v(" "),s("td",[t._v("Orders placed in the last 7 days")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("last30days")])]),t._v(" "),s("td",[t._v("Orders placed in the last 30 days")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("between")])]),t._v(" "),s("td",[t._v("Custom date range (requires "),s("code",[t._v("range")]),t._v(")")])])])]),t._v(" "),s("h3",{attrs:{id:"possible-values-for-status"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#possible-values-for-status"}},[t._v("#")]),t._v(" Possible values for "),s("code",[t._v("status")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Value")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("completed")])]),t._v(" "),s("td",[t._v("Successfully paid")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("waiting")])]),t._v(" "),s("td",[t._v("Pending payment")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("cancelled")])]),t._v(" "),s("td",[t._v("Cancelled")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("refunded")])]),t._v(" "),s("td",[t._v("Refunded")])])])]),t._v(" "),s("h3",{attrs:{id:"sample-return"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#sample-return"}},[t._v("#")]),t._v(" Sample Return")]),t._v(" "),s("div",{staticClass:"language-json extra-class"},[s("pre",{pre:!0,attrs:{class:"language-json"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n    "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"success"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n    "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"data"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n        "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n            "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"id"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1725")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"id_order"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"FI4629U0-1773595409"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"id_customer"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("679")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"email"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"john@doe.ie"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"firstname"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"John"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"lastname"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Doe"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"type"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Stripe"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"status"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"completed"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"amount"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("297.00")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"currency"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"USD"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"created_at"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2024-01-01T09:00:00.000000Z"')]),t._v("\n        "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n    "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n    "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"meta"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n        "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"current_page"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"last_page"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("24")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"per_page"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("50")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"total"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1180")]),t._v("\n    "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("h3",{attrs:{id:"possible-errors"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#possible-errors"}},[t._v("#")]),t._v(" Possible Errors")]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Code")]),t._v(" "),s("th",[t._v("HTTP")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("INVALID_STATUS")]),t._v(" "),s("td",[t._v("400")]),t._v(" "),s("td",[t._v("Invalid "),s("code",[t._v("status")]),t._v(" value")])]),t._v(" "),s("tr",[s("td",[t._v("INVALID_PERIOD")]),t._v(" "),s("td",[t._v("400")]),t._v(" "),s("td",[t._v("Invalid "),s("code",[t._v("period")]),t._v(" or missing "),s("code",[t._v("range")])])])])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"retrieve-order"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#retrieve-order"}},[t._v("#")]),t._v(" Retrieve Order")]),t._v(" "),s("div",{staticClass:"language- extra-class"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v("GET https://api.wolfeo.me/v1/order\n")])])]),s("h3",{attrs:{id:"example-request-2"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#example-request-2"}},[t._v("#")]),t._v(" Example Request")]),t._v(" "),s("div",{staticClass:"language-curl extra-class"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v('curl --request GET "https://api.wolfeo.me/v1/order?id_order=FI4629U0-1773595409" \\\n  --header "Authorization: Bearer YOUR_API_KEY"\n')])])]),s("h3",{attrs:{id:"parameters-2"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Parameter")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("id_order*")]),t._v(" "),s("td",[s("em",[t._v("string")])]),t._v(" "),s("td",[t._v("The order's string identifier")])])])]),t._v(" "),s("p",[s("em",[t._v("* denotes a required parameter")])]),t._v(" "),s("h3",{attrs:{id:"sample-return-2"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#sample-return-2"}},[t._v("#")]),t._v(" Sample Return")]),t._v(" "),s("div",{staticClass:"language-json extra-class"},[s("pre",{pre:!0,attrs:{class:"language-json"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n    "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"success"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n    "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"data"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n        "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"id"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1725")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"id_order"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"FI4629U0-1773595409"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"id_customer"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("679")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"email"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"john@doe.ie"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"firstname"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"John"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"lastname"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Doe"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"type"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Stripe"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"status"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"completed"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"amount"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("297.00")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"currency"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"USD"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"created_at"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2024-01-01T09:00:00.000000Z"')]),t._v("\n    "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("h3",{attrs:{id:"possible-errors-2"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#possible-errors-2"}},[t._v("#")]),t._v(" Possible Errors")]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Code")]),t._v(" "),s("th",[t._v("HTTP")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("NOT_FOUND")]),t._v(" "),s("td",[t._v("404")]),t._v(" "),s("td",[t._v("Order not found")])])])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"retrieve-sales-amount"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#retrieve-sales-amount"}},[t._v("#")]),t._v(" Retrieve Sales Amount")]),t._v(" "),s("div",{staticClass:"language- extra-class"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v("GET https://api.wolfeo.me/v1/sales-amount\n")])])]),s("p",[t._v("Returns the total revenue from completed and pending orders over a given time range.")]),t._v(" "),s("h3",{attrs:{id:"example-request-3"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#example-request-3"}},[t._v("#")]),t._v(" Example Request")]),t._v(" "),s("div",{staticClass:"language-curl extra-class"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v('curl --request GET "https://api.wolfeo.me/v1/sales-amount?period=last30days" \\\n  --header "Authorization: Bearer YOUR_API_KEY"\n')])])]),s("h3",{attrs:{id:"parameters-3"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Parameter")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("period*")]),t._v(" "),s("td",[s("em",[t._v("string")])]),t._v(" "),s("td",[t._v("Time range to filter by (see possible values below)")])]),t._v(" "),s("tr",[s("td",[t._v("range")]),t._v(" "),s("td",[s("em",[t._v("string")])]),t._v(" "),s("td",[t._v("Custom date range — only used when "),s("code",[t._v("period=between")])])])])]),t._v(" "),s("p",[s("em",[t._v("* denotes a required parameter")])]),t._v(" "),s("h3",{attrs:{id:"possible-values-for-period-2"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#possible-values-for-period-2"}},[t._v("#")]),t._v(" Possible values for "),s("code",[t._v("period")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Value")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("all")])]),t._v(" "),s("td",[t._v("All orders ever")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("today")])]),t._v(" "),s("td",[t._v("Orders placed today")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("yesterday")])]),t._v(" "),s("td",[t._v("Orders placed yesterday")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("last7days")])]),t._v(" "),s("td",[t._v("Orders placed in the last 7 days")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("last30days")])]),t._v(" "),s("td",[t._v("Orders placed in the last 30 days")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("between")])]),t._v(" "),s("td",[t._v("Custom date range (requires "),s("code",[t._v("range")]),t._v(")")])])])]),t._v(" "),s("h3",{attrs:{id:"format-for-range"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#format-for-range"}},[t._v("#")]),t._v(" Format for "),s("code",[t._v("range")])]),t._v(" "),s("p",[t._v("Pass two dates separated by "),s("code",[t._v("to")]),t._v(":")]),t._v(" "),s("div",{staticClass:"language- extra-class"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v("2023-06-01to2023-06-29\n")])])]),s("h3",{attrs:{id:"example-urls"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#example-urls"}},[t._v("#")]),t._v(" Example URLs")]),t._v(" "),s("div",{staticClass:"language- extra-class"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v("https://api.wolfeo.me/v1/sales-amount?period=all\nhttps://api.wolfeo.me/v1/sales-amount?period=today\nhttps://api.wolfeo.me/v1/sales-amount?period=last7days\nhttps://api.wolfeo.me/v1/sales-amount?period=between&range=2023-06-01to2023-06-29\n")])])]),s("h3",{attrs:{id:"sample-return-3"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#sample-return-3"}},[t._v("#")]),t._v(" Sample Return")]),t._v(" "),s("div",{staticClass:"language-json extra-class"},[s("pre",{pre:!0,attrs:{class:"language-json"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n    "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n        "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"amount"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1234.56")]),t._v("\n    "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n")])])]),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),s("p",[s("code",[t._v("amount")]),t._v(" is the sum in the account's default currency, rounded to 2 decimal places.")])]),t._v(" "),s("div",{staticClass:"custom-block warning"},[s("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),s("p",[t._v("This endpoint does not yet follow the standard "),s("code",[t._v('{"success": true, "data": ...}')]),t._v(" envelope. Errors return "),s("code",[t._v('{"success": false}')]),t._v(" with an HTTP 400 or 401 status and no "),s("code",[t._v("error")]),t._v(" object.")])])])}),[],!1,null,null,null);s.default=r.exports}}]);