{"__v":0,"_id":"575676128749830e00681e9d","category":{"version":"575676128749830e00681e82","project":"55a4d5531a5f991700a9409e","_id":"575676128749830e00681e83","__v":0,"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"},"parentDoc":null,"project":"55a4d5531a5f991700a9409e","user":"555b35be8e87d01900b8049e","version":{"__v":2,"_id":"575676128749830e00681e82","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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-02T06:18:30.579Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[]},"settings":"57bc0cc860d92e0e0079e564","auth":"required","params":[],"url":"/v2/stores/me/pickup-locations/urbning-hours"},"isReference":true,"order":6,"body":"[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"\"\n}\n[/block]\nEndpoint for retrieving **Urbning hours**.\nWill look at the opening hours on the current retailer and append average urbning time offset. Opening hours are setup in the **retailer portal**.\nYou can specify a datetime-span to get the opening hours for an extended amount of time.\nIf no parameter is passed, todays openhours will be returned.\n\n**Request parameters** \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Querystring\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Example\",\n    \"0-0\": \"from\",\n    \"0-1\": \"Date\",\n    \"0-2\": \"2015-07-15\",\n    \"1-0\": \"to\",\n    \"1-1\": \"Date\",\n    \"1-2\": \"2015-07-17\",\n    \"h-3\": \"Description\",\n    \"0-3\": \"Filter opening hours from this date\",\n    \"1-3\": \"Filter opening hours to this date\",\n    \"2-0\": \"pickup_location_id\",\n    \"2-1\": \"string\",\n    \"2-2\": \"d29ab990-1512-479d-b720-1c1d08c7a5f6\",\n    \"2-3\": \"Identifier of the specific pickuplocation\"\n  },\n  \"cols\": 4,\n  \"rows\": 3\n}\n[/block]\n**Response parameters**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"from\",\n    \"0-1\": \"DateTime (with the stores local timezoneoffset)\",\n    \"0-2\": \"Indicates from the time the store opening hours start.\",\n    \"1-0\": \"to\",\n    \"1-1\": \"DateTime (with the stores local timezoneoffset)\",\n    \"1-2\": \"Indicates what date and time the indicated opening hours end. Together with **from** this shows a timespan in between the store is open or closed.\",\n    \"2-0\": \"closed\",\n    \"2-1\": \"boolean\",\n    \"2-2\": \"If this parameter is returned as **true**, the store is closed between the given hours.\",\n    \"3-0\": \"date\",\n    \"3-1\": \"DateTime\",\n    \"3-2\": \"The given date\",\n    \"4-0\": \"day_of_week_int\",\n    \"4-1\": \"int\",\n    \"4-2\": \"Day of week as integer\",\n    \"5-0\": \"day_of_week_string\",\n    \"5-1\": \"string\",\n    \"5-2\": \"Day of week as string\",\n    \"6-0\": \"first_urb_specific\",\n    \"6-1\": \"DateTime\",\n    \"6-2\": \"First avaliable time for urbning\",\n    \"7-0\": \"last_urb_specific\",\n    \"7-1\": \"DateTime\",\n    \"7-2\": \"Last avaliable time for urbning\",\n    \"8-0\": \"last_urb_now\",\n    \"8-1\": \"DateTime\",\n    \"8-2\": \"Last avaliable time for now urbning\",\n    \"9-0\": \"offset2\",\n    \"9-1\": \"int\",\n    \"9-2\": \"Opening delay in minutes\"\n  },\n  \"cols\": 3,\n  \"rows\": 10\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example Request\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET https://stage-retailer-api.urb-it.com/api/urbninghours/?from=2015-11-26&to=2015-11-29&pickup_location_id=d29ab990-1512-479d-b720-1c1d08c7a5f6\\nHTTP/1.1\\nAccept-Encoding: gzip,deflate\\nAccept: application/vnd.urb-it.se+json; version=1\\nAuthorization: uwa b0477a45-1198-419f-b159-e484be341512:mltN3WwhN9/EZzu/0nRWjHFMdzYG1INAoVwUJ+mD9Nc=:b97ad65f78b741e78988dcb868f27d4d:1448549091\\nHost: dev-retailer-api.urb-it.com\\nConnection: Keep-Alive\\nUser-Agent: Apache-HttpClient/4.1.1 (java 1.5)\",\n      \"language\": \"http\",\n      \"name\": \"Request\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example Response\"\n}\n[/block]\nExample shows a store with opening hours setup. The example below shows a store where the setup is done for daily opening hours.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"[\\n  {\\n    \\\"closed\\\": false,\\n    \\\"date\\\": \\\"2016-06-02T00:00:00+02:00\\\",\\n    \\\"day_of_week_int\\\": 4,\\n    \\\"day_of_week_string\\\": \\\"Thursday\\\",\\n    \\\"first_urb_specific\\\": \\\"2016-06-02T15:00:00+02:00\\\",\\n    \\\"from\\\": \\\"2016-06-02T14:00:00+02:00\\\",\\n    \\\"last_urb_specific\\\": \\\"2016-06-02T23:00:00+02:00\\\",\\n    \\\"to\\\": \\\"2016-06-02T23:00:00+02:00\\\",\\n    \\\"last_urb_now\\\": \\\"2016-06-02T22:10:00+02:00\\\"\\n  }\\n],\\n\\\"offset\\\": 60\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\nThe example below shows a store with opening hours setup as **specific**.\nA store with specific hours shows times where it's open during a day, and times when it's not. This is done by looking at the timespan and the **closed** parameter.\n\nExample response for specific urbning hours.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"[\\n  {\\n    \\\"closed\\\": false,\\n    \\\"date\\\": \\\"2016-06-02T00:00:00+02:00\\\",\\n    \\\"day_of_week_int\\\": 4,\\n    \\\"day_of_week_string\\\": \\\"Thursday\\\",\\n    \\\"first_urb_specific\\\": \\\"2016-06-02T15:00:00+02:00\\\",\\n    \\\"from\\\": \\\"2016-06-02T14:00:00+02:00\\\",\\n    \\\"last_urb_specific\\\": \\\"2016-06-02T23:00:00+02:00\\\",\\n    \\\"to\\\": \\\"2016-06-02T23:00:00+02:00\\\",\\n    \\\"last_urb_now\\\": \\\"2016-06-02T22:10:00+02:00\\\"\\n  },\\n  {\\n    \\\"closed\\\": false,\\n    \\\"date\\\": \\\"2016-06-03T00:00:00+02:00\\\",\\n    \\\"day_of_week_int\\\": 5,\\n    \\\"day_of_week_string\\\": \\\"Friday\\\",\\n    \\\"first_urb_specific\\\": \\\"2016-06-03T03:00:00+02:00\\\",\\n    \\\"from\\\": \\\"2016-06-03T02:00:00+02:00\\\",\\n    \\\"last_urb_specific\\\": \\\"2016-06-03T14:00:00+02:00\\\",\\n    \\\"to\\\": \\\"2016-06-03T14:00:00+02:00\\\",\\n    \\\"last_urb_now\\\": \\\"2016-06-03T13:10:00+02:00\\\"\\n  }\\n],\\n\\\"offset\\\": 60\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"**Version 2.0**\nReturns avaliable urbning hours for the retailer","slug":"urbning-hours","type":"endpoint","title":"Urbning hours"}

getUrbning hours

**Version 2.0** Returns avaliable urbning hours for the retailer

Definition

{{ api_url }}{{ page_api_url }}

Documentation

[block:api-header] { "type": "get", "title": "" } [/block] Endpoint for retrieving **Urbning hours**. Will look at the opening hours on the current retailer and append average urbning time offset. Opening hours are setup in the **retailer portal**. You can specify a datetime-span to get the opening hours for an extended amount of time. If no parameter is passed, todays openhours will be returned. **Request parameters** [block:parameters] { "data": { "h-0": "Querystring", "h-1": "Type", "h-2": "Example", "0-0": "from", "0-1": "Date", "0-2": "2015-07-15", "1-0": "to", "1-1": "Date", "1-2": "2015-07-17", "h-3": "Description", "0-3": "Filter opening hours from this date", "1-3": "Filter opening hours to this date", "2-0": "pickup_location_id", "2-1": "string", "2-2": "d29ab990-1512-479d-b720-1c1d08c7a5f6", "2-3": "Identifier of the specific pickuplocation" }, "cols": 4, "rows": 3 } [/block] **Response parameters** [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Type", "h-2": "Description", "0-0": "from", "0-1": "DateTime (with the stores local timezoneoffset)", "0-2": "Indicates from the time the store opening hours start.", "1-0": "to", "1-1": "DateTime (with the stores local timezoneoffset)", "1-2": "Indicates what date and time the indicated opening hours end. Together with **from** this shows a timespan in between the store is open or closed.", "2-0": "closed", "2-1": "boolean", "2-2": "If this parameter is returned as **true**, the store is closed between the given hours.", "3-0": "date", "3-1": "DateTime", "3-2": "The given date", "4-0": "day_of_week_int", "4-1": "int", "4-2": "Day of week as integer", "5-0": "day_of_week_string", "5-1": "string", "5-2": "Day of week as string", "6-0": "first_urb_specific", "6-1": "DateTime", "6-2": "First avaliable time for urbning", "7-0": "last_urb_specific", "7-1": "DateTime", "7-2": "Last avaliable time for urbning", "8-0": "last_urb_now", "8-1": "DateTime", "8-2": "Last avaliable time for now urbning", "9-0": "offset2", "9-1": "int", "9-2": "Opening delay in minutes" }, "cols": 3, "rows": 10 } [/block] [block:api-header] { "type": "basic", "title": "Example Request" } [/block] [block:code] { "codes": [ { "code": "GET https://stage-retailer-api.urb-it.com/api/urbninghours/?from=2015-11-26&to=2015-11-29&pickup_location_id=d29ab990-1512-479d-b720-1c1d08c7a5f6\nHTTP/1.1\nAccept-Encoding: gzip,deflate\nAccept: application/vnd.urb-it.se+json; version=1\nAuthorization: uwa b0477a45-1198-419f-b159-e484be341512:mltN3WwhN9/EZzu/0nRWjHFMdzYG1INAoVwUJ+mD9Nc=:b97ad65f78b741e78988dcb868f27d4d:1448549091\nHost: dev-retailer-api.urb-it.com\nConnection: Keep-Alive\nUser-Agent: Apache-HttpClient/4.1.1 (java 1.5)", "language": "http", "name": "Request" } ] } [/block] [block:api-header] { "type": "basic", "title": "Example Response" } [/block] Example shows a store with opening hours setup. The example below shows a store where the setup is done for daily opening hours. [block:code] { "codes": [ { "code": "[\n {\n \"closed\": false,\n \"date\": \"2016-06-02T00:00:00+02:00\",\n \"day_of_week_int\": 4,\n \"day_of_week_string\": \"Thursday\",\n \"first_urb_specific\": \"2016-06-02T15:00:00+02:00\",\n \"from\": \"2016-06-02T14:00:00+02:00\",\n \"last_urb_specific\": \"2016-06-02T23:00:00+02:00\",\n \"to\": \"2016-06-02T23:00:00+02:00\",\n \"last_urb_now\": \"2016-06-02T22:10:00+02:00\"\n }\n],\n\"offset\": 60", "language": "json" } ] } [/block] The example below shows a store with opening hours setup as **specific**. A store with specific hours shows times where it’s open during a day, and times when it’s not. This is done by looking at the timespan and the **closed** parameter. Example response for specific urbning hours. [block:code] { "codes": [ { "code": "[\n {\n \"closed\": false,\n \"date\": \"2016-06-02T00:00:00+02:00\",\n \"day_of_week_int\": 4,\n \"day_of_week_string\": \"Thursday\",\n \"first_urb_specific\": \"2016-06-02T15:00:00+02:00\",\n \"from\": \"2016-06-02T14:00:00+02:00\",\n \"last_urb_specific\": \"2016-06-02T23:00:00+02:00\",\n \"to\": \"2016-06-02T23:00:00+02:00\",\n \"last_urb_now\": \"2016-06-02T22:10:00+02:00\"\n },\n {\n \"closed\": false,\n \"date\": \"2016-06-03T00:00:00+02:00\",\n \"day_of_week_int\": 5,\n \"day_of_week_string\": \"Friday\",\n \"first_urb_specific\": \"2016-06-03T03:00:00+02:00\",\n \"from\": \"2016-06-03T02:00:00+02:00\",\n \"last_urb_specific\": \"2016-06-03T14:00:00+02:00\",\n \"to\": \"2016-06-03T14:00:00+02:00\",\n \"last_urb_now\": \"2016-06-03T13:10:00+02:00\"\n }\n],\n\"offset\": 60", "language": "json" } ] } [/block]

User Information

Try It Out

get
 
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status 
Response Headers
{{ tryResults.responseHeaders }}