{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","params":[],"results":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"Shipment Stats","type":"basic","slug":"shipment-stats","excerpt":"Shipment Stats object specification for the Cratejoy Merchant API","body":"# Properties \n[block:html]\n{\n  \"html\": \"\\n<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\\\">customer_cycle</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\\\">This is the <i>n</i>th shipment the customer has had, across all their subscriptions.</td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">subscription_cycle</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\\\">This is the <i>n</i>th shipment the customer has had on <em>this</em> subscription. (null for non-subscription shipments)</td>\\n            </tr>\\n\\n            <tr class=\\\"fil ro\\\">\\n                <td class=\\\"prop-col\\\">has_addon</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\\\">Whether there's an add-on product included in the shipment.</td>\\n            </tr>\\n            </tbody>\\n    </table>\\n</div>\\n\\n\"\n}\n[/block]\n*italics* - readonly property;   **bold** - may be used to filter collections","updates":[],"order":999,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"60bfe2bb33ec11002a82543f","createdAt":"2021-06-08T21:35:55.114Z","user":"55694ec671f3960d00b1e754","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Merchant API Subresources","slug":"api-subresources","order":9,"from_sync":false,"reference":false,"_id":"58112e72ded0340f0085d034","project":"551e85be610f400d00837db7","version":"58112e71ded0340f0085d02a","__v":0,"createdAt":"2015-09-18T15:57:19.874Z"},"version":{"version":"2.0","version_clean":"2.0.0","codename":"new designer","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["58112e72ded0340f0085d02b","58112e72ded0340f0085d02c","58112e72ded0340f0085d02d","58112e72ded0340f0085d02e","58112e72ded0340f0085d02f","58112e72ded0340f0085d030","58112e72ded0340f0085d031","58112e72ded0340f0085d032","58112e72ded0340f0085d033","58112e72ded0340f0085d034","581137cc604d3c230048b7e4","58dc367221742d0f00a73f98","590768e54669da0f00db5c0b"],"_id":"58112e71ded0340f0085d02a","createdAt":"2016-10-26T22:30:09.862Z","project":"551e85be610f400d00837db7","releaseDate":"2016-10-26T22:30:09.862Z","__v":4},"project":"551e85be610f400d00837db7","__v":0}

Shipment Stats

Shipment Stats object specification for the Cratejoy Merchant API

# Properties [block:html] { "html": "\n<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\">customer_cycle</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\">This is the <i>n</i>th shipment the customer has had, across all their subscriptions.</td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">subscription_cycle</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\">This is the <i>n</i>th shipment the customer has had on <em>this</em> subscription. (null for non-subscription shipments)</td>\n </tr>\n\n <tr class=\"fil ro\">\n <td class=\"prop-col\">has_addon</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\">Whether there's an add-on product included in the shipment.</td>\n </tr>\n </tbody>\n </table>\n</div>\n\n" } [/block] *italics* - readonly property; **bold** - may be used to filter collections