{"_id":"575676128749830e00681e96","category":{"_id":"575676128749830e00681e84","version":"575676128749830e00681e82","__v":0,"project":"55a4d5531a5f991700a9409e","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-26T08:50:49.316Z","from_sync":false,"order":1,"slug":"click-get","title":"urb-it as click & Get"},"parentDoc":null,"__v":5,"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","user":"555b35be8e87d01900b8049e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-02T06:49:21.094Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"post","results":{"codes":[]},"settings":"57bc0cc860d92e0e0079e564","auth":"required","params":[],"url":"/v2/checkouts"},"isReference":true,"order":1,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request\"\n}\n[/block]\n**Properties**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"retailer_reference_id\",\n    \"0-1\": \"string\",\n    \"0-2\": \"External order or reference number, usually an order id\",\n    \"1-0\": \"currency\",\n    \"1-1\": \"string (required)\",\n    \"1-2\": \"ISO4217 standard, Both numeric and upper case letter codes are accepted\",\n    \"2-0\": \"return_url\",\n    \"2-1\": \"string (required)\",\n    \"2-2\": \"The url to return to after successful transaction\",\n    \"3-0\": \"cancel_url\",\n    \"3-1\": \"string (required)\",\n    \"3-2\": \"The url to return to in case the user cancels the checkout\",\n    \"4-0\": \"articles\",\n    \"4-1\": \"article []\",\n    \"4-2\": \"List of selected articles\",\n    \"5-0\": \"language\",\n    \"5-1\": \"string\",\n    \"5-2\": \"language as two-letter ISO 639‑1 code\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]\n**Article**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"retailer_reference_id\",\n    \"0-1\": \"string\",\n    \"0-2\": \"Retailers article reference (article id)\",\n    \"1-0\": \"description\",\n    \"1-1\": \"string\",\n    \"1-2\": \"Name or short description about the article\",\n    \"2-0\": \"price\",\n    \"2-1\": \"int\",\n    \"2-2\": \"Total price (including tax) in cents, multiplied by quantity\",\n    \"3-0\": \"vat_percentage\",\n    \"3-1\": \"int\",\n    \"3-2\": \"Percentage of tax rate, multiplied by 100 and provided as an integer. (ex: 2500 for 25%)\",\n    \"4-0\": \"quantity\",\n    \"4-1\": \"int\",\n    \"4-2\": \"Number of articles\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\n**Request example** \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST / HTTP/1.1\\nHost: stage-retailer-api.urb-it.com/api/checkout\\nAuthorization: UWA b0477a45-1198-419f-b159-e484be341512:DNX22veCTbges6DH9n67TAAzSa0jFE0qOtJBstvIdyU=:48e0e16-cbc9-4953-ad33-f3d17c5330dc:1444981142\\nContent-Type: application/json\\n{\\n  \\\"retailer_reference_id\\\": \\\"ref1\\\",\\n  \\\"currency\\\": \\\"SEK\\\",\\n  \\\"language\\\": \\\"sv\\\",\\n  \\\"return_url\\\": \\\"/\\\",\\n  \\\"cancel_url\\\": \\\"/\\\",\\n  \\\"articles\\\": [\\n    {\\n      \\\"retailer_reference_id\\\": \\\"art1\\\",\\n      \\\"description\\\": \\\"Test\\\",\\n      \\\"price\\\": 520000,\\n      \\\"vat_percentage\\\": 2500,\\n      \\\"quantity\\\": 1\\n    }\\n  ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\n**Properties**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"Location\",\n    \"0-1\": \"string\",\n    \"0-2\": \"Location to the created checkout\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n**Success response** \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP/1.1 201 Created\\nContent-Type: application/json\\n{\\n\\t\\\"location\\\":\\\"https://stage-checkout.urb-it.com/c/12434-234f3f3-f32f2f2-2f3f233\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n**Reference id already created response**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP/1.1 409 Conflict\\nContent-Type: application/json\\n{\\n  \\\"status\\\": 409,\\n  \\\"code\\\": \\\"409\\\",\\n  \\\"message\\\": \\\"Reference id already created\\\",\\n  \\\"developer_message\\\": \\\"Reference id already created\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n**Not configured**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP/1.1 403 Forbidden\\nContent-Type: application/json\\n{\\n  \\\"status\\\": 403,\\n  \\\"code\\\": \\\"403\\\",\\n  \\\"message\\\": \\\"Retailer is not configured to use click&get\\\",\\n  \\\"developer_message\\\": \\\"Retailer is not configured to use click&get\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n**UnprocessableEntity response**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP/1.1 422 UnprocessableEntity\\n{\\n  \\\"exception\\\": \\\"UnprocessableEntity\\\",\\n  \\\"description\\\": \\\"Your request was understood but contained invalid parameters.\\\",\\n  \\\"invalid_properties\\\": [\\n    {\\n      \\\"member_name\\\": \\\"amount\\\",\\n      \\\"message\\\": \\\"amount is required\\\"\\n    }\\n  ],\\n  \\\"status\\\": 422,\\n  \\\"code\\\": \\\"422\\\",\\n  \\\"message\\\": \\\"Unprocessable entity\\\",\\n  \\\"developer_message\\\": \\\"All properties are not valid. Check the invalid_properties for   \\t\\tmore information.\\\",\\n  \\\"more_info\\\": null\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"Instructions to integrate with the Click&Get","slug":"integrate-clickget","type":"endpoint","title":"Integrate Click&Get"}

postIntegrate Click&Get

Instructions to integrate with the Click&Get

Definition

{{ api_url }}{{ page_api_url }}

Documentation

[block:api-header] { "type": "basic", "title": "Request" } [/block] **Properties** [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Description", "h-3": "Description", "0-0": "retailer_reference_id", "0-1": "string", "0-2": "External order or reference number, usually an order id", "1-0": "currency", "1-1": "string (required)", "1-2": "ISO4217 standard, Both numeric and upper case letter codes are accepted", "2-0": "return_url", "2-1": "string (required)", "2-2": "The url to return to after successful transaction", "3-0": "cancel_url", "3-1": "string (required)", "3-2": "The url to return to in case the user cancels the checkout", "4-0": "articles", "4-1": "article []", "4-2": "List of selected articles", "5-0": "language", "5-1": "string", "5-2": "language as two-letter ISO 639‑1 code" }, "cols": 3, "rows": 6 } [/block] **Article** [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "retailer_reference_id", "0-1": "string", "0-2": "Retailers article reference (article id)", "1-0": "description", "1-1": "string", "1-2": "Name or short description about the article", "2-0": "price", "2-1": "int", "2-2": "Total price (including tax) in cents, multiplied by quantity", "3-0": "vat_percentage", "3-1": "int", "3-2": "Percentage of tax rate, multiplied by 100 and provided as an integer. (ex: 2500 for 25%)", "4-0": "quantity", "4-1": "int", "4-2": "Number of articles" }, "cols": 3, "rows": 5 } [/block] **Request example** [block:code] { "codes": [ { "code": "POST / HTTP/1.1\nHost: stage-retailer-api.urb-it.com/api/checkout\nAuthorization: UWA b0477a45-1198-419f-b159-e484be341512:DNX22veCTbges6DH9n67TAAzSa0jFE0qOtJBstvIdyU=:48e0e16-cbc9-4953-ad33-f3d17c5330dc:1444981142\nContent-Type: application/json\n{\n \"retailer_reference_id\": \"ref1\",\n \"currency\": \"SEK\",\n \"language\": \"sv\",\n \"return_url\": \"/\",\n \"cancel_url\": \"/\",\n \"articles\": [\n {\n \"retailer_reference_id\": \"art1\",\n \"description\": \"Test\",\n \"price\": 520000,\n \"vat_percentage\": 2500,\n \"quantity\": 1\n }\n ]\n}", "language": "json" } ] } [/block] [block:api-header] { "type": "basic", "title": "Response" } [/block] **Properties** [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "Location", "0-1": "string", "0-2": "Location to the created checkout" }, "cols": 3, "rows": 1 } [/block] **Success response** [block:code] { "codes": [ { "code": "HTTP/1.1 201 Created\nContent-Type: application/json\n{\n\t\"location\":\"https://stage-checkout.urb-it.com/c/12434-234f3f3-f32f2f2-2f3f233\"\n}", "language": "json" } ] } [/block] **Reference id already created response** [block:code] { "codes": [ { "code": "HTTP/1.1 409 Conflict\nContent-Type: application/json\n{\n \"status\": 409,\n \"code\": \"409\",\n \"message\": \"Reference id already created\",\n \"developer_message\": \"Reference id already created\"\n}", "language": "json" } ] } [/block] **Not configured** [block:code] { "codes": [ { "code": "HTTP/1.1 403 Forbidden\nContent-Type: application/json\n{\n \"status\": 403,\n \"code\": \"403\",\n \"message\": \"Retailer is not configured to use click&get\",\n \"developer_message\": \"Retailer is not configured to use click&get\"\n}", "language": "json" } ] } [/block] **UnprocessableEntity response** [block:code] { "codes": [ { "code": "HTTP/1.1 422 UnprocessableEntity\n{\n \"exception\": \"UnprocessableEntity\",\n \"description\": \"Your request was understood but contained invalid parameters.\",\n \"invalid_properties\": [\n {\n \"member_name\": \"amount\",\n \"message\": \"amount is required\"\n }\n ],\n \"status\": 422,\n \"code\": \"422\",\n \"message\": \"Unprocessable entity\",\n \"developer_message\": \"All properties are not valid. Check the invalid_properties for \t\tmore information.\",\n \"more_info\": null\n}", "language": "json" } ] } [/block]

User Information

Try It Out

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