{"_id":"58112e73ded0340f0085d076","project":"551e85be610f400d00837db7","__v":0,"user":"55253acaf0f4610d00f7193f","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,"category":{"_id":"58112e72ded0340f0085d030","version":"58112e71ded0340f0085d02a","project":"551e85be610f400d00837db7","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-25T20:14:44.667Z","from_sync":false,"order":4,"slug":"store-api-methods","title":"Store API Methods"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-21T04:43:57.088Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":5,"body":"_Methods for getting [Shipment](doc:shipment) data from the Store API._\n[block:html]\n{\n  \"html\": \"<div class=\\\"endpoint list\\\">\\n  <span class=\\\"method get\\\">GET</span>\\n  <span class=\\\"uri\\\">\\n    \\t\\t/v1/store/api/shipments/\\n  </span>\\n</div>\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<div class=\\\"endpoint list\\\">\\n  <span class=\\\"method get\\\">GET</span>\\n  <span class=\\\"uri\\\">\\n    /v1/store/api/shipments/{shipment_id}/\\n  </span>\\n</div>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$.get('/v1/store/api/shipments/');\",\n      \"language\": \"javascript\",\n      \"name\": \"List\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  count: 1,\\n  next: \\\"?page=1\\\",\\n  prev: null,\\n  results: [\\n    ...\\n  ]\\n}\",\n      \"language\": \"javascript\",\n      \"name\": \"200 OK\"\n    }\n  ]\n}\n[/block]\n# Get a shipment\n[block:html]\n{\n  \"html\": \"<div class=\\\"endpoint list\\\">\\n  <span class=\\\"method get\\\">GET</span>\\n  <span class=\\\"uri\\\">\\n\\t\\t/v1/store/api/shipments/\\n  </span>\\n</div>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$.get('/v1/store/api/shipments/75562100/');\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"adjusted_ordered_at\\\": \\\"2015-09-15T20:00:24Z\\\", \\n  \\\"created_at\\\": \\\"2015-09-15T20:00:24Z\\\", \\n  \\\"customer\\\": {\\n    \\\"country\\\": \\\"US\\\", \\n    \\\"email\\\": \\\"joey+2:::at:::cratejoy.com\\\", \\n    \\\"first_name\\\": \\\"Joey\\\", \\n    \\\"id\\\": 75561862, \\n    \\\"last_name\\\": \\\"Tallieu\\\", \\n    \\\"location\\\": \\\"TX, US\\\", \\n    \\\"name\\\": \\\"Joey Tallieu\\\", \\n    \\\"num_orders\\\": 21, \\n    \\\"num_subscriptions\\\": 21, \\n    \\\"store_settings\\\": null, \\n    \\\"subscription_status\\\": \\\"active\\\", \\n    \\\"total_revenue\\\": 26388, \\n    \\\"type\\\": \\\"customer\\\"\\n  }, \\n  \\\"fulfillments\\\": [\\n    {\\n      \\\"adjusted_fulfillment_date\\\": \\\"2015-09-15T20:00:24Z\\\", \\n      \\\"cycle_number\\\": 0, \\n      \\\"fulfillment_date\\\": \\\"2015-09-15T20:00:24Z\\\", \\n      \\\"id\\\": 75562099, \\n      \\\"instance\\\": {\\n        \\\"deleted\\\": false, \\n        \\\"gift\\\": false, \\n        \\\"id\\\": 55065963, \\n        \\\"images\\\": [], \\n        \\\"inventory\\\": null, \\n        \\\"price\\\": 0, \\n        \\\"product\\\": {\\n          \\\"deleted\\\": false, \\n          \\\"id\\\": 55065957, \\n          \\\"name\\\": \\\"My Product with Options\\\", \\n          \\\"single_purchasable\\\": false\\n        }, \\n        \\\"product_id\\\": 55065957, \\n        \\\"ship_weight\\\": 2.0, \\n        \\\"sku\\\": \\\"SQ1595281\\\", \\n        \\\"term_prices\\\": [\\n          {\\n            \\\"id\\\": 55065969, \\n            \\\"price\\\": 1200, \\n            \\\"term_id\\\": 55065958, \\n            \\\"type\\\": \\\"product_instance_subscription_type_term_price\\\"\\n          }, \\n          {\\n            \\\"id\\\": 55065970, \\n            \\\"price\\\": 3000, \\n            \\\"term_id\\\": 55065959, \\n            \\\"type\\\": \\\"product_instance_subscription_type_term_price\\\"\\n          }, \\n          {\\n            \\\"id\\\": 55065971, \\n            \\\"price\\\": 0, \\n            \\\"term_id\\\": 55065960, \\n            \\\"type\\\": \\\"product_instance_subscription_type_term_price\\\"\\n          }, \\n          {\\n            \\\"id\\\": 55065972, \\n            \\\"price\\\": 0, \\n            \\\"term_id\\\": 55065961, \\n            \\\"type\\\": \\\"product_instance_subscription_type_term_price\\\"\\n          }\\n        ], \\n        \\\"type\\\": \\\"product_instance\\\", \\n        \\\"variants\\\": [\\n          {\\n            \\\"id\\\": 55065981, \\n            \\\"product_instance_id\\\": 55065963, \\n            \\\"product_variant_type_id\\\": 55065962, \\n            \\\"product_variant_value_id\\\": 55065966, \\n            \\\"type\\\": \\\"product_instance_variant\\\", \\n            \\\"variant_type\\\": {\\n              \\\"description\\\": \\\"\\\", \\n              \\\"id\\\": 55065962, \\n              \\\"name\\\": \\\"size\\\", \\n              \\\"product_id\\\": 55065957, \\n              \\\"type\\\": \\\"product_variant_type\\\", \\n              \\\"values\\\": [\\n                {\\n                  \\\"description\\\": null, \\n                  \\\"id\\\": 55065966, \\n                  \\\"images\\\": [], \\n                  \\\"is_default\\\": false, \\n                  \\\"product_variant_type_id\\\": 55065962, \\n                  \\\"type\\\": \\\"product_variant_value\\\", \\n                  \\\"value\\\": \\\"Small\\\"\\n                }, \\n                {\\n                  \\\"description\\\": null, \\n                  \\\"id\\\": 55065967, \\n                  \\\"images\\\": [], \\n                  \\\"is_default\\\": false, \\n                  \\\"product_variant_type_id\\\": 55065962, \\n                  \\\"type\\\": \\\"product_variant_value\\\", \\n                  \\\"value\\\": \\\"Medium\\\"\\n                }, \\n                {\\n                  \\\"description\\\": null, \\n                  \\\"id\\\": 55065968, \\n                  \\\"images\\\": [], \\n                  \\\"is_default\\\": false, \\n                  \\\"product_variant_type_id\\\": 55065962, \\n                  \\\"type\\\": \\\"product_variant_value\\\", \\n                  \\\"value\\\": \\\"Large\\\"\\n                }\\n              ]\\n            }, \\n            \\\"variant_value\\\": {\\n              \\\"description\\\": null, \\n              \\\"id\\\": 55065966, \\n              \\\"is_default\\\": false, \\n              \\\"product_variant_type_id\\\": 55065962, \\n              \\\"type\\\": \\\"product_variant_value\\\", \\n              \\\"value\\\": \\\"Small\\\"\\n            }\\n          }\\n        ]\\n      }, \\n      \\\"is_test\\\": true, \\n      \\\"order\\\": {\\n        \\\"customer\\\": {\\n          \\\"country\\\": \\\"US\\\", \\n          \\\"email\\\": \\\"joey+2@cratejoy.com\\\", \\n          \\\"first_name\\\": \\\"Joey\\\", \\n          \\\"id\\\": 75561862, \\n          \\\"last_name\\\": \\\"Tallieu\\\", \\n          \\\"location\\\": \\\"TX, US\\\", \\n          \\\"name\\\": \\\"Joey Tallieu\\\", \\n          \\\"num_orders\\\": 21, \\n          \\\"num_subscriptions\\\": 21, \\n          \\\"subscription_status\\\": \\\"active\\\", \\n          \\\"total_revenue\\\": 26388, \\n          \\\"type\\\": \\\"customer\\\"\\n        }, \\n        \\\"customer_id\\\": 75561862, \\n        \\\"financial_status\\\": \\\"paid\\\", \\n        \\\"fulfillment_status\\\": \\\"fulfilled\\\", \\n        \\\"id\\\": 75562090, \\n        \\\"is_renewal\\\": false, \\n        \\\"is_test\\\": true, \\n        \\\"note\\\": null, \\n        \\\"placed_at\\\": \\\"2015-09-15T20:00:24Z\\\", \\n        \\\"prorated_charge\\\": null, \\n        \\\"received_gift\\\": null, \\n        \\\"refund_applied\\\": null, \\n        \\\"refunded_amount\\\": 0, \\n        \\\"sent_gift\\\": null, \\n        \\\"status\\\": \\\"closed\\\", \\n        \\\"store_id\\\": 4848355, \\n        \\\"subscriptions\\\": [\\n          {\\n            \\\"autorenew\\\": true, \\n            \\\"billing\\\": {\\n              \\\"id\\\": 55065955, \\n              \\\"rebill_day\\\": 1, \\n              \\\"rebill_months\\\": 1, \\n              \\\"rebill_weeks\\\": null, \\n              \\\"rebill_window\\\": 10, \\n              \\\"store_id\\\": 4848355, \\n              \\\"type\\\": \\\"product_billing\\\"\\n            }, \\n            \\\"credit\\\": null, \\n            \\\"customer\\\": {\\n              \\\"country\\\": \\\"US\\\", \\n              \\\"email\\\": \\\"joey+2@cratejoy.com\\\", \\n              \\\"first_name\\\": \\\"Joey\\\", \\n              \\\"id\\\": 75561862, \\n              \\\"last_name\\\": \\\"Tallieu\\\", \\n              \\\"location\\\": \\\"TX, US\\\", \\n              \\\"name\\\": \\\"Joey Tallieu\\\", \\n              \\\"num_orders\\\": 21, \\n              \\\"num_subscriptions\\\": 21, \\n              \\\"subscription_status\\\": \\\"active\\\", \\n              \\\"total_revenue\\\": 26388, \\n              \\\"type\\\": \\\"customer\\\"\\n            }, \\n            \\\"end_date\\\": \\\"2015-09-15T20:00:24Z\\\", \\n            \\\"id\\\": 75562094, \\n            \\\"is_test\\\": true, \\n            \\\"note\\\": null, \\n            \\\"product_billing_id\\\": 55065955, \\n            \\\"revenue\\\": 1200, \\n            \\\"skipped_date\\\": null, \\n            \\\"start_date\\\": \\\"2015-09-15T20:00:24Z\\\", \\n            \\\"status\\\": \\\"active\\\", \\n            \\\"store_id\\\": 4848355, \\n            \\\"term\\\": {\\n              \\\"description\\\": \\\"Charged every month\\\", \\n              \\\"enabled\\\": true, \\n              \\\"id\\\": 55065958, \\n              \\\"name\\\": \\\"Month to Month\\\", \\n              \\\"num_cycles\\\": 1, \\n              \\\"type\\\": \\\"subscription_type_term\\\"\\n            }, \\n            \\\"type\\\": \\\"subscription\\\"\\n          }\\n        ], \\n        \\\"total\\\": 1200, \\n        \\\"total_app_fees\\\": null, \\n        \\\"total_label_cost\\\": null, \\n        \\\"total_pending_fees\\\": null, \\n        \\\"total_price\\\": 1200, \\n        \\\"total_shipping\\\": 0, \\n        \\\"total_tax\\\": 0, \\n        \\\"transaction_fee\\\": 0, \\n        \\\"transaction_fee_status\\\": null, \\n        \\\"type\\\": \\\"order\\\"\\n      }, \\n      \\\"shipment_id\\\": 75562100, \\n      \\\"shipping\\\": 0, \\n      \\\"status\\\": \\\"open\\\", \\n      \\\"subscription_id\\\": 75562094, \\n      \\\"tax\\\": 0, \\n      \\\"test\\\": true, \\n      \\\"total_cycles\\\": 1, \\n      \\\"type\\\": \\\"fulfillment\\\"\\n    }\\n  ], \\n  \\\"id\\\": 75562100, \\n  \\\"is_test\\\": true, \\n  \\\"labels\\\": [], \\n  \\\"ship_address\\\": {\\n    \\\"city\\\": \\\"Minnesota\\\", \\n    \\\"company\\\": \\\"\\\", \\n    \\\"country\\\": \\\"US\\\", \\n    \\\"icon\\\": \\\"United-States.png\\\", \\n    \\\"id\\\": 75561864, \\n    \\\"phone_number\\\": \\\"\\\", \\n    \\\"state\\\": \\\"TX\\\", \\n    \\\"status\\\": 0, \\n    \\\"status_message\\\": null, \\n    \\\"street\\\": \\\"101 Brazos St\\\", \\n    \\\"to\\\": \\\"Joey Tallieu\\\", \\n    \\\"type\\\": \\\"address\\\", \\n    \\\"unit\\\": \\\"\\\", \\n    \\\"zip_code\\\": \\\"78701\\\"\\n  }, \\n  \\\"shipped_at\\\": null, \\n  \\\"status\\\": \\\"unshipped\\\",\\n  \\\"tracking_number\\\": null, \\n  \\\"type\\\": \\\"shipment\\\"\\n}\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"shipment-methods","type":"basic","title":"Shipment Methods"}
_Methods for getting [Shipment](doc:shipment) data from the Store API._ [block:html] { "html": "<div class=\"endpoint list\">\n <span class=\"method get\">GET</span>\n <span class=\"uri\">\n \t\t/v1/store/api/shipments/\n </span>\n</div>" } [/block] [block:html] { "html": "<div class=\"endpoint list\">\n <span class=\"method get\">GET</span>\n <span class=\"uri\">\n /v1/store/api/shipments/{shipment_id}/\n </span>\n</div>" } [/block] [block:code] { "codes": [ { "code": "$.get('/v1/store/api/shipments/');", "language": "javascript", "name": "List" } ] } [/block] [block:code] { "codes": [ { "code": "{\n count: 1,\n next: \"?page=1\",\n prev: null,\n results: [\n ...\n ]\n}", "language": "javascript", "name": "200 OK" } ] } [/block] # Get a shipment [block:html] { "html": "<div class=\"endpoint list\">\n <span class=\"method get\">GET</span>\n <span class=\"uri\">\n\t\t/v1/store/api/shipments/\n </span>\n</div>" } [/block] [block:code] { "codes": [ { "code": "$.get('/v1/store/api/shipments/75562100/');", "language": "javascript" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"adjusted_ordered_at\": \"2015-09-15T20:00:24Z\", \n \"created_at\": \"2015-09-15T20:00:24Z\", \n \"customer\": {\n \"country\": \"US\", \n \"email\": \"joey+2@cratejoy.com\", \n \"first_name\": \"Joey\", \n \"id\": 75561862, \n \"last_name\": \"Tallieu\", \n \"location\": \"TX, US\", \n \"name\": \"Joey Tallieu\", \n \"num_orders\": 21, \n \"num_subscriptions\": 21, \n \"store_settings\": null, \n \"subscription_status\": \"active\", \n \"total_revenue\": 26388, \n \"type\": \"customer\"\n }, \n \"fulfillments\": [\n {\n \"adjusted_fulfillment_date\": \"2015-09-15T20:00:24Z\", \n \"cycle_number\": 0, \n \"fulfillment_date\": \"2015-09-15T20:00:24Z\", \n \"id\": 75562099, \n \"instance\": {\n \"deleted\": false, \n \"gift\": false, \n \"id\": 55065963, \n \"images\": [], \n \"inventory\": null, \n \"price\": 0, \n \"product\": {\n \"deleted\": false, \n \"id\": 55065957, \n \"name\": \"My Product with Options\", \n \"single_purchasable\": false\n }, \n \"product_id\": 55065957, \n \"ship_weight\": 2.0, \n \"sku\": \"SQ1595281\", \n \"term_prices\": [\n {\n \"id\": 55065969, \n \"price\": 1200, \n \"term_id\": 55065958, \n \"type\": \"product_instance_subscription_type_term_price\"\n }, \n {\n \"id\": 55065970, \n \"price\": 3000, \n \"term_id\": 55065959, \n \"type\": \"product_instance_subscription_type_term_price\"\n }, \n {\n \"id\": 55065971, \n \"price\": 0, \n \"term_id\": 55065960, \n \"type\": \"product_instance_subscription_type_term_price\"\n }, \n {\n \"id\": 55065972, \n \"price\": 0, \n \"term_id\": 55065961, \n \"type\": \"product_instance_subscription_type_term_price\"\n }\n ], \n \"type\": \"product_instance\", \n \"variants\": [\n {\n \"id\": 55065981, \n \"product_instance_id\": 55065963, \n \"product_variant_type_id\": 55065962, \n \"product_variant_value_id\": 55065966, \n \"type\": \"product_instance_variant\", \n \"variant_type\": {\n \"description\": \"\", \n \"id\": 55065962, \n \"name\": \"size\", \n \"product_id\": 55065957, \n \"type\": \"product_variant_type\", \n \"values\": [\n {\n \"description\": null, \n \"id\": 55065966, \n \"images\": [], \n \"is_default\": false, \n \"product_variant_type_id\": 55065962, \n \"type\": \"product_variant_value\", \n \"value\": \"Small\"\n }, \n {\n \"description\": null, \n \"id\": 55065967, \n \"images\": [], \n \"is_default\": false, \n \"product_variant_type_id\": 55065962, \n \"type\": \"product_variant_value\", \n \"value\": \"Medium\"\n }, \n {\n \"description\": null, \n \"id\": 55065968, \n \"images\": [], \n \"is_default\": false, \n \"product_variant_type_id\": 55065962, \n \"type\": \"product_variant_value\", \n \"value\": \"Large\"\n }\n ]\n }, \n \"variant_value\": {\n \"description\": null, \n \"id\": 55065966, \n \"is_default\": false, \n \"product_variant_type_id\": 55065962, \n \"type\": \"product_variant_value\", \n \"value\": \"Small\"\n }\n }\n ]\n }, \n \"is_test\": true, \n \"order\": {\n \"customer\": {\n \"country\": \"US\", \n \"email\": \"joey+2@cratejoy.com\", \n \"first_name\": \"Joey\", \n \"id\": 75561862, \n \"last_name\": \"Tallieu\", \n \"location\": \"TX, US\", \n \"name\": \"Joey Tallieu\", \n \"num_orders\": 21, \n \"num_subscriptions\": 21, \n \"subscription_status\": \"active\", \n \"total_revenue\": 26388, \n \"type\": \"customer\"\n }, \n \"customer_id\": 75561862, \n \"financial_status\": \"paid\", \n \"fulfillment_status\": \"fulfilled\", \n \"id\": 75562090, \n \"is_renewal\": false, \n \"is_test\": true, \n \"note\": null, \n \"placed_at\": \"2015-09-15T20:00:24Z\", \n \"prorated_charge\": null, \n \"received_gift\": null, \n \"refund_applied\": null, \n \"refunded_amount\": 0, \n \"sent_gift\": null, \n \"status\": \"closed\", \n \"store_id\": 4848355, \n \"subscriptions\": [\n {\n \"autorenew\": true, \n \"billing\": {\n \"id\": 55065955, \n \"rebill_day\": 1, \n \"rebill_months\": 1, \n \"rebill_weeks\": null, \n \"rebill_window\": 10, \n \"store_id\": 4848355, \n \"type\": \"product_billing\"\n }, \n \"credit\": null, \n \"customer\": {\n \"country\": \"US\", \n \"email\": \"joey+2@cratejoy.com\", \n \"first_name\": \"Joey\", \n \"id\": 75561862, \n \"last_name\": \"Tallieu\", \n \"location\": \"TX, US\", \n \"name\": \"Joey Tallieu\", \n \"num_orders\": 21, \n \"num_subscriptions\": 21, \n \"subscription_status\": \"active\", \n \"total_revenue\": 26388, \n \"type\": \"customer\"\n }, \n \"end_date\": \"2015-09-15T20:00:24Z\", \n \"id\": 75562094, \n \"is_test\": true, \n \"note\": null, \n \"product_billing_id\": 55065955, \n \"revenue\": 1200, \n \"skipped_date\": null, \n \"start_date\": \"2015-09-15T20:00:24Z\", \n \"status\": \"active\", \n \"store_id\": 4848355, \n \"term\": {\n \"description\": \"Charged every month\", \n \"enabled\": true, \n \"id\": 55065958, \n \"name\": \"Month to Month\", \n \"num_cycles\": 1, \n \"type\": \"subscription_type_term\"\n }, \n \"type\": \"subscription\"\n }\n ], \n \"total\": 1200, \n \"total_app_fees\": null, \n \"total_label_cost\": null, \n \"total_pending_fees\": null, \n \"total_price\": 1200, \n \"total_shipping\": 0, \n \"total_tax\": 0, \n \"transaction_fee\": 0, \n \"transaction_fee_status\": null, \n \"type\": \"order\"\n }, \n \"shipment_id\": 75562100, \n \"shipping\": 0, \n \"status\": \"open\", \n \"subscription_id\": 75562094, \n \"tax\": 0, \n \"test\": true, \n \"total_cycles\": 1, \n \"type\": \"fulfillment\"\n }\n ], \n \"id\": 75562100, \n \"is_test\": true, \n \"labels\": [], \n \"ship_address\": {\n \"city\": \"Minnesota\", \n \"company\": \"\", \n \"country\": \"US\", \n \"icon\": \"United-States.png\", \n \"id\": 75561864, \n \"phone_number\": \"\", \n \"state\": \"TX\", \n \"status\": 0, \n \"status_message\": null, \n \"street\": \"101 Brazos St\", \n \"to\": \"Joey Tallieu\", \n \"type\": \"address\", \n \"unit\": \"\", \n \"zip_code\": \"78701\"\n }, \n \"shipped_at\": null, \n \"status\": \"unshipped\",\n \"tracking_number\": null, \n \"type\": \"shipment\"\n}", "language": "javascript" } ] } [/block]