{"_id":"575676128749830e00681e9a","parentDoc":null,"__v":0,"user":"555b35be8e87d01900b8049e","version":{"_id":"575676128749830e00681e82","__v":2,"project":"55a4d5531a5f991700a9409e","createdAt":"2016-06-07T07:21:54.005Z","releaseDate":"2016-06-07T07:21:54.005Z","categories":["575676128749830e00681e83","575676128749830e00681e84","575676128749830e00681e85","575676128749830e00681e86","575676128749830e00681e87","575676128749830e00681e88","575676128749830e00681e89","575676128749830e00681e8a","575676128749830e00681e8b","580c5ff36c35230f003d3b49"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"project":"55a4d5531a5f991700a9409e","category":{"_id":"575676128749830e00681e83","__v":0,"version":"575676128749830e00681e82","project":"55a4d5531a5f991700a9409e","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-07-14T09:24:36.519Z","from_sync":false,"order":0,"slug":"setup","title":"urb-it as delivery method"},"updates":["56d58d055acf9f0b00f7365e"],"next":{"pages":[],"description":""},"createdAt":"2015-07-17T10:52:28.409Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"","code":"","language":"json"}]},"method":"post","results":{"codes":[]},"settings":"57bc0cc860d92e0e0079e564","auth":"required","params":[],"url":"/v2/orders"},"isReference":true,"order":3,"body":"This endpoint creates a new urb-it order. The [Validate delivery](doc:validate-delivery)  is called before the order is created, As described in the [Getting Started with Retailer API](doc:getting-started)  section the authorization header needs to be present.\n\nCurrently two order types are available:\n  * \t“Onehour” meaning that the order will be delivered within one hour.\n  * \t“Specific” meaning that the order will be delivered at a specific date and time that is specified in the delivery_expected_at parameter.\n\nSeveral delivery options are available. “StoreToConsumer” is one of the most common. This options should be used when the items are picked up from a store and delivered to the customer.  “ConsumerToStore” is when the items are picked up from a customer and delivered to store. This two delivery option can be linked together by creating two urb-it orders(one ConsumerToStore ) with the same retailer_reference_id. In case of a present, the beneficiary field should contain the address and contact information of the person that should receive the items. In case the beneficiary field is missing the consumer field is used as delivery address.\n\n\n**Request Parameters Information**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Constraints\",\n    \"0-2\": \"string(max)\",\n    \"0-1\": \"string\",\n    \"0-0\": \"retailer_reference_id\\n*required*\",\n    \"2-0\": \"store_location\\n*required*\",\n    \"2-1\": \"[Delivery Type](doc:delivery-type)\",\n    \"2-2\": \"[Delivery Type](doc:delivery-type)\",\n    \"4-0\": \"delivery_expected_at\\n*required*\",\n    \"4-1\": \"datetime\",\n    \"4-2\": \"2015-07-17T09:00:07+02:00\",\n    \"3-0\": \"order_direction\\n*required*\",\n    \"3-2\": \"[Order Direction](doc:order-direction)\",\n    \"5-0\": \"store_location\\n*required*\",\n    \"5-2\": \"[Store Location](doc:store-location)\",\n    \"6-0\": \"consumer\\n*required*\",\n    \"7-0\": \"beneficiary\\n*optional*\",\n    \"7-2\": \"[Consumer](doc:consumer)\",\n    \"8-0\": \"articles\\n*required*\",\n    \"8-2\": \"[Article](doc:article) []\",\n    \"9-0\": \"require_id_card\\n*optional*\",\n    \"10-0\": \"total_amount_excl_vat\\n*required*\",\n    \"10-2\": \"decimal\",\n    \"9-2\": \"boolean\",\n    \"9-1\": \"boolean\",\n    \"10-1\": \"decimal\",\n    \"8-1\": \"[Article](doc:article) []\",\n    \"5-1\": \"[Store Location](doc:store-location)\",\n    \"6-1\": \"[Consumer](doc:consumer)\",\n    \"7-1\": \"[Consumer](doc:consumer)\",\n    \"3-1\": \"[Order Direction](doc:order-direction)\",\n    \"6-2\": \"[Consumer](doc:consumer)\",\n    \"h-3\": \"Description\",\n    \"0-3\": \"Retailer reference for the order\\nMost likely the retailer order identifier\",\n    \"2-3\": \"The available delivery types are described here: [Delivery Type](doc:delivery-type)\",\n    \"3-3\": \"The order direction. ex: store to consumer/ consumer to store\",\n    \"4-3\": \"The expected date and time of the delivery.\\n\\nBy default the API datetime input uses Universal Time Coordinated (UTC). To offset the UTC, use plus or minus 00:00 in your API call. \\nThis allows you to input times in a different time zone; however, this does not modify the output times, which are always UTC..\",\n    \"5-3\": \"The preferred Store location where the Associate should go to pickup/deliver the order, if no storie pickup location provided the closest to the customer will be used as pickup location.\",\n    \"6-3\": \"The person that placed the order.\",\n    \"7-3\": \"The person that will receive the delivery. If not specified the consumer will be sett as beneficiary.\",\n    \"8-3\": \"The list of articles that should be delivered.\",\n    \"9-3\": \"Does the consumer have to show an id-card when the order is handed-over.\",\n    \"10-3\": \"Total price for the order excluding VAT.\",\n    \"1-0\": \"delivery_type\\n*required*\",\n    \"1-1\": \"[Delivery Type](doc:delivery-type)\",\n    \"1-2\": \"[Delivery Type](doc:delivery-type)\",\n    \"1-3\": \"The available delivery types are described here: [Delivery Type](doc:delivery-type)\",\n    \"11-0\": \"total_amount\\n*required*\",\n    \"11-1\": \"decimal\",\n    \"11-2\": \"decimal\",\n    \"11-3\": \"Total price for the order.\",\n    \"12-0\": \"require_delivery_confirmation\\n*required*\",\n    \"12-1\": \"boolean\",\n    \"12-2\": \"boolean\",\n    \"12-3\": \"Set to true, if the consumer wants the beneficiary person to confirm the delivery.\"\n  },\n  \"cols\": 4,\n  \"rows\": 13\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Important\",\n  \"body\": \"Opening hours can be configured in the Retailer Portal. If set, delivery_expected_at will be validated against those hours.\\n\\nIf no opening hours configured in Retailer Portal, no opening hours validation will be made. We assume that the expected delivery date is validated against the retailers opening hours at the client. \\nThe store pickup location is open at least one hour before the specified date and time.\"\n}\n[/block]\n** Response Parameters **\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Constraints\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"order_number\",\n    \"0-1\": \"int\",\n    \"0-2\": \"int\",\n    \"0-3\": \"The order number of the created order.\",\n    \"1-0\": \"order_id\",\n    \"1-1\": \"string\",\n    \"1-2\": \"Guid\",\n    \"1-3\": \"The guid representation of the created order. This works as an exact identification for the new order.\",\n    \"2-0\": \"reference_id\",\n    \"2-1\": \"string\",\n    \"2-2\": \"string\",\n    \"2-3\": \"A string representation of the reference_id for the give order.\",\n    \"3-0\": \"order_type\",\n    \"3-1\": \"string\",\n    \"3-2\": \"string\",\n    \"3-3\": \"The orders type, can be \\\"now\\\", \\\"asap\\\" or \\\"Specific\\\"\",\n    \"4-0\": \"order_items\",\n    \"4-1\": \"object[]\",\n    \"4-2\": \"object order_items[]\",\n    \"4-3\": \"Array of order items containing the information of all items in the order.\",\n    \"5-0\": \"delivery\",\n    \"5-1\": \"[Order Delivery](doc:order-delivery)\",\n    \"5-2\": \"[Order Delivery](doc:order-delivery)\",\n    \"5-3\": \"Array of order delivery.\\nSee [Order Delivery](doc:order-delivery) for specifics.\",\n    \"6-0\": \"pickup_location\",\n    \"6-1\": \"object\",\n    \"6-2\": \"object pickup_location\",\n    \"6-3\": \"Array of pickup locations included in the order.\",\n    \"7-0\": \"created_at\",\n    \"7-1\": \"datetime\",\n    \"7-2\": \"datetime\",\n    \"7-3\": \"DateTime object of creation time and date.\",\n    \"8-0\": \"modified_at\",\n    \"8-1\": \"datetime\",\n    \"8-2\": \"datetime\",\n    \"8-3\": \"DateTime object of when the order was last modified.\",\n    \"9-0\": \"total_amount_excl_vat\",\n    \"9-1\": \"decimal\",\n    \"9-2\": \"decimal\",\n    \"9-3\": \"Decimal value of the total amount, vat excluded.\",\n    \"10-0\": \"order_consumer\",\n    \"10-1\": \"object\",\n    \"10-2\": \"object order_consumer\",\n    \"10-3\": \"Array of the order_consumer object.\"\n  },\n  \"cols\": 4,\n  \"rows\": 11\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example Request\"\n}\n[/block]\n** Sample HTTP Request Header **\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST https://stage-retailer-api.urb-it.com/api/order HTTP/1.1\\nAccept-Encoding: gzip,deflate\\nContent-Type: application/json;charset=UTF-8\\nAuthorization: UWA b0477a45-1198-419f-b159-e484be341512:DNX22veCTbges6DH9n67TAAzSa0jFE0qOtJBstvIdyU=:48e0e16-cbc9-4953-ad33-f3d17c5330dc:1444981142\\nHost: stage-retailer-api.urb-it.com\\nContent-Type: application/json\\nCache-Control: no-cache\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n** Sample Request Body **\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"retailer_reference_id\\\": \\\"ABC123\\\",\\n  \\\"delivery_type\\\": \\\"OneHour\\\",\\n  \\\"postal_code\\\": \\\"11123\\\",\\n  \\\"delivery_expected_at\\\": \\\"2015-07-17T09:00:07+02:00\\\",\\n  \\\"order_direction\\\": \\\"StoreToConsumer\\\",\\n  \\\"store_location\\\": {\\n    \\\"id\\\": \\\"\\\"\\n  },\\n  \\\"articles\\\": [\\n    {\\n      \\\"identifier\\\": \\\"123TEST\\\",\\n      \\\"quantity\\\": 1,\\n      \\\"description\\\": \\\"Apple iphone 6\\\"\\n    },\\n    {\\n      \\\"identifier\\\": \\\"122TEST\\\",\\n      \\\"quantity\\\": 3,\\n      \\\"description\\\": \\\"Laddnings kabel\\\"\\n    }\\n  ],\\n  \\\"consumer\\\": {\\n    \\\"address\\\": {\\n      \\\"street\\\": \\\"Kungsgatan 20\\\",\\n      \\\"postal_code\\\": \\\"11442\\\",\\n      \\\"city\\\": \\\"Stockholm\\\",\\n      \\\"country\\\": \\\"Sweden\\\",\\n      \\\"care_of\\\": \\\"Josip\\\",\\n      \\\"street2\\\": \\\"andralånggatan\\\",\\n      \\\"company_name\\\":\\\"star republic AB\\\"\\n    },\\n    \\\"first_name\\\": \\\"Jonas\\\",\\n    \\\"last_name\\\": \\\"Bengtsson\\\",\\n    \\\"email\\\": \\\"test:::at:::urb-it.com\\\",\\n    \\\"cell_phone\\\": \\\"+467070707\\\",\\n    \\\"consumer_comment\\\": \\\"First floor, door code is 4433\\\"\\n  },\\n  \\\"total_amount_excl_vat\\\": 999.5,\\n  \\\"total_amount\\\": 1050,\\n  \\\"require_delivery_confirmation\\\" : false\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example Response\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"order_number\\\": 11616,\\n  \\\"order_id\\\": \\\"17f68d64-57b7-47cd-b367-20fa52ad2375\\\",\\n  \\\"reference_id\\\": \\\"10001awaw1sad11asq21q2103232\\\",\\n  \\\"order_type\\\": \\\"now\\\",\\n  \\\"order_items\\\": [\\n    {\\n      \\\"id\\\": 0,\\n      \\\"retailer_reference_id\\\": \\\"123TEST\\\",\\n      \\\"item_description\\\": \\\"Apple iphone 6\\\",\\n      \\\"quantity\\\": 1,\\n      \\\"pickup_ready\\\": false,\\n      \\\"user_id\\\": null\\n    },\\n    {\\n      \\\"id\\\": 0,\\n      \\\"retailer_reference_id\\\": \\\"122TEST\\\",\\n      \\\"item_description\\\": \\\"Laddnings kabel\\\",\\n      \\\"quantity\\\": 3,\\n      \\\"pickup_ready\\\": false,\\n      \\\"user_id\\\": null\\n    }\\n  ],\\n  \\\"delivery\\\": {\\n    \\\"location_type\\\": \\\"Consumer\\\",\\n    \\\"address\\\": {\\n      \\\"street\\\": \\\"Kungsgatan 20\\\",\\n      \\\"postal_code\\\": \\\"11442\\\",\\n      \\\"city\\\": \\\"Stockholm\\\",\\n      \\\"country\\\": \\\"Sweden\\\",\\n      \\\"position\\\": {\\n        \\\"longitude\\\": 18.0681399,\\n        \\\"latitude\\\": 59.3359963\\n      },\\n      \\\"street2\\\": \\\"andralånggattan\\\",\\n      \\\"care_of\\\": \\\"Josip\\\",\\n      \\\"company_name\\\": \\\"star republic ab\\\"\\n    },\\n    \\\"first_name\\\": \\\"Jonas\\\",\\n    \\\"last_name\\\": \\\"Bengtsson\\\",\\n    \\\"email\\\": \\\"[email protected]\\\",\\n    \\\"cell_phone\\\": \\\"+46768670234\\\",\\n    \\\"phone\\\": null,\\n    \\\"name\\\": null,\\n    \\\"store_location_id\\\": null,\\n    \\\"consumer_comment\\\": \\\"First floor, door code is 4433\\\",\\n    \\\"expected_delivery_at\\\": \\\"2015-07-17T09:00:07.1670501\\\",\\n    \\\"original_expected_delivery_at\\\": \\\"2015-07-17T08:50:07.1670501\\\",\\n    \\\"delivered_at\\\": null,\\n    \\\"authentication_code\\\": \\\"N0ZDQ4\\\",\\n    \\\"consumer_rating\\\": null\\n  },\\n  \\\"pickup_location\\\": {\\n    \\\"location_type\\\": \\\"Store\\\",\\n    \\\"store_location_id\\\": \\\"61e3dca6-dd2d-4789-ba75-77bad74971c4\\\",\\n    \\\"address\\\": {\\n      \\\"street\\\": \\\"Kungsgatan 37\\\",\\n      \\\"postal_code\\\": \\\"11157\\\",\\n      \\\"city\\\": \\\"Stockholm\\\",\\n      \\\"country\\\": \\\"Sverige\\\",\\n      \\\"position\\\": {\\n        \\\"longitude\\\": 18.064465,\\n        \\\"latitude\\\": 59.335635\\n      },\\n      \\\"street2\\\": null,\\n      \\\"care_of\\\": null,\\n      \\\"company_name\\\": null\\n    },\\n    \\\"first_name\\\": null,\\n    \\\"last_name\\\": null,\\n    \\\"email\\\": null,\\n    \\\"name\\\": \\\"Star Republic Kontor STHLM\\\",\\n    \\\"phone\\\": \\\"0707070707\\\",\\n    \\\"cell_phone\\\": null,\\n    \\\"authentication_code\\\": \\\"0FHX2S\\\",\\n    \\\"info\\\": \\\"testinfo\\\",\\n    \\\"expected_pickup_time\\\": \\\"2015-07-17T08:00:07.1670501\\\",\\n  },\\n  \\\"created_at\\\": \\\"2015-07-17T12:14:23.3609882Z\\\",\\n  \\\"modified_at\\\": \\\"2015-07-17T12:14:23.3609882Z\\\",\\n  \\\"total_amount_excl_vat\\\": 999.5,\\n  \\\"order_consumer\\\": {\\n    \\\"address\\\": {\\n      \\\"street\\\": \\\"Kungsgatan 20\\\",\\n      \\\"postal_code\\\": \\\"11442\\\",\\n      \\\"city\\\": \\\"Stockholm\\\",\\n      \\\"country\\\": \\\"Sweden\\\",\\n      \\\"position\\\": null,\\n      \\\"street2\\\": null,\\n      \\\"care_of\\\": null,\\n      \\\"company_name\\\": null\\n    },\\n    \\\"first_name\\\": \\\"Jonas\\\",\\n    \\\"last_name\\\": \\\"Bengtsson\\\",\\n    \\\"email\\\": \\\"[email protected]\\\",\\n    \\\"cell_phone\\\": \\\"+46768670234\\\",\\n    \\\"authentication_code\\\": \\\"AXJGPN\\\",\\n    \\\"consumer_message\\\": null\\n  }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"**Version 2.0**\nCreates an Urb-it order.","slug":"create-order","type":"endpoint","title":"Create Order"}