{"_id":"58112e72ded0340f0085d051","parentDoc":null,"version":{"_id":"58112e71ded0340f0085d02a","project":"551e85be610f400d00837db7","__v":4,"createdAt":"2016-10-26T22:30:09.862Z","releaseDate":"2016-10-26T22:30:09.862Z","categories":["58112e72ded0340f0085d02b","58112e72ded0340f0085d02c","58112e72ded0340f0085d02d","58112e72ded0340f0085d02e","58112e72ded0340f0085d02f","58112e72ded0340f0085d030","58112e72ded0340f0085d031","58112e72ded0340f0085d032","58112e72ded0340f0085d033","58112e72ded0340f0085d034","581137cc604d3c230048b7e4","58dc367221742d0f00a73f98","590768e54669da0f00db5c0b"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"new designer","version_clean":"2.0.0","version":"2.0"},"__v":0,"category":{"_id":"58112e72ded0340f0085d033","project":"551e85be610f400d00837db7","version":"58112e71ded0340f0085d02a","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-25T13:57:54.835Z","from_sync":false,"order":8,"slug":"api-resources","title":"Merchant API Resources"},"project":"551e85be610f400d00837db7","user":"55f2fd49b5b25021002b7dfd","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-14T04:19:31.018Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":4,"body":"# Properties\n[block:html]\n{\n  \"html\": \"<div class=\\\"property-table-wrap\\\">\\n    <table class=\\\"property-table\\\">\\n        <thead>\\n            <tr>\\n                <th class=\\\"prop-col\\\">Property</th>\\n                <th class=\\\"filter-col\\\">Filter</th>\\n                <th class=\\\"editable-col\\\">Edit</th>\\n                <th class=\\\"type-col\\\">Type</th>\\n                <th class=\\\"description-col\\\">Description</th>\\n            </tr>\\n        </thead>\\n\\n        <tbody class=\\\"properties\\\">\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">id</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">INT</td>\\n                <td class=\\\"description-col\\\">Unique identifier</td>\\n            </tr>\\n          \\n            <tr class=\\\"ro\\\">\\n                <td class=\\\"prop-col\\\">card_refunded_amount</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">INT</td>\\n                <td class=\\\"description-col\\\">How much was refunded to a gift card.</td>\\n            </tr>\\n          \\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">credit_applied</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">INT</td>\\n                <td class=\\\"description-col\\\"></td>\\n            </tr>          \\n          \\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">customer_id</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">INT</td>\\n                <td class=\\\"description-col\\\">Unique identifier for the customer</td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">financial_status</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">STRING</td>\\n                <td class=\\\"description-col\\\">The order's financial status <a href=\\\"http://docs.cratejoy.com/v2.0/docs/order#order-financial-status\\\">(See table below)</a></td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">fulfillment_status</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">STRING</td>\\n                <td class=\\\"description-col\\\">The fulfillment status--either 1 (unfulfilled), 2 (partial), or 3 (fulfilled)</td>\\n            </tr>\\n \\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">gift_card_discount</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">INT</td>\\n                <td class=\\\"description-col\\\"></td>\\n            </tr>\\n          \\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">gift_message</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">STRING</td>\\n                <td class=\\\"description-col\\\">The gift message entered on checkout.</td>\\n            </tr>\\n          \\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">gift_renewal_notif</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">BOOLEAN</td>\\n                <td class=\\\"description-col\\\"></td>\\n            </tr>\\n          \\n            <tr class=\\\"ro\\\">\\n                <td class=\\\"prop-col\\\">gross_shipping</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">INT</td>\\n                <td class=\\\"description-col\\\"></td>\\n            </tr>          \\n          \\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">is_gift</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">BOOL</td>\\n                <td class=\\\"description-col\\\">Is this a gift order (Gifting 2 and 3 only!)</td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">is_renewal</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">BOOLEAN</td>\\n                <td class=\\\"description-col\\\">Note: This is false for \\\"Charge Immediately\\\" orders.</td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">is_test</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">BOOLEAN</td>\\n                <td class=\\\"description-col\\\"></td>\\n            </tr>\\n\\n            <tr class=\\\"fil rw\\\">\\n                <td class=\\\"prop-col\\\">note</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">STRING</td>\\n                <td class=\\\"description-col\\\">Note on the order</td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">placed_at</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">DATETIME</td>\\n                <td class=\\\"description-col\\\"></td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">prorated_charge</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">INT</td>\\n                <td class=\\\"description-col\\\"></td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">refund_applied</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">INT</td>\\n                <td class=\\\"description-col\\\"></td>\\n            </tr>\\n\\n            <tr class=\\\"ro\\\">\\n                <td class=\\\"prop-col\\\">refunded_amount</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">INT</td>\\n                <td class=\\\"description-col\\\"></td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">status</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">STRING</td>\\n                <td class=\\\"description-col\\\">Open (1) or Closed (2).</td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">store_id</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">INT</td>\\n                <td class=\\\"description-col\\\"></td>\\n            </tr>\\n          \\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">sub_total</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">INT</td>\\n                <td class=\\\"description-col\\\"></td>\\n            </tr>\\n          \\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">total</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">INT</td>\\n                <td class=\\\"description-col\\\"></td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">total_app_fees</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">INT</td>\\n                <td class=\\\"description-col\\\"></td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">total_label_cost</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">INT</td>\\n                <td class=\\\"description-col\\\"></td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">total_pending_fees</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">INT</td>\\n                <td class=\\\"description-col\\\"></td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">total_price</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">INT</td>\\n                <td class=\\\"description-col\\\"></td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">total_shipping</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">INT</td>\\n                <td class=\\\"description-col\\\"></td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">total_tax</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">INT</td>\\n                <td class=\\\"description-col\\\"></td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">transaction_fes</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">INT</td>\\n                <td class=\\\"description-col\\\"></td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">transaction_fee_status</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">INT</td>\\n                <td class=\\\"description-col\\\">1 (Paid), 2 (Pending Renewal), or 3 (Unpaid)</td>\\n            </tr>\\n\\n            <tr class=\\\"ro\\\">\\n                <td class=\\\"prop-col\\\">type</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">STRING</td>\\n              <td class=\\\"description-col\\\">Always <code>order</code></td>\\n            </tr>\\n\\n            <tr class=\\\"ro\\\">\\n                <td class=\\\"prop-col\\\">url</td>\\n                <td class=\\\"filter-col\\\"></td>\\n                <td class=\\\"editable-col\\\"></td>\\n                <td class=\\\"type-col\\\">STRING</td>\\n                <td class=\\\"description-col\\\"></td>\\n            </tr>\\n\\n            </tbody>\\n    </table>\\n</div>\"\n}\n[/block]\n## Relation Properties\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Resource\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"customer\",\n    \"0-1\": \"[Customer](doc:customer-1)\",\n    \"0-2\": \"The customer the order belongs to\",\n    \"1-0\": \"products\",\n    \"1-1\": \"[Cart Products](doc:cart-products)\",\n    \"1-2\": \"A collection of CartProducts associated with the order\",\n    \"h-3\": \"Filter?\",\n    \"0-3\": \"Yes\",\n    \"1-3\": \"Yes\"\n  },\n  \"cols\": 4,\n  \"rows\": 2\n}\n[/block]\n## Additional Related Properties\nsee [Working with Object Relationships](doc:working-with-object-relationships) \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Resource\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"cart\",\n    \"0-1\": \"[Cart](doc:cart)\",\n    \"1-0\": \"logs\",\n    \"1-1\": \"OrderLog\",\n    \"2-0\": \"gifts\",\n    \"2-1\": \"\",\n    \"3-0\": \"coupons\",\n    \"3-1\": \"[Cart Coupon](doc:cart-coupon)\",\n    \"4-0\": \"sent_gift\",\n    \"5-0\": \"bill_address\",\n    \"6-0\": \"ship_address\",\n    \"7-0\": \"fulfillments\",\n    \"5-1\": \"[Address](doc:customeraddress)\",\n    \"6-1\": \"[Address](doc:customeraddress)\",\n    \"7-1\": \"[Fulfillment](doc:fulfillment)\",\n    \"8-0\": \"transactions\",\n    \"8-1\": \"[Transaction](doc:transaction)\",\n    \"9-0\": \"subscriptions\",\n    \"9-1\": \"[Subscription](doc:subscription)\",\n    \"10-0\": \"received_gift\",\n    \"11-0\": \"referral_token\",\n    \"2-2\": \"[Deprecated] \\nGifting 1.0 products.\",\n    \"h-3\": \"Filter?\",\n    \"0-3\": \"Yes\",\n    \"1-3\": \"Yes\",\n    \"2-3\": \"Yes\",\n    \"3-3\": \"Yes\",\n    \"4-2\": \"[Deprecated] \\nGifting 1.0 gift-giver.\",\n    \"4-3\": \"Yes\",\n    \"5-2\": \"The billing address for the order.\",\n    \"3-2\": \"If available, the coupons applied to the order.\",\n    \"0-2\": \"\",\n    \"5-3\": \"Yes\",\n    \"6-2\": \"The shipping address for the order.\",\n    \"6-3\": \"Yes\",\n    \"7-2\": \"The fulfillments associated with the order.\",\n    \"7-3\": \"Yes\",\n    \"8-2\": \"The transactions associated with the order\",\n    \"9-2\": \"The subscriptions associated with the order.\",\n    \"10-2\": \"[Deprecated] \\nGifting 1.0 gift-recipient.\",\n    \"8-3\": \"Yes\",\n    \"10-3\": \"Yes\",\n    \"11-3\": \"Yes\",\n    \"9-3\": \"Yes\"\n  },\n  \"cols\": 4,\n  \"rows\": 12\n}\n[/block]\nThe above properties on the order are references to another Cratejoy resource or another collection of Cratejoy resources. The properties can either be a URL to fetch the related resources OR contain the resources themselves\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Order Financial Status\"\n}\n[/block]\nTo filter on financial_status, you'll need to filter using the integer values from this table:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"1\",\n    \"0-1\": \"pending\",\n    \"h-0\": \"Key\",\n    \"h-1\": \"Status\",\n    \"1-0\": \"2\",\n    \"1-1\": \"authorized\",\n    \"2-0\": \"3\",\n    \"2-1\": \"partially_paid\",\n    \"3-0\": \"4\",\n    \"3-1\": \"paid\",\n    \"4-0\": \"5\",\n    \"4-1\": \"partially_refunded\",\n    \"5-0\": \"6\",\n    \"5-1\": \"refunded\",\n    \"6-0\": \"7\",\n    \"6-1\": \"voided\"\n  },\n  \"cols\": 2,\n  \"rows\": 7\n}\n[/block]","excerpt":"Order data object specification for the Cratejoy Merchant API","slug":"order","type":"basic","title":"Order"}

Order

Order data object specification for the Cratejoy Merchant API

# Properties [block:html] { "html": "<div class=\"property-table-wrap\">\n <table class=\"property-table\">\n <thead>\n <tr>\n <th class=\"prop-col\">Property</th>\n <th class=\"filter-col\">Filter</th>\n <th class=\"editable-col\">Edit</th>\n <th class=\"type-col\">Type</th>\n <th class=\"description-col\">Description</th>\n </tr>\n </thead>\n\n <tbody class=\"properties\">\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">id</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">INT</td>\n <td class=\"description-col\">Unique identifier</td>\n </tr>\n \n <tr class=\"ro\">\n <td class=\"prop-col\">card_refunded_amount</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">INT</td>\n <td class=\"description-col\">How much was refunded to a gift card.</td>\n </tr>\n \n <tr class=\"fil ro\">\n <td class=\"prop-col\">credit_applied</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">INT</td>\n <td class=\"description-col\"></td>\n </tr> \n \n <tr class=\"fil ro\">\n <td class=\"prop-col\">customer_id</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">INT</td>\n <td class=\"description-col\">Unique identifier for the customer</td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">financial_status</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">STRING</td>\n <td class=\"description-col\">The order's financial status <a href=\"http://docs.cratejoy.com/v2.0/docs/order#order-financial-status\">(See table below)</a></td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">fulfillment_status</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">STRING</td>\n <td class=\"description-col\">The fulfillment status--either 1 (unfulfilled), 2 (partial), or 3 (fulfilled)</td>\n </tr>\n \n <tr class=\"fil ro\">\n <td class=\"prop-col\">gift_card_discount</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">INT</td>\n <td class=\"description-col\"></td>\n </tr>\n \n <tr class=\"fil ro\">\n <td class=\"prop-col\">gift_message</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">STRING</td>\n <td class=\"description-col\">The gift message entered on checkout.</td>\n </tr>\n \n <tr class=\"fil ro\">\n <td class=\"prop-col\">gift_renewal_notif</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">BOOLEAN</td>\n <td class=\"description-col\"></td>\n </tr>\n \n <tr class=\"ro\">\n <td class=\"prop-col\">gross_shipping</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">INT</td>\n <td class=\"description-col\"></td>\n </tr> \n \n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">is_gift</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">BOOL</td>\n <td class=\"description-col\">Is this a gift order (Gifting 2 and 3 only!)</td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">is_renewal</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">BOOLEAN</td>\n <td class=\"description-col\">Note: This is false for \"Charge Immediately\" orders.</td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">is_test</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">BOOLEAN</td>\n <td class=\"description-col\"></td>\n </tr>\n\n <tr class=\"fil rw\">\n <td class=\"prop-col\">note</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">STRING</td>\n <td class=\"description-col\">Note on the order</td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">placed_at</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">DATETIME</td>\n <td class=\"description-col\"></td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">prorated_charge</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">INT</td>\n <td class=\"description-col\"></td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">refund_applied</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">INT</td>\n <td class=\"description-col\"></td>\n </tr>\n\n <tr class=\"ro\">\n <td class=\"prop-col\">refunded_amount</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">INT</td>\n <td class=\"description-col\"></td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">status</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">STRING</td>\n <td class=\"description-col\">Open (1) or Closed (2).</td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">store_id</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">INT</td>\n <td class=\"description-col\"></td>\n </tr>\n \n <tr class=\"fil ro\">\n <td class=\"prop-col\">sub_total</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">INT</td>\n <td class=\"description-col\"></td>\n </tr>\n \n <tr class=\"fil ro\">\n <td class=\"prop-col\">total</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">INT</td>\n <td class=\"description-col\"></td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">total_app_fees</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">INT</td>\n <td class=\"description-col\"></td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">total_label_cost</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">INT</td>\n <td class=\"description-col\"></td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">total_pending_fees</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">INT</td>\n <td class=\"description-col\"></td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">total_price</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">INT</td>\n <td class=\"description-col\"></td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">total_shipping</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">INT</td>\n <td class=\"description-col\"></td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">total_tax</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">INT</td>\n <td class=\"description-col\"></td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">transaction_fes</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">INT</td>\n <td class=\"description-col\"></td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">transaction_fee_status</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">INT</td>\n <td class=\"description-col\">1 (Paid), 2 (Pending Renewal), or 3 (Unpaid)</td>\n </tr>\n\n <tr class=\"ro\">\n <td class=\"prop-col\">type</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">STRING</td>\n <td class=\"description-col\">Always <code>order</code></td>\n </tr>\n\n <tr class=\"ro\">\n <td class=\"prop-col\">url</td>\n <td class=\"filter-col\"></td>\n <td class=\"editable-col\"></td>\n <td class=\"type-col\">STRING</td>\n <td class=\"description-col\"></td>\n </tr>\n\n </tbody>\n </table>\n</div>" } [/block] ## Relation Properties [block:parameters] { "data": { "h-0": "Property", "h-1": "Resource", "h-2": "Description", "0-0": "customer", "0-1": "[Customer](doc:customer-1)", "0-2": "The customer the order belongs to", "1-0": "products", "1-1": "[Cart Products](doc:cart-products)", "1-2": "A collection of CartProducts associated with the order", "h-3": "Filter?", "0-3": "Yes", "1-3": "Yes" }, "cols": 4, "rows": 2 } [/block] ## Additional Related Properties see [Working with Object Relationships](doc:working-with-object-relationships) [block:parameters] { "data": { "h-0": "Property", "h-1": "Resource", "h-2": "Description", "0-0": "cart", "0-1": "[Cart](doc:cart)", "1-0": "logs", "1-1": "OrderLog", "2-0": "gifts", "2-1": "", "3-0": "coupons", "3-1": "[Cart Coupon](doc:cart-coupon)", "4-0": "sent_gift", "5-0": "bill_address", "6-0": "ship_address", "7-0": "fulfillments", "5-1": "[Address](doc:customeraddress)", "6-1": "[Address](doc:customeraddress)", "7-1": "[Fulfillment](doc:fulfillment)", "8-0": "transactions", "8-1": "[Transaction](doc:transaction)", "9-0": "subscriptions", "9-1": "[Subscription](doc:subscription)", "10-0": "received_gift", "11-0": "referral_token", "2-2": "[Deprecated] \nGifting 1.0 products.", "h-3": "Filter?", "0-3": "Yes", "1-3": "Yes", "2-3": "Yes", "3-3": "Yes", "4-2": "[Deprecated] \nGifting 1.0 gift-giver.", "4-3": "Yes", "5-2": "The billing address for the order.", "3-2": "If available, the coupons applied to the order.", "0-2": "", "5-3": "Yes", "6-2": "The shipping address for the order.", "6-3": "Yes", "7-2": "The fulfillments associated with the order.", "7-3": "Yes", "8-2": "The transactions associated with the order", "9-2": "The subscriptions associated with the order.", "10-2": "[Deprecated] \nGifting 1.0 gift-recipient.", "8-3": "Yes", "10-3": "Yes", "11-3": "Yes", "9-3": "Yes" }, "cols": 4, "rows": 12 } [/block] The above properties on the order are references to another Cratejoy resource or another collection of Cratejoy resources. The properties can either be a URL to fetch the related resources OR contain the resources themselves [block:api-header] { "type": "basic", "title": "Order Financial Status" } [/block] To filter on financial_status, you'll need to filter using the integer values from this table: [block:parameters] { "data": { "0-0": "1", "0-1": "pending", "h-0": "Key", "h-1": "Status", "1-0": "2", "1-1": "authorized", "2-0": "3", "2-1": "partially_paid", "3-0": "4", "3-1": "paid", "4-0": "5", "4-1": "partially_refunded", "5-0": "6", "5-1": "refunded", "6-0": "7", "6-1": "voided" }, "cols": 2, "rows": 7 } [/block]