{"_id":"58112e73ded0340f0085d069","category":{"_id":"58112e72ded0340f0085d034","project":"551e85be610f400d00837db7","version":"58112e71ded0340f0085d02a","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-18T15:57:19.874Z","from_sync":false,"order":9,"slug":"api-subresources","title":"Merchant API Subresources"},"project":"551e85be610f400d00837db7","user":"55f2fd49b5b25021002b7dfd","__v":0,"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"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-18T16:16:47.471Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":8,"body":"http://api.cratejoy.com/v1/shipments/{ID}/?with=labels\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"ShippingLabel Properties\"\n}\n[/block]\n## ShippingLabel Summary Properties\n\nA shipping label has the following properties.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"0-0\": \"*id*\",\n    \"0-1\": \"Int\",\n    \"1-0\": \"*carrier*\",\n    \"1-1\": \"String\",\n    \"0-2\": \"Unique identifier\",\n    \"1-2\": \"e.g., \\\"USPS\\\"\",\n    \"h-2\": \"Description\",\n    \"h-1\": \"Type\",\n    \"2-0\": \"*created_at*\",\n    \"2-1\": \"Timestamp\",\n    \"2-2\": \"The time the label was created.\",\n    \"3-0\": \"*filetype*\",\n    \"3-1\": \"String\",\n    \"3-2\": \"e.g., \\\"image/png\\\"\",\n    \"4-0\": \"*financial_status*\",\n    \"4-1\": \"Int\",\n    \"4-2\": \"1 = Paid, 2 = Unpaid\",\n    \"5-0\": \"*is_test*\",\n    \"5-1\": \"Boolean\",\n    \"5-2\": \"Is it a test label?\",\n    \"6-0\": \"*is_void*\",\n    \"6-1\": \"Boolean\",\n    \"6-2\": \"Has it been voided?\",\n    \"7-0\": \"tracking\",\n    \"7-1\": \"String\",\n    \"7-2\": \"Tracking number.\",\n    \"8-0\": \"*street*\",\n    \"8-1\": \"String\",\n    \"8-2\": \"How many orders this customer has\",\n    \"9-0\": \"*url*\",\n    \"9-1\": \"String\",\n    \"9-2\": \"Direct download URL for the label.\",\n    \"10-0\": \"*cost*\",\n    \"10-1\": \"Int\",\n    \"10-2\": \"Cost in cents.\"\n  },\n  \"cols\": 3,\n  \"rows\": 11\n}\n[/block]\n*italics* - readonly property;   **bold** - may be used to filter collections","excerpt":"ShipmentLabel data object specification for the Cratejoy Merchant API.","slug":"shippinglabel","type":"basic","title":"Shipping Label"}

Shipping Label

ShipmentLabel data object specification for the Cratejoy Merchant API.

http://api.cratejoy.com/v1/shipments/{ID}/?with=labels [block:api-header] { "type": "basic", "title": "ShippingLabel Properties" } [/block] ## ShippingLabel Summary Properties A shipping label has the following properties. [block:parameters] { "data": { "h-0": "Property", "0-0": "*id*", "0-1": "Int", "1-0": "*carrier*", "1-1": "String", "0-2": "Unique identifier", "1-2": "e.g., \"USPS\"", "h-2": "Description", "h-1": "Type", "2-0": "*created_at*", "2-1": "Timestamp", "2-2": "The time the label was created.", "3-0": "*filetype*", "3-1": "String", "3-2": "e.g., \"image/png\"", "4-0": "*financial_status*", "4-1": "Int", "4-2": "1 = Paid, 2 = Unpaid", "5-0": "*is_test*", "5-1": "Boolean", "5-2": "Is it a test label?", "6-0": "*is_void*", "6-1": "Boolean", "6-2": "Has it been voided?", "7-0": "tracking", "7-1": "String", "7-2": "Tracking number.", "8-0": "*street*", "8-1": "String", "8-2": "How many orders this customer has", "9-0": "*url*", "9-1": "String", "9-2": "Direct download URL for the label.", "10-0": "*cost*", "10-1": "Int", "10-2": "Cost in cents." }, "cols": 3, "rows": 11 } [/block] *italics* - readonly property; **bold** - may be used to filter collections